From 9b6210c105599a50e63bf1e63017816dad6603a1 Mon Sep 17 00:00:00 2001 From: Russell Cohen Date: Thu, 28 Apr 2022 18:24:21 -0400 Subject: [PATCH] Release (#1351) * Bump version numbers in gradle.properties * Add auto-changelog script * Update models, holding back S3 * Update CI to 1.58.1 --- .github/workflows/ci.yml | 2 +- .github/workflows/pull-request-bot.yml | 2 +- CHANGELOG.md | 10 + CHANGELOG.next.toml | 30 - aws/SDK_CHANGELOG.md | 12 + aws/sdk/aws-models/amplify.json | 10 +- aws/sdk/aws-models/appflow.json | 100 +- aws/sdk/aws-models/appstream.json | 22 + aws/sdk/aws-models/athena.json | 34 +- aws/sdk/aws-models/auditmanager.json | 6 +- aws/sdk/aws-models/autoscaling.json | 143 +- aws/sdk/aws-models/batch.json | 255 +++- aws/sdk/aws-models/braket.json | 160 +- aws/sdk/aws-models/chime-sdk-meetings.json | 161 ++ aws/sdk/aws-models/cloudfront.json | 82 ++ aws/sdk/aws-models/cloudtrail.json | 72 +- aws/sdk/aws-models/connect.json | 1539 +++++++++++++++++++- aws/sdk/aws-models/ec2.json | 310 +++- aws/sdk/aws-models/elasticache.json | 27 +- aws/sdk/aws-models/fsx.json | 22 +- aws/sdk/aws-models/gamelift.json | 106 +- aws/sdk/aws-models/glue.json | 398 ++++- aws/sdk/aws-models/guardduty.json | 13 +- aws/sdk/aws-models/iotsitewise.json | 1314 ++++++++++++++--- aws/sdk/aws-models/iottwinmaker.json | 23 +- aws/sdk/aws-models/iotwireless.json | 910 +++++++++++- aws/sdk/aws-models/kendra.json | 167 ++- aws/sdk/aws-models/kms.json | 533 +++++-- aws/sdk/aws-models/lightsail.json | 315 +++- aws/sdk/aws-models/lookoutequipment.json | 692 ++++++++- aws/sdk/aws-models/lookoutmetrics.json | 355 +++++ aws/sdk/aws-models/macie2.json | 33 +- aws/sdk/aws-models/mediatailor.json | 609 +++++++- aws/sdk/aws-models/mgn.json | 407 +++--- aws/sdk/aws-models/monitoring.json | 120 +- aws/sdk/aws-models/mq.json | 77 +- aws/sdk/aws-models/network-firewall.json | 431 +++++- aws/sdk/aws-models/personalize.json | 129 +- aws/sdk/aws-models/polly.json | 8 + aws/sdk/aws-models/pricing.json | 32 +- aws/sdk/aws-models/rds-data.json | 165 ++- aws/sdk/aws-models/rds.json | 684 ++------- aws/sdk/aws-models/redshift.json | 94 +- aws/sdk/aws-models/rekognition.json | 463 +++++- aws/sdk/aws-models/sagemaker.json | 683 ++++++--- aws/sdk/aws-models/secretsmanager.json | 80 +- aws/sdk/aws-models/securityhub.json | 51 +- aws/sdk/aws-models/ssm.json | 59 +- aws/sdk/aws-models/storagegateway.json | 44 +- aws/sdk/aws-models/textract.json | 129 +- aws/sdk/aws-models/transfer.json | 43 +- aws/sdk/aws-models/wisdom.json | 393 +++-- aws/sdk/aws-models/worklink.json | 139 +- gradle.properties | 4 +- tools/sdk-lints/Cargo.lock | 49 + tools/sdk-lints/Cargo.toml | 2 + tools/sdk-lints/src/changelog.rs | 2 +- tools/sdk-lints/src/main.rs | 61 +- 58 files changed, 10541 insertions(+), 2275 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e94a7c7a01..2c2eff7371 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -9,7 +9,7 @@ on: workflow_call: env: - rust_version: 1.56.1 + rust_version: 1.58.1 rust_toolchain_components: clippy,rustfmt jobs: diff --git a/.github/workflows/pull-request-bot.yml b/.github/workflows/pull-request-bot.yml index 8a21923758..c424d08dac 100644 --- a/.github/workflows/pull-request-bot.yml +++ b/.github/workflows/pull-request-bot.yml @@ -15,7 +15,7 @@ concurrency: env: java_version: 11 - rust_version: 1.56.1 + rust_version: 1.58.1 rust_toolchain_components: clippy,rustfmt apt_dependencies: libssl-dev gnuplot jq diff --git a/CHANGELOG.md b/CHANGELOG.md index bd1a1be066..23aa146ccf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,14 @@ +0.41.0 (April 28th, 2022) +========================= +**Breaking Changes:** +- ⚠ ([smithy-rs#1318](https://github.com/awslabs/smithy-rs/issues/1318)) Bump [MSRV](https://github.com/awslabs/aws-sdk-rust#supported-rust-versions-msrv) from 1.56.1 to 1.58.1 per our "two versions behind" policy. + +**New this release:** +- ([smithy-rs#1307](https://github.com/awslabs/smithy-rs/issues/1307)) Add new trait for HTTP body callbacks. This is the first step to enabling us to implement optional checksum verification of requests and responses. +- ([smithy-rs#1330](https://github.com/awslabs/smithy-rs/issues/1330)) Upgrade to Smithy 1.21.0 + + 0.40.2 (April 14th, 2022) ========================= diff --git a/CHANGELOG.next.toml b/CHANGELOG.next.toml index 1bf22eaf31..72d79628e7 100644 --- a/CHANGELOG.next.toml +++ b/CHANGELOG.next.toml @@ -10,33 +10,3 @@ # references = ["smithy-rs#920"] # meta = { "breaking" = false, "tada" = false, "bug" = false } # author = "rcoh" - -[[aws-sdk-rust]] -message = "Bump [MSRV](https://github.com/awslabs/aws-sdk-rust#supported-rust-versions-msrv) from 1.56.1 to 1.58.1 per our \"two versions behind\" policy." -references = ["smithy-rs#1318"] -meta = { "breaking" = true, "tada" = false, "bug" = false } -author = "Velfi" - -[[smithy-rs]] -message = "Bump [MSRV](https://github.com/awslabs/aws-sdk-rust#supported-rust-versions-msrv) from 1.56.1 to 1.58.1 per our \"two versions behind\" policy." -references = ["smithy-rs#1318"] -meta = { "breaking" = true, "tada" = false, "bug" = false } -author = "Velfi" - -[[smithy-rs]] -message = "Add new trait for HTTP body callbacks. This is the first step to enabling us to implement optional checksum verification of requests and responses." -references = ["smithy-rs#1307"] -meta = { "breaking" = false, "tada" = false, "bug" = false } -author = "Velfi" - -[[smithy-rs]] -message = "Upgrade to Smithy 1.21.0" -references = ["smithy-rs#1330"] -meta = { "breaking" = false, "tada" = false, "bug" = false } -author = "jdisanti" - -[[aws-sdk-rust]] -message = "Suppress irrelevant `$HOME` expansion warning when running in a Lambda Extension" -references = ["smithy-rs#1344"] -meta = { "breaking" = false, "tada" = false, "bug" = true } -author = "ryansb" diff --git a/aws/SDK_CHANGELOG.md b/aws/SDK_CHANGELOG.md index dd9a9428b5..cfb0af3561 100644 --- a/aws/SDK_CHANGELOG.md +++ b/aws/SDK_CHANGELOG.md @@ -1,4 +1,16 @@ +0.11.0 (April 28th, 2022) +========================= +**Breaking Changes:** +- ⚠ ([smithy-rs#1318](https://github.com/awslabs/smithy-rs/issues/1318)) Bump [MSRV](https://github.com/awslabs/aws-sdk-rust#supported-rust-versions-msrv) from 1.56.1 to 1.58.1 per our "two versions behind" policy. + +**New this release:** +- 🐛 ([smithy-rs#1344](https://github.com/awslabs/smithy-rs/issues/1344), @ryansb) Suppress irrelevant `$HOME` expansion warning when running in a Lambda Extension + +**Contributors** +Thank you for your contributions! ❤ +- @ryansb ([smithy-rs#1344](https://github.com/awslabs/smithy-rs/issues/1344)) + 0.10.1 (April 14th, 2022) ========================= diff --git a/aws/sdk/aws-models/amplify.json b/aws/sdk/aws-models/amplify.json index 55cfdb00be..e5fdcd00ad 100644 --- a/aws/sdk/aws-models/amplify.json +++ b/aws/sdk/aws-models/amplify.json @@ -340,7 +340,7 @@ "repositoryCloneMethod": { "target": "com.amazonaws.amplify#RepositoryCloneMethod", "traits": { - "smithy.api#documentation": "

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

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

This is for internal use.

\n \n

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

" } } }, @@ -1001,13 +1001,13 @@ "oauthToken": { "target": "com.amazonaws.amplify#OauthToken", "traits": { - "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key. The OAuth token is not\n stored.

" + "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" } }, "accessToken": { "target": "com.amazonaws.amplify#AccessToken", "traits": { - "smithy.api#documentation": "

The personal access token for a third-party source control system for an Amplify app.\n The personal access token is used to create a webhook and a read-only deploy key. The\n token is not stored.

" + "smithy.api#documentation": "

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" } }, "environmentVariables": { @@ -5008,13 +5008,13 @@ "oauthToken": { "target": "com.amazonaws.amplify#OauthToken", "traits": { - "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The token\n is used to create a webhook and a read-only deploy key. The OAuth token is not stored.\n

" + "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit.

\n

To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" } }, "accessToken": { "target": "com.amazonaws.amplify#AccessToken", "traits": { - "smithy.api#documentation": "

The personal access token for a third-party source control system for an Amplify app.\n The token is used to create webhook and a read-only deploy key. The token is not stored.\n

" + "smithy.api#documentation": "

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" } } }, diff --git a/aws/sdk/aws-models/appflow.json b/aws/sdk/aws-models/appflow.json index 1ea5b90c8d..f21f240a81 100644 --- a/aws/sdk/aws-models/appflow.json +++ b/aws/sdk/aws-models/appflow.json @@ -283,7 +283,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 512 + "max": 2048 }, "smithy.api#pattern": "^\\S+$" } @@ -4871,6 +4871,77 @@ "smithy.api#documentation": "

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

" } }, + "com.amazonaws.appflow#OAuth2CustomParameter": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.appflow#Key", + "traits": { + "smithy.api#documentation": "

The key of the custom parameter required for OAuth 2.0 authentication.

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

Indicates whether the custom parameter for OAuth 2.0 authentication is required.

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

The label of the custom parameter used for OAuth 2.0 authentication.

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

A description about the custom parameter used for OAuth 2.0 authentication.

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

Indicates whether this authentication custom parameter is a sensitive field.

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

Contains default values for this authentication parameter that are supplied by the\n connector.

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

Indicates whether custom parameter is used with TokenUrl or AuthUrl.

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

Custom parameter required for OAuth 2.0 authentication.

" + } + }, + "com.amazonaws.appflow#OAuth2CustomPropType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TOKEN_URL", + "name": "TOKEN_URL" + }, + { + "value": "AUTH_URL", + "name": "AUTH_URL" + } + ] + } + }, + "com.amazonaws.appflow#OAuth2CustomPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.appflow#OAuth2CustomParameter" + } + }, "com.amazonaws.appflow#OAuth2Defaults": { "type": "structure", "members": { @@ -4897,6 +4968,12 @@ "traits": { "smithy.api#documentation": "

OAuth 2.0 grant types supported by the connector.

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

List of custom parameters required for OAuth 2.0 authentication.

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

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

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

Associates your token URL with a map of properties that you define. Use this parameter\n to provide any additional details that the connector requires to authenticate your\n request.

" + } } }, "traits": { @@ -7799,6 +7882,21 @@ "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" } }, + "com.amazonaws.appflow#TokenUrlCustomProperties": { + "type": "map", + "key": { + "target": "com.amazonaws.appflow#CustomPropertyKey" + }, + "value": { + "target": "com.amazonaws.appflow#CustomPropertyValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.appflow#TokenUrlList": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/appstream.json b/aws/sdk/aws-models/appstream.json index 667c0ca134..a3bdb0f138 100644 --- a/aws/sdk/aws-models/appstream.json +++ b/aws/sdk/aws-models/appstream.json @@ -1382,6 +1382,12 @@ "traits": { "smithy.api#documentation": "

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

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

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

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

The USB device filter strings associated with the fleet.

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

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

" + } } }, "traits": { @@ -4151,6 +4163,10 @@ { "value": "USB_DEVICE_FILTER_STRINGS", "name": "USB_DEVICE_FILTER_STRINGS" + }, + { + "value": "SESSION_SCRIPT_S3_LOCATION", + "name": "SESSION_SCRIPT_S3_LOCATION" } ] } @@ -6867,6 +6883,12 @@ "traits": { "smithy.api#documentation": "

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.

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

The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.

" + } } } }, diff --git a/aws/sdk/aws-models/athena.json b/aws/sdk/aws-models/athena.json index 5a24124b64..a5807d3897 100644 --- a/aws/sdk/aws-models/athena.json +++ b/aws/sdk/aws-models/athena.json @@ -35,7 +35,7 @@ "S3AclOption": { "target": "com.amazonaws.athena#S3AclOption", "traits": { - "smithy.api#documentation": "

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

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

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

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

An integer value that provides specific information about an Athena query\n error. For the meaning of specific values, see the Error Type Reference in the Amazon Athena User\n Guide.

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

True if the query might succeed if resubmitted.

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

Contains a short description of the error that occurred.

" + } } }, "traits": { @@ -1027,19 +1039,19 @@ "EncryptionOption": { "target": "com.amazonaws.athena#EncryptionOption", "traits": { - "smithy.api#documentation": "

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

\n

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

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

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

\n

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

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

For SSE-KMS and CSE-KMS, this is the KMS key ARN or\n ID.

" + "smithy.api#documentation": "

For SSE_KMS and CSE_KMS, this is the KMS key ARN or\n ID.

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

If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE-KMS or CSE-KMS) and key\n information.

" + "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE_KMS or CSE_KMS) and key\n information.

" } }, "com.amazonaws.athena#EncryptionOption": { @@ -2356,7 +2368,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } }, "com.amazonaws.athena#NamedQueryDescriptionString": { @@ -2731,13 +2743,13 @@ "EncryptionConfiguration": { "target": "com.amazonaws.athena#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE-KMS or CSE-KMS) and key information.\n This is a client-side setting. If workgroup settings override client-side settings, then\n the query uses the encryption configuration that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" + "smithy.api#documentation": "

If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, SSE_KMS or CSE_KMS) and key information.\n This is a client-side setting. If workgroup settings override client-side settings, then\n the query uses the encryption configuration that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

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

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

\n

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

" + "smithy.api#documentation": "

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

\n

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

" } }, "AclConfiguration": { @@ -2763,7 +2775,7 @@ "RemoveOutputLocation": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the\n OutputLocation in ResultConfigurationUpdates (the\n client-side setting), the OutputLocation in the workgroup's\n ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

" + "smithy.api#documentation": "

If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the\n OutputLocation in ResultConfigurationUpdates (the\n client-side setting), the OutputLocation in the workgroup's\n ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

" } }, "EncryptionConfiguration": { @@ -2781,13 +2793,13 @@ "ExpectedBucketOwner": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

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

\n \n

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

" + "smithy.api#documentation": "

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

\n\n

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

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

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

" + "smithy.api#documentation": "

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

" } }, "AclConfiguration": { @@ -3407,7 +3419,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

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

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

", "smithy.api#idempotent": {} } }, diff --git a/aws/sdk/aws-models/auditmanager.json b/aws/sdk/aws-models/auditmanager.json index 83b5d06e30..603c85617d 100644 --- a/aws/sdk/aws-models/auditmanager.json +++ b/aws/sdk/aws-models/auditmanager.json @@ -3295,7 +3295,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an assessment report from an assessment in Audit Manager.

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

Deletes an assessment report in Audit Manager.

\n

When you run the DeleteAssessmentReport operation, Audit Manager attempts to delete the following data:

\n
    \n
  1. \n

    The specified assessment report that’s stored in your S3 bucket

    \n
    2. \n
  2. \n

    The associated metadata that’s stored in Audit Manager

    \n
    3. \n
\n

If Audit Manager can’t access the assessment report in your S3 bucket, the report\n isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t\n fail. Instead, it proceeds to delete the associated metadata only. You must then delete the\n assessment report from the S3 bucket yourself.

\n

This scenario happens when Audit Manager receives a 403 (Forbidden) or\n 404 (Not Found) error from Amazon S3. To avoid this, make sure that\n your S3 bucket is available, and that you configured the correct permissions for Audit Manager to delete resources in your S3 bucket. For an example permissions policy that\n you can use, see Assessment report destination permissions in the Audit Manager User Guide. For information about the issues that could cause a 403\n (Forbidden) or 404 (Not Found) error from Amazon S3, see\n List of Error Codes in the Amazon Simple Storage Service API\n Reference.

", "smithy.api#http": { "method": "DELETE", "uri": "/assessments/{assessmentId}/reports/{assessmentReportId}", @@ -6743,13 +6743,13 @@ "keywordInputType": { "target": "com.amazonaws.auditmanager#KeywordInputType", "traits": { - "smithy.api#documentation": "

The method of input for the keyword.

" + "smithy.api#documentation": "

The input method for the keyword.

" } }, "keywordValue": { "target": "com.amazonaws.auditmanager#KeywordValue", "traits": { - "smithy.api#documentation": "

The value of the keyword that's used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names\n when mapping a control data source.

" + "smithy.api#documentation": "

The value of the keyword that's used when mapping a control data source. For example,\n this can be a CloudTrail event name, a rule name for Config, a\n Security Hub control, or the name of an Amazon Web Services API call.

\n

If you’re mapping a data source to a rule in Config, the\n keywordValue that you specify depends on the type of rule:

\n " } } }, diff --git a/aws/sdk/aws-models/autoscaling.json b/aws/sdk/aws-models/autoscaling.json index 6fb25d9b68..2d80fed1b2 100644 --- a/aws/sdk/aws-models/autoscaling.json +++ b/aws/sdk/aws-models/autoscaling.json @@ -394,6 +394,9 @@ "input": { "target": "com.amazonaws.autoscaling#AttachInstancesQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -607,7 +610,7 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n health check.

" + "smithy.api#documentation": "

The duration of the health check grace period, in seconds.

" } }, "Instances": { @@ -710,7 +713,13 @@ "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

\n

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

\n

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

" + "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only.

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

The duration of the default instance warmup, in seconds.

" } } }, @@ -1568,6 +1577,9 @@ "input": { "target": "com.amazonaws.autoscaling#CreateAutoScalingGroupType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" @@ -1643,7 +1655,7 @@ "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300. This setting applies\n when using simple scaling policies, but not when using other scaling policies or\n scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling\n in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

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

\n

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

\n

Default: 300 seconds

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

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

\n

Required if you are adding an ELB health check.

" + "smithy.api#documentation": "

\n \n

\n

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the InService state. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

\n

Default: 0 seconds

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

The name of an existing placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

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

\n \n

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

\n " } }, "VPCZoneIdentifier": { @@ -1741,6 +1753,12 @@ "traits": { "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

\n

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

\n \n

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

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

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

\n \n

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

\n

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

\n \n

Default: None

" + } } } }, @@ -1749,6 +1767,9 @@ "input": { "target": "com.amazonaws.autoscaling#CreateLaunchConfigurationType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" @@ -1795,13 +1816,13 @@ "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

\n

This parameter can only be used if you are launching EC2-Classic instances.

" + "smithy.api#documentation": "

\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n

\n

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances.

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

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

\n

If you specify the ClassicLinkVPCId parameter, you must specify this\n parameter.

" + "smithy.api#documentation": "

\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n

\n

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances.

\n

If you specify the ClassicLinkVPCId parameter, you must specify this\n parameter.

" } }, "UserData": { @@ -1889,6 +1910,9 @@ "input": { "target": "com.amazonaws.autoscaling#CreateOrUpdateTagsType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" @@ -1960,11 +1984,20 @@ "smithy.api#documentation": "

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

\n

To create your customized metric specification:

\n \n

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

\n \n

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

\n " } }, + "com.amazonaws.autoscaling#DefaultInstanceWarmup": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.autoscaling#DeleteAutoScalingGroup": { "type": "operation", "input": { "target": "com.amazonaws.autoscaling#DeleteAutoScalingGroupType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2003,6 +2036,9 @@ "input": { "target": "com.amazonaws.autoscaling#LaunchConfigurationNameType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2060,6 +2096,9 @@ "input": { "target": "com.amazonaws.autoscaling#DeleteNotificationConfigurationType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2093,6 +2132,9 @@ "input": { "target": "com.amazonaws.autoscaling#DeletePolicyType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2128,6 +2170,9 @@ "input": { "target": "com.amazonaws.autoscaling#DeleteScheduledActionType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2161,6 +2206,9 @@ "input": { "target": "com.amazonaws.autoscaling#DeleteTagsType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -2235,6 +2283,9 @@ }, "com.amazonaws.autoscaling#DescribeAccountLimits": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer" }, @@ -2278,6 +2329,9 @@ }, "com.amazonaws.autoscaling#DescribeAdjustmentTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeAdjustmentTypesAnswer" }, @@ -2455,6 +2509,9 @@ }, "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeAutoScalingNotificationTypesAnswer" }, @@ -2573,6 +2630,9 @@ }, "com.amazonaws.autoscaling#DescribeLifecycleHookTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeLifecycleHookTypesAnswer" }, @@ -2766,6 +2826,9 @@ }, "com.amazonaws.autoscaling#DescribeMetricCollectionTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeMetricCollectionTypesAnswer" }, @@ -2989,6 +3052,9 @@ }, "com.amazonaws.autoscaling#DescribeScalingProcessTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#ProcessesType" }, @@ -3119,6 +3185,9 @@ }, "com.amazonaws.autoscaling#DescribeTerminationPolicyTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer" }, @@ -3364,6 +3433,9 @@ "input": { "target": "com.amazonaws.autoscaling#DisableMetricsCollectionQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -3458,6 +3530,9 @@ "input": { "target": "com.amazonaws.autoscaling#EnableMetricsCollectionQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -3604,6 +3679,9 @@ "input": { "target": "com.amazonaws.autoscaling#ExecutePolicyType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -3737,7 +3815,7 @@ "Name": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n

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

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n \n

\n DescribeTags\n

\n

Valid values for Name include the following:

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

The name of the filter.

\n

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

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n \n

\n DescribeTags\n

\n

Valid values for Name include the following:

\n " } }, "Values": { @@ -4517,13 +4595,13 @@ "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n

\n

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

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

The IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId.

\n

For more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

\n EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.\n

\n

The IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId.

" } }, "UserData": { @@ -4824,7 +4902,7 @@ "GlobalTimeout": { "target": "com.amazonaws.autoscaling#GlobalTimeout", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, that an instance can remain in a\n Pending:Wait or Terminating:Wait state. The maximum is\n 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is\n smaller.

" + "smithy.api#documentation": "

The maximum time, in seconds, that an instance can remain in a wait state. The maximum\n is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is\n smaller.

" } }, "DefaultResult": { @@ -5776,7 +5854,7 @@ "PredefinedMetricType": { "target": "com.amazonaws.autoscaling#MetricType", "traits": { - "smithy.api#documentation": "

The metric type. The following predefined metrics are available:

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

The metric type. The following predefined metrics are available:

\n ", "smithy.api#required": {} } }, @@ -6216,6 +6294,9 @@ "input": { "target": "com.amazonaws.autoscaling#PutNotificationConfigurationType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#LimitExceededFault" @@ -6330,7 +6411,7 @@ "Cooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The duration of the policy's cooldown period, in seconds. When a cooldown period is\n specified here, it overrides the default cooldown period defined for the Auto Scaling\n group.

\n

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

" + "smithy.api#documentation": "

A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.

\n

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

\n

Default: None

" } }, "MetricAggregationType": { @@ -6348,7 +6429,7 @@ "EstimatedInstanceWarmup": { "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", "traits": { - "smithy.api#documentation": "

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. If not provided, the default is to use the value from the default cooldown\n period for the Auto Scaling group.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

" + "smithy.api#documentation": "

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. This warm-up period applies to instances launched due to a specific target\n tracking or step scaling policy. When a warm-up period is specified here, it overrides\n the default instance warmup.

\n

Valid only if the policy type is TargetTrackingScaling or\n StepScaling.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then EstimatedInstanceWarmup\n falls back to the value of default cooldown.

\n " } }, "TargetTrackingConfiguration": { @@ -6376,6 +6457,9 @@ "input": { "target": "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#AlreadyExistsFault" @@ -6585,13 +6669,13 @@ "MinHealthyPercentage": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { - "smithy.api#documentation": "

The amount of capacity in the Auto Scaling group that must remain healthy during an instance\n refresh to allow the operation to continue. The value is expressed as a percentage of\n the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default\n is 90.

\n

Setting the minimum healthy percentage to 100 percent limits the rate of replacement\n to one instance at a time. In contrast, setting it to 0 percent has the effect of\n replacing all instances at the same time.

" + "smithy.api#documentation": "

The amount of capacity in the Auto Scaling group that must pass your group's health checks to\n allow the operation to continue. The value is expressed as a percentage of the desired\n capacity of the Auto Scaling group (rounded up to the nearest integer). The default is\n 90.

\n

Setting the minimum healthy percentage to 100 percent limits the rate of replacement\n to one instance at a time. In contrast, setting it to 0 percent has the effect of\n replacing all instances at the same time.

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

The number of seconds until a newly launched instance is configured and ready to use.\n During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The\n default is to use the value for the health check grace period defined for the\n group.

" + "smithy.api#documentation": "

\n Not needed if the default instance warmup is defined for the\n group.\n

\n

The duration of the instance warmup, in seconds.

\n \n

The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then InstanceWarmup falls\n back to the value of the health check grace period.

\n " } }, "CheckpointPercentages": { @@ -6683,6 +6767,9 @@ "input": { "target": "com.amazonaws.autoscaling#ScalingProcessQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7110,6 +7197,9 @@ "input": { "target": "com.amazonaws.autoscaling#SetDesiredCapacityType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7152,6 +7242,9 @@ "input": { "target": "com.amazonaws.autoscaling#SetInstanceHealthQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7371,6 +7464,9 @@ "input": { "target": "com.amazonaws.autoscaling#ScalingProcessQuery" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7647,6 +7743,9 @@ "input": { "target": "com.amazonaws.autoscaling#UpdateAutoScalingGroupType" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.autoscaling#ResourceContentionFault" @@ -7711,7 +7810,7 @@ "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300. This setting applies\n when using simple scaling policies, but not when using other scaling policies or\n scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling\n in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

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

\n

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

" } }, "AvailabilityZones": { @@ -7729,13 +7828,13 @@ "HealthCheckGracePeriod": { "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "

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

\n

Required if you are adding an ELB health check.

" + "smithy.api#documentation": "

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service and marking it unhealthy due to a failed\n Elastic Load Balancing or custom health check. This is useful if your instances do not immediately pass\n these health checks after they enter the InService state. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.

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

The name of an existing placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

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

\n \n

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

\n " } }, "VPCZoneIdentifier": { @@ -7785,6 +7884,12 @@ "traits": { "smithy.api#documentation": "

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

\n

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

\n

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

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

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

\n \n

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

\n

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

\n " + } } } }, diff --git a/aws/sdk/aws-models/batch.json b/aws/sdk/aws-models/batch.json index 4e5af544be..50f9f9c1e7 100644 --- a/aws/sdk/aws-models/batch.json +++ b/aws/sdk/aws-models/batch.json @@ -415,6 +415,21 @@ ] } }, + "com.amazonaws.batch#CRUpdateAllocationStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BEST_FIT_PROGRESSIVE", + "name": "BEST_FIT_PROGRESSIVE" + }, + { + "value": "SPOT_CAPACITY_OPTIMIZED", + "name": "SPOT_CAPACITY_OPTIMIZED" + } + ] + } + }, "com.amazonaws.batch#CancelJob": { "type": "operation", "input": { @@ -505,8 +520,7 @@ "ecsClusterArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

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

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

" } }, "tags": { @@ -518,7 +532,7 @@ "type": { "target": "com.amazonaws.batch#CEType", "traits": { - "smithy.api#documentation": "

The type of the compute environment: MANAGED or UNMANAGED. For more information, see\n Compute Environments in the\n Batch User Guide.

" + "smithy.api#documentation": "

The type of the compute environment: MANAGED or UNMANAGED. For more information, see\n Compute environments in the\n Batch User Guide.

" } }, "state": { @@ -542,7 +556,7 @@ "computeResources": { "target": "com.amazonaws.batch#ComputeResource", "traits": { - "smithy.api#documentation": "

The compute resources defined for the compute environment. For more information, see Compute Environments in the\n Batch User Guide.

" + "smithy.api#documentation": "

The compute resources defined for the compute environment. For more information, see Compute environments in the\n Batch User Guide.

" } }, "serviceRole": { @@ -550,6 +564,12 @@ "traits": { "smithy.api#documentation": "

The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API\n operations on your behalf. For more information, see Batch service IAM role in the\n Batch User Guide.

" } + }, + "updatePolicy": { + "target": "com.amazonaws.batch#UpdatePolicy", + "traits": { + "smithy.api#documentation": "

Specifies the infrastructure update policy for the compute environment. For more information about\n infrastructure updates, see Updating compute\n environments in the Batch User Guide.

" + } } }, "traits": { @@ -596,20 +616,20 @@ "type": { "target": "com.amazonaws.batch#CRType", "traits": { - "smithy.api#documentation": "

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute Environments in the\n Batch User Guide.

\n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 Spot Fleet role in the\n Batch User Guide.

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

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.

\n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.

", "smithy.api#required": {} } }, "allocationStrategy": { "target": "com.amazonaws.batch#CRAllocationStrategy", "traits": { - "smithy.api#documentation": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance\n type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation Strategies\n in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n
\n
BEST_FIT (default)
\n
\n

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost\n instance type. If additional instances of the selected instance type aren't available, Batch waits for the\n additional instances to be available. If there aren't enough instances available, or if the user is reaching\n Amazon EC2 service limits\n then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps\n costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM\n Role must be specified.

\n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch will select additional instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the\n previously selected instance types aren't available, Batch will select new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch will select one or more instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy\n is only available for Spot Instance compute resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might\n need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

" + "smithy.api#documentation": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance\n type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies\n in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n
\n
BEST_FIT (default)
\n
\n

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost\n instance type. If additional instances of the selected instance type aren't available, Batch waits for the\n additional instances to be available. If there aren't enough instances available, or if the user is reaching\n Amazon EC2 service limits\n then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps\n costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM\n Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support\n infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the\n Batch User Guide.

\n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch will select additional instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the\n previously selected instance types aren't available, Batch will select new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch will select one or more instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy\n is only available for Spot Instance compute resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might\n need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

" } }, "minvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "maxvCpus": { @@ -622,13 +642,13 @@ "desiredvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum\n and maximum values, based on job queue demand.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum\n and maximum values, based on job queue demand.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "instanceTypes": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) that match the demand of your job queues.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n \n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are\n used.

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

The instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) that match the demand of your job queues.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n \n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are\n used.

\n " } }, "imageId": { @@ -637,13 +657,13 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use ec2Configuration[].imageIdOverride instead." }, - "smithy.api#documentation": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is\n overridden by the imageIdOverride member of the Ec2Configuration structure.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.

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

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is\n overridden by the imageIdOverride member of the Ec2Configuration structure.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.

\n " } }, "subnets": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and Subnets in the Amazon VPC User\n Guide.

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

The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User\n Guide.

", "smithy.api#required": {} } }, @@ -656,54 +676,54 @@ "ec2KeyPair": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "instanceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam:::instance-profile/ecsInstanceRole\n .\n For more information, see Amazon ECS Instance\n Role in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam:::instance-profile/ecsInstanceRole\n .\n For more information, see Amazon ECS instance\n role in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "tags": { "target": "com.amazonaws.batch#TagsMap", "traits": { - "smithy.api#documentation": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any\n changes to these tags require that you create a new compute environment and remove the old compute environment. These\n tags aren't seen when using the Batch ListTagsForResource API operation.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any\n changes to these tags require that you create a new compute environment and remove the old compute environment. These\n tags aren't seen when using the Batch ListTagsForResource API operation.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "placementGroup": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for\n Linux Instances.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for\n Linux Instances.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "bidPercentage": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "spotIamFleetRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is\n required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For\n more information, see Amazon EC2 Spot Fleet\n Role in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot\n Instances. For more information, see Spot Instances not tagged on creation in the\n Batch User Guide.

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

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is\n required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For\n more information, see Amazon EC2 spot fleet\n role in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot\n Instances. For more information, see Spot instances not tagged on creation in the\n Batch User Guide.

\n " } }, "launchTemplate": { "target": "com.amazonaws.batch#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

The launch template to use for your compute resources. Any other compute resource parameters that you specify in\n a CreateComputeEnvironment API operation override the same parameters in the launch template. You\n must specify either the launch template ID or launch template name in the request, but not both. For more\n information, see Launch Template Support in\n the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The launch template to use for your compute resources. Any other compute resource parameters that you specify in\n a CreateComputeEnvironment API operation override the same parameters in the launch template. You\n must specify either the launch template ID or launch template name in the request, but not both. For more\n information, see Launch template support in\n the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "ec2Configuration": { "target": "com.amazonaws.batch#Ec2ConfigurationList", "traits": { - "smithy.api#documentation": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.

\n

One or two values can be provided.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.

\n

One or two values can be provided.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

An object representing an Batch compute resource. For more information, see Compute Environments in the\n Batch User Guide.

" + "smithy.api#documentation": "

An object representing an Batch compute resource. For more information, see Compute environments in the\n Batch User Guide.

" } }, "com.amazonaws.batch#ComputeResourceUpdate": { @@ -712,7 +732,7 @@ "minvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "maxvCpus": { @@ -724,24 +744,96 @@ "desiredvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The desired number of Amazon EC2 vCPUS in the compute environment.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum\n and maximum values based on job queue demand.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "subnets": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16\n subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This\n can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User\n Guide.

" + "smithy.api#documentation": "

The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16\n subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't\n specified and no change is made. For EC2 compute resources, providing an empty list removes the VPC subnets from the\n compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.

\n

When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

" } }, "securityGroupIds": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is\n required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for\n EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is\n made.

" + "smithy.api#documentation": "

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is\n required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute\n resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2\n compute resources, providing an empty list removes the security groups from the compute resource.

\n

When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

" + } + }, + "allocationStrategy": { + "target": "com.amazonaws.batch#CRUpdateAllocationStrategy", + "traits": { + "smithy.api#documentation": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance\n type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies\n in the Batch User Guide.

\n

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide. BEST_FIT isn't supported when updating a compute\n environment.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch will select additional instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the\n previously selected instance types aren't available, Batch will select new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

Batch will select one or more instance types that are large enough to meet the requirements of the jobs in\n the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy\n is only available for Spot Instance compute resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies, Batch might\n need to go above maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

" + } + }, + "instanceTypes": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "

The instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) that match the demand of your job queues.

\n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

When you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.

\n \n \n

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are\n used.

\n " + } + }, + "ec2KeyPair": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

\n

When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "instanceRole": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam:::instance-profile/ecsInstanceRole\n .\n For more information, see Amazon ECS instance\n role in the Batch User Guide.

\n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "tags": { + "target": "com.amazonaws.batch#TagsMap", + "traits": { + "smithy.api#documentation": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. These tags aren't seen when using the Batch ListTagsForResource API\n operation.

\n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "placementGroup": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for\n Linux Instances.

\n

When updating a compute environment, changing the placement group requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "bidPercentage": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage.

\n

When updating a compute environment, changing the bid percentage requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "launchTemplate": { + "target": "com.amazonaws.batch#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "

The updated launch template to use for your compute resources. You must specify either the launch template ID or\n launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide.\n To remove the custom launch template and use the default launch template, set launchTemplateId or\n launchTemplateName member of the launch template specification to an empty string. Removing the launch\n template from a compute environment will not remove the AMI specified in the launch template. In order to update the\n AMI specified in a launch template, the updateToLatestImageVersion parameter must be set to\n true.

\n

When updating a compute environment, changing the launch template requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "ec2Configuration": { + "target": "com.amazonaws.batch#Ec2ConfigurationList", + "traits": { + "smithy.api#documentation": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.

\n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide. To remove the EC2 configuration\n and any custom AMI ID specified in imageIdOverride, set this value to an empty string.

\n

One or two values can be provided.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " + } + }, + "updateToLatestImageVersion": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute\n environment has an infrastructure update. The default value is false.

\n \n \n

If an AMI ID is specified in the imageId or imageIdOverride parameters or by the\n launch template specified in the launchTemplate parameter, this parameter is ignored. For more\n information on updating AMI IDs during an infrastructure update, see Updating the AMI ID in\n the Batch User Guide.

\n \n \n

When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

" + } + }, + "type": { + "target": "com.amazonaws.batch#CRType", + "traits": { + "smithy.api#documentation": "

The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.

\n

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.

\n

When updating a compute environment, changing the type of a compute environment requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.

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

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is\n overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the\n custom AMI ID and use the default AMI ID, set this value to an empty string.

\n

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n \n \n

The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.

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

An object representing the attributes of a compute environment that can be updated. For more information, see\n Compute Environments in the\n Batch User Guide.

" + "smithy.api#documentation": "

An object representing the attributes of a compute environment that can be updated. For more information, see\n Updating compute environments\n in the Batch User Guide.

" } }, "com.amazonaws.batch#ContainerDetail": { @@ -780,7 +872,7 @@ "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the\n execution\n role that Batch can assume. For more information, see Batch execution IAM role in the\n Batch User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the\n Batch User Guide.

" } }, "volumes": { @@ -882,7 +974,7 @@ "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance. Or, alternatively, it must be configured on a different log server for remote logging options.\n For more information on the options for different supported log drivers, see Configure logging drivers in the Docker\n documentation.

\n \n

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS\n container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the\n Amazon Elastic Container Service Developer Guide.

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

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance. Or, alternatively, it must be configured on a different log server for remote logging options.\n For more information on the options for different supported log drivers, see Configure logging drivers in the Docker\n documentation.

\n \n

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS\n container agent.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the\n Amazon Elastic Container Service Developer Guide.

\n " } }, "secrets": { @@ -917,7 +1009,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "

This parameter is deprecated, use resourceRequirements to override the vcpus parameter\n that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2\n resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU\n requirement specified in the resourceRequirements structure in the job definition. To override vCPU\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to VCPU and value set to the new value. For more information, see Can't override\n job definition resource requirements in the Batch User Guide.

" + "smithy.api#documentation": "

This parameter is deprecated, use resourceRequirements to override the vcpus parameter\n that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2\n resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU\n requirement specified in the resourceRequirements structure in the job definition. To override vCPU\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to VCPU and value set to the new value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.

" } }, "memory": { @@ -926,7 +1018,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "

This parameter is deprecated, use resourceRequirements to override the memory requirements\n specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2\n resources, it overrides the memory parameter set in the job definition, but doesn't override any memory\n requirement specified in the resourceRequirements structure in the job definition. To override memory\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to MEMORY and value set to the new value. For more information, see Can't override\n job definition resource requirements in the Batch User Guide.

" + "smithy.api#documentation": "

This parameter is deprecated, use resourceRequirements to override the memory requirements\n specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2\n resources, it overrides the memory parameter set in the job definition, but doesn't override any memory\n requirement specified in the resourceRequirements structure in the job definition. To override memory\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type\n set to MEMORY and value set to the new value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.

" } }, "command": { @@ -994,7 +1086,7 @@ "jobRoleArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see\n IAM Roles for Tasks\n in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see\n IAM roles for tasks\n in the Amazon Elastic Container Service Developer Guide.

" } }, "executionRoleArn": { @@ -1066,7 +1158,7 @@ "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance (or on a different log server for remote logging options). For more information on the options for\n different supported log drivers, see Configure\n logging drivers in the Docker documentation.

\n \n

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the\n Amazon Elastic Container Service Developer Guide.

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

The log configuration specification for the container.

\n

This parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance (or on a different log server for remote logging options). For more information on the options for\n different supported log drivers, see Configure\n logging drivers in the Docker documentation.

\n \n

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

\n \n

The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the\n Amazon Elastic Container Service Developer Guide.

\n " } }, "secrets": { @@ -1263,7 +1355,7 @@ "computeEnvironmentOrder": { "target": "com.amazonaws.batch#ComputeEnvironmentOrders", "traits": { - "smithy.api#documentation": "

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler\n uses this parameter to determine which compute environment should run a specific job. Compute environments must be in\n the VALID state before you can associate them with a job queue. You can associate up to three compute\n environments with a job queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute\n environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.

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

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler\n uses this parameter to determine which compute environment runs a specific job. Compute environments must be in\n the VALID state before you can associate them with a job queue. You can associate up to three compute\n environments with a job queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute\n environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.

\n ", "smithy.api#required": {} } }, @@ -1344,6 +1436,9 @@ "smithy.api#documentation": "

The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

\n

These tags can be updated or removed using the TagResource and UntagResource API operations.

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

Contains the parameters for CreateSchedulingPolicy.

" } }, "com.amazonaws.batch#CreateSchedulingPolicyResponse": { @@ -1488,6 +1583,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DeleteSchedulingPolicy.

" } }, "com.amazonaws.batch#DeleteSchedulingPolicyResponse": { @@ -1552,7 +1650,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes one or more of your compute environments.

\n

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment\n operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances\n into.

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

Describes one or more of your compute environments.

\n

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment\n operation to determine the ecsClusterArn that you launch your Amazon ECS container instances\n into.

", "smithy.api#http": { "method": "POST", "uri": "/v1/describecomputeenvironments", @@ -1852,6 +1950,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for DescribeSchedulingPolicies.

" } }, "com.amazonaws.batch#DescribeSchedulingPoliciesResponse": { @@ -1929,13 +2030,13 @@ "accessPointId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the\n EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set\n on the EFS access point. If an access point is used, transit encryption must be enabled in the\n EFSVolumeConfiguration. For more information, see Working with Amazon EFS Access Points in the\n Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the\n EFSVolumeConfiguration must either be omitted or set to / which will enforce the path set\n on the EFS access point. If an access point is used, transit encryption must be enabled in the\n EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the\n Amazon Elastic File System User Guide.

" } }, "iam": { "target": "com.amazonaws.batch#EFSAuthorizationConfigIAM", "traits": { - "smithy.api#documentation": "

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.\n If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is\n omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the\n Batch User Guide. EFS IAM authorization requires that TransitEncryption be\n ENABLED and that a JobRoleArn is specified.

" + "smithy.api#documentation": "

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.\n If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is\n omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the\n Batch User Guide. EFS IAM authorization requires that TransitEncryption be\n ENABLED and that a JobRoleArn is specified.

" } } }, @@ -1998,7 +2099,7 @@ "transitEncryptionPort": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a\n transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be\n between 0 and 65,535. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a\n transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be\n between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

" } }, "authorizationConfig": { @@ -2018,14 +2119,14 @@ "imageType": { "target": "com.amazonaws.batch#ImageType", "traits": { - "smithy.api#documentation": "

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter\n isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI\n (ECS_AL2) is used.

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2− Default for all non-GPU instance families.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux\n 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and\n can be used for all non Amazon Web Services Graviton-based instance types.

\n
\n
ECS_AL1
\n
\n

\n Amazon Linux.\n Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.

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

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter\n isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI\n (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type\n that's supported by Batch is used.

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2− Default for all non-GPU instance families.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux\n 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and\n can be used for all non Amazon Web Services Graviton-based instance types.

\n
\n
ECS_AL1
\n
\n

\n Amazon Linux.\n Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.

\n
\n
", "smithy.api#required": {} } }, "imageIdOverride": { "target": "com.amazonaws.batch#ImageIdOverride", "traits": { - "smithy.api#documentation": "

The AMI ID used for instances launched in the compute environment that match the image type. This setting\n overrides the imageId set in the computeResource object.

" + "smithy.api#documentation": "

The AMI ID used for instances launched in the compute environment that match the image type. This setting\n overrides the imageId set in the computeResource object.

\n \n

The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.

\n " } } }, @@ -2260,7 +2361,7 @@ "parameters": { "target": "com.amazonaws.batch#ParametersMap", "traits": { - "smithy.api#documentation": "

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding\n parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the\n Batch User Guide.

" + "smithy.api#documentation": "

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding\n parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the\n Batch User Guide.

" } }, "retryStrategy": { @@ -2390,7 +2491,7 @@ "status": { "target": "com.amazonaws.batch#JobStatus", "traits": { - "smithy.api#documentation": "

The current status for the job.

\n \n

If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the\n troubleshooting section of the Batch User Guide.

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

The current status for the job.

\n \n

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the\n troubleshooting section of the Batch User Guide.

\n ", "smithy.api#required": {} } }, @@ -2452,7 +2553,7 @@ "jobDefinition": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The job definition that's used by this job.

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

The Amazon Resource Name (ARN) of the job definition that's used by this job.

", "smithy.api#required": {} } }, @@ -2521,6 +2622,15 @@ "target": "com.amazonaws.batch#JobDetail" } }, + "com.amazonaws.batch#JobExecutionTimeoutMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 360 + } + } + }, "com.amazonaws.batch#JobQueueDetail": { "type": "structure", "members": { @@ -2789,7 +2899,7 @@ "version": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The version number of the launch template, $Latest, or $Default.

\n

If the value is $Latest, the latest version of the launch template is used. If the value is\n $Default, the default version of the launch template is used.

\n \n

After the compute environment is created, the launch template version that's used isn't changed, even if the\n $Default or $Latest version for the launch template is updated. To use a new launch\n template version, create a new compute environment, add the new compute environment to the existing job queue,\n remove the old compute environment from the job queue, and delete the old compute environment.

\n \n

Default: $Default.

" + "smithy.api#documentation": "

The version number of the launch template, $Latest, or $Default.

\n

If the value is $Latest, the latest version of the launch template is used. If the value is\n $Default, the default version of the launch template is used.

\n \n

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the\n compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute\n environment is set to true. During an infrastructure update, if either $Latest or\n $Default is specified, Batch re-evaluates the launch template version, and it might use a different\n version of the launch template. This is the case even if the launch template isn't specified in the update. When\n updating a compute environment, changing the launch template requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the\n Batch User Guide.

\n \n

Default: $Default.

" } } }, @@ -2833,7 +2943,7 @@ "swappiness": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A swappiness value of\n 0 causes swapping not to happen unless absolutely necessary. A swappiness value of\n 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter isn't specified, a default value of\n 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If\n maxSwap is set to 0, the container doesn't use swap. This parameter maps to the\n --memory-swappiness option to docker run.

\n

Consider the following when you use a per-container swap configuration.

\n \n \n

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be\n provided.

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

This allows you to tune a container's memory swappiness behavior. A swappiness value of\n 0 causes swapping not to happen unless absolutely necessary. A swappiness value of\n 100 causes pages to be swapped very aggressively. Accepted values are whole numbers between\n 0 and 100. If the swappiness parameter isn't specified, a default value of\n 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If\n maxSwap is set to 0, the container doesn't use swap. This parameter maps to the\n --memory-swappiness option to docker run.

\n

Consider the following when you use a per-container swap configuration.

\n \n \n

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be\n provided.

\n " } } }, @@ -2990,6 +3100,9 @@ "smithy.api#documentation": "

The nextToken value that's returned from a previous paginated ListSchedulingPolicies\n request where maxResults was used and the results exceeded the value of that parameter. Pagination\n continues from the end of the previous results that returned the nextToken value. This value is\n null when there are no more results to\n return.

\n \n

This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

Contains the parameters for ListSchedulingPolicies.

" } }, "com.amazonaws.batch#ListSchedulingPoliciesResponse": { @@ -3045,6 +3158,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for ListTagsForResource.

" } }, "com.amazonaws.batch#ListTagsForResourceResponse": { @@ -3064,7 +3180,7 @@ "logDriver": { "target": "com.amazonaws.batch#LogDriver", "traits": { - "smithy.api#documentation": "

The log driver to use for the container. The valid values listed for this parameter are log drivers that the\n Amazon ECS container agent can communicate with by default.

\n

The supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.

\n \n

Jobs that are running on Fargate resources are restricted to the awslogs and splunk\n log drivers.

\n \n
\n
awslogs
\n
\n

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs Log Driver in the\n Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

\n
\n
fluentd
\n
\n

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker\n documentation.

\n
\n
gelf
\n
\n

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and\n options, see Graylog Extended Format logging\n driver in the Docker documentation.

\n
\n
journald
\n
\n

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker\n documentation.

\n
\n
json-file
\n
\n

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker\n documentation.

\n
\n
splunk
\n
\n

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker\n documentation.

\n
\n
syslog
\n
\n

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker\n documentation.

\n
\n
\n \n

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you\n can fork the Amazon ECS container agent project that's available on\n GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that\n you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

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

The log driver to use for the container. The valid values listed for this parameter are log drivers that the\n Amazon ECS container agent can communicate with by default.

\n

The supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.

\n \n

Jobs that are running on Fargate resources are restricted to the awslogs and splunk\n log drivers.

\n \n
\n
awslogs
\n
\n

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the\n Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

\n
\n
fluentd
\n
\n

Specifies the Fluentd logging driver. For more information, including usage and options, see Fluentd logging driver in the Docker\n documentation.

\n
\n
gelf
\n
\n

Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and\n options, see Graylog Extended Format logging\n driver in the Docker documentation.

\n
\n
journald
\n
\n

Specifies the journald logging driver. For more information, including usage and options, see Journald logging driver in the Docker\n documentation.

\n
\n
json-file
\n
\n

Specifies the JSON file logging driver. For more information, including usage and options, see JSON File logging driver in the Docker\n documentation.

\n
\n
splunk
\n
\n

Specifies the Splunk logging driver. For more information, including usage and options, see Splunk logging driver in the Docker\n documentation.

\n
\n
syslog
\n
\n

Specifies the syslog logging driver. For more information, including usage and options, see Syslog logging driver in the Docker\n documentation.

\n
\n
\n \n

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you\n can fork the Amazon ECS container agent project that's available on\n GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that\n you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.

\n \n

This parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log into your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n

", "smithy.api#required": {} } }, @@ -3077,7 +3193,7 @@ "secretOptions": { "target": "com.amazonaws.batch#SecretList", "traits": { - "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the\n Batch User Guide.

" + "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the\n Batch User Guide.

" } } }, @@ -3525,7 +3641,7 @@ "value": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

\n \n

GPUs are not available for jobs that are running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n Management in the Batch User Guide.

\n \n

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5120, 6144, or 7168
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, or 4

\n
\n
value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n
\n

\n VCPU = 4

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.

\n

For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that VCPU value.\n The supported values are 0.25, 0.5, 1, 2, and 4

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1024, 2048, 3072, or 4096

\n
\n
value = 1
\n
\n

\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

\n
\n
value = 2
\n
\n

\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

\n
\n
value = 4
\n
\n

\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

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

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

\n \n

GPUs are not available for jobs that are running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n management in the Batch User Guide.

\n \n

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5120, 6144, or 7168
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, or 4

\n
\n
value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n
\n

\n VCPU = 4

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.

\n

For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that VCPU value.\n The supported values are 0.25, 0.5, 1, 2, and 4

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1024, 2048, 3072, or 4096

\n
\n
value = 1
\n
\n

\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

\n
\n
value = 2
\n
\n

\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

\n
\n
value = 4
\n
\n

\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

\n
\n
\n
\n
", "smithy.api#required": {} } }, @@ -3627,7 +3743,7 @@ "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of\n a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

" + "smithy.api#documentation": "

The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of\n a key and an optional value. For more information, see Tagging Amazon Web Services resources in Amazon Web Services General\n Reference.

" } } }, @@ -3821,7 +3937,7 @@ "containerOverrides": { "target": "com.amazonaws.batch#ContainerOverrides", "traits": { - "smithy.api#documentation": "

A list of container overrides in the JSON format that specify the name of a container in the specified job\n definition and the overrides it should receive. You can override the default command for a container, which is\n specified in the job definition or the Docker image, with a command override. You can also override\n existing environment variables on a container or add new environment variables to it with an environment\n override.

" + "smithy.api#documentation": "

A list of container overrides in the JSON format that specify the name of a container in the specified job\n definition and the overrides it receives. You can override the default command for a container, which is specified in\n the job definition or the Docker image, with a command override. You can also override\n existing environment variables on a container or add new environment variables to it with an environment\n override.

" } }, "nodeOverrides": { @@ -3948,6 +4064,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for TagResource.

" } }, "com.amazonaws.batch#TagResourceResponse": { @@ -4151,6 +4270,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

Contains the parameters for UntagResource.

" } }, "com.amazonaws.batch#UntagResourceResponse": { @@ -4201,7 +4323,7 @@ "unmanagedvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of vCPUs expected to be used for an unmanaged compute environment. This parameter should not\n be specified for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU\n capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity\n will be reserved.

" + "smithy.api#documentation": "

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Do not specify this\n parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU\n capacity for new share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity\n will be reserved.

" } }, "computeResources": { @@ -4213,7 +4335,13 @@ "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf.\n For more information, see Batch service IAM\n role in the Batch User Guide.

\n \n

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role.\n Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked\n role.

\n \n

If your specified role has a path other than /, then you must either specify the full role ARN\n (this is recommended) or prefix the role name with the path.

\n \n

Depending on how you created your Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.

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

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf.\n For more information, see Batch service IAM\n role in the Batch User Guide.

\n \n

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role.\n Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To\n update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see\n Updating compute\n environments in the Batch User Guide.

\n \n

If your specified role has a path other than /, then you must either specify the full role ARN\n (recommended) or prefix the role name with the path.

\n \n

Depending on how you created your Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.

\n " + } + }, + "updatePolicy": { + "target": "com.amazonaws.batch#UpdatePolicy", + "traits": { + "smithy.api#documentation": "

Specifies the updated infrastructure update policy for the compute environment. For more information about\n infrastructure updates, see Updating\n compute environments in the Batch User Guide.

" } } }, @@ -4288,13 +4416,13 @@ "priority": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order, for example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and\n Fargate compute environments can't be mixed.

" + "smithy.api#documentation": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order. For example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and\n Fargate compute environments can't be mixed.

" } }, "computeEnvironmentOrder": { "target": "com.amazonaws.batch#ComputeEnvironmentOrders", "traits": { - "smithy.api#documentation": "

Details the set of compute environments mapped to a job queue and their order relative to each other. This is\n one of the parameters used by the job scheduler to determine which compute environment should run a given job.\n Compute environments must be in the VALID state before you can associate them with a job queue. All of\n the compute environments must be either EC2 (EC2 or SPOT) or Fargate\n (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.

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

Details the set of compute environments mapped to a job queue and their order relative to each other. This is\n one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute\n environments must be in the VALID state before you can associate them with a job queue. All of\n the compute environments must be either EC2 (EC2 or SPOT) or Fargate\n (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

\n \n

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.

\n " } } }, @@ -4319,6 +4447,26 @@ } } }, + "com.amazonaws.batch#UpdatePolicy": { + "type": "structure", + "members": { + "terminateJobsOnUpdate": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The\n default value is false.

" + } + }, + "jobExecutionTimeoutMinutes": { + "target": "com.amazonaws.batch#JobExecutionTimeoutMinutes", + "traits": { + "smithy.api#documentation": "

Specifies the job timeout, in minutes, when the compute environment infrastructure is updated. The default value\n is 30.

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

Specifies the infrastructure update policy for the compute environment. For more information about\n infrastructure updates, see Infrastructure updates\n in the Batch User Guide.

" + } + }, "com.amazonaws.batch#UpdateSchedulingPolicy": { "type": "operation", "input": { @@ -4360,6 +4508,9 @@ "smithy.api#documentation": "

The fair share policy.

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

Contains the parameters for UpdateSchedulingPolicy.

" } }, "com.amazonaws.batch#UpdateSchedulingPolicyResponse": { diff --git a/aws/sdk/aws-models/braket.json b/aws/sdk/aws-models/braket.json index 62ba2cb34c..9484f62058 100644 --- a/aws/sdk/aws-models/braket.json +++ b/aws/sdk/aws-models/braket.json @@ -31,7 +31,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the Amazon Braket job to be created. Specifies the container image the job uses and the paths to\n the Python scripts used for entry and training.

" + "smithy.api#documentation": "

Defines the Amazon Braket job to be created. Specifies the container image the job uses\n and the paths to the Python scripts used for entry and training.

" } }, "com.amazonaws.braket#Braket": { @@ -39,10 +39,7 @@ "traits": { "aws.api#service": { "sdkId": "Braket", - "arnNamespace": "braket", - "cloudFormationName": "Braket", - "cloudTrailEventSource": "braket.amazonaws.com", - "endpointPrefix": "braket" + "cloudTrailEventSource": "braket.amazonaws.com" }, "aws.auth#sigv4": { "name": "braket" @@ -50,23 +47,24 @@ "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ - "x-amz-content-sha256", - "x-amzn-trace-id", - "x-amz-user-agent", "*", "content-type", - "x-amzn-platform-id" + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" ], "additionalExposedHeaders": [ - "date", - "x-amz-apigw-id", - "x-amzn-trace-id", "x-amzn-errortype", "x-amzn-requestid", - "x-amzn-errormessage" + "x-amzn-trace-id", + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amz-apigw-id", + "date" ] }, - "smithy.api#documentation": "

The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.

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

The Amazon Braket API Reference provides information about the operations and structures\n supported in Amazon Braket.

\n

Additional Resources:

\n ", "smithy.api#title": "Braket" }, "version": "2019-09-01", @@ -124,9 +122,8 @@ "traits": { "smithy.api#documentation": "

Cancels an Amazon Braket job.

", "smithy.api#http": { - "method": "PUT", "uri": "/job/{jobArn}/cancel", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -194,9 +191,8 @@ "traits": { "smithy.api#documentation": "

Cancels the specified task.

", "smithy.api#http": { - "method": "PUT", "uri": "/quantum-task/{quantumTaskArn}/cancel", - "code": 200 + "method": "PUT" }, "smithy.api#idempotent": {} } @@ -333,8 +329,8 @@ "traits": { "smithy.api#documentation": "

Creates an Amazon Braket job.

", "smithy.api#http": { - "method": "POST", "uri": "/job", + "method": "POST", "code": 201 } } @@ -353,7 +349,7 @@ "algorithmSpecification": { "target": "com.amazonaws.braket#AlgorithmSpecification", "traits": { - "smithy.api#documentation": "

Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information\n about the Python scripts used for entry and training.

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

Definition of the Amazon Braket job to be created. Specifies the container image the job\n uses and information about the Python scripts used for entry and training.

", "smithy.api#required": {} } }, @@ -370,7 +366,7 @@ "outputDataConfig": { "target": "com.amazonaws.braket#JobOutputDataConfig", "traits": { - "smithy.api#documentation": "

The path to the S3 location where you want to store job artifacts and the\n encryption key used to store them.

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

The path to the S3 location where you want to store job artifacts and the encryption key\n used to store them.

", "smithy.api#required": {} } }, @@ -415,20 +411,20 @@ "hyperParameters": { "target": "com.amazonaws.braket#HyperParameters", "traits": { - "smithy.api#documentation": "

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of\n the training job. The values are set with a string of JSON key:value pairs, where the key is the\n name of the hyperparameter and the value is the value of th hyperparameter.

" + "smithy.api#documentation": "

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of\n the training job. The values are set with a string of JSON key:value pairs, where the key\n is the name of the hyperparameter and the value is the value of th hyperparameter.

" } }, "deviceConfig": { "target": "com.amazonaws.braket#DeviceConfig", "traits": { - "smithy.api#documentation": "

The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

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

The quantum processing unit (QPU) or simulator used to create an Amazon Braket\n job.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

" + "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.

" } } } @@ -479,8 +475,8 @@ "traits": { "smithy.api#documentation": "

Creates a quantum task.

", "smithy.api#http": { - "method": "POST", "uri": "/quantum-task", + "method": "POST", "code": 201 } } @@ -612,13 +608,13 @@ "device": { "target": "com.amazonaws.braket#String256", "traits": { - "smithy.api#documentation": "

The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.

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

The primary quantum processing unit (QPU) or simulator used to create and run an Amazon\n Braket job.

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

Configures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.

" + "smithy.api#documentation": "

Configures the quantum processing units (QPUs) or simulator used to create and run an\n Amazon Braket job.

" } }, "com.amazonaws.braket#DeviceOfflineException": { @@ -650,9 +646,7 @@ "traits": { "aws.api#arn": { "template": "{deviceArn}", - "absolute": true, - "noAccount": false, - "noRegion": false + "absolute": true } } }, @@ -778,11 +772,10 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the devices available in Amazon Braket.

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

Retrieves the devices available in Amazon Braket.

\n \n

For backwards compatibility with older versions of BraketSchemas, OpenQASM\n information is omitted from GetDevice API calls. To get this information the user-agent\n needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK\n automatically reports this for you. If you do not see OpenQASM results in the GetDevice\n response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment\n variable to configure user-agent. See the code examples provided below for how to do\n this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

\n ", "smithy.api#http": { - "method": "GET", "uri": "/device/{deviceArn}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -875,9 +868,8 @@ "traits": { "smithy.api#documentation": "

Retrieves the specified Amazon Braket job.

", "smithy.api#http": { - "method": "GET", "uri": "/job/{jobArn}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -940,7 +932,7 @@ "hyperParameters": { "target": "com.amazonaws.braket#HyperParameters", "traits": { - "smithy.api#documentation": "

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of\n the traiing job. The values are set with a string of JSON key:value pairs, where the key is the\n name of the hyperparameter and the value is the value of th hyperparameter.

" + "smithy.api#documentation": "

Algorithm-specific parameters used by an Amazon Braket job that influence the quality of\n the traiing job. The values are set with a string of JSON key:value pairs, where the key is\n the name of the hyperparameter and the value is the value of th hyperparameter.

" } }, "inputDataConfig": { @@ -952,7 +944,7 @@ "outputDataConfig": { "target": "com.amazonaws.braket#JobOutputDataConfig", "traits": { - "smithy.api#documentation": "

The path to the S3 location where job artifacts are stored and the encryption\n key used to store them there.

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

The path to the S3 location where job artifacts are stored and the encryption key used\n to store them there.

", "smithy.api#required": {} } }, @@ -971,14 +963,14 @@ "algorithmSpecification": { "target": "com.amazonaws.braket#AlgorithmSpecification", "traits": { - "smithy.api#documentation": "

Definition of the Amazon Braket job created. Specifies the container image the job uses, information about\n the Python scripts used for entry and training, and the user-defined metrics used to\n evaluation the job.

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

Definition of the Amazon Braket job created. Specifies the container image the job uses,\n information about the Python scripts used for entry and training, and the user-defined\n metrics used to evaluation the job.

", "smithy.api#required": {} } }, "instanceConfig": { "target": "com.amazonaws.braket#InstanceConfig", "traits": { - "smithy.api#documentation": "

The resource instances to use while running the hybrid job on Amazon\n Braket.

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

The resource instances to use while running the hybrid job on Amazon Braket.

", "smithy.api#required": {} } }, @@ -1025,7 +1017,7 @@ "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

" + "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.

" } } } @@ -1058,9 +1050,8 @@ "traits": { "smithy.api#documentation": "

Retrieves the specified quantum task.

", "smithy.api#http": { - "method": "GET", "uri": "/quantum-task/{quantumTaskArn}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1227,7 +1218,7 @@ "instanceType": { "target": "com.amazonaws.braket#InstanceType", "traits": { - "smithy.api#documentation": "

Configures the type resource instances to use while running an Amazon Braket hybrid job.

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

Configures the type resource instances to use while running an Amazon Braket hybrid\n job.

", "smithy.api#required": {} } }, @@ -1240,10 +1231,19 @@ }, "smithy.api#required": {} } + }, + "instanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Configures the number of resource instances to use while running an Amazon Braket job on\n Amazon Braket. The default value is 1.

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

Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon\n Braket.

" + "smithy.api#documentation": "

Configures the resource instances to use while running the Amazon Braket hybrid job on\n Amazon Braket.

" } }, "com.amazonaws.braket#InstanceType": { @@ -1417,7 +1417,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or failure.

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

The request processing has failed because of an unknown error, exception, or\n failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1438,13 +1438,13 @@ "localPath": { "target": "com.amazonaws.braket#String4096", "traits": { - "smithy.api#documentation": "

(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.

" + "smithy.api#documentation": "

(Optional) The local directory where checkpoints are written. The default directory is\n /opt/braket/checkpoints/.

" } }, "s3Uri": { "target": "com.amazonaws.braket#S3Path", "traits": { - "smithy.api#documentation": "

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.

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

Identifies the S3 path where you want Amazon Braket to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.

", "smithy.api#required": {} } } @@ -1553,13 +1553,13 @@ "kmsKeyId": { "target": "com.amazonaws.braket#String2048", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the\n job training artifacts at rest using Amazon S3 server-side encryption.

" + "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job\n training artifacts at rest using Amazon S3 server-side encryption.

" } }, "s3Path": { "target": "com.amazonaws.braket#S3Path", "traits": { - "smithy.api#documentation": "

Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For\n example, s3://bucket-name/key-name-prefix.

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

Identifies the S3 path where you want Amazon Braket to store the job training artifacts.\n For example, s3://bucket-name/key-name-prefix.

", "smithy.api#required": {} } } @@ -1623,9 +1623,7 @@ "traits": { "aws.api#arn": { "template": "{jobArn}", - "absolute": true, - "noAccount": false, - "noRegion": false + "absolute": true } } }, @@ -1674,7 +1672,7 @@ "device": { "target": "com.amazonaws.braket#String256", "traits": { - "smithy.api#documentation": "

Provides summary information about the primary device used by an Amazon Braket job.

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

Provides summary information about the primary device used by an Amazon Braket\n job.

", "smithy.api#required": {} } }, @@ -1703,7 +1701,7 @@ "tags": { "target": "com.amazonaws.braket#TagsMap", "traits": { - "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

" + "smithy.api#documentation": "

A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.

" } } }, @@ -1755,8 +1753,7 @@ "smithy.api#documentation": "

Shows the tags associated with this resource.

", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -1820,9 +1817,7 @@ "traits": { "aws.api#arn": { "template": "{quantumTaskArn}", - "absolute": true, - "noAccount": false, - "noRegion": false + "absolute": true } } }, @@ -2006,7 +2001,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about the Python scripts used for entry and by an Amazon Braket job.

" + "smithy.api#documentation": "

Contains information about the Python scripts used for entry and by an Amazon Braket\n job.

" } }, "com.amazonaws.braket#SearchDevices": { @@ -2034,15 +2029,14 @@ "traits": { "smithy.api#documentation": "

Searches for devices using the specified filters.

", "smithy.api#http": { - "method": "POST", "uri": "/devices", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "devices", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "devices" }, "smithy.api#readonly": {} } @@ -2089,7 +2083,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

" + "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned\n from the previous request continue results where the previous request ended.

" } }, "maxResults": { @@ -2121,14 +2115,14 @@ "devices": { "target": "com.amazonaws.braket#DeviceSummaryList", "traits": { - "smithy.api#documentation": "

An array of DeviceSummary objects for devices that match the specified filter values.

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

An array of DeviceSummary objects for devices that match the specified\n filter values.

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

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

" + "smithy.api#documentation": "

A token used for pagination of results, or null if there are no additional results. Use\n the token value in a subsequent request to continue results where the previous request\n ended.

" } } } @@ -2158,15 +2152,14 @@ "traits": { "smithy.api#documentation": "

Searches for Amazon Braket jobs that match the specified filter values.

", "smithy.api#http": { - "method": "POST", "uri": "/jobs", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "jobs", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "jobs" } } }, @@ -2289,7 +2282,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination of results, or null if there are no additional results. Use\n the token value in a subsequent request to continue results where the previous request\n ended.

" + "smithy.api#documentation": "

A token used for pagination of results, or null if there are no additional\n results. Use the token value in a subsequent request to continue results where the previous\n request ended.

" } } } @@ -2319,15 +2312,14 @@ "traits": { "smithy.api#documentation": "

Searches for tasks that match the specified filter values.

", "smithy.api#http": { - "method": "POST", "uri": "/quantum-tasks", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "quantumTasks", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "quantumTasks" }, "smithy.api#readonly": {} } @@ -2408,7 +2400,7 @@ "nextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

" + "smithy.api#documentation": "

A token used for pagination of results returned in the response. Use the token returned\n from the previous request continue results where the previous request ended.

" } }, "maxResults": { @@ -2440,14 +2432,14 @@ "quantumTasks": { "target": "com.amazonaws.braket#QuantumTaskSummaryList", "traits": { - "smithy.api#documentation": "

An array of QuantumTaskSummary objects for tasks that match the specified filters.

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

An array of QuantumTaskSummary objects for tasks that match the specified\n filters.

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

A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.

" + "smithy.api#documentation": "

A token used for pagination of results, or null if there are no additional results. Use\n the token value in a subsequent request to continue results where the previous request\n ended.

" } } } @@ -2545,8 +2537,7 @@ "smithy.api#documentation": "

Add a tag to the specified resource.

", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" } } }, @@ -2556,7 +2547,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specify the resourceArn of the resource to which a tag will be added.

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

Specify the resourceArn of the resource to which a tag will be\n added.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2619,8 +2610,7 @@ "smithy.api#documentation": "

Remove tags from a resource.

", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -2631,7 +2621,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specify the resourceArn for the resource from which to remove the tags.

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

Specify the resourceArn for the resource from which to remove the\n tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/aws/sdk/aws-models/chime-sdk-meetings.json b/aws/sdk/aws-models/chime-sdk-meetings.json index b1a9e9762d..67ec46a4a9 100644 --- a/aws/sdk/aws-models/chime-sdk-meetings.json +++ b/aws/sdk/aws-models/chime-sdk-meetings.json @@ -129,11 +129,20 @@ { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, { "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnprocessableEntityException" } ], "traits": { @@ -277,9 +286,15 @@ { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, { "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" }, @@ -392,12 +407,21 @@ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, { "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, { "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } @@ -485,12 +509,21 @@ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, { "target": "com.amazonaws.chimesdkmeetings#LimitExceededException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, { "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } @@ -602,12 +635,30 @@ "input": { "target": "com.amazonaws.chimesdkmeetings#DeleteAttendeeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, { "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" }, { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } ], "traits": { @@ -645,12 +696,30 @@ "input": { "target": "com.amazonaws.chimesdkmeetings#DeleteMeetingRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" }, { "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } ], "traits": { @@ -873,6 +942,18 @@ }, { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } ], "traits": { @@ -933,6 +1014,18 @@ }, { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } ], "traits": { @@ -1023,6 +1116,18 @@ }, { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" } ], "traits": { @@ -1297,6 +1402,25 @@ "com.amazonaws.chimesdkmeetings#RetryAfterSeconds": { "type": "string" }, + "com.amazonaws.chimesdkmeetings#ServiceFailureException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String" + } + }, + "traits": { + "smithy.api#documentation": "

The service encountered an unexpected error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, "com.amazonaws.chimesdkmeetings#ServiceUnavailableException": { "type": "structure", "members": { @@ -1331,6 +1455,9 @@ "input": { "target": "com.amazonaws.chimesdkmeetings#StartMeetingTranscriptionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" @@ -1344,9 +1471,15 @@ { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, { "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" }, @@ -1388,6 +1521,9 @@ "input": { "target": "com.amazonaws.chimesdkmeetings#StopMeetingTranscriptionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmeetings#BadRequestException" @@ -1398,9 +1534,15 @@ { "target": "com.amazonaws.chimesdkmeetings#NotFoundException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceFailureException" + }, { "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" }, + { + "target": "com.amazonaws.chimesdkmeetings#ThrottlingException" + }, { "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" }, @@ -1439,6 +1581,25 @@ } } }, + "com.amazonaws.chimesdkmeetings#ThrottlingException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String" + } + }, + "traits": { + "smithy.api#documentation": "

The number of customer requests exceeds the request rate limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.chimesdkmeetings#TranscribeContentIdentificationType": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/cloudfront.json b/aws/sdk/aws-models/cloudfront.json index 922bd19624..1769a5bab7 100644 --- a/aws/sdk/aws-models/cloudfront.json +++ b/aws/sdk/aws-models/cloudfront.json @@ -223,6 +223,9 @@ "input": { "target": "com.amazonaws.cloudfront#AssociateAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3364,6 +3367,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteCachePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3418,6 +3424,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteCloudFrontOriginAccessIdentityRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3472,6 +3481,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteDistributionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3526,6 +3538,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3577,6 +3592,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3628,6 +3646,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteFunctionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#FunctionInUse" @@ -3680,6 +3701,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteKeyGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" @@ -3773,6 +3797,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteOriginRequestPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3827,6 +3854,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeletePublicKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3878,6 +3908,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteRealtimeLogConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3923,6 +3956,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteResponseHeadersPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -3977,6 +4013,9 @@ "input": { "target": "com.amazonaws.cloudfront#DeleteStreamingDistributionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -11047,6 +11086,12 @@ "traits": { "smithy.api#documentation": "

A configuration for a set of custom HTTP response headers.

" } + }, + "ServerTimingHeadersConfig": { + "target": "com.amazonaws.cloudfront#ResponseHeadersPolicyServerTimingHeadersConfig", + "traits": { + "smithy.api#documentation": "

A configuration for enabling the Server-Timing header in HTTP responses\n\t\t\tsent from CloudFront.

" + } } }, "traits": { @@ -11339,6 +11384,27 @@ "smithy.api#documentation": "

A configuration for a set of security-related HTTP response headers. CloudFront adds these headers\n\t\t\tto HTTP responses that it sends for requests that match a cache behavior associated with\n\t\t\tthis response headers policy.

" } }, + "com.amazonaws.cloudfront#ResponseHeadersPolicyServerTimingHeadersConfig": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP\n\t\t\tresponses that it sends in response to requests that match a cache behavior that's\n\t\t\tassociated with this response headers policy.

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

A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to\n\t\t\tadd the Server-Timing header to. When you set the sampling rate to 100,\n\t\t\tCloudFront adds the Server-Timing header to the HTTP response for every request\n\t\t\tthat matches the cache behavior that this response headers policy is attached to. When\n\t\t\tyou set it to 50, CloudFront adds the header to 50% of the responses for requests that match\n\t\t\tthe cache behavior. You can set the sampling rate to any number 0–100 with up to four\n\t\t\tdecimal places.

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

A configuration for enabling the Server-Timing header in HTTP responses sent\n\t\t\tfrom CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests\n\t\t\tthat match a cache behavior that's associated with this response headers policy.

\n\t\t

You can use the Server-Timing header to view metrics that can help you gain\n\t\t\tinsights about the behavior and performance of CloudFront. For example, you can see which\n\t\t\tcache layer served a cache hit, or the first byte latency from the origin when there was\n\t\t\ta cache miss. You can use the metrics in the Server-Timing header to\n\t\t\ttroubleshoot issues or test the efficiency of your CloudFront configuration. For more\n\t\t\tinformation, see Server-Timing header in the\n\t\t\tAmazon CloudFront Developer Guide.

" + } + }, "com.amazonaws.cloudfront#ResponseHeadersPolicyStrictTransportSecurity": { "type": "structure", "members": { @@ -11524,6 +11590,16 @@ ] } }, + "com.amazonaws.cloudfront#SamplingRate": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0.0, + "max": 100.0 + } + } + }, "com.amazonaws.cloudfront#Signer": { "type": "structure", "members": { @@ -12027,6 +12103,9 @@ "input": { "target": "com.amazonaws.cloudfront#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" @@ -12950,6 +13029,9 @@ "input": { "target": "com.amazonaws.cloudfront#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" diff --git a/aws/sdk/aws-models/cloudtrail.json b/aws/sdk/aws-models/cloudtrail.json index 99462381ff..40f5fd13e2 100644 --- a/aws/sdk/aws-models/cloudtrail.json +++ b/aws/sdk/aws-models/cloudtrail.json @@ -76,7 +76,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. \n Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. \n If you specify a key without a value, the tag will be created with the specified key and a value of null. \n You can tag a trail that applies to all Amazon Web Services Regions only from the Region in which the trail was created (also known as its home region).

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

Adds one or more tags to a trail or event data store, up to a limit of 50. Overwrites an \n existing tag's value when a new value is specified for an existing tag key. \n Tag key names must be unique for a trail; you cannot have two keys with the same name but \n different values. \n If you specify a key without a value, the tag will be created with the specified key and a \n value of null. \n You can tag a trail or event data store that applies to all Amazon Web Services Regions \n only from the Region in which the trail or event data store was created (also known as its \n home region).

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

Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

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

Specifies the ARN of the trail or event data store to which one or more tags will be added. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

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

Specifies the tags to add to a trail.

" + "smithy.api#documentation": "

Specifies the tags to add to a trail or event data store.

" } }, "com.amazonaws.cloudtrail#AddTagsResponse": { @@ -493,7 +493,7 @@ "code": "ConflictException", "httpResponseCode": 409 }, - "smithy.api#documentation": "

This exception is thrown when the specified resource is not ready for an operation. \n This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail. \n If this exception occurs, wait a few minutes, and then try the operation again.

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

This exception is thrown when the specified resource is not ready for an operation. \n This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource. \n If this exception occurs, wait a few minutes, and then try the operation again.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1328,49 +1328,73 @@ "TerminationProtectionEnabled": { "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the event data store is protected from termination.

" + "smithy.api#deprecated": { + "message": "TerminationProtectionEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

This field is being deprecated. 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.

" + "smithy.api#deprecated": { + "message": "Status is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

This field is being deprecated. 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.

" + "smithy.api#deprecated": { + "message": "AdvancedEventSelectors is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

This field is being deprecated. 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.

" + "smithy.api#deprecated": { + "message": "MultiRegionEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

This field is being deprecated. 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.

" + "smithy.api#deprecated": { + "message": "OrganizationEnabled is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

This field is being deprecated. 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.

" + "smithy.api#deprecated": { + "message": "RetentionPeriod is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

This field is being deprecated. The retention period, in days.

" } }, "CreatedTimestamp": { "target": "com.amazonaws.cloudtrail#Date", "traits": { - "smithy.api#documentation": "

The timestamp of the event data store's creation.

" + "smithy.api#deprecated": { + "message": "CreatedTimestamp is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

This field is being deprecated. 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.

" + "smithy.api#deprecated": { + "message": "UpdatedTimestamp is no longer returned by ListEventDataStores" + }, + "smithy.api#documentation": "

This field is being deprecated. 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.

" } } }, @@ -2126,7 +2150,7 @@ "code": "InactiveEventDataStore", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The event data store against which you ran your query is inactive.

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

The event data store is inactive.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2221,7 +2245,7 @@ "code": "InsufficientDependencyServiceAccessPermission", "httpResponseCode": 400 }, - "smithy.api#documentation": "

This exception is thrown when the IAM user or role that is used to create the organization trail is lacking one or more required permissions for \n creating an organization trail in a required service. For more information, see \n Prepare For Creating a Trail For Your Organization.

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

This exception is thrown when the IAM user or role that is used to create \n the organization resource lacks one or more required permissions for \n creating an organization resource in a required service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2347,7 +2371,7 @@ "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#documentation": "

A date range for the query was specified that is not valid. Be sure that the start time is chronologically \n before the end time. 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 } @@ -3124,7 +3148,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags for the trail in the current region.

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

Lists the tags for the trail or event data store in the current region.

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

Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The following is the format of \n a trail ARN.

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

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

Specifies a list of trail and event data store ARNs whose tags will be listed. The list \n has a limit of 20 ARNs.

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

Specifies a list of trail tags to return.

" + "smithy.api#documentation": "

Specifies a list of tags to return.

" } }, "com.amazonaws.cloudtrail#ListTagsResponse": { @@ -3485,7 +3509,7 @@ "code": "NotOrganizationMasterAccount", "httpResponseCode": 400 }, - "smithy.api#documentation": "

This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail is not the management account for an \n organization in Organizations. For more information, see \n Prepare For Creating a Trail For Your Organization.

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

This exception is thrown when the Amazon Web Services account making the request to create \n or update an organization trail or event data store is not the management account for an \n organization in Organizations. For more information, see \n Prepare For Creating a Trail For Your Organization or Create an event data store.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3546,7 +3570,7 @@ "code": "OrganizationNotInAllFeaturesMode", "httpResponseCode": 400 }, - "smithy.api#documentation": "

This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support\n creating an organization trail. For more information, see \n Prepare For Creating a Trail For Your Organization.

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

This exception is thrown when Organizations is not configured to support all \n features. All features must be enabled in Organizations to support\n creating an organization trail or event data store.

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

Removes the specified tags from a trail.

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

Removes the specified tags from a trail or event data store.

", "smithy.api#idempotent": {} } }, @@ -4043,7 +4067,7 @@ "ResourceId": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:

\n

\n arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

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

Specifies the ARN of the trail or event data store from which tags should be removed.

\n

\n Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail\n

\n

Example event data store ARN format: arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE\n

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

Specifies the tags to remove from a trail.

" + "smithy.api#documentation": "

Specifies the tags to remove from a trail or event data store.

" } }, "com.amazonaws.cloudtrail#RemoveTagsResponse": { @@ -4300,7 +4324,7 @@ "smithy.api#box": {}, "smithy.api#range": { "min": 7, - "max": 2555 + "max": 2557 } } }, diff --git a/aws/sdk/aws-models/connect.json b/aws/sdk/aws-models/connect.json index 42916c096f..54edb3855d 100644 --- a/aws/sdk/aws-models/connect.json +++ b/aws/sdk/aws-models/connect.json @@ -330,6 +330,9 @@ { "target": "com.amazonaws.connect#AssociateLexBot" }, + { + "target": "com.amazonaws.connect#AssociatePhoneNumberContactFlow" + }, { "target": "com.amazonaws.connect#AssociateQueueQuickConnects" }, @@ -339,6 +342,9 @@ { "target": "com.amazonaws.connect#AssociateSecurityKey" }, + { + "target": "com.amazonaws.connect#ClaimPhoneNumber" + }, { "target": "com.amazonaws.connect#CreateAgentStatus" }, @@ -438,6 +444,9 @@ { "target": "com.amazonaws.connect#DescribeInstanceStorageConfig" }, + { + "target": "com.amazonaws.connect#DescribePhoneNumber" + }, { "target": "com.amazonaws.connect#DescribeQueue" }, @@ -477,6 +486,9 @@ { "target": "com.amazonaws.connect#DisassociateLexBot" }, + { + "target": "com.amazonaws.connect#DisassociatePhoneNumberContactFlow" + }, { "target": "com.amazonaws.connect#DisassociateQueueQuickConnects" }, @@ -543,6 +555,9 @@ { "target": "com.amazonaws.connect#ListPhoneNumbers" }, + { + "target": "com.amazonaws.connect#ListPhoneNumbersV2" + }, { "target": "com.amazonaws.connect#ListPrompts" }, @@ -582,9 +597,21 @@ { "target": "com.amazonaws.connect#ListUsers" }, + { + "target": "com.amazonaws.connect#PutUserStatus" + }, + { + "target": "com.amazonaws.connect#ReleasePhoneNumber" + }, { "target": "com.amazonaws.connect#ResumeContactRecording" }, + { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbers" + }, + { + "target": "com.amazonaws.connect#SearchUsers" + }, { "target": "com.amazonaws.connect#SearchVocabularies" }, @@ -657,6 +684,9 @@ { "target": "com.amazonaws.connect#UpdateInstanceStorageConfig" }, + { + "target": "com.amazonaws.connect#UpdatePhoneNumber" + }, { "target": "com.amazonaws.connect#UpdateQueueHoursOfOperation" }, @@ -736,11 +766,20 @@ "smithy.api#documentation": "

Configuration of the answering machine detection.

" } }, + "com.amazonaws.connect#ApproximateTotalCount": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.connect#AssociateApprovedOrigin": { "type": "operation", "input": { "target": "com.amazonaws.connect#AssociateApprovedOriginRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -798,6 +837,9 @@ "input": { "target": "com.amazonaws.connect#AssociateBotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -997,6 +1039,9 @@ "input": { "target": "com.amazonaws.connect#AssociateLambdaFunctionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -1054,6 +1099,9 @@ "input": { "target": "com.amazonaws.connect#AssociateLexBotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -1106,11 +1154,75 @@ } } }, + "com.amazonaws.connect#AssociatePhoneNumberContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociatePhoneNumberContactFlowRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a contact flow with a phone number claimed to your Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/phone-number/{PhoneNumberId}/contact-flow", + "code": 200 + } + } + }, + "com.amazonaws.connect#AssociatePhoneNumberContactFlowRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact flow.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#AssociateQueueQuickConnects": { "type": "operation", "input": { "target": "com.amazonaws.connect#AssociateQueueQuickConnectsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -1173,6 +1285,9 @@ "input": { "target": "com.amazonaws.connect#AssociateRoutingProfileQueuesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -1389,6 +1504,38 @@ "com.amazonaws.connect#AutoAccept": { "type": "boolean" }, + "com.amazonaws.connect#AvailableNumberSummary": { + "type": "structure", + "members": { + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

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

Information about available phone numbers.

" + } + }, + "com.amazonaws.connect#AvailableNumbersList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AvailableNumberSummary" + } + }, "com.amazonaws.connect#Boolean": { "type": "boolean" }, @@ -1524,6 +1671,160 @@ } } }, + "com.amazonaws.connect#ClaimPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ClaimPhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#ClaimPhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Claims an available phone number to your Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/claim", + "code": 200 + } + } + }, + "com.amazonaws.connect#ClaimPhoneNumberRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

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

The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

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

The description of the phone number.

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

The tags used to organize, track, or control access for this resource.

" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#ClaimPhoneNumberResponse": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + } + } + }, + "com.amazonaws.connect#ClaimedPhoneNumberSummary": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "PhoneNumberDescription": { + "target": "com.amazonaws.connect#PhoneNumberDescription", + "traits": { + "smithy.api#documentation": "

The description of the phone number.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

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

The tags used to organize, track, or control access for this resource.

" + } + }, + "PhoneNumberStatus": { + "target": "com.amazonaws.connect#PhoneNumberStatus", + "traits": { + "smithy.api#documentation": "

The status of the phone number.

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

Information about a phone number that has been claimed to your Amazon Connect instance.

" + } + }, "com.amazonaws.connect#ClientToken": { "type": "string", "traits": { @@ -2091,6 +2392,32 @@ "target": "com.amazonaws.connect#Reference" } }, + "com.amazonaws.connect#ControlPlaneTagFilter": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#TagOrConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#TagAndConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + } + }, + "TagCondition": { + "target": "com.amazonaws.connect#TagCondition", + "traits": { + "smithy.api#documentation": "

A leaf node condition which can be used to specify a tag condition.

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

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an\n OR of AND (List of List) input where:

\n " + } + }, "com.amazonaws.connect#CreateAgentStatus": { "type": "operation", "input": { @@ -3770,7 +4097,10 @@ "input": { "target": "com.amazonaws.connect#DeleteContactFlowRequest" }, - "errors": [ + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ { "target": "com.amazonaws.connect#AccessDeniedException" }, @@ -3887,6 +4217,9 @@ "input": { "target": "com.amazonaws.connect#DeleteHoursOfOperationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -3939,6 +4272,9 @@ "input": { "target": "com.amazonaws.connect#DeleteInstanceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -3977,6 +4313,9 @@ "input": { "target": "com.amazonaws.connect#DeleteIntegrationAssociationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4026,6 +4365,9 @@ "input": { "target": "com.amazonaws.connect#DeleteQuickConnectRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4078,6 +4420,9 @@ "input": { "target": "com.amazonaws.connect#DeleteSecurityProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#AccessDeniedException" @@ -4136,6 +4481,9 @@ "input": { "target": "com.amazonaws.connect#DeleteUseCaseRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4193,6 +4541,9 @@ "input": { "target": "com.amazonaws.connect#DeleteUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4224,6 +4575,9 @@ "input": { "target": "com.amazonaws.connect#DeleteUserHierarchyGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -4907,6 +5261,64 @@ } } }, + "com.amazonaws.connect#DescribePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribePhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details and status of a phone number that’s claimed to your Amazon Connect instance

", + "smithy.api#http": { + "method": "GET", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribePhoneNumberResponse": { + "type": "structure", + "members": { + "ClaimedPhoneNumberSummary": { + "target": "com.amazonaws.connect#ClaimedPhoneNumberSummary", + "traits": { + "smithy.api#documentation": "

Information about a phone number that's been claimed to your Amazon Connect instance.

" + } + } + } + }, "com.amazonaws.connect#DescribeQueue": { "type": "operation", "input": { @@ -5525,6 +5937,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateApprovedOriginRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5577,6 +5992,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateBotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5627,6 +6045,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateInstanceStorageConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5687,6 +6108,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateLambdaFunctionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5739,6 +6163,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateLexBotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5794,11 +6221,69 @@ } } }, + "com.amazonaws.connect#DisassociatePhoneNumberContactFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociatePhoneNumberContactFlowRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/phone-number/{PhoneNumberId}/contact-flow", + "code": 200 + } + } + }, + "com.amazonaws.connect#DisassociatePhoneNumberContactFlowRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpQuery": "instanceId", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#DisassociateQueueQuickConnects": { "type": "operation", "input": { "target": "com.amazonaws.connect#DisassociateQueueQuickConnectsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5858,6 +6343,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateRoutingProfileQueuesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -5917,6 +6405,9 @@ "input": { "target": "com.amazonaws.connect#DisassociateSecurityKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -6473,9 +6964,44 @@ "smithy.api#documentation": "

Contains information about a hierarchy group.

" } }, + "com.amazonaws.connect#HierarchyGroupCondition": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The value in the hierarchy group condition.

" + } + }, + "HierarchyGroupMatchType": { + "target": "com.amazonaws.connect#HierarchyGroupMatchType", + "traits": { + "smithy.api#documentation": "

The type of hierarchy group match.

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

A leaf node condition which can be used to specify a hierarchy group condition.

" + } + }, "com.amazonaws.connect#HierarchyGroupId": { "type": "string" }, + "com.amazonaws.connect#HierarchyGroupMatchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EXACT", + "name": "EXACT" + }, + { + "value": "WITH_CHILD_GROUPS", + "name": "WITH_CHILD_GROUPS" + } + ] + } + }, "com.amazonaws.connect#HierarchyGroupName": { "type": "string" }, @@ -7660,6 +8186,15 @@ "smithy.api#documentation": "

Configuration information of a Kinesis video stream.

" } }, + "com.amazonaws.connect#LargeNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100000 + } + } + }, "com.amazonaws.connect#LexBot": { "type": "structure", "members": { @@ -9085,23 +9620,73 @@ } } }, - "com.amazonaws.connect#ListPrompts": { + "com.amazonaws.connect#ListPhoneNumbersSummary": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + }, + "PhoneNumber": { + "target": "com.amazonaws.connect#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

" + } + }, + "PhoneNumberCountryCode": { + "target": "com.amazonaws.connect#PhoneNumberCountryCode", + "traits": { + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberType": { + "target": "com.amazonaws.connect#PhoneNumberType", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

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

Information about phone numbers that have been claimed to your Amazon Connect instance.

" + } + }, + "com.amazonaws.connect#ListPhoneNumbersSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ListPhoneNumbersSummary" + } + }, + "com.amazonaws.connect#ListPhoneNumbersV2": { "type": "operation", "input": { - "target": "com.amazonaws.connect#ListPromptsRequest" + "target": "com.amazonaws.connect#ListPhoneNumbersV2Request" }, "output": { - "target": "com.amazonaws.connect#ListPromptsResponse" + "target": "com.amazonaws.connect#ListPhoneNumbersV2Response" }, "errors": [ { - "target": "com.amazonaws.connect#InternalServiceException" + "target": "com.amazonaws.connect#AccessDeniedException" }, { - "target": "com.amazonaws.connect#InvalidParameterException" + "target": "com.amazonaws.connect#InternalServiceException" }, { - "target": "com.amazonaws.connect#InvalidRequestException" + "target": "com.amazonaws.connect#InvalidParameterException" }, { "target": "com.amazonaws.connect#ResourceNotFoundException" @@ -9111,61 +9696,160 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about the prompts for the specified Amazon Connect instance.

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

Lists phone numbers claimed to your Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator Guide.

", "smithy.api#http": { - "method": "GET", - "uri": "/prompts-summary/{InstanceId}", + "method": "POST", + "uri": "/phone-number/list", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "PromptSummaryList", + "items": "ListPhoneNumbersSummaryList", "pageSize": "MaxResults" } } }, - "com.amazonaws.connect#ListPromptsRequest": { + "com.amazonaws.connect#ListPhoneNumbersV2Request": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "TargetArn": { + "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

" } }, "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "target": "com.amazonaws.connect#LargeNextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" } }, - "MaxResults": { - "target": "com.amazonaws.connect#MaxResult1000", + "PhoneNumberCountryCodes": { + "target": "com.amazonaws.connect#PhoneNumberCountryCodes", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of results to return per page.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The ISO country code.

" + } + }, + "PhoneNumberTypes": { + "target": "com.amazonaws.connect#PhoneNumberTypes", + "traits": { + "smithy.api#documentation": "

The type of phone number.

" + } + }, + "PhoneNumberPrefix": { + "target": "com.amazonaws.connect#PhoneNumberPrefix", + "traits": { + "smithy.api#documentation": "

The prefix of the phone number. If provided, it must contain + as part of the country code.

" } } } }, - "com.amazonaws.connect#ListPromptsResponse": { + "com.amazonaws.connect#ListPhoneNumbersV2Response": { "type": "structure", "members": { - "PromptSummaryList": { - "target": "com.amazonaws.connect#PromptSummaryList", + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", "traits": { - "smithy.api#documentation": "

Information about the prompts.

" + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" } }, - "NextToken": { - "target": "com.amazonaws.connect#NextToken", + "ListPhoneNumbersSummaryList": { + "target": "com.amazonaws.connect#ListPhoneNumbersSummaryList", "traits": { - "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + "smithy.api#documentation": "

Information about phone numbers that have been claimed to your Amazon Connect instances.

" + } + } + } + }, + "com.amazonaws.connect#ListPrompts": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListPromptsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListPromptsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides information about the prompts for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/prompts-summary/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "PromptSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListPromptsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance.

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

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListPromptsResponse": { + "type": "structure", + "members": { + "PromptSummaryList": { + "target": "com.amazonaws.connect#PromptSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the prompts.

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

If there are additional results, this is the token for the next set of results.

" } } } @@ -10314,6 +10998,15 @@ "com.amazonaws.connect#NextToken": { "type": "string" }, + "com.amazonaws.connect#NextToken2500": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2500 + } + } + }, "com.amazonaws.connect#Origin": { "type": "string", "traits": { @@ -10451,7 +11144,10 @@ } }, "com.amazonaws.connect#PhoneNumber": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#pattern": "^\\\\+[1-9]\\\\d{1,14}$" + } }, "com.amazonaws.connect#PhoneNumberCountryCode": { "type": "string", @@ -11420,9 +12116,25 @@ } } }, + "com.amazonaws.connect#PhoneNumberDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[\\W\\S_]*$" + } + }, "com.amazonaws.connect#PhoneNumberId": { "type": "string" }, + "com.amazonaws.connect#PhoneNumberPrefix": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\\\+?[0-9]{1,11}$" + } + }, "com.amazonaws.connect#PhoneNumberQuickConnectConfig": { "type": "structure", "members": { @@ -11438,6 +12150,26 @@ "smithy.api#documentation": "

Contains information about a phone number for a quick connect.

" } }, + "com.amazonaws.connect#PhoneNumberStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.connect#PhoneNumberWorkflowStatus", + "traits": { + "smithy.api#documentation": "

The status.

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

The status message.

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

The status of the phone number.

" + } + }, "com.amazonaws.connect#PhoneNumberSummary": { "type": "structure", "members": { @@ -11509,6 +12241,35 @@ } } }, + "com.amazonaws.connect#PhoneNumberWorkflowMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\W\\S_]*$" + } + }, + "com.amazonaws.connect#PhoneNumberWorkflowStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CLAIMED", + "name": "Claimed" + }, + { + "value": "IN_PROGRESS", + "name": "InProgress" + }, + { + "value": "FAILED", + "name": "Failed" + } + ] + } + }, "com.amazonaws.connect#PhoneType": { "type": "string", "traits": { @@ -11627,6 +12388,75 @@ "target": "com.amazonaws.connect#PromptSummary" } }, + "com.amazonaws.connect#PutUserStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#PutUserStatusRequest" + }, + "output": { + "target": "com.amazonaws.connect#PutUserStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the current status of a user or agent in Amazon Connect.\n If the agent is currently handling a contact, this sets the agent's next status.

\n

For more information, see Agent status \n and Set your next status\n in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/users/{InstanceId}/{UserId}/status", + "code": 200 + } + } + }, + "com.amazonaws.connect#PutUserStatusRequest": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#PutUserStatusResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.connect#Queue": { "type": "structure", "members": { @@ -12160,6 +12990,67 @@ } } }, + "com.amazonaws.connect#ReleasePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ReleasePhoneNumberRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#ReleasePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + } + }, "com.amazonaws.connect#ResourceConflictException": { "type": "structure", "members": { @@ -12571,6 +13462,201 @@ "smithy.api#documentation": "

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

" } }, + "com.amazonaws.connect#SearchAvailablePhoneNumbers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbersRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchAvailablePhoneNumbersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for available phone numbers that you can claim to your Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/phone-number/search-available", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AvailableNumbersList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchAvailablePhoneNumbersRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

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

The ISO country code.

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

The type of phone number.

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

The prefix of the phone number. If provided, it must contain + as part of the country code.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult10", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + } + } + }, + "com.amazonaws.connect#SearchAvailablePhoneNumbersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#LargeNextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "AvailableNumbersList": { + "target": "com.amazonaws.connect#AvailableNumbersList", + "traits": { + "smithy.api#documentation": "

A list of available phone numbers that you can claim for your Amazon Connect instance.

" + } + } + } + }, + "com.amazonaws.connect#SearchUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchUsersRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches users in an Amazon Connect instance, with optional filtering.

", + "smithy.api#http": { + "method": "POST", + "uri": "/search-users", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Users", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchUsersRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#UserSearchFilter", + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#UserSearchCriteria" + } + } + }, + "com.amazonaws.connect#SearchUsersResponse": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.connect#UserSearchSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the users.

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

If there are additional results, this is the token for the next set of results.

" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "

The total number of users who matched your search query.

" + } + } + } + }, "com.amazonaws.connect#SearchVocabularies": { "type": "operation", "input": { @@ -13579,6 +14665,51 @@ "com.amazonaws.connect#String": { "type": "string" }, + "com.amazonaws.connect#StringComparisonType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STARTS_WITH", + "name": "STARTS_WITH" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "EXACT", + "name": "EXACT" + } + ] + } + }, + "com.amazonaws.connect#StringCondition": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The name of the field in the string condition.

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

The value of the string.

" + } + }, + "ComparisonType": { + "target": "com.amazonaws.connect#StringComparisonType", + "traits": { + "smithy.api#documentation": "

The type of comparison to be made when evaluating the string condition.

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

A leaf node condition which can be used to specify a string condition, for example,\n username = 'abc'.

" + } + }, "com.amazonaws.connect#SupportedMessagingContentType": { "type": "string", "traits": { @@ -13652,6 +14783,32 @@ "type": "structure", "members": {} }, + "com.amazonaws.connect#TagAndConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TagCondition" + } + }, + "com.amazonaws.connect#TagCondition": { + "type": "structure", + "members": { + "TagKey": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The tag key in the tag condition.

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

The tag value in the tag condition.

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

A leaf node condition which can be used to specify a tag condition, for example, HAVE\n BPO = 123.

" + } + }, "com.amazonaws.connect#TagKey": { "type": "string", "traits": { @@ -13689,11 +14846,20 @@ } } }, + "com.amazonaws.connect#TagOrConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TagAndConditionList" + } + }, "com.amazonaws.connect#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.connect#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -13712,7 +14878,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, queues, quick connects, contact\n flows, agent status, and hours of operation.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

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

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, queues, quick connects, contact\n flows, agent status, hours of operation, and phone number.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -13847,6 +15013,9 @@ "input": { "target": "com.amazonaws.connect#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -13899,6 +15068,9 @@ "input": { "target": "com.amazonaws.connect#UpdateAgentStatusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14092,6 +15264,9 @@ "input": { "target": "com.amazonaws.connect#UpdateContactFlowContentRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14154,6 +15329,9 @@ "input": { "target": "com.amazonaws.connect#UpdateContactFlowMetadataRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14379,6 +15557,9 @@ "input": { "target": "com.amazonaws.connect#UpdateContactFlowNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14556,6 +15737,9 @@ "input": { "target": "com.amazonaws.connect#UpdateHoursOfOperationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14644,6 +15828,9 @@ "input": { "target": "com.amazonaws.connect#UpdateInstanceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14703,6 +15890,9 @@ "input": { "target": "com.amazonaws.connect#UpdateInstanceStorageConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14764,11 +15954,98 @@ } } }, + "com.amazonaws.connect#UpdatePhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdatePhoneNumberRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdatePhoneNumberResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/phone-number/{PhoneNumberId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdatePhoneNumberRequest": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#UpdatePhoneNumberResponse": { + "type": "structure", + "members": { + "PhoneNumberId": { + "target": "com.amazonaws.connect#PhoneNumberId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the phone number.

" + } + }, + "PhoneNumberArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the phone number.

" + } + } + } + }, "com.amazonaws.connect#UpdateQueueHoursOfOperation": { "type": "operation", "input": { "target": "com.amazonaws.connect#UpdateQueueHoursOfOperationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14828,6 +16105,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQueueMaxContactsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -14887,6 +16167,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQueueNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -14954,6 +16237,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQueueOutboundCallerConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15013,6 +16299,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQueueStatusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15072,6 +16361,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQuickConnectConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15140,6 +16432,9 @@ "input": { "target": "com.amazonaws.connect#UpdateQuickConnectNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15204,6 +16499,9 @@ "input": { "target": "com.amazonaws.connect#UpdateRoutingProfileConcurrencyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15263,6 +16561,9 @@ "input": { "target": "com.amazonaws.connect#UpdateRoutingProfileDefaultOutboundQueueRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15322,6 +16623,9 @@ "input": { "target": "com.amazonaws.connect#UpdateRoutingProfileNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -15389,6 +16693,9 @@ "input": { "target": "com.amazonaws.connect#UpdateRoutingProfileQueuesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15448,6 +16755,9 @@ "input": { "target": "com.amazonaws.connect#UpdateSecurityProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15512,6 +16822,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserHierarchyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15543,6 +16856,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserHierarchyGroupNameRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#DuplicateResourceException" @@ -15632,6 +16948,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserHierarchyStructureRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15686,6 +17005,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserIdentityInfoRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15745,6 +17067,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserPhoneConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15804,6 +17129,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserRoutingProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -15863,6 +17191,9 @@ "input": { "target": "com.amazonaws.connect#UpdateUserSecurityProfilesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" @@ -16090,6 +17421,26 @@ "smithy.api#documentation": "

Contains information about the identity of a user.

" } }, + "com.amazonaws.connect#UserIdentityInfoLite": { + "type": "structure", + "members": { + "FirstName": { + "target": "com.amazonaws.connect#AgentFirstName", + "traits": { + "smithy.api#documentation": "

The user's first name.

" + } + }, + "LastName": { + "target": "com.amazonaws.connect#AgentLastName", + "traits": { + "smithy.api#documentation": "

The user's last name.

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

The user's first name and last name.

" + } + }, "com.amazonaws.connect#UserNotFoundException": { "type": "structure", "members": { @@ -16158,6 +17509,126 @@ "smithy.api#documentation": "

Contains information about the quick connect configuration settings for a user. The contact\n flow must be of type Transfer to Agent.

" } }, + "com.amazonaws.connect#UserSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserSearchCriteria" + } + }, + "com.amazonaws.connect#UserSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#UserSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#UserSearchConditionList", + "traits": { + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition", + "traits": { + "smithy.api#documentation": "

A leaf node condition which can be used to specify a string condition.

" + } + }, + "HierarchyGroupCondition": { + "target": "com.amazonaws.connect#HierarchyGroupCondition", + "traits": { + "smithy.api#documentation": "

A leaf node condition which can be used to specify a hierarchy group condition.

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

The search criteria to be used to return users.

" + } + }, + "com.amazonaws.connect#UserSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "

Filters to be applied to search results.

" + } + }, + "com.amazonaws.connect#UserSearchSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.

" + } + }, + "DirectoryUserId": { + "target": "com.amazonaws.connect#DirectoryUserId", + "traits": { + "smithy.api#documentation": "

The directory identifier of the user.

" + } + }, + "HierarchyGroupId": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the user's hierarchy group.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The identifier of the user's summary.

" + } + }, + "IdentityInfo": { + "target": "com.amazonaws.connect#UserIdentityInfoLite", + "traits": { + "smithy.api#documentation": "

The user's first name and last name.

" + } + }, + "PhoneConfig": { + "target": "com.amazonaws.connect#UserPhoneConfig" + }, + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the user's routing profile.

" + } + }, + "SecurityProfileIds": { + "target": "com.amazonaws.connect#SecurityProfileIds", + "traits": { + "smithy.api#documentation": "

The identifiers of the user's security profiles.

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

The tags used to organize, track, or control access for this resource.

" + } + }, + "Username": { + "target": "com.amazonaws.connect#AgentUsername", + "traits": { + "smithy.api#documentation": "

The name of the user.

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

Information about the returned users.

" + } + }, + "com.amazonaws.connect#UserSearchSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserSearchSummary" + } + }, "com.amazonaws.connect#UserSummary": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index 3b76f2454b..a2bb01bf7f 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -426,7 +426,7 @@ "target": "com.amazonaws.ec2#AcceptVpcEndpointConnectionsResult" }, "traits": { - "smithy.api#documentation": "

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint\n service.

" + "smithy.api#documentation": "

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.

" } }, "com.amazonaws.ec2#AcceptVpcEndpointConnectionsRequest": { @@ -4087,6 +4087,9 @@ "input": { "target": "com.amazonaws.ec2#AssociateDhcpOptionsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

\n

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

\n

For more information, see DHCP options sets\n in the Amazon Virtual Private Cloud User Guide.

" } @@ -4964,6 +4967,9 @@ "input": { "target": "com.amazonaws.ec2#AttachInternetGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and\n\t\t\tthe VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" } @@ -6697,6 +6703,9 @@ "input": { "target": "com.amazonaws.ec2#CancelConversionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all\n artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is\n in the process of transferring the final disk image, the command fails and returns an exception.

\n

For more information, see Importing a Virtual Machine Using the Amazon\n EC2 CLI.

" } @@ -6706,6 +6715,9 @@ "input": { "target": "com.amazonaws.ec2#CancelExportTaskRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Cancels an active export task. The request removes all artifacts of the export, including any partially-created\n Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the\n command fails and returns an error.

" } @@ -10485,7 +10497,7 @@ "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" }, "traits": { - "smithy.api#documentation": "

Provides information to Amazon Web Services about your VPN customer gateway device. The\n customer gateway is the appliance at your end of the VPN connection. (The device on the\n Amazon Web Services side of the VPN connection is the virtual private gateway.) You\n must provide the internet-routable IP address of the customer gateway's external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your\n network. If you don't have an ASN already, you can use a private ASN (in the 64512 -\n 65534 range).

\n \n

Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with\n the exception of the following:

\n \n \n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

\n \n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. Identical requests\n return information about the existing customer gateway and do not create new\n customer gateways.

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

Provides information to Amazon Web Services about your VPN customer gateway device. The\n customer gateway is the appliance at your end of the VPN connection. (The device on the\n Amazon Web Services side of the VPN connection is the virtual private gateway.) You\n must provide the internet-routable IP address of the customer gateway's external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

" } }, "com.amazonaws.ec2#CreateCustomerGatewayRequest": { @@ -11222,7 +11234,7 @@ "target": "com.amazonaws.ec2#CreateImageResult" }, "traits": { - "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n \n

By default, Amazon EC2 shuts down and reboots the instance before creating the AMI to ensure that everything on \n the instance is stopped and in a consistent state during the creation process. If you're confident that your \n instance is in a consistent state appropriate for AMI creation, use the NoReboot \n parameter to prevent Amazon EC2 from shutting down and rebooting the instance.

\n \n \n \n \n \t\n \t

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

\n \t

For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance \n \tthat is either running or stopped.

\n\t

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \t \n\t\t\t\t\t

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n\t\t\t\t \n \n \n \n \t\n \t

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the \n \tnew AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, \n \tthe instance automatically launches with those additional volumes.

\n \t

For more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateImageRequest": { @@ -11274,7 +11286,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "NoReboot", - "smithy.api#documentation": "

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. \n If the No Reboot option is set, Amazon EC2 doesn't shut down the instance before creating \n the image. Without a reboot, the AMI will be crash consistent (all the volumes are snapshotted \n at the same time), but not application consistent (all the operating system buffers are not flushed \n to disk before the snapshots are created).

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

By default, when Amazon EC2 creates the new AMI, it reboots the instance so that it can \n\t\t\t\t\ttake snapshots of the attached volumes while data is at rest, in order to ensure a consistent \n\t\t\t\t\tstate. You can set the NoReboot parameter to true in the API request, \n\t\t\t\t\tor use the --no-reboot option in the CLI to prevent Amazon EC2 from shutting down and \n\t\t\t\t\trebooting the instance.

\n \t \n\t\t\t\t\t

If you choose to bypass the shutdown and reboot process by setting the NoReboot \n\t\t\t\t\tparameter to true in the API request, or by using the --no-reboot option \n\t\t\t\t\tin the CLI, we can't guarantee the file system integrity of the created image.

\n\t\t\t\t \n

Default: false (follow standard reboot process)

", "smithy.api#xmlName": "noReboot" } }, @@ -11488,7 +11500,7 @@ "target": "com.amazonaws.ec2#CreateIpamResult" }, "traits": { - "smithy.api#documentation": "

Create an IPAM. Amazon VCP IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization.

\n

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" + "smithy.api#documentation": "

Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use\n to automate your IP address management workflows including assigning, tracking,\n troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts\n throughout your Amazon Web Services Organization.

\n

For more information, see Create an IPAM in the Amazon VPC IPAM User Guide.\n

" } }, "com.amazonaws.ec2#CreateIpamPool": { @@ -11739,7 +11751,7 @@ "target": "com.amazonaws.ec2#KeyPair" }, "traits": { - "smithy.api#documentation": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public\n key and displays the private key for you to save to a file. The private key is returned\n as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name\n already exists, Amazon EC2 returns an error.

\n\t\t

The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the\n specified PEM or PPK format. Amazon EC2 stores the public key and displays the private\n key for you to save to a file. The private key is returned as an unencrypted PEM encoded\n PKCS#1 private key or an unencrypted PPK formatted private key for use with PuTTY. If a\n key with the specified name already exists, Amazon EC2 returns an error.

\n\t\t

The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateKeyPairRequest": { @@ -11763,7 +11775,7 @@ "KeyType": { "target": "com.amazonaws.ec2#KeyType", "traits": { - "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.

\n

Default: rsa\n

" + "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances.

\n

Default: rsa\n

" } }, "TagSpecifications": { @@ -11772,6 +11784,12 @@ "smithy.api#documentation": "

The tags to apply to the new key pair.

", "smithy.api#xmlName": "TagSpecification" } + }, + "KeyFormat": { + "target": "com.amazonaws.ec2#KeyFormat", + "traits": { + "smithy.api#documentation": "

The format of the key pair.

\n

Default: pem\n

" + } } } }, @@ -11784,7 +11802,7 @@ "target": "com.amazonaws.ec2#CreateLaunchTemplateResult" }, "traits": { - "smithy.api#documentation": "

Creates a launch template. A launch template contains the parameters to launch an\n instance. When you launch an instance using RunInstances, you can\n specify a launch template instead of providing the launch parameters in the request. For\n more information, see Launching an instance from a\n launch template in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates a launch template.

\n

A launch template contains the parameters to launch an\n instance. When you launch an instance using RunInstances, you can\n specify a launch template instead of providing the launch parameters in the request. For\n more information, see Launching an instance from a\n launch template in the Amazon Elastic Compute Cloud User Guide.

\n

If you want to clone an existing launch template as the basis for creating a new\n launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support\n cloning a template. For more information, see Create a launch template from an existing launch template in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateLaunchTemplateRequest": { @@ -12219,6 +12237,9 @@ "input": { "target": "com.amazonaws.ec2#CreateNetworkAclEntryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules \n\t\t and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated \n\t\t with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of \n\t\t ingress rules and a separate set of egress rules.

\n\t\t

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the \n\t\t other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

\n\t\t

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

\n

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" } @@ -13729,6 +13750,9 @@ "input": { "target": "com.amazonaws.ec2#CreateTagsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or\n resources. When you specify an existing tag key, the value is overwritten with\n the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and\n optional value. Tag keys must be unique per resource.

\n \n

For more information about tags, see Tagging Your Resources in the\n Amazon Elastic Compute Cloud User Guide. For more information about\n creating IAM policies that control users' access to resources based on tags, see Supported\n Resource-Level Permissions for Amazon EC2 API Actions in the Amazon\n Elastic Compute Cloud User Guide.

" } @@ -14923,7 +14947,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPC endpoint for a specified service. An endpoint enables you to create a\n private connection between your VPC and the service. The service may be provided by Amazon Web Services,\n an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, \n see VPC Endpoints in the\n Amazon Virtual Private Cloud User Guide.

\n

A gateway endpoint serves as a target for a route in your route table for\n traffic destined for the Amazon Web Service. You can specify an endpoint policy to attach \n to the endpoint, which will control access to the service from your VPC. You can also\n specify the VPC route tables that use the endpoint.

\n

An interface endpoint is a network interface in your subnet that\n serves as an endpoint for communicating with the specified service. You can specify the\n subnets in which to create an endpoint, and the security groups to associate with the\n endpoint network interface.

\n

A GatewayLoadBalancer endpoint is a network interface in your subnet that serves an endpoint for communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service.

\n

Use DescribeVpcEndpointServices to get a list of supported\n services.

" + "smithy.api#documentation": "

Creates a VPC endpoint for a specified service. An endpoint enables you to create a\n private connection between your VPC and the service. The service may be provided by Amazon Web Services,\n an Amazon Web Services Marketplace Partner, or another Amazon Web Services account. For more information, \n see the Amazon Web Services PrivateLink Guide.

" } }, "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification": { @@ -15115,7 +15139,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPC endpoint service configuration to which service consumers (Amazon Web Services accounts,\n IAM users, and IAM roles) can connect.

\n

To create an endpoint service configuration, you must first create one of the\n following for your service:

\n \n

For more information, see VPC Endpoint Services in the\n Amazon Virtual Private Cloud User Guide.

\n

If you set the private DNS name, you must prove that you own the private DNS domain\n name. For more information, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Creates a VPC endpoint service to which service consumers (Amazon Web Services accounts,\n IAM users, and IAM roles) can connect.

\n

Before you create an endpoint service, you must create one of the following for your service:

\n \n

If you set the private DNS name, you must prove that you own the private DNS domain\n name.

\n\t

For more information, see the Amazon Web Services PrivateLink \n\t Guide.

" } }, "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { @@ -15130,7 +15154,7 @@ "AcceptanceRequired": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted. To accept a request, use AcceptVpcEndpointConnections.

" + "smithy.api#documentation": "

Indicates whether requests from service consumers to create an endpoint to your service must\n be accepted manually.

" } }, "PrivateDnsName": { @@ -15451,6 +15475,9 @@ "input": { "target": "com.amazonaws.ec2#CreateVpnConnectionRouteRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Creates a static route associated with a VPN connection between an existing virtual\n private gateway and a VPN customer gateway. The static route allows traffic to be routed\n from the virtual private gateway to the VPN customer gateway.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" } @@ -15945,6 +15972,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteCustomerGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified customer gateway. You must delete the VPN connection before you\n can delete the customer gateway.

" } @@ -15977,6 +16007,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteDhcpOptionsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" } @@ -16366,6 +16399,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteInternetGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified internet gateway. You must detach the internet gateway from the\n\t\t\tVPC before you can delete it.

" } @@ -16401,7 +16437,7 @@ "target": "com.amazonaws.ec2#DeleteIpamResult" }, "traits": { - "smithy.api#documentation": "

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

\n \n

You cannot delete an IPAM if there are CIDRs provisioned to pools or if there are allocations in the pools within the IPAM. To deprovision pool \n CIDRs, see DeprovisionIpamPoolCidr. To release allocations, see ReleaseIpamPoolAllocation.\n

\n \n

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.\n

" + "smithy.api#documentation": "

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

\n

For more information, see Delete an IPAM in the Amazon VPC IPAM User Guide.\n

" } }, "com.amazonaws.ec2#DeleteIpamPool": { @@ -16532,6 +16568,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteKeyPairRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified key pair, by removing the public key from Amazon EC2.

" } @@ -16948,6 +16987,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteNetworkAclRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" } @@ -16957,6 +16999,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteNetworkAclEntryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" } @@ -17200,6 +17245,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteNetworkInterfaceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified network interface. You must detach the network interface before you can delete it.

" } @@ -17289,6 +17337,9 @@ "input": { "target": "com.amazonaws.ec2#DeletePlacementGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified placement group. You must terminate all instances in the\n placement group before you can delete the placement group. For more information, see\n Placement groups in the Amazon EC2 User Guide.

" } @@ -17473,6 +17524,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteRouteRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified route from the specified route table.

" } @@ -17526,6 +17580,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteRouteTableRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" } @@ -17557,6 +17614,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteSecurityGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes a security group.

\n

If you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.

" } @@ -17591,6 +17651,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteSnapshotRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified snapshot.

\n

When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.

\n

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.

\n

For more information, see Delete an Amazon EBS snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } @@ -17620,6 +17683,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteSpotDatafeedSubscriptionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the data feed for Spot Instances.

" } @@ -17645,6 +17711,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteSubnetRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" } @@ -17717,6 +17786,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteTagsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of resources.

\n

To list the current tags, use DescribeTags. For more information about tags, see \n Tagging Your Resources \n in the Amazon Elastic Compute Cloud User Guide.

" } @@ -18329,6 +18401,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVolumeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified EBS volume. The volume must be in the available state\n (not attached to an instance).

\n

The volume can remain in the deleting state for several minutes.

\n

For more information, see Delete an Amazon EBS volume in the\n Amazon Elastic Compute Cloud User Guide.

" } @@ -18358,6 +18433,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVpcRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" } @@ -18572,6 +18650,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVpnConnectionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified VPN connection.

\n

If you're deleting the VPC and its associated components, we recommend that you detach\n the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n connection. If you believe that the tunnel credentials for your VPN connection have been\n compromised, you can delete the VPN connection and create a new one that has new keys,\n without needing to delete the VPC or virtual private gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway device using the new configuration\n information returned with the new VPN connection ID.

\n

For certificate-based authentication, delete all Certificate Manager (ACM) private\n certificates used for the Amazon Web Services-side tunnel endpoints for the VPN\n connection before deleting the VPN connection.

" } @@ -18604,6 +18685,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVpnConnectionRouteRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified static route associated with a VPN connection between an\n existing virtual private gateway and a VPN customer gateway. The static route allows\n traffic to be routed from the virtual private gateway to the VPN customer\n gateway.

" } @@ -18635,6 +18719,9 @@ "input": { "target": "com.amazonaws.ec2#DeleteVpnGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified virtual private gateway. You must first detach the virtual\n private gateway from the VPC. Note that you don't need to delete the virtual private\n gateway if you plan to delete and recreate the VPN connection between your VPC and your\n network.

" } @@ -18826,6 +18913,9 @@ "input": { "target": "com.amazonaws.ec2#DeregisterImageRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deregisters the specified AMI. After you deregister an AMI, it can't be used to \n launch new instances.

\n \n \n

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is \n retained in the Recycle Bin for the specified retention period. For more information, \n see Recycle\n Bin in the Amazon Elastic Compute Cloud User Guide.

\n \n

When you deregister an AMI, it doesn't affect any instances that you've already \n launched from the AMI. You'll continue to incur usage costs for those instances until \n you terminate them.

\n \t

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was\n\t\t\tcreated for the root volume of the instance during the AMI creation process. When you\n\t\t\tderegister an instance store-backed AMI, it doesn't affect the files that you uploaded\n\t\t\tto Amazon S3 when you created the AMI.

" } @@ -22395,7 +22485,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

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

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -23286,7 +23376,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

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

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -23831,6 +23921,12 @@ "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.

", "smithy.api#xmlName": "dryRun" } + }, + "IncludePublicKey": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, the public key material is included in the response.

\n

Default: false\n

" + } } } }, @@ -24374,7 +24470,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -24734,6 +24830,27 @@ } ], "minDelay": 15 + }, + "NatGatewayDeleted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "NatGateways[].State", + "expected": "deleted", + "comparator": "allStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "NatGatewayNotFound" + } + } + ], + "minDelay": 15 } } } @@ -27555,7 +27672,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -30611,6 +30728,9 @@ "input": { "target": "com.amazonaws.ec2#DetachInternetGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Detaches an internet gateway from a VPC, disabling connectivity between the internet\n\t\t\tand the VPC. The VPC must not contain any running instances with Elastic IP addresses or\n\t\t\tpublic IPv4 addresses.

" } @@ -30651,6 +30771,9 @@ "input": { "target": "com.amazonaws.ec2#DetachNetworkInterfaceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Detaches a network interface from an instance.

" } @@ -30743,6 +30866,9 @@ "input": { "target": "com.amazonaws.ec2#DetachVpnGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn\n off the VPC and not use it anymore. You can confirm a virtual private gateway has been\n completely detached from a VPC by describing the virtual private gateway (any\n attachments to the virtual private gateway are also described).

\n

You must wait for the attachment's state to switch to detached before you\n can delete the VPC or attach a different VPC to the virtual private gateway.

" } @@ -31506,6 +31632,9 @@ "input": { "target": "com.amazonaws.ec2#DisableVgwRoutePropagationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Disables a virtual private gateway (VGW) from propagating routes to a specified route\n table of a VPC.

" } @@ -31627,6 +31756,9 @@ "input": { "target": "com.amazonaws.ec2#DisassociateAddressRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n\t\t\t

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more\n\t\t\tinformation, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" } @@ -31854,6 +31986,9 @@ "input": { "target": "com.amazonaws.ec2#DisassociateRouteTableRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Disassociates a subnet or gateway from a route table.

\n\t\t

After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\ttables in the Amazon Virtual Private Cloud User Guide.

" } @@ -32539,7 +32674,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored.

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

The ARN of the Outpost on which the snapshot is stored.

\n

This parameter is only supported on BlockDeviceMapping objects called \n by \n CreateImage.

", "smithy.api#xmlName": "outpostArn" } }, @@ -33793,6 +33928,9 @@ "input": { "target": "com.amazonaws.ec2#EnableVgwRoutePropagationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Enables a virtual private gateway (VGW) to propagate routes to the specified route\n table of a VPC.

" } @@ -33830,6 +33968,9 @@ "input": { "target": "com.amazonaws.ec2#EnableVolumeIORequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Enables I/O operations for a volume that had I/O operations disabled because the data on\n the volume was potentially inconsistent.

" } @@ -41889,7 +42030,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "smithy.api#documentation": "", "smithy.api#xmlName": "keyFingerprint" } }, @@ -49522,6 +49663,21 @@ "com.amazonaws.ec2#KernelId": { "type": "string" }, + "com.amazonaws.ec2#KeyFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "pem", + "name": "pem" + }, + { + "value": "ppk", + "name": "ppk" + } + ] + } + }, "com.amazonaws.ec2#KeyNameStringList": { "type": "list", "member": { @@ -49538,7 +49694,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

The SHA-1 digest of the DER encoded private key.

", + "smithy.api#documentation": "", "smithy.api#xmlName": "keyFingerprint" } }, @@ -49606,7 +49762,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair:

\n \n

If you used ImportKeyPair to provide Amazon Web Services the public key:

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

If you used CreateKeyPair to create the key pair:

\n \n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n ", "smithy.api#xmlName": "keyFingerprint" } }, @@ -49633,6 +49789,22 @@ "smithy.api#documentation": "

Any tags applied to the key pair.

", "smithy.api#xmlName": "tagSet" } + }, + "PublicKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicKey", + "smithy.api#documentation": "

The public key material.

", + "smithy.api#xmlName": "publicKey" + } + }, + "CreateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

If you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.

\n

If you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.

", + "smithy.api#xmlName": "createTime" + } } }, "traits": { @@ -49825,7 +49997,7 @@ "target": "com.amazonaws.ec2#InstanceType", "traits": { "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

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

The instance type. Only one instance type can be specified.

", "smithy.api#xmlName": "instanceType" } }, @@ -53788,6 +53960,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyIdFormatRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the ID format for the specified resource on a per-Region basis. You can\n specify that resources should receive longer IDs (17-character IDs) when they are\n created.

\n

This request can only be used to modify longer ID settings for resource types that\n are within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

This setting applies to the IAM user who makes the request; it does not apply to the\n entire Amazon Web Services account. By default, an IAM user defaults to the same settings as the root user. If\n you're using this action as the root user, then these settings apply to the entire account,\n unless an IAM user explicitly overrides these settings for themselves. For more information,\n see Resource IDs \n in the Amazon Elastic Compute Cloud User Guide.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless\n of these settings and provided that they have permission to use the relevant\n Describe command for the resource type.

" } @@ -53816,6 +53991,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyIdentityIdFormatRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root\n user for an account; or all IAM users, IAM roles, and the root user for an account. You can\n specify that resources should receive longer IDs (17-character IDs) when they are created.

\n

This request can only be used to modify longer ID settings for resource types that are\n within the opt-in period. Resources currently in their opt-in period include:\n bundle | conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | internet-gateway | network-acl\n | network-acl-association | network-interface |\n network-interface-attachment | prefix-list |\n route-table | route-table-association |\n security-group | subnet |\n subnet-cidr-block-association | vpc |\n vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

\n

For more information, see Resource IDs in the\n Amazon Elastic Compute Cloud User Guide.

\n

This setting applies to the principal specified in the request; it does not apply to the\n principal that makes the request.

\n

Resources created with longer IDs are visible to all IAM roles and users, regardless of these\n settings and provided that they have permission to use the relevant Describe\n command for the resource type.

" } @@ -53857,6 +54035,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyImageAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.\n You can use the Attribute parameter to specify the attribute or one of the following parameters: \n Description or LaunchPermission.

\n \t

Images with an Amazon Web Services Marketplace product code cannot be made public.

\n

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance \n and create an AMI from the instance.

" } @@ -53954,6 +54135,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyInstanceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the specified attribute of the specified instance. You can specify only one\n attribute at a time.

\n

\n Note: Using this action to change the security groups\n associated with an elastic network interface (ENI) attached to an instance in a VPC can\n result in an error if the instance has more than one ENI. To change the security groups\n associated with an ENI attached to an instance that has multiple ENIs, we recommend that\n you use the ModifyNetworkInterfaceAttribute action.

\n

To modify some attributes, the instance must be stopped. For more information, see\n Modify a stopped instance in the\n Amazon EC2 User Guide.

" } @@ -54956,6 +55140,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the specified network interface attribute. You can specify only one\n attribute at a time. You can use this action to attach and detach security groups from\n an existing EC2 instance.

" } @@ -55192,6 +55379,9 @@ "input": { "target": "com.amazonaws.ec2#ModifySnapshotAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Adds or removes permission settings for the specified snapshot. You may add or remove\n specified Amazon Web Services account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single operation. If you need to both add and remove account IDs for a snapshot,\n you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

\n

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made\n public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } @@ -55390,6 +55580,9 @@ "input": { "target": "com.amazonaws.ec2#ModifySubnetAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies a subnet attribute. You can only modify one attribute at a time.

\n\t \n\t

Use this action to modify subnets on Amazon Web Services Outposts.

\n \n\t \n\t

For more information about Amazon Web Services Outposts, see the following:

\n\t \n\t " } @@ -55439,7 +55632,7 @@ "PrivateDnsHostnameTypeOnLaunch": { "target": "com.amazonaws.ec2#HostnameType", "traits": { - "smithy.api#documentation": "

The type of hostnames to assign to instances in the subnet at launch. For IPv4 only subnets, an\n instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance\n DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS\n names use the instance IPv4 address or the instance ID.

" + "smithy.api#documentation": "

The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an\n instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance\n DNS name must be based on the instance ID (resource-name).

" } }, "EnableResourceNameDnsARecordOnLaunch": { @@ -55989,7 +56182,7 @@ "target": "com.amazonaws.ec2#ModifyVolumeResult" }, "traits": { - "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) \n or Amazon EBS Elastic Volumes (Windows instances).

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or \n Extend a Windows file system.

\n

You can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitor the progress of volume modifications.

\n

With previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.

\n

If you reach the maximum volume modification rate per volume limit, you must wait\n at least six hours before applying further modifications to the affected EBS volume.

" + "smithy.api#documentation": "

You can modify several parameters of an existing EBS volume, including volume size, volume\n type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance\n type, you might be able to apply these changes without stopping the instance or detaching the\n volume from it. For more information about modifying EBS volumes, see Amazon EBS Elastic Volumes (Linux instances) \n or Amazon EBS Elastic Volumes (Windows instances).

\n

When you complete a resize operation on your volume, you need to extend the volume's\n file-system size to take advantage of the new storage capacity. For more information, see Extend a Linux file system or \n Extend a Windows file system.

\n

You can use CloudWatch Events to check the status of a modification to an EBS volume. For\n information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a\n modification using DescribeVolumesModifications. For information\n about tracking status changes using either method, see Monitor the progress of volume modifications.

\n

With previous-generation instance types, resizing an EBS volume might require detaching and\n reattaching the volume or stopping and restarting the instance.

\n

After modifying a volume, you must wait at least six hours and ensure that the volume \n is in the in-use or available state before you can modify the same \n volume. This is sometimes referred to as a cooldown period.

" } }, "com.amazonaws.ec2#ModifyVolumeAttribute": { @@ -55997,6 +56190,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyVolumeAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies a volume attribute.

\n

By default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the\n data consistency on your volume.

\n

You can change the default behavior to resume I/O operations. We recommend that you change\n this only for boot volumes or for volumes that are stateless or disposable.

" } @@ -56093,6 +56289,9 @@ "input": { "target": "com.amazonaws.ec2#ModifyVpcAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Modifies the specified attribute of the specified VPC.

" } @@ -56132,7 +56331,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointResult" }, "traits": { - "smithy.api#documentation": "

Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see\n VPC\n Endpoints in the Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, \n see the Amazon Web Services PrivateLink \n Guide.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification": { @@ -56293,7 +56492,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.

\n\t

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name. For more information, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.

\n\t

If you set or modify the private DNS name, you must prove that you own the private DNS\n domain name.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { @@ -56432,7 +56631,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsResult" }, "traits": { - "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, \n\t IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.

\n\t

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" + "smithy.api#documentation": "

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers \n\t (IAM users, IAM roles, and Amazon Web Services accounts) to connect to your endpoint service.

\n\t

If you grant permissions to all principals, the service is public. Any users who know the name of a\n\t public service can send a request to attach an endpoint. If the service does not require manual approval,\n\t attachments are automatically approved.

" } }, "com.amazonaws.ec2#ModifyVpcEndpointServicePermissionsRequest": { @@ -60937,7 +61136,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the private DNS name for the service endpoint. For more information\n about these parameters, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.

" + "smithy.api#documentation": "

Information about the private DNS name for the service endpoint.

" } }, "com.amazonaws.ec2#PrivateDnsNameOptionsOnLaunch": { @@ -62042,6 +62241,9 @@ "input": { "target": "com.amazonaws.ec2#RebootInstancesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Requests a reboot of the specified instances. This operation is asynchronous; it only\n queues a request to reboot the specified instances. The operation succeeds if the\n instances are valid and belong to you. Requests to reboot terminated instances are\n ignored.

\n

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a\n hard reboot.

\n

For more information about troubleshooting, see Troubleshoot an unreachable\n instance in the Amazon EC2 User Guide.

" } @@ -62777,6 +62979,9 @@ "input": { "target": "com.amazonaws.ec2#ReleaseAddressRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Releases the specified Elastic IP address.

\n

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address without\n\t\t\t\treleasing it, use DisassociateAddress.

\n

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address\n\t\t\t before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

\n

After releasing an Elastic IP address, it is released to the IP address pool. \n Be sure to update your DNS records and any servers or devices that communicate with the address. \n If you attempt to release an Elastic IP address that you already released, you'll get an\n AuthFailure error if the address is already allocated to another Amazon Web Services account.

\n

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it.\n For more information, see AllocateAddress.

" } @@ -63074,6 +63279,9 @@ "input": { "target": "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

" } @@ -63280,6 +63488,9 @@ "input": { "target": "com.amazonaws.ec2#ReplaceRouteRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Replaces an existing route within a route table in a VPC. You must provide only one of\n the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC\n peering connection, network interface, egress-only internet gateway, or transit\n gateway.

\n

For more information, see Route tables in the\n Amazon Virtual Private Cloud User Guide.

" } @@ -63601,6 +63812,9 @@ "input": { "target": "com.amazonaws.ec2#ReportInstanceStatusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Submits feedback about the status of an instance. The instance must be in the\n running state. If your experience with the instance differs from the\n instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon\n EC2 collects this information to improve the accuracy of status checks.

\n

Use of this action does not change the value returned by DescribeInstanceStatus.

" } @@ -63936,7 +64150,7 @@ } }, "traits": { - "smithy.api#documentation": "

The information to include in the launch template.

" + "smithy.api#documentation": "

The information to include in the launch template.

\n \n

You must specify at least one parameter for the launch template data.

\n " } }, "com.amazonaws.ec2#RequestSpotFleet": { @@ -63948,7 +64162,7 @@ "target": "com.amazonaws.ec2#RequestSpotFleetResponse" }, "traits": { - "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

Creates a Spot Fleet request.

\n

The Spot Fleet request specifies the total target capacity and the On-Demand target\n capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand\n capacity, and launches the difference as Spot capacity.

\n

You can submit a single request that includes multiple launch specifications that vary\n by instance type, AMI, Availability Zone, or subnet.

\n

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the\n price per unit is the lowest. Each launch specification can include its own instance\n weighting that reflects the value of the instance type to your application\n workload.

\n

Alternatively, you can specify that the Spot Fleet distribute the target capacity\n across the Spot pools included in its launch specifications. By ensuring that the Spot\n Instances in your Spot Fleet are in different Spot pools, you can improve the\n availability of your fleet.

\n

You can specify tags for the Spot Fleet request and instances launched by the fleet.\n You cannot tag other resource types in a Spot Fleet request because only the\n spot-fleet-request and instance resource types are\n supported.

\n

For more information, see Spot Fleet requests\n in the Amazon EC2 User Guide for Linux Instances.

\n \n \n

We strongly discourage using the RequestSpotFleet API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.

\n " } }, "com.amazonaws.ec2#RequestSpotFleetRequest": { @@ -64001,7 +64215,7 @@ "target": "com.amazonaws.ec2#RequestSpotInstancesResult" }, "traits": { - "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

" + "smithy.api#documentation": "

Creates a Spot Instance request.

\n

For more information, see Spot Instance requests in\n the Amazon EC2 User Guide for Linux Instances.

\n \n \n

We strongly discourage using the RequestSpotInstances API because it is a legacy\n API with no planned investment. For options for requesting Spot Instances, see\n Which\n is the best Spot request method to use? in the\n Amazon EC2 User Guide for Linux Instances.

\n " } }, "com.amazonaws.ec2#RequestSpotInstancesRequest": { @@ -64188,7 +64402,7 @@ "target": "com.amazonaws.ec2#InstanceType", "traits": { "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

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

The instance type. Only one instance type can be specified.

", "smithy.api#xmlName": "instanceType" } }, @@ -65329,6 +65543,9 @@ "input": { "target": "com.amazonaws.ec2#ResetImageAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Resets an attribute of an AMI to its default value.

" } @@ -65379,6 +65596,9 @@ "input": { "target": "com.amazonaws.ec2#ResetInstanceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Resets an attribute of an instance to its default value. To reset the\n kernel or ramdisk, the instance must be in a stopped\n state. To reset the sourceDestCheck, the instance can be either running or\n stopped.

\n

The sourceDestCheck attribute controls whether source/destination\n checking is enabled. The default value is true, which means checking is\n enabled. This value must be false for a NAT instance to perform NAT. For\n more information, see NAT Instances in the\n Amazon VPC User Guide.

" } @@ -65419,6 +65639,9 @@ "input": { "target": "com.amazonaws.ec2#ResetNetworkInterfaceAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Resets a network interface attribute. You can specify only one attribute at a time.

" } @@ -65461,6 +65684,9 @@ "input": { "target": "com.amazonaws.ec2#ResetSnapshotAttributeRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Resets permission settings for the specified snapshot.

\n

For more information about modifying snapshot permissions, see Share a snapshot in the\n Amazon Elastic Compute Cloud User Guide.

" } @@ -67342,9 +67568,9 @@ } }, "UserData": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#RunInstancesUserData", "traits": { - "smithy.api#documentation": "

The user data to make available to the instance. For more information, see Run commands on\n your Linux instance at launch and Run commands on your\n Windows instance at launch. If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.

" + "smithy.api#documentation": "

The user data script to make available to the instance. For more information, see Run commands\n on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool,\n base64-encoding is performed for you, and you can load the text from a file. Otherwise,\n you must provide base64-encoded text. User data is limited to 16 KB.

" } }, "AdditionalInfo": { @@ -67509,6 +67735,12 @@ } } }, + "com.amazonaws.ec2#RunInstancesUserData": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.ec2#RunScheduledInstances": { "type": "operation", "input": { @@ -69042,6 +69274,9 @@ "input": { "target": "com.amazonaws.ec2#SendDiagnosticInterruptRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a\n kernel panic (on Linux instances), or a blue\n screen/stop error (on Windows instances). For\n instances based on Intel and AMD processors, the interrupt is received as a\n non-maskable interrupt (NMI).

\n\n

In general, the operating system crashes and reboots when a kernel panic or stop error\n is triggered. The operating system can also be configured to perform diagnostic tasks,\n such as generating a memory dump file, loading a secondary kernel, or obtaining a call\n trace.

\n\n

Before sending a diagnostic interrupt to your instance, ensure that its operating\n system is configured to perform the required diagnostic tasks.

\n\n

For more information about configuring your operating system to generate a crash dump\n when a kernel panic or stop error occurs, see Send a diagnostic interrupt\n (for advanced users) (Linux instances) or Send a diagnostic\n interrupt (for advanced users) (Windows instances).

" } @@ -70874,7 +71109,7 @@ "target": "com.amazonaws.ec2#SpotInstanceState", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Spot Instance request. Spot status information helps track your Spot\n Instance requests. For more information, see Spot status in the\n Amazon EC2 User Guide for Linux Instances.

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

The state of the Spot Instance request. Spot request status information helps track your Spot\n Instance requests. For more information, see Spot request status in the\n Amazon EC2 User Guide for Linux Instances.

", "smithy.api#xmlName": "state" } }, @@ -71010,7 +71245,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Code", - "smithy.api#documentation": "

The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances.

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

The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.

", "smithy.api#xmlName": "code" } }, @@ -71696,7 +71931,7 @@ "target": "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationResult" }, "traits": { - "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server. For more information, see Adding a TXT Record to Your Domain's DNS Server in the Amazon VPC User Guide.

" + "smithy.api#documentation": "

Initiates the verification process to prove that the service provider owns the private\n DNS name domain for the endpoint service.

\n

The service provider must successfully perform the verification before the consumer can use the name to access the service.

\n

Before the service provider runs this command, they must add a record to the DNS server.

" } }, "com.amazonaws.ec2#StartVpcEndpointServicePrivateDnsVerificationRequest": { @@ -76531,6 +76766,9 @@ "input": { "target": "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.

" } diff --git a/aws/sdk/aws-models/elasticache.json b/aws/sdk/aws-models/elasticache.json index 2155c94ab2..0d34cdf717 100644 --- a/aws/sdk/aws-models/elasticache.json +++ b/aws/sdk/aws-models/elasticache.json @@ -727,7 +727,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

The name of the compute and memory capacity node type for the cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -1083,7 +1083,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "com.amazonaws.elasticache#CacheNodeIdsList": { @@ -2081,7 +2081,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -2639,7 +2639,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { @@ -3344,6 +3344,9 @@ "input": { "target": "com.amazonaws.elasticache#DeleteCacheParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.elasticache#CacheParameterGroupNotFoundFault" @@ -3382,6 +3385,9 @@ "input": { "target": "com.amazonaws.elasticache#DeleteCacheSecurityGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.elasticache#CacheSecurityGroupNotFoundFault" @@ -3420,6 +3426,9 @@ "input": { "target": "com.amazonaws.elasticache#DeleteCacheSubnetGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.elasticache#CacheSubnetGroupInUse" @@ -4562,7 +4571,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

The cache node type filter value. \n Use this parameter to show only those reservations matching the specified cache node type.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -4641,7 +4650,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

The cache node type filter value. \n Use this parameter to show only the available offerings matching the specified cache node type.

\n\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -8715,7 +8724,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

The cache node type for the reserved cache nodes.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "StartTime": { @@ -8875,7 +8884,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Duration": { @@ -9445,7 +9454,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

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

The name of the compute and memory capacity node type for the source cluster.

\n \n

The following node types are supported by ElastiCache. \n\t\t\t\tGenerally speaking, the current generation types provide more memory and computational power\n\t\t\tat lower cost when compared to their equivalent previous generation counterparts.

\n\t\t \n\t\t\t\t\n\t\t

\n Additional node type info\n

\n\t\t " } }, "Engine": { diff --git a/aws/sdk/aws-models/fsx.json b/aws/sdk/aws-models/fsx.json index 071d7dbb54..95d1d84a19 100644 --- a/aws/sdk/aws-models/fsx.json +++ b/aws/sdk/aws-models/fsx.json @@ -1607,14 +1607,14 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OntapDeploymentType", "traits": { - "smithy.api#documentation": "

Specifies the FSx for ONTAP file system deployment type to use in creating the file system. \n MULTI_AZ_1 is the supported ONTAP deployment type.

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

Specifies the FSx for ONTAP file system deployment type to use in creating\n the file system.

\n \n

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing Multi-AZ or\n Single-AZ file system deployment.

", "smithy.api#required": {} } }, "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "

Specifies the IP address range in which the endpoints to access your file system\n will be created. By default, Amazon FSx selects an unused IP address range for you\n from the 198.19.* range.

\n \n

The Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.

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

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your\n file system will be created. By default, Amazon FSx selects an unused IP address\n range for you from the 198.19.* range.

\n \n

The Endpoint IP address range you select for your file system must exist outside\n the VPC's CIDR range and must be at least /30 or larger.

\n " } }, "FsxAdminPassword": { @@ -1632,19 +1632,19 @@ "PreferredSubnetId": { "target": "com.amazonaws.fsx#SubnetId", "traits": { - "smithy.api#documentation": "

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet \n in which you want the preferred file server to be located.

" + "smithy.api#documentation": "

Required when DeploymentType is set to MULTI_AZ_1. This\n specifies the subnet in which you want the preferred file server to be located.

" } }, "RouteTableIds": { "target": "com.amazonaws.fsx#RouteTableIds", "traits": { - "smithy.api#documentation": "

Specifies the virtual private cloud (VPC) route tables in which your file system's\n endpoints will be created. You should specify all VPC route tables associated with the\n subnets in which your clients are located. By default, Amazon FSx selects your VPC's\n default route table.

" + "smithy.api#documentation": "

(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your\n file system's endpoints will be created. You should specify all VPC route tables\n associated with the subnets in which your clients are located. By default, Amazon FSx\n selects your VPC's default route table.

" } }, "ThroughputCapacity": { "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "

Sets the throughput capacity for the file system that you're creating. \n Valid values are 128, 256, 512, 1024, and 2048 MBps.

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

Sets the throughput capacity for the file system that you're creating. Valid values\n are 128, 256, 512, 1024, and 2048 MBps.

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

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

" + "smithy.api#documentation": "

The ONTAP configuration properties of the FSx for ONTAP file system that you\n are creating.

" } }, "com.amazonaws.fsx#CreateFileSystemOpenZFSConfiguration": { @@ -5460,6 +5460,10 @@ { "value": "MULTI_AZ_1", "name": "MULTI_AZ_1" + }, + { + "value": "SINGLE_AZ_1", + "name": "SINGLE_AZ_1" } ] } @@ -5488,13 +5492,13 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OntapDeploymentType", "traits": { - "smithy.api#documentation": "

The ONTAP file system deployment type.

" + "smithy.api#documentation": "

Specifies the FSx for ONTAP file system deployment type in use in the file\n system.

\n \n

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing Multi-AZ or\n Single-AZ file system deployment.

" } }, "EndpointIpAddressRange": { "target": "com.amazonaws.fsx#IpAddressRange", "traits": { - "smithy.api#documentation": "

The IP address range in which the endpoints to access your file system\n are created.

\n \n

The Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.\n If you do not specify this optional parameter, Amazon FSx will automatically\n select a CIDR block for you.

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

(Multi-AZ only) The IP address range in which the endpoints to access your file system\n are created.

\n \n

The Endpoint IP address range you select for your file system\n must exist outside the VPC's CIDR range and must be at least /30 or larger.\n If you do not specify this optional parameter, Amazon FSx will automatically\n select a CIDR block for you.

\n " } }, "Endpoints": { @@ -5515,7 +5519,7 @@ "RouteTableIds": { "target": "com.amazonaws.fsx#RouteTableIds", "traits": { - "smithy.api#documentation": "

The VPC route tables in which your file system's endpoints are\n created.

" + "smithy.api#documentation": "

(Multi-AZ only) The VPC route tables in which your file system's endpoints are\n created.

" } }, "ThroughputCapacity": { diff --git a/aws/sdk/aws-models/gamelift.json b/aws/sdk/aws-models/gamelift.json index 51bf6b0372..c03fb19292 100644 --- a/aws/sdk/aws-models/gamelift.json +++ b/aws/sdk/aws-models/gamelift.json @@ -52,7 +52,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a player's acceptance or rejection of a proposed FlexMatch match. A\n matchmaking configuration may require player acceptance; if so, then matches built with\n that configuration cannot be completed unless all players accept the proposed match\n within a specified time limit.

\n

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed\n match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for\n your game to get acceptance from all players in the ticket. Acceptances are only valid\n for tickets when they are in this status; all other acceptances result in an\n error.

\n

To register acceptance, specify the ticket ID, a response, and one or more players.\n Once all players have registered acceptance, the matchmaking tickets advance to status\n PLACING, where a new game session is created for the match.

\n

If any player rejects the match, or if acceptances are not received before a specified\n timeout, the proposed match is dropped. The matchmaking tickets are then handled in one\n of two ways: For tickets where one or more players rejected the match, the ticket status\n is returned to SEARCHING to find a new match. For tickets where one or more\n players failed to respond, the ticket status is set to CANCELLED, and\n processing is terminated. A new matchmaking request for these players can be submitted\n as needed.

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n FlexMatch events (reference)

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" + "smithy.api#documentation": "

Registers a player's acceptance or rejection of a proposed FlexMatch match. A\n matchmaking configuration may require player acceptance; if so, then matches built with\n that configuration cannot be completed unless all players accept the proposed match\n within a specified time limit.

\n

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed\n match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for\n your game to get acceptance from all players in the ticket. Acceptances are only valid\n for tickets when they are in this status; all other acceptances result in an\n error.

\n

To register acceptance, specify the ticket ID, a response, and one or more players.\n Once all players have registered acceptance, the matchmaking tickets advance to status\n PLACING, where a new game session is created for the match.

\n

If any player rejects the match, or if acceptances are not received before a specified\n timeout, the proposed match is dropped. The matchmaking tickets are then handled in one\n of two ways: For tickets where one or more players rejected the match or failed to\n respond, the ticket status is set to CANCELLED, and processing is\n terminated. For tickets where players have accepted or not yet responded, the ticket\n status is returned to SEARCHING to find a new match. A new matchmaking\n request for these players can be submitted as needed.

\n

\n Learn more\n

\n

\n \n Add FlexMatch to a game client\n

\n

\n FlexMatch events (reference)

\n

\n Related actions\n

\n

\n StartMatchmaking | \n DescribeMatchmaking | \n StopMatchmaking | \n AcceptMatch | \n StartMatchBackfill | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#AcceptMatchInput": { @@ -244,13 +244,13 @@ "AccessKeyId": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Temporary key allowing access to the Amazon Web Services S3 account.

" + "smithy.api#documentation": "

Temporary key allowing access to the Amazon GameLift S3 account.

" } }, "SecretAccessKey": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

Temporary secret key allowing access to the Amazon Web Services S3 account.

" + "smithy.api#documentation": "

Temporary secret key allowing access to the Amazon GameLift S3 account.

" } }, "SessionToken": { @@ -261,7 +261,7 @@ } }, "traits": { - "smithy.api#documentation": "

Temporary access credentials used for uploading game build files to Amazon Web Services. They\n are valid for a limited time. If they expire before you upload your game build, get a\n new set by calling RequestUploadCredentials.

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

Temporary access credentials used for uploading game build files to Amazon GameLift. They\n are valid for a limited time. If they expire before you upload your game build, get a\n new set by calling RequestUploadCredentials.

", "smithy.api#sensitive": {} } }, @@ -410,7 +410,7 @@ "CertificateType": { "target": "com.amazonaws.gamelift#CertificateType", "traits": { - "smithy.api#documentation": "

Indicates whether a TLS/SSL certificate is generated for a fleet.

\n

Valid values include:

\n \n

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

Indicates whether a TLS/SSL certificate is generated for a fleet.

\n

Valid values include:

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

Creates an alias for a fleet. In most situations, you can use an alias ID in place of\n a fleet ID. An alias provides a level of abstraction for a fleet that is useful when\n redirecting player traffic from one fleet to another, such as when updating your game\n build.

\n

Amazon Web Services supports two types of routing strategies for aliases: simple and terminal. A\n simple alias points to an active fleet. A terminal alias is used to display messaging or\n link to a URL instead of routing players to an active fleet. For example, you might use\n a terminal alias when a game version is no longer supported and you want to direct\n players to an upgrade site.

\n

To create a fleet alias, specify an alias name, routing strategy, and optional\n description. Each simple alias can point to only one fleet, but a fleet can have\n multiple aliases. If successful, a new alias record is returned, including an alias ID\n and an ARN. You can reassign an alias to another fleet by calling\n UpdateAlias.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates an alias for a fleet. In most situations, you can use an alias ID in place of\n a fleet ID. An alias provides a level of abstraction for a fleet that is useful when\n redirecting player traffic from one fleet to another, such as when updating your game\n build.

\n

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A\n simple alias points to an active fleet. A terminal alias is used to display messaging or\n link to a URL instead of routing players to an active fleet. For example, you might use\n a terminal alias when a game version is no longer supported and you want to direct\n players to an upgrade site.

\n

To create a fleet alias, specify an alias name, routing strategy, and optional\n description. Each simple alias can point to only one fleet, but a fleet can have\n multiple aliases. If successful, a new alias record is returned, including an alias ID\n and an ARN. You can reassign an alias to another fleet by calling\n UpdateAlias.

\n

\n Related actions\n

\n

\n CreateAlias | \n ListAliases | \n DescribeAlias | \n UpdateAlias | \n DeleteAlias | \n ResolveAlias | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateAliasInput": { @@ -642,7 +642,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Web Services build resource for your game server binary files. Game server\n binaries must be combined into a zip file for use with Amazon Web Services.

\n \n

When setting up a new game build for GameLift, we recommend using the Amazon Web Services CLI\n command \n upload-build\n . This helper command combines two tasks: (1) it\n uploads your build files from a file directory to a GameLift Amazon S3 location, and (2)\n it creates a new build resource.

\n \n

The CreateBuild operation can used in the following scenarios:

\n \n

If successful, this operation creates a new build resource with a unique build ID and\n places it in INITIALIZED status. A build must be in READY\n status before you can create fleets with it.

\n

\n Learn more\n

\n

\n Uploading Your\n Game\n

\n

\n Create a Build with Files in Amazon S3\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a new Amazon GameLift build resource for your game server binary files. Game server\n binaries must be combined into a zip file for use with Amazon GameLift.

\n \n

When setting up a new game build for GameLift, we recommend using the Amazon Web Services CLI\n command \n upload-build\n . This helper command combines two tasks: (1) it\n uploads your build files from a file directory to a GameLift Amazon S3 location, and (2)\n it creates a new build resource.

\n \n

The CreateBuild operation can used in the following scenarios:

\n \n

If successful, this operation creates a new build resource with a unique build ID and\n places it in INITIALIZED status. A build must be in READY\n status before you can create fleets with it.

\n

\n Learn more\n

\n

\n Uploading Your\n Game\n

\n

\n Create a Build with Files in Amazon S3\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateBuildInput": { @@ -663,7 +663,7 @@ "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { - "smithy.api#documentation": "

Information indicating where your game build files are stored. Use this parameter only\n when creating a build with files stored in an Amazon S3 bucket that you own. The storage\n location must specify an Amazon S3 bucket name and key. The location must also specify a role\n ARN that you set up to allow Amazon Web Services to access your Amazon S3 bucket. The S3 bucket and your\n new build must be in the same Region.

\n

If a StorageLocation is specified, the size of your file\n can be found in your Amazon S3 bucket. Amazon Web Services will report a SizeOnDisk of 0. \n

" + "smithy.api#documentation": "

Information indicating where your game build files are stored. Use this parameter only\n when creating a build with files stored in an Amazon S3 bucket that you own. The storage\n location must specify an Amazon S3 bucket name and key. The location must also specify a role\n ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your\n new build must be in the same Region.

\n

If a StorageLocation is specified, the size of your file\n can be found in your Amazon S3 bucket. Amazon GameLift will report a SizeOnDisk of 0. \n

" } }, "OperatingSystem": { @@ -695,7 +695,7 @@ "UploadCredentials": { "target": "com.amazonaws.gamelift#AwsCredentials", "traits": { - "smithy.api#documentation": "

This element is returned only when the operation is called without a storage\n location. It contains credentials to use when you are uploading a build file to an Amazon S3\n bucket that is owned by Amazon Web Services. Credentials have a limited life span. To refresh these\n credentials, call RequestUploadCredentials.

" + "smithy.api#documentation": "

This element is returned only when the operation is called without a storage\n location. It contains credentials to use when you are uploading a build file to an Amazon S3\n bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these\n credentials, call RequestUploadCredentials.

" } }, "StorageLocation": { @@ -1019,7 +1019,7 @@ "RoleArn": { "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.

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

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

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

Creates a multiplayer game session for players in a specific fleet location. This\n operation prompts an available server process to start a game session and retrieves\n connection information for the new game session. As an alternative, consider using the\n GameLift game session placement feature with

\n

with StartGameSessionPlacement, which uses FleetIQ algorithms and\n queues to optimize the placement process.

\n

When creating a game session, you specify exactly where you want to place it and\n provide a set of game session configuration settings. The fleet must be in\n ACTIVE status before a game session can be created in it.

\n

This operation can be used in the following ways:

\n \n

If successful, a workflow is initiated to start a new game session. A\n GameSession object is returned containing the game session\n configuration and status. When the status is ACTIVE, game session\n connection information is provided and player sessions can be created for the game\n session. By default, newly created game sessions are open to new players. You can\n restrict new player access by using UpdateGameSession to change the\n game session's player session creation policy.

\n

Game session logs are retained for all active game sessions for 14 days. To access the\n logs, call GetGameSessionLogUrl to download the log files.

\n

\n Available in Amazon Web Services Local.\n

\n

\n Learn more\n

\n

\n Start a game session\n

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a multiplayer game session for players in a specific fleet location. This\n operation prompts an available server process to start a game session and retrieves\n connection information for the new game session. As an alternative, consider using the\n GameLift game session placement feature with

\n

with StartGameSessionPlacement, which uses FleetIQ algorithms and\n queues to optimize the placement process.

\n

When creating a game session, you specify exactly where you want to place it and\n provide a set of game session configuration settings. The fleet must be in\n ACTIVE status before a game session can be created in it.

\n

This operation can be used in the following ways:

\n \n

If successful, a workflow is initiated to start a new game session. A\n GameSession object is returned containing the game session\n configuration and status. When the status is ACTIVE, game session\n connection information is provided and player sessions can be created for the game\n session. By default, newly created game sessions are open to new players. You can\n restrict new player access by using UpdateGameSession to change the\n game session's player session creation policy.

\n

Game session logs are retained for all active game sessions for 14 days. To access the\n logs, call GetGameSessionLogUrl to download the log files.

\n

\n Available in Amazon GameLift Local.\n

\n

\n Learn more\n

\n

\n Start a game session\n

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateGameSessionInput": { @@ -1582,7 +1582,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reserves an open player slot in a game session for a player. New player sessions can be\n created in any game session with an open slot that is in ACTIVE status and\n has a player creation policy of ACCEPT_ALL. You can add a group of players\n to a game session with CreatePlayerSessions.

\n

To create a player session, specify a game session ID, player ID, and optionally a set of\n player data.

\n

If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned with a player session ID. The player\n references the player session ID when sending a connection request to the game session,\n and the game server can use it to validate the player reservation with the GameLift service. Player\n sessions cannot be updated.

\n

The maximum number of players per game session is 200. It is not adjustable.\n

\n

\n Available in Amazon Web Services Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

" + "smithy.api#documentation": "

Reserves an open player slot in a game session for a player. New player sessions can be\n created in any game session with an open slot that is in ACTIVE status and\n has a player creation policy of ACCEPT_ALL. You can add a group of players\n to a game session with CreatePlayerSessions.

\n

To create a player session, specify a game session ID, player ID, and optionally a set of\n player data.

\n

If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned with a player session ID. The player\n references the player session ID when sending a connection request to the game session,\n and the game server can use it to validate the player reservation with the GameLift service. Player\n sessions cannot be updated.

\n

The maximum number of players per game session is 200. It is not adjustable.\n

\n

\n Available in Amazon GameLift Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreatePlayerSessionInput": { @@ -1659,7 +1659,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reserves open slots in a game session for a group of players. New player sessions can be\n created in any game session with an open slot that is in ACTIVE status and\n has a player creation policy of ACCEPT_ALL. To add a single player to a\n game session, use CreatePlayerSession.

\n

To create player sessions, specify a game session ID and a list of player IDs. Optionally,\n provide a set of player data for each player ID.

\n

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player\n references their player session ID when sending a connection request to the game\n session, and the game server can use it to validate the player reservation with the\n GameLift service. Player sessions cannot be updated.

\n

The maximum number of players per game session is 200. It is not adjustable.\n

\n

\n Available in Amazon Web Services Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

" + "smithy.api#documentation": "

Reserves open slots in a game session for a group of players. New player sessions can be\n created in any game session with an open slot that is in ACTIVE status and\n has a player creation policy of ACCEPT_ALL. To add a single player to a\n game session, use CreatePlayerSession.

\n

To create player sessions, specify a game session ID and a list of player IDs. Optionally,\n provide a set of player data for each player ID.

\n

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player\n references their player session ID when sending a connection request to the game\n session, and the game server can use it to validate the player reservation with the\n GameLift service. Player sessions cannot be updated.

\n

The maximum number of players per game session is 200. It is not adjustable.\n

\n

\n Available in Amazon GameLift Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreatePlayerSessionsInput": { @@ -1682,7 +1682,7 @@ "PlayerDataMap": { "target": "com.amazonaws.gamelift#PlayerDataMap", "traits": { - "smithy.api#documentation": "

Map of string pairs, each specifying a player ID and a set of developer-defined\n information related to the player. Amazon Web Services does not use this data, so it can be formatted\n as needed for use in the game. Any player data strings for player IDs that are not\n included in the PlayerIds parameter are ignored.

" + "smithy.api#documentation": "

Map of string pairs, each specifying a player ID and a set of developer-defined\n information related to the player. Amazon GameLift does not use this data, so it can be formatted\n as needed for use in the game. Any player data strings for player IDs that are not\n included in the PlayerIds parameter are ignored.

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

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that\n provide configuration settings and optional custom game logic for your game. The script\n is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is\n executed during an active game session.

\n

To create a new script record, specify a script name and provide the script file(s).\n The script files and all dependencies must be zipped into a single file. You can pull\n the zip file from either of these locations:

\n \n

If the call is successful, a new script record is created with a unique script ID. If the \n script file is provided as a local file, the file is uploaded to an Amazon Web Services-owned S3 bucket \n and the script record's storage location reflects this location. If the script file is provided\n as an S3 bucket, Amazon Web Services accesses the file at this storage location as needed for deployment.

\n

\n Learn more\n

\n \n

\n Amazon Web Services Realtime Servers\n

\n

\n Set Up a Role for Amazon Web Services Access\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that\n provide configuration settings and optional custom game logic for your game. The script\n is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is\n executed during an active game session.

\n

To create a new script record, specify a script name and provide the script file(s).\n The script files and all dependencies must be zipped into a single file. You can pull\n the zip file from either of these locations:

\n \n

If the call is successful, a new script record is created with a unique script ID. If the \n script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket \n and the script record's storage location reflects this location. If the script file is provided\n as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

\n

\n Learn more\n

\n \n

\n Amazon GameLift Realtime Servers\n

\n

\n Set Up a Role for Amazon GameLift Access\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateScriptInput": { @@ -1751,7 +1751,7 @@ "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { - "smithy.api#documentation": "

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon Web Services to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon Web Services uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.

" + "smithy.api#documentation": "

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.

" } }, "ZipFile": { @@ -1774,7 +1774,7 @@ "Script": { "target": "com.amazonaws.gamelift#Script", "traits": { - "smithy.api#documentation": "

The newly created script record with a unique script ID and ARN. The new script's\n storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3\n bucket under your account, the storage location reflects the information that was\n provided in the CreateScript request; (2) If the script file was\n uploaded from a local zip file, the storage location reflects an S3 location controls by\n the Amazon Web Services service.

" + "smithy.api#documentation": "

The newly created script record with a unique script ID and ARN. The new script's\n storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3\n bucket under your account, the storage location reflects the information that was\n provided in the CreateScript request; (2) If the script file was\n uploaded from a local zip file, the storage location reflects an S3 location controls by\n the Amazon GameLift service.

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

Requests authorization to create or delete a peer connection between the VPC for\n your Amazon Web Services fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game\n servers on your fleet to communicate directly with other Amazon Web Services resources. Once you've\n received authorization, call CreateVpcPeeringConnection to establish\n the peering connection. For more information, see VPC Peering with Amazon Web Services\n Fleets.

\n

You can peer with VPCs that are owned by any Amazon Web Services account you have access to,\n including the account that you use to manage your Amazon Web Services fleets. You cannot peer with\n VPCs that are in different Regions.

\n

To request authorization to create a connection, call this operation from the Amazon Web Services\n account with the VPC that you want to peer to your Amazon Web Services fleet. For example, to\n enable your game servers to retrieve data from a DynamoDB table, use the account that\n manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC\n that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage\n Amazon Web Services. If successful, VPC peering is authorized for the specified VPC.

\n

To request authorization to delete a connection, call this operation from the Amazon Web Services\n account with the VPC that is peered with your Amazon Web Services fleet. Identify the following\n values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the\n Amazon Web Services account that you use to manage Amazon Web Services.

\n

The authorization remains valid for 24 hours unless it is canceled by a call to\n DeleteVpcPeeringAuthorization. You must create or delete the\n peering connection while the authorization is valid.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Requests authorization to create or delete a peer connection between the VPC for\n your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game\n servers on your fleet to communicate directly with other Amazon Web Services resources. Once you've\n received authorization, call CreateVpcPeeringConnection to establish\n the peering connection. For more information, see VPC Peering with Amazon GameLift\n Fleets.

\n

You can peer with VPCs that are owned by any Amazon Web Services account you have access to,\n including the account that you use to manage your Amazon GameLift fleets. You cannot peer with\n VPCs that are in different Regions.

\n

To request authorization to create a connection, call this operation from the Amazon Web Services\n account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to\n enable your game servers to retrieve data from a DynamoDB table, use the account that\n manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC\n that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage\n Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

\n

To request authorization to delete a connection, call this operation from the Amazon Web Services\n account with the VPC that is peered with your Amazon GameLift fleet. Identify the following\n values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the\n Amazon Web Services account that you use to manage Amazon GameLift.

\n

The authorization remains valid for 24 hours unless it is canceled by a call to\n DeleteVpcPeeringAuthorization. You must create or delete the\n peering connection while the authorization is valid.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateVpcPeeringAuthorizationInput": { @@ -1864,7 +1864,7 @@ } ], "traits": { - "smithy.api#documentation": "

Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC\n for your Amazon Web Services fleet. VPC peering enables the game servers on your fleet to\n communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account\n that you have access to, including the account that you use to manage your Amazon Web Services\n fleets. You cannot peer with VPCs that are in different Regions. For more information,\n see VPC Peering with Amazon Web Services Fleets.

\n

Before calling this operation to establish the peering connection, you first need\n to call CreateVpcPeeringAuthorization and identify the VPC you want to\n peer with. Once the authorization for the specified VPC is issued, you have 24 hours to\n establish the connection. These two operations handle all tasks necessary to peer the\n two VPCs, including acceptance, updating routing tables, etc.

\n

To establish the connection, call this operation from the Amazon Web Services account that is used\n to manage the Amazon Web Services fleets. Identify the following values: (1) The ID of the fleet\n you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC\n that you want to peer with; and (3) The ID of the VPC you want to peer with. This\n operation is asynchronous. If successful, a VpcPeeringConnection\n request is created. You can use continuous polling to track the request's status using\n DescribeVpcPeeringConnections, or by monitoring fleet events for\n success or failure using DescribeFleetEvents.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC\n for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to\n communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account\n that you have access to, including the account that you use to manage your Amazon GameLift\n fleets. You cannot peer with VPCs that are in different Regions. For more information,\n see VPC Peering with Amazon GameLift Fleets.

\n

Before calling this operation to establish the peering connection, you first need\n to call CreateVpcPeeringAuthorization and identify the VPC you want to\n peer with. Once the authorization for the specified VPC is issued, you have 24 hours to\n establish the connection. These two operations handle all tasks necessary to peer the\n two VPCs, including acceptance, updating routing tables, etc.

\n

To establish the connection, call this operation from the Amazon Web Services account that is used\n to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet\n you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC\n that you want to peer with; and (3) The ID of the VPC you want to peer with. This\n operation is asynchronous. If successful, a VpcPeeringConnection\n request is created. You can use continuous polling to track the request's status using\n DescribeVpcPeeringConnections, or by monitoring fleet events for\n success or failure using DescribeFleetEvents.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#CreateVpcPeeringConnectionInput": { @@ -1873,14 +1873,14 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon Web Services which GameLift\n VPC to peer with.

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

A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift\n VPC to peer with.

", "smithy.api#required": {} } }, "PeerVpcAwsAccountId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for the Amazon Web Services account with the VPC that you want to peer your\n Amazon Web Services fleet with. You can find your Account ID in the Amazon Web Services Management Console under account\n settings.

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

A unique identifier for the Amazon Web Services account with the VPC that you want to peer your\n Amazon GameLift fleet with. You can find your Account ID in the Amazon Web Services Management Console under account\n settings.

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

Deletes a Realtime script. This operation permanently deletes the script record. If\n script files were uploaded, they are also deleted (files stored in an S3 bucket are not\n deleted).

\n

To delete a script, specify the script ID. Before deleting a script, be sure to\n terminate all fleets that are deployed with the script being deleted. Fleet instances\n periodically check for script updates, and if the script record no longer exists, the\n instance will go into an error state and be unable to host game sessions.

\n

\n Learn more\n

\n

\n Amazon Web Services Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Deletes a Realtime script. This operation permanently deletes the script record. If\n script files were uploaded, they are also deleted (files stored in an S3 bucket are not\n deleted).

\n

To delete a script, specify the script ID. Before deleting a script, be sure to\n terminate all fleets that are deployed with the script being deleted. Fleet instances\n periodically check for script updates, and if the script record no longer exists, the\n instance will go into an error state and be unable to host game sessions.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#DeleteScriptInput": { @@ -2472,7 +2472,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a VPC peering connection. To delete the connection, you must have a valid\n authorization for the VPC peering connection that you want to delete. You can check for\n an authorization by calling DescribeVpcPeeringAuthorizations or\n request a new one using CreateVpcPeeringAuthorization.

\n

Once a valid authorization exists, call this operation from the Amazon Web Services account that is\n used to manage the Amazon Web Services fleets. Identify the connection to delete by the connection\n ID and fleet ID. If successful, the connection is removed.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Removes a VPC peering connection. To delete the connection, you must have a valid\n authorization for the VPC peering connection that you want to delete. You can check for\n an authorization by calling DescribeVpcPeeringAuthorizations or\n request a new one using CreateVpcPeeringAuthorization.

\n

Once a valid authorization exists, call this operation from the Amazon Web Services account that is\n used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection\n ID and fleet ID. If successful, the connection is removed.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#DeleteVpcPeeringConnectionInput": { @@ -3799,7 +3799,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a set of one or more game sessions in a specific fleet location. You can\n optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are\n filtered by certain criteria. To retrieve the protection policy for game sessions, use\n DescribeGameSessionDetails.

\n

This operation is not designed to be continually called to track game session status. \n This practice can cause you to exceed your API limit, which results in errors. Instead, \n you must configure configure an \n Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling \n with DescribeGameSessions should only be used for games in development with \n low game session usage.\n

\n \n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a GameSession object is returned for each game session\n that matches the request.

\n

This operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide\n the topic ARN in the matchmaking configuration. Continuously poling ticket status with\n DescribeGameSessions should only be used for games in development\n with low matchmaking usage.

\n

\n Available in Amazon Web Services Local.\n

\n

\n Learn more\n

\n

\n Find a game session\n

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

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

Retrieves a set of one or more game sessions in a specific fleet location. You can\n optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are\n filtered by certain criteria. To retrieve the protection policy for game sessions, use\n DescribeGameSessionDetails.

\n

This operation is not designed to be continually called to track game session status. \n This practice can cause you to exceed your API limit, which results in errors. Instead, \n you must configure configure an \n Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling \n with DescribeGameSessions should only be used for games in development with \n low game session usage.\n

\n \n

This operation can be used in the following ways:

\n \n

Use the pagination parameters to retrieve results as a set of sequential pages.

\n

If successful, a GameSession object is returned for each game session\n that matches the request.

\n

This operation is not designed to be continually called to track matchmaking ticket\n status. This practice can cause you to exceed your API limit, which results in errors.\n Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide\n the topic ARN in the matchmaking configuration. Continuously poling ticket status with\n DescribeGameSessions should only be used for games in development\n with low matchmaking usage.

\n

\n Available in Amazon GameLift Local.\n

\n

\n Learn more\n

\n

\n Find a game session\n

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

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

Retrieves properties for one or more player sessions.

\n

This action can be used in the following ways:

\n \n

To request player sessions, specify either a player session ID, game session ID, or player\n ID. You can filter this request by player session status. Use the pagination parameters\n to retrieve results as a set of sequential pages.

\n

If successful, a PlayerSession object is returned for each session that\n matches the request.

\n

\n Available in Amazon Web Services Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

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

Retrieves properties for one or more player sessions.

\n

This action can be used in the following ways:

\n \n

To request player sessions, specify either a player session ID, game session ID, or player\n ID. You can filter this request by player session status. Use the pagination parameters\n to retrieve results as a set of sequential pages.

\n

If successful, a PlayerSession object is returned for each session that\n matches the request.

\n

\n Available in Amazon GameLift Local.\n

\n

\n Related actions\n

\n

\n CreatePlayerSession |\n CreatePlayerSessions |\n DescribePlayerSessions |\n StartGameSessionPlacement | \n DescribeGameSessionPlacement |\n All APIs by task\n

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

Retrieves properties for a Realtime script.

\n

To request a script record, specify the script ID. If successful, an object containing the script properties \n is returned.

\n

\n Learn more\n

\n

\n Amazon Web Services Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves properties for a Realtime script.

\n

To request a script record, specify the script ID. If successful, an object containing the script properties \n is returned.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeScriptInput": { @@ -4533,7 +4533,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information on VPC peering connections. Use this operation to get peering\n information for all fleets or for one specific fleet ID.

\n

To retrieve connection information, call this operation from the Amazon Web Services account that\n is used to manage the Amazon Web Services fleets. Specify a fleet ID or leave the parameter empty\n to retrieve all connection records. If successful, the retrieved information includes\n both active and pending connections. Active connections identify the IpV4 CIDR block\n that the VPC uses to connect.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves information on VPC peering connections. Use this operation to get peering\n information for all fleets or for one specific fleet ID.

\n

To retrieve connection information, call this operation from the Amazon Web Services account that\n is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty\n to retrieve all connection records. If successful, the retrieved information includes\n both active and pending connections. Active connections identify the IpV4 CIDR block\n that the VPC uses to connect.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#DescribeVpcPeeringConnectionsInput": { @@ -6118,7 +6118,7 @@ "RoleArn": { "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

" } }, "InstanceDefinitions": { @@ -7744,14 +7744,14 @@ "FromPort": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#documentation": "

A starting value for a range of allowed port numbers.

\n

For fleets using Linux builds, only port 22, 443, 1026-60000 are valid.\n For fleets using Windows builds, only port 443, 1026-60000 are valid.

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

A starting value for a range of allowed port numbers.

\n

For fleets using Windows and Linux builds, only ports 1026-60000 are valid.

", "smithy.api#required": {} } }, "ToPort": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#documentation": "

An ending value for a range of allowed port numbers. Port numbers are end-inclusive.\n This value must be higher than FromPort.

\n

For fleets using Linux builds, only port 22, 443, 1026-60000 are valid.\n For fleets using Windows builds, only port 443, 1026-60000 are valid.

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

An ending value for a range of allowed port numbers. Port numbers are end-inclusive.\n This value must be higher than FromPort.

\n

For fleets using Windows and Linux builds, only ports 1026-60000 are valid.

", "smithy.api#required": {} } }, @@ -7877,12 +7877,12 @@ "Version": { "target": "com.amazonaws.gamelift#LaunchTemplateVersion", "traits": { - "smithy.api#documentation": "

The version of the Amazon EC2 launch template to use. If no version is specified, the\n default version will be used. With Amazon Elastic Compute Cloud, you can specify a default version for a\n launch template. If none is set, the default is the first version created.

" + "smithy.api#documentation": "

The version of the Amazon EC2 launch template to use. If no version is specified, the\n default version will be used. With Amazon EC2, you can specify a default version for a\n launch template. If none is set, the default is the first version created.

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

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

An Amazon EC2 launch template that contains configuration settings and game server code to\n be deployed to all instances in a game server group. The launch template is specified\n when creating a new game server group with CreateGameServerGroup.

" + "smithy.api#documentation": "

\n This data type is used with the GameLift FleetIQ and game server groups.\n

\n

An Amazon Elastic Compute Cloud launch template that contains configuration settings and game server code to\n be deployed to all instances in a game server group. The launch template is specified\n when creating a new game server group with CreateGameServerGroup.

" } }, "com.amazonaws.gamelift#LaunchTemplateVersion": { @@ -8301,7 +8301,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

\n

\n Learn more\n

\n

\n Amazon Web Services Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

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

Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9300,7 +9300,7 @@ "Port": { "target": "com.amazonaws.gamelift#PortNumber", "traits": { - "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon Web Services server process, an app\n needs both the IP address and port number.

" + "smithy.api#documentation": "

Port number for the game session. To connect to a Amazon GameLift server process, an app\n needs both the IP address and port number.

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

Creates or updates a scaling policy for a fleet. Scaling policies are used to\n automatically scale a fleet's hosting capacity to meet player demand. An active scaling\n policy instructs Amazon Web Services to track a fleet metric and automatically change the fleet's\n capacity when a certain threshold is reached. There are two types of scaling policies:\n target-based and rule-based. Use a target-based policy to quickly and efficiently manage\n fleet scaling; this option is the most commonly used. Use rule-based policies when you\n need to exert fine-grained control over auto-scaling.

\n

Fleets can have multiple scaling policies of each type in force at the same time;\n you can have one target-based policy, one or multiple rule-based scaling policies, or\n both. We recommend caution, however, because multiple auto-scaling policies can have\n unintended consequences.

\n

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling\n policies, call StartFleetActions with the same fleet action. To stop\n just one scaling policy--or to permanently remove it, you must delete the policy with\n DeleteScalingPolicy.

\n

Learn more about how to work with auto-scaling in Set Up Fleet Automatic\n Scaling.

\n

\n Target-based policy\n

\n

A target-based policy tracks a single metric: PercentAvailableGameSessions. This\n metric tells us how much of a fleet's hosting capacity is ready to host game sessions\n but is not currently in use. This is the fleet's buffer; it measures the additional\n player demand that the fleet could handle at current capacity. With a target-based\n policy, you set your ideal buffer size and leave it to Amazon Web Services to take whatever action\n is needed to maintain that target.

\n

For example, you might choose to maintain a 10% buffer for a fleet that has the\n capacity to host 100 simultaneous game sessions. This policy tells Amazon Web Services to take\n action whenever the fleet's available capacity falls below or rises above 10 game\n sessions. Amazon Web Services will start new instances or stop unused instances in order to return\n to the 10% buffer.

\n

To create or update a target-based policy, specify a fleet ID and name, and set the\n policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions)\n and reference a TargetConfiguration object with your desired buffer\n value. Exclude all other parameters. On a successful request, the policy name is\n returned. The scaling policy is automatically in force as soon as it's successfully\n created. If the fleet's auto-scaling actions are temporarily suspended, the new policy\n will be in force once the fleet actions are restarted.

\n

\n Rule-based policy\n

\n

A rule-based policy tracks specified fleet metric, sets a threshold value, and\n specifies the type of action to initiate when triggered. With a rule-based policy, you\n can select from several available fleet metrics. Each policy specifies whether to scale\n up or scale down (and by how much), so you need one policy for each type of action.

\n

For example, a policy may make the following statement: \"If the percentage of idle\n instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity\n by 10%.\"

\n

A policy's rule statement has the following structure:

\n

If [MetricName] is [ComparisonOperator]\n [Threshold] for [EvaluationPeriods] minutes, then\n [ScalingAdjustmentType] to/by\n [ScalingAdjustment].

\n

To implement the example, the rule statement would look like this:

\n

If [PercentIdleInstances] is [GreaterThanThreshold]\n [20] for [15] minutes, then\n [PercentChangeInCapacity] to/by [10].

\n

To create or update a scaling policy, specify a unique combination of name and\n fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a\n policy rule statement. On a successful request, the policy name is returned. Scaling\n policies are automatically in force as soon as they're successfully created. If the\n fleet's auto-scaling actions are temporarily suspended, the new policy will be in force\n once the fleet actions are restarted.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

" + "smithy.api#documentation": "

Creates or updates a scaling policy for a fleet. Scaling policies are used to\n automatically scale a fleet's hosting capacity to meet player demand. An active scaling\n policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's\n capacity when a certain threshold is reached. There are two types of scaling policies:\n target-based and rule-based. Use a target-based policy to quickly and efficiently manage\n fleet scaling; this option is the most commonly used. Use rule-based policies when you\n need to exert fine-grained control over auto-scaling.

\n

Fleets can have multiple scaling policies of each type in force at the same time;\n you can have one target-based policy, one or multiple rule-based scaling policies, or\n both. We recommend caution, however, because multiple auto-scaling policies can have\n unintended consequences.

\n

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling\n policies, call StartFleetActions with the same fleet action. To stop\n just one scaling policy--or to permanently remove it, you must delete the policy with\n DeleteScalingPolicy.

\n

Learn more about how to work with auto-scaling in Set Up Fleet Automatic\n Scaling.

\n

\n Target-based policy\n

\n

A target-based policy tracks a single metric: PercentAvailableGameSessions. This\n metric tells us how much of a fleet's hosting capacity is ready to host game sessions\n but is not currently in use. This is the fleet's buffer; it measures the additional\n player demand that the fleet could handle at current capacity. With a target-based\n policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action\n is needed to maintain that target.

\n

For example, you might choose to maintain a 10% buffer for a fleet that has the\n capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take\n action whenever the fleet's available capacity falls below or rises above 10 game\n sessions. Amazon GameLift will start new instances or stop unused instances in order to return\n to the 10% buffer.

\n

To create or update a target-based policy, specify a fleet ID and name, and set the\n policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions)\n and reference a TargetConfiguration object with your desired buffer\n value. Exclude all other parameters. On a successful request, the policy name is\n returned. The scaling policy is automatically in force as soon as it's successfully\n created. If the fleet's auto-scaling actions are temporarily suspended, the new policy\n will be in force once the fleet actions are restarted.

\n

\n Rule-based policy\n

\n

A rule-based policy tracks specified fleet metric, sets a threshold value, and\n specifies the type of action to initiate when triggered. With a rule-based policy, you\n can select from several available fleet metrics. Each policy specifies whether to scale\n up or scale down (and by how much), so you need one policy for each type of action.

\n

For example, a policy may make the following statement: \"If the percentage of idle\n instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity\n by 10%.\"

\n

A policy's rule statement has the following structure:

\n

If [MetricName] is [ComparisonOperator]\n [Threshold] for [EvaluationPeriods] minutes, then\n [ScalingAdjustmentType] to/by\n [ScalingAdjustment].

\n

To implement the example, the rule statement would look like this:

\n

If [PercentIdleInstances] is [GreaterThanThreshold]\n [20] for [15] minutes, then\n [PercentChangeInCapacity] to/by [10].

\n

To create or update a scaling policy, specify a unique combination of name and\n fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a\n policy rule statement. On a successful request, the policy name is returned. Scaling\n policies are automatically in force as soon as they're successfully created. If the\n fleet's auto-scaling actions are temporarily suspended, the new policy will be in force\n once the fleet actions are restarted.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#PutScalingPolicyInput": { @@ -9553,7 +9553,7 @@ "MetricName": { "target": "com.amazonaws.gamelift#MetricName", "traits": { - "smithy.api#documentation": "

Name of the Amazon Web Services-defined metric that is used to trigger a scaling adjustment. For\n detailed descriptions of fleet metrics, see Monitor Amazon Web Services\n with Amazon CloudWatch.

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

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For\n detailed descriptions of fleet metrics, see Monitor Amazon GameLift\n with Amazon CloudWatch.

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

Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon Web Services's Amazon S3. This is done as part of the build creation process; see\n CreateBuild.

\n

To request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.

\n

\n Learn more\n

\n

\n \n Create a Build with Files in S3\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" + "smithy.api#documentation": "

Retrieves a fresh set of credentials for use when uploading a new set of game build\n files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see\n CreateBuild.

\n

To request new credentials, specify the build ID as returned with an initial\n CreateBuild request. If successful, a new set of credentials are\n returned, along with the S3 storage location associated with the build ID.

\n

\n Learn more\n

\n

\n \n Create a Build with Files in S3\n

\n

\n Related actions\n

\n

\n CreateBuild | \n ListBuilds | \n DescribeBuild | \n UpdateBuild | \n DeleteBuild | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#RequestUploadCredentialsInput": { @@ -9997,18 +9997,18 @@ "RoleArn": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon Web Services to access the S3 bucket.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access the S3 bucket.

" } }, "ObjectVersion": { "target": "com.amazonaws.gamelift#NonEmptyString", "traits": { - "smithy.api#documentation": "

The version of the file, if object versioning is turned on for the bucket. Amazon Web Services uses\n this information when retrieving files from an S3 bucket that you own. Use this\n parameter to specify a specific version of the file. If not set, the latest version of\n the file is retrieved.

" + "smithy.api#documentation": "

The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses\n this information when retrieving files from an S3 bucket that you own. Use this\n parameter to specify a specific version of the file. If not set, the latest version of\n the file is retrieved.

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

The location in Amazon S3 where build or script files are stored for access by Amazon Web Services. This\n location is specified in CreateBuild, CreateScript,\n and UpdateScript requests.

" + "smithy.api#documentation": "

The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This\n location is specified in CreateBuild, CreateScript,\n and UpdateScript requests.

" } }, "com.amazonaws.gamelift#ScalingAdjustmentType": { @@ -10090,7 +10090,7 @@ "MetricName": { "target": "com.amazonaws.gamelift#MetricName", "traits": { - "smithy.api#documentation": "

Name of the Amazon Web Services-defined metric that is used to trigger a scaling adjustment. For\n detailed descriptions of fleet metrics, see Monitor Amazon Web Services\n with Amazon CloudWatch.

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

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For\n detailed descriptions of fleet metrics, see Monitor Amazon GameLift\n with Amazon CloudWatch.

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

Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon Web Services\n searches for available resources on the queue's destinations, scanning each until it\n finds resources or the placement request times out.

\n

A game session placement request can also request player sessions. When a new game\n session is successfully created, Amazon Web Services creates a player session for each player\n included in the request.

\n

When placing a game session, by default Amazon Web Services tries each fleet in the order they\n are listed in the queue configuration. Ideally, a queue's destinations are listed in\n preference order.

\n

Alternatively, when requesting a game session with players, you can also provide\n latency data for each player in relevant Regions. Latency data indicates the performance\n lag a player experiences when connected to a fleet in the Region. Amazon Web Services uses latency\n data to reorder the list of destinations to place the game session in a Region with\n minimal lag. If latency data is provided for multiple players, Amazon Web Services calculates each\n Region's average lag for all players and reorders to get the best game play across all\n players.

\n

To place a new game session request, specify the following:

\n \n

If successful, a new game session placement is created.

\n

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the\n status is FULFILLED, a new game session has been created and a game session\n ARN and Region are referenced. If the placement request times out, you can resubmit the\n request or retry it with a different queue.

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" + "smithy.api#documentation": "

Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift\n searches for available resources on the queue's destinations, scanning each until it\n finds resources or the placement request times out.

\n

A game session placement request can also request player sessions. When a new game\n session is successfully created, Amazon GameLift creates a player session for each player\n included in the request.

\n

When placing a game session, by default Amazon GameLift tries each fleet in the order they\n are listed in the queue configuration. Ideally, a queue's destinations are listed in\n preference order.

\n

Alternatively, when requesting a game session with players, you can also provide\n latency data for each player in relevant Regions. Latency data indicates the performance\n lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency\n data to reorder the list of destinations to place the game session in a Region with\n minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each\n Region's average lag for all players and reorders to get the best game play across all\n players.

\n

To place a new game session request, specify the following:

\n \n

If successful, a new game session placement is created.

\n

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the\n status is FULFILLED, a new game session has been created and a game session\n ARN and Region are referenced. If the placement request times out, you can resubmit the\n request or retry it with a different queue.

\n

\n Related actions\n

\n

\n CreateGameSession | \n DescribeGameSessions | \n DescribeGameSessionDetails | \n SearchGameSessions | \n UpdateGameSession | \n GetGameSessionLogUrl | \n StartGameSessionPlacement | \n DescribeGameSessionPlacement | \n StopGameSessionPlacement | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#StartGameSessionPlacementInput": { @@ -10614,7 +10614,7 @@ "TicketId": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon Web Services will generate one in the form of\n a UUID. Use this identifier to track the match backfill ticket status and retrieve match\n results.

" + "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the match backfill ticket status and retrieve match\n results.

" } }, "ConfigurationName": { @@ -10688,7 +10688,7 @@ "TicketId": { "target": "com.amazonaws.gamelift#MatchmakingIdStringModel", "traits": { - "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon Web Services will generate one in the form of\n a UUID. Use this identifier to track the matchmaking ticket status and retrieve match\n results.

" + "smithy.api#documentation": "

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of\n a UUID. Use this identifier to track the matchmaking ticket status and retrieve match\n results.

" } }, "ConfigurationName": { @@ -11112,7 +11112,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings for a target-based scaling policy (see ScalingPolicy. A\n target-based policy tracks a particular fleet metric specifies a target value for the\n metric. As player usage changes, the policy triggers Amazon Web Services to adjust capacity so\n that the metric returns to the target value. The target configuration specifies settings\n as needed for the target based policy, including the target value.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

" + "smithy.api#documentation": "

Settings for a target-based scaling policy (see ScalingPolicy. A\n target-based policy tracks a particular fleet metric specifies a target value for the\n metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so\n that the metric returns to the target value. The target configuration specifies settings\n as needed for the target based policy, including the target value.

\n

\n Related actions\n

\n

\n DescribeFleetCapacity | \n UpdateFleetCapacity | \n DescribeEC2InstanceLimits | \n PutScalingPolicy | \n DescribeScalingPolicies | \n DeleteScalingPolicy | \n StopFleetActions | \n StartFleetActions | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#TargetTrackingConfiguration": { @@ -11696,7 +11696,7 @@ "RoleArn": { "target": "com.amazonaws.gamelift#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon Web Services to access your Amazon EC2 Auto Scaling groups.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role that\n allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

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

Updates Realtime script metadata and content.

\n

To update script metadata, specify the script ID and provide updated name and/or\n version values.

\n

To update script content, provide an updated zip file by pointing to either a local\n file or an Amazon S3 bucket location. You can use either method regardless of how the\n original script was uploaded. Use the Version parameter to track\n updates to the script.

\n

If the call is successful, the updated metadata is stored in the script record and a\n revised script is uploaded to the Amazon Web Services service. Once the script is updated and\n acquired by a fleet instance, the new version is used for all new game sessions.

\n

\n Learn more\n

\n

\n Amazon Web Services Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" + "smithy.api#documentation": "

Updates Realtime script metadata and content.

\n

To update script metadata, specify the script ID and provide updated name and/or\n version values.

\n

To update script content, provide an updated zip file by pointing to either a local\n file or an Amazon S3 bucket location. You can use either method regardless of how the\n original script was uploaded. Use the Version parameter to track\n updates to the script.

\n

If the call is successful, the updated metadata is stored in the script record and a\n revised script is uploaded to the Amazon GameLift service. Once the script is updated and\n acquired by a fleet instance, the new version is used for all new game sessions.

\n

\n Learn more\n

\n

\n Amazon GameLift Realtime Servers\n

\n

\n Related actions\n

\n

\n CreateScript | \n ListScripts | \n DescribeScript | \n UpdateScript | \n DeleteScript | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#UpdateScriptInput": { @@ -12209,7 +12209,7 @@ "StorageLocation": { "target": "com.amazonaws.gamelift#S3Location", "traits": { - "smithy.api#documentation": "

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon Web Services to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon Web Services uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.

" + "smithy.api#documentation": "

The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is\n stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the\n \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3\n bucket must be in the same Region where you want to create a new script. By default,\n Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning\n turned on, you can use the ObjectVersion parameter to specify an earlier\n version.

" } }, "ZipFile": { @@ -12226,7 +12226,7 @@ "Script": { "target": "com.amazonaws.gamelift#Script", "traits": { - "smithy.api#documentation": "

The newly created script record with a unique script ID. The new script's storage\n location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket\n under your account, the storage location reflects the information that was provided in\n the CreateScript request; (2) If the script file was uploaded from\n a local zip file, the storage location reflects an S3 location controls by the Amazon Web Services\n service.

" + "smithy.api#documentation": "

The newly created script record with a unique script ID. The new script's storage\n location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket\n under your account, the storage location reflects the information that was provided in\n the CreateScript request; (2) If the script file was uploaded from\n a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift\n service.

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

Represents an authorization for a VPC peering connection between the VPC for an\n Amazon Web Services fleet and another VPC on an account you have access to. This authorization\n must exist and be valid for the peering connection to be established. Authorizations are\n valid for 24 hours after they are issued.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Represents an authorization for a VPC peering connection between the VPC for an\n Amazon GameLift fleet and another VPC on an account you have access to. This authorization\n must exist and be valid for the peering connection to be established. Authorizations are\n valid for 24 hours after they are issued.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#VpcPeeringAuthorizationList": { @@ -12333,7 +12333,7 @@ "FleetId": { "target": "com.amazonaws.gamelift#FleetId", "traits": { - "smithy.api#documentation": "

A unique identifier for the fleet. This ID determines the ID of the Amazon Web Services VPC for your fleet.

" + "smithy.api#documentation": "

A unique identifier for the fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

" } }, "FleetArn": { @@ -12369,12 +12369,12 @@ "GameLiftVpcId": { "target": "com.amazonaws.gamelift#NonZeroAndMaxString", "traits": { - "smithy.api#documentation": "

A unique identifier for the VPC that contains the Amazon Web Services fleet for this\n connection. This VPC is managed by Amazon Web Services and does not appear in your Amazon Web Services account.\n

" + "smithy.api#documentation": "

A unique identifier for the VPC that contains the Amazon GameLift fleet for this\n connection. This VPC is managed by Amazon GameLift and does not appear in your Amazon Web Services account.\n

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

Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the\n VPC for your Amazon Web Services fleets. This record may be for an active peering connection or a\n pending connection that has not yet been established.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" + "smithy.api#documentation": "

Represents a peering connection between a VPC on one of your Amazon Web Services accounts and the\n VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a\n pending connection that has not yet been established.

\n

\n Related actions\n

\n

\n CreateVpcPeeringAuthorization | \n DescribeVpcPeeringAuthorizations | \n DeleteVpcPeeringAuthorization | \n CreateVpcPeeringConnection | \n DescribeVpcPeeringConnections | \n DeleteVpcPeeringConnection | \n All APIs by task\n

" } }, "com.amazonaws.gamelift#VpcPeeringConnectionList": { diff --git a/aws/sdk/aws-models/glue.json b/aws/sdk/aws-models/glue.json index ddd4c8d73f..e05cd87b64 100644 --- a/aws/sdk/aws-models/glue.json +++ b/aws/sdk/aws-models/glue.json @@ -69,6 +69,9 @@ { "target": "com.amazonaws.glue#BatchGetCrawlers" }, + { + "target": "com.amazonaws.glue#BatchGetCustomEntityTypes" + }, { "target": "com.amazonaws.glue#BatchGetDevEndpoints" }, @@ -111,6 +114,9 @@ { "target": "com.amazonaws.glue#CreateCrawler" }, + { + "target": "com.amazonaws.glue#CreateCustomEntityType" + }, { "target": "com.amazonaws.glue#CreateDatabase" }, @@ -174,6 +180,9 @@ { "target": "com.amazonaws.glue#DeleteCrawler" }, + { + "target": "com.amazonaws.glue#DeleteCustomEntityType" + }, { "target": "com.amazonaws.glue#DeleteDatabase" }, @@ -264,6 +273,9 @@ { "target": "com.amazonaws.glue#GetCrawlers" }, + { + "target": "com.amazonaws.glue#GetCustomEntityType" + }, { "target": "com.amazonaws.glue#GetDatabase" }, @@ -414,6 +426,9 @@ { "target": "com.amazonaws.glue#ListCrawlers" }, + { + "target": "com.amazonaws.glue#ListCustomEntityTypes" + }, { "target": "com.amazonaws.glue#ListDevEndpoints" }, @@ -1291,6 +1306,58 @@ } } }, + "com.amazonaws.glue#BatchGetCustomEntityTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#BatchGetCustomEntityTypesRequest" + }, + "output": { + "target": "com.amazonaws.glue#BatchGetCustomEntityTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details for the custom patterns specified by a list of names.

" + } + }, + "com.amazonaws.glue#BatchGetCustomEntityTypesRequest": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.glue#CustomEntityTypeNames", + "traits": { + "smithy.api#documentation": "

A list of names of the custom patterns that you want to retrieve.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#BatchGetCustomEntityTypesResponse": { + "type": "structure", + "members": { + "CustomEntityTypes": { + "target": "com.amazonaws.glue#CustomEntityTypes", + "traits": { + "smithy.api#documentation": "

A list of CustomEntityType objects representing the custom patterns that have been created.

" + } + }, + "CustomEntityTypesNotFound": { + "target": "com.amazonaws.glue#CustomEntityTypeNames", + "traits": { + "smithy.api#documentation": "

A list of the names of custom patterns that were not found.

" + } + } + } + }, "com.amazonaws.glue#BatchGetDevEndpoints": { "type": "operation", "input": { @@ -3575,6 +3642,18 @@ "smithy.api#documentation": "

Specifies the connections used by a job.

" } }, + "com.amazonaws.glue#ContextWords": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NameString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, "com.amazonaws.glue#Crawl": { "type": "structure", "members": { @@ -3770,7 +3849,10 @@ } }, "LakeFormationConfiguration": { - "target": "com.amazonaws.glue#LakeFormationConfiguration" + "target": "com.amazonaws.glue#LakeFormationConfiguration", + "traits": { + "smithy.api#documentation": "

Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

" + } } }, "traits": { @@ -4366,6 +4448,77 @@ "smithy.api#documentation": "

Specifies a custom CSV classifier for CreateClassifier to create.

" } }, + "com.amazonaws.glue#CreateCustomEntityType": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateCustomEntityTypeRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateCustomEntityTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, + { + "target": "com.amazonaws.glue#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.

\n\t\n\t

Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.

" + } + }, + "com.amazonaws.glue#CreateCustomEntityTypeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.

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

A regular expression string that is used for detecting sensitive data in a custom pattern.

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

A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

\n\t\n\t

If no context words are passed only a regular expression is checked.

" + } + } + } + }, + "com.amazonaws.glue#CreateCustomEntityTypeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the custom pattern you created.

" + } + } + } + }, "com.amazonaws.glue#CreateDatabase": { "type": "operation", "input": { @@ -6206,6 +6359,52 @@ "smithy.api#pattern": "^[^\\r\\n]$" } }, + "com.amazonaws.glue#CustomEntityType": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A name for the custom pattern that allows it to be retrieved or deleted later. This name must be unique per Amazon Web Services account.

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

A regular expression string that is used for detecting sensitive data in a custom pattern.

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

A list of context words. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

\n\t\n\t

If no context words are passed only a regular expression is checked.

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

An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.

" + } + }, + "com.amazonaws.glue#CustomEntityTypeNames": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#NameString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.glue#CustomEntityTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#CustomEntityType" + } + }, "com.amazonaws.glue#CustomPatterns": { "type": "string", "traits": { @@ -6845,6 +7044,58 @@ "type": "structure", "members": {} }, + "com.amazonaws.glue#DeleteCustomEntityType": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteCustomEntityTypeRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteCustomEntityTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a custom pattern by specifying its name.

" + } + }, + "com.amazonaws.glue#DeleteCustomEntityTypeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the custom pattern that you want to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#DeleteCustomEntityTypeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the custom pattern you deleted.

" + } + } + } + }, "com.amazonaws.glue#DeleteDatabase": { "type": "operation", "input": { @@ -9341,6 +9592,70 @@ } } }, + "com.amazonaws.glue#GetCustomEntityType": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetCustomEntityTypeRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetCustomEntityTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AccessDeniedException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details of a custom pattern by specifying its name.

" + } + }, + "com.amazonaws.glue#GetCustomEntityTypeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the custom pattern that you want to retrieve.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#GetCustomEntityTypeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the custom pattern that you retrieved.

" + } + }, + "RegexString": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

A regular expression string that is used for detecting sensitive data in a custom pattern.

" + } + }, + "ContextWords": { + "target": "com.amazonaws.glue#ContextWords", + "traits": { + "smithy.api#documentation": "

A list of context words if specified when you created the custom pattern. If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data.

" + } + } + } + }, "com.amazonaws.glue#GetDataCatalogEncryptionSettings": { "type": "operation", "input": { @@ -13646,6 +13961,12 @@ "traits": { "smithy.api#documentation": "

Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.

\n \n

For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

\n\t \n\t

Jobs that are created without specifying a Glue version default to Glue 0.9.

" } + }, + "DPUSeconds": { + "target": "com.amazonaws.glue#NullableDouble", + "traits": { + "smithy.api#documentation": "

This field populates only when an Auto Scaling job run completes, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X and 2 for G.2X workers). This value may be different than the executionEngineRuntime * MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity. Therefore, it is possible that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity.

" + } } }, "traits": { @@ -13933,11 +14254,20 @@ "type": "structure", "members": { "UseLakeFormationCredentials": { - "target": "com.amazonaws.glue#NullableBoolean" + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.

" + } }, "AccountId": { - "target": "com.amazonaws.glue#AccountId" + "target": "com.amazonaws.glue#AccountId", + "traits": { + "smithy.api#documentation": "

Required for cross account crawls. For same account crawls as the target data, this can be left as null.

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

Specifies AWS Lake Formation configuration settings for the crawler.

" } }, "com.amazonaws.glue#Language": { @@ -14203,6 +14533,68 @@ } } }, + "com.amazonaws.glue#ListCustomEntityTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListCustomEntityTypesRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListCustomEntityTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the custom patterns that have been created.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#ListCustomEntityTypesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.glue#PaginationToken", + "traits": { + "smithy.api#documentation": "

A paginated token to offset the results.

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

The maximum number of results to return.

" + } + } + } + }, + "com.amazonaws.glue#ListCustomEntityTypesResponse": { + "type": "structure", + "members": { + "CustomEntityTypes": { + "target": "com.amazonaws.glue#CustomEntityTypes", + "traits": { + "smithy.api#documentation": "

A list of CustomEntityType objects representing custom patterns.

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

A pagination token, if more results are available.

" + } + } + } + }, "com.amazonaws.glue#ListDevEndpoints": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/guardduty.json b/aws/sdk/aws-models/guardduty.json index 58456f7ffd..d589425b85 100644 --- a/aws/sdk/aws-models/guardduty.json +++ b/aws/sdk/aws-models/guardduty.json @@ -406,6 +406,7 @@ "UserAgent": { "target": "com.amazonaws.guardduty#String", "traits": { + "smithy.api#documentation": "

The agent through which the API request was made.

", "smithy.api#jsonName": "userAgent" } }, @@ -929,7 +930,7 @@ "FindingCriteria": { "target": "com.amazonaws.guardduty#FindingCriteria", "traits": { - "smithy.api#documentation": "

Represents the criteria to be used in the filter for querying findings.

\n

You can only use the following attributes to query findings:

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

Represents the criteria to be used in the filter for querying findings.

\n

You can only use the following attributes to query findings:

\n ", "smithy.api#jsonName": "findingCriteria", "smithy.api#required": {} } @@ -2306,7 +2307,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates GuardDuty member accounts (to the current GuardDuty administrator account)\n specified by the account IDs.

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

Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) \n specified by the account IDs. Member accounts added through Invitation get deleted from the \n current GuardDuty administrator account after 30 days of disassociation.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/disassociate", @@ -4546,6 +4547,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DetectorIds", "pageSize": "MaxResults" } } @@ -4617,6 +4619,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "FilterNames", "pageSize": "MaxResults" } } @@ -4697,6 +4700,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "FindingIds", "pageSize": "MaxResults" } } @@ -4789,6 +4793,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "IpSetIds", "pageSize": "MaxResults" } } @@ -4869,6 +4874,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Invitations", "pageSize": "MaxResults" } } @@ -4939,6 +4945,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Members", "pageSize": "MaxResults" } } @@ -5026,6 +5033,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "AdminAccounts", "pageSize": "MaxResults" } } @@ -5227,6 +5235,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ThreatIntelSetIds", "pageSize": "MaxResults" } } diff --git a/aws/sdk/aws-models/iotsitewise.json b/aws/sdk/aws-models/iotsitewise.json index bedd1480c0..2e92f0002a 100644 --- a/aws/sdk/aws-models/iotsitewise.json +++ b/aws/sdk/aws-models/iotsitewise.json @@ -70,6 +70,15 @@ { "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssets" }, + { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregates" + }, + { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValue" + }, + { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistory" + }, { "target": "com.amazonaws.iotsitewise#BatchPutAssetPropertyValue" }, @@ -1229,6 +1238,9 @@ "input": { "target": "com.amazonaws.iotsitewise#AssociateAssetsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -1300,6 +1312,9 @@ "input": { "target": "com.amazonaws.iotsitewise#AssociateTimeSeriesToAssetPropertyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -1348,279 +1363,1181 @@ "smithy.api#required": {} } }, - "propertyId": { - "target": "com.amazonaws.iotsitewise#ID", + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

", + "smithy.api#httpQuery": "propertyId", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotsitewise#AssociatedAssetsSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#AssociatedAssetsSummary" + } + }, + "com.amazonaws.iotsitewise#AssociatedAssetsSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.iotsitewise#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the asset, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}\n

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

The name of the asset.

", + "smithy.api#required": {} + } + }, + "assetModelId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset model used to create the asset.

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

The date the asset was created, in Unix epoch time.

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

The date the asset was last updated, in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.iotsitewise#AssetStatus", + "traits": { + "smithy.api#documentation": "

The current status of the asset.

", + "smithy.api#required": {} + } + }, + "hierarchies": { + "target": "com.amazonaws.iotsitewise#AssetHierarchies", + "traits": { + "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

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

Contains a summary of an associated asset.

" + } + }, + "com.amazonaws.iotsitewise#Attribute": { + "type": "structure", + "members": { + "defaultValue": { + "target": "com.amazonaws.iotsitewise#DefaultValue", + "traits": { + "smithy.api#documentation": "

The default value of the asset model property attribute. All assets that you create from\n the asset model contain this attribute value. You can update an attribute's value after you\n create an asset. For more information, see Updating attribute values in the\n IoT SiteWise User Guide.

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

Contains an asset attribute property. For more information, see\n Attributes in the IoT SiteWise User Guide.

" + } + }, + "com.amazonaws.iotsitewise#AuthMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IAM", + "name": "IAM" + }, + { + "value": "SSO", + "name": "SSO" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchAssociateProjectAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#LimitExceededException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

", + "smithy.api#endpoint": { + "hostPrefix": "monitor." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{projectId}/assets/associate", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#AssetErrorDetails" + } + }, + "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest": { + "type": "structure", + "members": { + "projectId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the project to which to associate the assets.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIds": { + "target": "com.amazonaws.iotsitewise#IDs", + "traits": { + "smithy.api#documentation": "

The IDs of the assets to be associated to the project.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsErrors", + "traits": { + "smithy.api#documentation": "

A list of associated error information, if any.

" + } + } + } + }, + "com.amazonaws.iotsitewise#BatchDisassociateProjectAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

", + "smithy.api#endpoint": { + "hostPrefix": "monitor." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/projects/{projectId}/assets/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#AssetErrorDetails" + } + }, + "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsRequest": { + "type": "structure", + "members": { + "projectId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the project from which to disassociate the assets.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIds": { + "target": "com.amazonaws.iotsitewise#IDs", + "traits": { + "smithy.api#documentation": "

The IDs of the assets to be disassociated from the project.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.iotsitewise#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsErrors", + "traits": { + "smithy.api#documentation": "

A list of associated error information, if any.

" + } + } + } + }, + "com.amazonaws.iotsitewise#BatchEntryCompletionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregates": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. \n For more information, see Querying\n aggregates in the IoT SiteWise User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/properties/batch/aggregates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset in which the asset property was created.

" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

" + } + }, + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", + "traits": { + "smithy.api#documentation": "

The alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n IoT SiteWise User Guide.

" + } + }, + "aggregateTypes": { + "target": "com.amazonaws.iotsitewise#AggregateTypes", + "traits": { + "smithy.api#documentation": "

The data aggregating function.

", + "smithy.api#required": {} + } + }, + "resolution": { + "target": "com.amazonaws.iotsitewise#Resolution", + "traits": { + "smithy.api#documentation": "

The time interval over which to aggregate data.

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

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

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

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

", + "smithy.api#required": {} + } + }, + "qualities": { + "target": "com.amazonaws.iotsitewise#Qualities", + "traits": { + "smithy.api#documentation": "

The quality by which to filter asset data.

" + } + }, + "timeOrdering": { + "target": "com.amazonaws.iotsitewise#TimeOrdering", + "traits": { + "smithy.api#documentation": "

The chronological sorting order of the requested information.

\n

Default: ASCENDING\n

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

Contains information for an asset property aggregate entry that is associated with the \n BatchGetAssetPropertyAggregates API.

\n

To identify an asset property, you must specify one of the following:

\n " + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ResourceNotFoundException", + "name": "ResourceNotFoundException" + }, + { + "value": "InvalidRequestException", + "name": "InvalidRequestException" + }, + { + "value": "AccessDeniedException", + "name": "AccessDeniedException" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorEntry": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The associated error message.

", + "smithy.api#required": {} + } + }, + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

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

Contains error information for an asset property aggregate entry that is associated with the \n BatchGetAssetPropertyAggregates API.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorInfo": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

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

The date the error occurred, in Unix epoch time.

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

Contains the error code and the timestamp for an asset property aggregate entry that is associated with the \n BatchGetAssetPropertyAggregates API.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesRequest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesEntries", + "traits": { + "smithy.api#documentation": "

The list of asset property aggregate entries for the batch get request. \n You can specify up to 16 entries per request.

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

The token to be used for the next set of paginated results.

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

The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

\n " + } + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesResponse": { + "type": "structure", + "members": { + "errorEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorEntries", + "traits": { + "smithy.api#documentation": "

A list of the errors (if any) associated with the batch request. Each error entry\n contains the entryId of the entry that failed.

", + "smithy.api#required": {} + } + }, + "successEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSuccessEntries", + "traits": { + "smithy.api#documentation": "

A list of entries that were processed successfully by this batch request. Each success entry\n contains the entryId of the entry that succeeded and the latest query result.

", + "smithy.api#required": {} + } + }, + "skippedEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSkippedEntries", + "traits": { + "smithy.api#documentation": "

A list of entries that were not processed by this batch request. \n because these entries had been completely processed by previous paginated requests. \n Each skipped entry contains the entryId of the entry that skipped.

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

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSkippedEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSkippedEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSkippedEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "completionStatus": { + "target": "com.amazonaws.iotsitewise#BatchEntryCompletionStatus", + "traits": { + "smithy.api#documentation": "

The completion status of each entry that is associated with the \n BatchGetAssetPropertyAggregates API.

", + "smithy.api#required": {} + } + }, + "errorInfo": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesErrorInfo", + "traits": { + "smithy.api#documentation": "

The error information, such as the error code and the timestamp.

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

Contains information for an entry that has been processed by the previous \n BatchGetAssetPropertyAggregates request.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSuccessEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSuccessEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyAggregatesSuccessEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "aggregatedValues": { + "target": "com.amazonaws.iotsitewise#AggregatedValues", + "traits": { + "smithy.api#documentation": "

The requested aggregated asset property values (for example, average, minimum, and maximum).

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

Contains success information for an entry that is associated with the \n BatchGetAssetPropertyAggregates API.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValue": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the current value for one or more asset properties. For more information, see Querying\n current values in the IoT SiteWise User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/properties/batch/latest", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken" + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset in which the asset property was created.

" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

" + } + }, + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", + "traits": { + "smithy.api#documentation": "

The alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n IoT SiteWise User Guide.

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

Contains information for an asset property value entry that is associated with the \n BatchGetAssetPropertyValue API.

\n

To identify an asset property, you must specify one of the following:

\n " + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ResourceNotFoundException", + "name": "ResourceNotFoundException" + }, + { + "value": "InvalidRequestException", + "name": "InvalidRequestException" + }, + { + "value": "AccessDeniedException", + "name": "AccessDeniedException" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorEntry": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The associated error message.

", + "smithy.api#required": {} + } + }, + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

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

Contains error information for an asset property value entry that is associated with the \n BatchGetAssetPropertyValue API.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorInfo": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

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

The date the error occurred, in Unix epoch time.

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

The error information, such as the error code and the timestamp.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryRequest" + }, + "output": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsitewise#InternalFailureException" + }, + { + "target": "com.amazonaws.iotsitewise#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotsitewise#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iotsitewise#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the historical values for one or more asset properties. For more information, see Querying\n historical values in the IoT SiteWise User Guide.

", + "smithy.api#endpoint": { + "hostPrefix": "data." + }, + "smithy.api#http": { + "method": "POST", + "uri": "/properties/batch/history", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset in which the asset property was created.

" + } + }, + "propertyId": { + "target": "com.amazonaws.iotsitewise#ID", + "traits": { + "smithy.api#documentation": "

The ID of the asset property.

" + } + }, + "propertyAlias": { + "target": "com.amazonaws.iotsitewise#AssetPropertyAlias", + "traits": { + "smithy.api#documentation": "

The alias that identifies the property, such as an OPC-UA server data stream path\n (for example, /company/windfarm/3/turbine/7/temperature). For more information, see\n Mapping industrial data streams to asset properties in the\n IoT SiteWise User Guide.

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

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

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

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

" + } + }, + "qualities": { + "target": "com.amazonaws.iotsitewise#Qualities", + "traits": { + "smithy.api#documentation": "

The quality by which to filter asset data.

" + } + }, + "timeOrdering": { + "target": "com.amazonaws.iotsitewise#TimeOrdering", + "traits": { + "smithy.api#documentation": "

The chronological sorting order of the requested information.

\n

Default: ASCENDING\n

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

Contains information for an asset property historical value entry that is associated with the \n BatchGetAssetPropertyValueHistory API.

\n

To identify an asset property, you must specify one of the following:

\n " + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ResourceNotFoundException", + "name": "ResourceNotFoundException" + }, + { + "value": "InvalidRequestException", + "name": "InvalidRequestException" + }, + { + "value": "AccessDeniedException", + "name": "AccessDeniedException" + } + ] + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorEntry": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "com.amazonaws.iotsitewise#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The associated error message.

", + "smithy.api#required": {} + } + }, + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", + "traits": { + "smithy.api#documentation": "

The ID of the entry.

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

A list of the errors (if any) associated with the batch request. Each error entry\n contains the entryId of the entry that failed.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorInfo": { + "type": "structure", + "members": { + "errorCode": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

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

The date the error occurred, in Unix epoch time.

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

The error information, such as the error code and the timestamp.

" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryRequest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryEntries", + "traits": { + "smithy.api#documentation": "

The list of asset property historical value entries for the batch get request. \n You can specify up to 16 entries per request.

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

The ID of the asset property.

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

The token to be used for the next set of paginated results.

" } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "maxResults": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryMaxResults", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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

The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

\n " } } } }, - "com.amazonaws.iotsitewise#AssociatedAssetsSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.iotsitewise#AssociatedAssetsSummary" - } - }, - "com.amazonaws.iotsitewise#AssociatedAssetsSummary": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryResponse": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.iotsitewise#ID", - "traits": { - "smithy.api#documentation": "

The ID of the asset.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.iotsitewise#ARN", + "errorEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorEntries", "traits": { - "smithy.api#documentation": "

The ARN of the asset, which has the following format.

\n

\n arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}\n

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

A list of the errors (if any) associated with the batch request. Each error entry\n contains the entryId of the entry that failed.

", "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotsitewise#Name", + "successEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySuccessEntries", "traits": { - "smithy.api#documentation": "

The name of the asset.

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

A list of entries that were processed successfully by this batch request. Each success entry\n contains the entryId of the entry that succeeded and the latest query result.

", "smithy.api#required": {} } }, - "assetModelId": { - "target": "com.amazonaws.iotsitewise#ID", + "skippedEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySkippedEntries", "traits": { - "smithy.api#documentation": "

The ID of the asset model used to create the asset.

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

A list of entries that were not processed by this batch request. \n because these entries had been completely processed by previous paginated requests. \n Each skipped entry contains the entryId of the entry that skipped.

", "smithy.api#required": {} } }, - "creationDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", "traits": { - "smithy.api#documentation": "

The date the asset was created, in Unix epoch time.

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

The token for the next set of results, or null if there are no additional results.

" } - }, - "lastUpdateDate": { - "target": "com.amazonaws.iotsitewise#Timestamp", + } + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySkippedEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySkippedEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySkippedEntry": { + "type": "structure", + "members": { + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", "traits": { - "smithy.api#documentation": "

The date the asset was last updated, in Unix epoch time.

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

The ID of the entry.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.iotsitewise#AssetStatus", + "completionStatus": { + "target": "com.amazonaws.iotsitewise#BatchEntryCompletionStatus", "traits": { - "smithy.api#documentation": "

The current status of the asset.

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

The completion status of each entry that is associated with the \n BatchGetAssetPropertyValueHistory API.

", "smithy.api#required": {} } }, - "hierarchies": { - "target": "com.amazonaws.iotsitewise#AssetHierarchies", + "errorInfo": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistoryErrorInfo", "traits": { - "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

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

The error information, such as the error code and the timestamp.

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

Contains a summary of an associated asset.

" + "smithy.api#documentation": "

Contains information for an entry that has been processed by the previous \n BatchGetAssetPropertyValueHistory request.

" } }, - "com.amazonaws.iotsitewise#Attribute": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySuccessEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySuccessEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueHistorySuccessEntry": { "type": "structure", "members": { - "defaultValue": { - "target": "com.amazonaws.iotsitewise#DefaultValue", + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", "traits": { - "smithy.api#documentation": "

The default value of the asset model property attribute. All assets that you create from\n the asset model contain this attribute value. You can update an attribute's value after you\n create an asset. For more information, see Updating attribute values in the\n IoT SiteWise User Guide.

" + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} + } + }, + "assetPropertyValueHistory": { + "target": "com.amazonaws.iotsitewise#AssetPropertyValueHistory", + "traits": { + "smithy.api#documentation": "

The requested historical values for the specified asset property.

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

Contains an asset attribute property. For more information, see\n Attributes in the IoT SiteWise User Guide.

" + "smithy.api#documentation": "

Contains success information for an entry that is associated with the \n BatchGetAssetPropertyValueHistory API.

" } }, - "com.amazonaws.iotsitewise#AuthMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "IAM", - "name": "IAM" - }, - { - "value": "SSO", - "name": "SSO" + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueRequest": { + "type": "structure", + "members": { + "entries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueEntries", + "traits": { + "smithy.api#documentation": "

The list of asset property value entries for the batch get request. \n You can specify up to 16 entries per request.

", + "smithy.api#required": {} } - ] - } - }, - "com.amazonaws.iotsitewise#BatchAssociateProjectAssets": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest" - }, - "output": { - "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotsitewise#InternalFailureException" - }, - { - "target": "com.amazonaws.iotsitewise#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotsitewise#LimitExceededException" - }, - { - "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iotsitewise#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

", - "smithy.api#endpoint": { - "hostPrefix": "monitor." }, - "smithy.api#http": { - "method": "POST", - "uri": "/projects/{projectId}/assets/associate", - "code": 200 + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", + "traits": { + "smithy.api#documentation": "

The token to be used for the next set of paginated results.

" + } } } }, - "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.iotsitewise#AssetErrorDetails" - } - }, - "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsRequest": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueResponse": { "type": "structure", "members": { - "projectId": { - "target": "com.amazonaws.iotsitewise#ID", + "errorEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorEntries", "traits": { - "smithy.api#documentation": "

The ID of the project to which to associate the assets.

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

A list of the errors (if any) associated with the batch request. Each error entry\n contains the entryId of the entry that failed.

", "smithy.api#required": {} } }, - "assetIds": { - "target": "com.amazonaws.iotsitewise#IDs", + "successEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSuccessEntries", "traits": { - "smithy.api#documentation": "

The IDs of the assets to be associated to the project.

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

A list of entries that were processed successfully by this batch request. Each success entry\n contains the entryId of the entry that succeeded and the latest query result.

", "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "skippedEntries": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSkippedEntries", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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

A list of entries that were not processed by this batch request. \n because these entries had been completely processed by previous paginated requests. \n Each skipped entry contains the entryId of the entry that skipped.

", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsResponse": { - "type": "structure", - "members": { - "errors": { - "target": "com.amazonaws.iotsitewise#BatchAssociateProjectAssetsErrors", + }, + "nextToken": { + "target": "com.amazonaws.iotsitewise#NextToken", "traits": { - "smithy.api#documentation": "

A list of associated error information, if any.

" + "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" } } } }, - "com.amazonaws.iotsitewise#BatchDisassociateProjectAssets": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsRequest" - }, - "output": { - "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotsitewise#InternalFailureException" - }, - { - "target": "com.amazonaws.iotsitewise#InvalidRequestException" - }, - { - "target": "com.amazonaws.iotsitewise#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iotsitewise#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

", - "smithy.api#endpoint": { - "hostPrefix": "monitor." - }, - "smithy.api#http": { - "method": "POST", - "uri": "/projects/{projectId}/assets/disassociate", - "code": 200 - } - } - }, - "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsErrors": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSkippedEntries": { "type": "list", "member": { - "target": "com.amazonaws.iotsitewise#AssetErrorDetails" + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSkippedEntry" } }, - "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsRequest": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSkippedEntry": { "type": "structure", "members": { - "projectId": { - "target": "com.amazonaws.iotsitewise#ID", + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", "traits": { - "smithy.api#documentation": "

The ID of the project from which to disassociate the assets.

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

The ID of the entry.

", "smithy.api#required": {} } }, - "assetIds": { - "target": "com.amazonaws.iotsitewise#IDs", + "completionStatus": { + "target": "com.amazonaws.iotsitewise#BatchEntryCompletionStatus", "traits": { - "smithy.api#documentation": "

The IDs of the assets to be disassociated from the project.

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

The completion status of each entry that is associated with the \n BatchGetAssetPropertyValue request.

", "smithy.api#required": {} } }, - "clientToken": { - "target": "com.amazonaws.iotsitewise#ClientToken", + "errorInfo": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueErrorInfo", "traits": { - "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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

The error information, such as the error code and the timestamp.

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

Contains information for an entry that has been processed by the previous \n BatchGetAssetPropertyValue request.

" } }, - "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsResponse": { + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSuccessEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSuccessEntry" + } + }, + "com.amazonaws.iotsitewise#BatchGetAssetPropertyValueSuccessEntry": { "type": "structure", "members": { - "errors": { - "target": "com.amazonaws.iotsitewise#BatchDisassociateProjectAssetsErrors", + "entryId": { + "target": "com.amazonaws.iotsitewise#EntryId", "traits": { - "smithy.api#documentation": "

A list of associated error information, if any.

" + "smithy.api#documentation": "

The ID of the entry.

", + "smithy.api#required": {} } + }, + "assetPropertyValue": { + "target": "com.amazonaws.iotsitewise#AssetPropertyValue" } + }, + "traits": { + "smithy.api#documentation": "

Contains success information for an entry that is associated with the \n BatchGetAssetPropertyValue API.

" } }, "com.amazonaws.iotsitewise#BatchPutAssetPropertyError": { @@ -3079,6 +3996,9 @@ "input": { "target": "com.amazonaws.iotsitewise#DeleteGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#InternalFailureException" @@ -3252,6 +4172,9 @@ "input": { "target": "com.amazonaws.iotsitewise#DeleteTimeSeriesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -4774,6 +5697,9 @@ "input": { "target": "com.amazonaws.iotsitewise#DisassociateAssetsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -4842,6 +5768,9 @@ "input": { "target": "com.amazonaws.iotsitewise#DisassociateTimeSeriesFromAssetPropertyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -5210,6 +6139,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "aggregatedValues", "pageSize": "maxResults" } } @@ -5393,6 +6323,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetPropertyValueHistory", "pageSize": "maxResults" } } @@ -5558,6 +6489,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "interpolatedAssetPropertyValues", "pageSize": "maxResults" } } @@ -6073,6 +7005,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "accessPolicySummaries", "pageSize": "maxResults" } } @@ -6181,6 +7114,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetModelSummaries", "pageSize": "maxResults" } } @@ -6257,6 +7191,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetRelationshipSummaries", "pageSize": "maxResults" } } @@ -6349,6 +7284,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetSummaries", "pageSize": "maxResults" } } @@ -6454,6 +7390,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetSummaries", "pageSize": "maxResults" } } @@ -6549,6 +7486,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "dashboardSummaries", "pageSize": "maxResults" } } @@ -6630,6 +7568,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "gatewaySummaries", "pageSize": "maxResults" } } @@ -6703,6 +7642,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "portalSummaries", "pageSize": "maxResults" } } @@ -6775,6 +7715,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assetIds", "pageSize": "maxResults" } } @@ -6856,6 +7797,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "projectSummaries", "pageSize": "maxResults" } } @@ -7007,6 +7949,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "TimeSeriesSummaries", "pageSize": "maxResults" } } @@ -7749,10 +8692,7 @@ } }, "com.amazonaws.iotsitewise#PropertyValueStringValue": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[^\\u0000-\\u001F\\u007F]+$" - } + "type": "string" }, "com.amazonaws.iotsitewise#PutAssetPropertyValueEntries": { "type": "list", @@ -8383,7 +9323,7 @@ "smithy.api#box": {}, "smithy.api#range": { "min": 1, - "max": 31556889864403199 + "max": 9223372036854774 } } }, @@ -8918,6 +9858,9 @@ "input": { "target": "com.amazonaws.iotsitewise#UpdateAssetPropertyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" @@ -9109,6 +10052,9 @@ "input": { "target": "com.amazonaws.iotsitewise#UpdateGatewayRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iotsitewise#ConflictingOperationException" diff --git a/aws/sdk/aws-models/iottwinmaker.json b/aws/sdk/aws-models/iottwinmaker.json index 1754aed2f6..8dfbc16ac8 100644 --- a/aws/sdk/aws-models/iottwinmaker.json +++ b/aws/sdk/aws-models/iottwinmaker.json @@ -2132,10 +2132,16 @@ } }, "startTime": { - "target": "com.amazonaws.iottwinmaker#Time" + "target": "com.amazonaws.iottwinmaker#Time", + "traits": { + "smithy.api#documentation": "

The ISO8601 DateTime of the earliest property value to return.

\n

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

" + } }, "endTime": { - "target": "com.amazonaws.iottwinmaker#Time" + "target": "com.amazonaws.iottwinmaker#Time", + "traits": { + "smithy.api#documentation": "

The ISO8601 DateTime of the latest property value to return.

\n

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

" + } } } }, @@ -2444,7 +2450,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_-]+$" + "smithy.api#pattern": "^[a-zA-Z_0-9][a-zA-Z_\\-0-9]*[a-zA-Z0-9]+$|^arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\\/a-zA-Z0-9_-]+$" } }, "com.amazonaws.iottwinmaker#Integer": { @@ -2590,7 +2596,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that filters items in a list of component types.

" + "smithy.api#documentation": "

An object that filters items in a list of component types.

\n \n

Only one object is accepted as a valid input.

\n " } }, "com.amazonaws.iottwinmaker#ListComponentTypesFilters": { @@ -2746,7 +2752,7 @@ "filters": { "target": "com.amazonaws.iottwinmaker#ListEntitiesFilters", "traits": { - "smithy.api#documentation": "

A list of objects that filter the request.

" + "smithy.api#documentation": "

A list of objects that filter the request.

\n \n

Only one object is accepted as a valid input.

\n " } }, "maxResults": { @@ -3415,7 +3421,10 @@ } }, "time": { - "target": "com.amazonaws.iottwinmaker#Time" + "target": "com.amazonaws.iottwinmaker#Time", + "traits": { + "smithy.api#documentation": "

ISO8601 DateTime of a value for a time series property.

\n

The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].

\n \n

\n Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]

" + } } }, "traits": { @@ -3440,7 +3449,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that specifies information about time series property values.

" + "smithy.api#documentation": "

An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.

" } }, "com.amazonaws.iottwinmaker#PropertyValueHistory": { diff --git a/aws/sdk/aws-models/iotwireless.json b/aws/sdk/aws-models/iotwireless.json index d88e65bbb8..d56e7f7bbe 100644 --- a/aws/sdk/aws-models/iotwireless.json +++ b/aws/sdk/aws-models/iotwireless.json @@ -43,6 +43,12 @@ "traits": { "smithy.api#documentation": "

Session keys for ABP v1.0.x

" } + }, + "FCntStart": { + "target": "com.amazonaws.iotwireless#FCntStart", + "traits": { + "smithy.api#documentation": "

The FCnt init value.

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

Session keys for ABP v1.1

" } + }, + "FCntStart": { + "target": "com.amazonaws.iotwireless#FCntStart", + "traits": { + "smithy.api#documentation": "

The FCnt init value.

" + } } }, "traits": { @@ -780,6 +792,40 @@ ] } }, + "com.amazonaws.iotwireless#ConnectionStatusEventConfiguration": { + "type": "structure", + "members": { + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANConnectionStatusEventNotificationConfigurations", + "traits": { + "smithy.api#documentation": "

Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

" + } + }, + "WirelessGatewayIdEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled\n .

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

Connection status event configuration object for enabling or disabling topic.

" + } + }, + "com.amazonaws.iotwireless#ConnectionStatusResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANConnectionStatusResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Connection status resource type event configuration object for enabling or disabling LoRaWAN related\n event topics.

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

Connection status resource type event configuration object for enabling or disabling topic.

" + } + }, "com.amazonaws.iotwireless#Crc": { "type": "long", "traits": { @@ -1138,6 +1184,95 @@ } } }, + "com.amazonaws.iotwireless#CreateNetworkAnalyzerConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateNetworkAnalyzerConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateNetworkAnalyzerConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new network analyzer configuration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/network-analyzer-configurations", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateNetworkAnalyzerConfigurationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName", + "traits": { + "smithy.api#required": {} + } + }, + "TraceContent": { + "target": "com.amazonaws.iotwireless#TraceContent" + }, + "WirelessDevices": { + "target": "com.amazonaws.iotwireless#WirelessDeviceList", + "traits": { + "smithy.api#documentation": "

Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

" + } + }, + "WirelessGateways": { + "target": "com.amazonaws.iotwireless#WirelessGatewayList", + "traits": { + "smithy.api#documentation": "

Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description" + }, + "Tags": { + "target": "com.amazonaws.iotwireless#TagList" + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotwireless#CreateNetworkAnalyzerConfigurationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName" + } + } + }, "com.amazonaws.iotwireless#CreateServiceProfile": { "type": "operation", "input": { @@ -1793,6 +1928,59 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#DeleteNetworkAnalyzerConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteNetworkAnalyzerConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteNetworkAnalyzerConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a network analyzer configuration.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/network-analyzer-configurations/{ConfigurationName}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteNetworkAnalyzerConfigurationRequest": { + "type": "structure", + "members": { + "ConfigurationName": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteNetworkAnalyzerConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#DeleteQueuedMessages": { "type": "operation", "input": { @@ -1819,7 +2007,7 @@ } ], "traits": { - "smithy.api#documentation": "

The operation to delete queued messages.

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

Remove queued messages from the downlink queue.

", "smithy.api#http": { "method": "DELETE", "uri": "/wireless-devices/{Id}/data", @@ -1833,7 +2021,7 @@ "Id": { "target": "com.amazonaws.iotwireless#WirelessDeviceId", "traits": { - "smithy.api#documentation": "

Id of a given wireless device which messages will be deleted

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

The ID of a given wireless device for which downlink messages will be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1841,7 +2029,7 @@ "MessageId": { "target": "com.amazonaws.iotwireless#MessageId", "traits": { - "smithy.api#documentation": "

if messageID==\"*\", the queue for a particular wireless deviceId will be purged, otherwise, the specific message with messageId will be deleted

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

If message ID is \"*\", it cleares the entire downlink queue for a given\n device, specified by the wireless device ID. Otherwise, the downlink message with the\n specified message ID will be deleted.

", "smithy.api#httpQuery": "messageId", "smithy.api#required": {} } @@ -1849,7 +2037,7 @@ "WirelessDeviceType": { "target": "com.amazonaws.iotwireless#WirelessDeviceType", "traits": { - "smithy.api#documentation": "

The wireless device type, it is either Sidewalk or LoRaWAN.

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

The wireless device type, which can be either Sidewalk or LoRaWAN.

", "smithy.api#httpQuery": "WirelessDeviceType" } } @@ -2282,12 +2470,32 @@ "traits": { "smithy.api#documentation": "

Device registration state event configuration object for enabling or disabling Sidewalk related event\n topics.

" } + }, + "WirelessDeviceIdEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the wireless device id device registration state event topic is enabled or disabled.

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

Device registration state event configuration object for enabling and disabling relevant topics.

" } }, + "com.amazonaws.iotwireless#DeviceRegistrationStateResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Device registration resource type state event configuration object for enabling or disabling Sidewalk\n related event topics.

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

Device registration state resource type event configuration object for enabling or disabling topic.

" + } + }, "com.amazonaws.iotwireless#DeviceState": { "type": "string", "traits": { @@ -2784,19 +2992,19 @@ "MessageId": { "target": "com.amazonaws.iotwireless#MessageId", "traits": { - "smithy.api#documentation": "

The messageId allocated by IoT Wireless for tracing purpose

" + "smithy.api#documentation": "

The message ID assigned by IoT Wireless to each downlink message, which helps identify the\n message.

" } }, "TransmitMode": { "target": "com.amazonaws.iotwireless#TransmitMode", "traits": { - "smithy.api#documentation": "

The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

" + "smithy.api#documentation": "

The transmit mode to use for sending data to the wireless device. This can be 0 for UM (unacknowledge mode)\n or 1 for AM (acknowledge mode).

" } }, "ReceivedAt": { "target": "com.amazonaws.iotwireless#ISODateTimeString", "traits": { - "smithy.api#documentation": "

The timestamp that Iot Wireless received the message.

" + "smithy.api#documentation": "

The time at which Iot Wireless received the downlink message.

" } }, "LoRaWAN": { @@ -2804,7 +3012,7 @@ } }, "traits": { - "smithy.api#documentation": "

The message in downlink queue.

" + "smithy.api#documentation": "

The message in the downlink queue.

" } }, "com.amazonaws.iotwireless#DownlinkQueueMessagesList": { @@ -2868,6 +3076,73 @@ ] } }, + "com.amazonaws.iotwireless#EventConfigurationItem": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.iotwireless#Identifier", + "traits": { + "smithy.api#documentation": "

Resource identifier opted in for event messaging.

" + } + }, + "IdentifierType": { + "target": "com.amazonaws.iotwireless#IdentifierType", + "traits": { + "smithy.api#documentation": "

Identifier type of the particular resource identifier for event configuration.

" + } + }, + "PartnerType": { + "target": "com.amazonaws.iotwireless#EventNotificationPartnerType", + "traits": { + "smithy.api#documentation": "

Partner type of the resource if the identifier type is PartnerAccountId.

" + } + }, + "Events": { + "target": "com.amazonaws.iotwireless#EventNotificationItemConfigurations" + } + }, + "traits": { + "smithy.api#documentation": "

Event configuration object for a single resource.

" + } + }, + "com.amazonaws.iotwireless#EventConfigurationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#EventConfigurationItem" + } + }, + "com.amazonaws.iotwireless#EventNotificationItemConfigurations": { + "type": "structure", + "members": { + "DeviceRegistrationState": { + "target": "com.amazonaws.iotwireless#DeviceRegistrationStateEventConfiguration", + "traits": { + "smithy.api#documentation": "

Device registration state event configuration for an event configuration item.

" + } + }, + "Proximity": { + "target": "com.amazonaws.iotwireless#ProximityEventConfiguration", + "traits": { + "smithy.api#documentation": "

Proximity event configuration for an event configuration item.

" + } + }, + "Join": { + "target": "com.amazonaws.iotwireless#JoinEventConfiguration", + "traits": { + "smithy.api#documentation": "

Join event configuration for an event configuration item.

" + } + }, + "ConnectionStatus": { + "target": "com.amazonaws.iotwireless#ConnectionStatusEventConfiguration", + "traits": { + "smithy.api#documentation": "

Connection status event configuration for an event configuration item.

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

Object of all event configurations and the status of the event topics.

" + } + }, "com.amazonaws.iotwireless#EventNotificationPartnerType": { "type": "string", "traits": { @@ -2879,6 +3154,25 @@ ] } }, + "com.amazonaws.iotwireless#EventNotificationResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SidewalkAccount", + "name": "SidewalkAccount" + }, + { + "value": "WirelessDevice", + "name": "WirelessDevice" + }, + { + "value": "WirelessGateway", + "name": "WirelessGateway" + } + ] + } + }, "com.amazonaws.iotwireless#EventNotificationTopicStatus": { "type": "string", "traits": { @@ -2918,6 +3212,17 @@ ] } }, + "com.amazonaws.iotwireless#FCntStart": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The FCnt init value.

", + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, "com.amazonaws.iotwireless#FNwkSIntKey": { "type": "string", "traits": { @@ -3307,6 +3612,67 @@ } } }, + "com.amazonaws.iotwireless#GetEventConfigurationByResourceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetEventConfigurationByResourceTypesRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetEventConfigurationByResourceTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the event configuration by resource types.

", + "smithy.api#http": { + "method": "GET", + "uri": "/event-configurations-resource-types", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetEventConfigurationByResourceTypesRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#GetEventConfigurationByResourceTypesResponse": { + "type": "structure", + "members": { + "DeviceRegistrationState": { + "target": "com.amazonaws.iotwireless#DeviceRegistrationStateResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Resource type event configuration for the device registration state event

" + } + }, + "Proximity": { + "target": "com.amazonaws.iotwireless#ProximityResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Resource type event configuration for the proximity event

" + } + }, + "Join": { + "target": "com.amazonaws.iotwireless#JoinResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Resource type event configuration for the join event

" + } + }, + "ConnectionStatus": { + "target": "com.amazonaws.iotwireless#ConnectionStatusResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Resource type event configuration for the connection status event

" + } + } + } + }, "com.amazonaws.iotwireless#GetFuotaTask": { "type": "operation", "input": { @@ -3589,7 +3955,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get NetworkAnalyzer configuration.

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

Get network analyzer configuration.

", "smithy.api#http": { "method": "GET", "uri": "/network-analyzer-configurations/{ConfigurationName}", @@ -3618,14 +3984,26 @@ "WirelessDevices": { "target": "com.amazonaws.iotwireless#WirelessDeviceList", "traits": { - "smithy.api#documentation": "

List of WirelessDevices in the NetworkAnalyzerConfiguration.

" + "smithy.api#documentation": "

List of wireless gateway resources that have been added to the network analyzer configuration.

" } }, "WirelessGateways": { "target": "com.amazonaws.iotwireless#WirelessGatewayList", "traits": { - "smithy.api#documentation": "

List of WirelessGateways in the NetworkAnalyzerConfiguration.

" + "smithy.api#documentation": "

List of wireless gateway resources that have been added to the network analyzer configuration.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description" + }, + "Arn": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" } + }, + "Name": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName" } } }, @@ -3774,6 +4152,18 @@ "traits": { "smithy.api#documentation": "

Event configuration for the Proximity event

" } + }, + "Join": { + "target": "com.amazonaws.iotwireless#JoinEventConfiguration", + "traits": { + "smithy.api#documentation": "

Event configuration for the join event.

" + } + }, + "ConnectionStatus": { + "target": "com.amazonaws.iotwireless#ConnectionStatusEventConfiguration", + "traits": { + "smithy.api#documentation": "

Event configuration for the connection status event.

" + } } } }, @@ -3876,7 +4266,7 @@ "ServiceType": { "target": "com.amazonaws.iotwireless#WirelessGatewayServiceType", "traits": { - "smithy.api#documentation": "

The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint.

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

The service type for which to get endpoint information about. Can be CUPS for the\n Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint or\n CLAIM for the global endpoint.

", "smithy.api#httpQuery": "serviceType" } } @@ -4654,6 +5044,22 @@ { "value": "PartnerAccountId", "name": "PartnerAccountId" + }, + { + "value": "DevEui", + "name": "DevEui" + }, + { + "value": "GatewayEui", + "name": "GatewayEui" + }, + { + "value": "WirelessDeviceId", + "name": "WirelessDeviceId" + }, + { + "value": "WirelessGatewayId", + "name": "WirelessGatewayId" } ] } @@ -4718,6 +5124,40 @@ } } }, + "com.amazonaws.iotwireless#JoinEventConfiguration": { + "type": "structure", + "members": { + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANJoinEventNotificationConfigurations", + "traits": { + "smithy.api#documentation": "

Join event configuration object for enabling or disabling LoRaWAN related event topics.

" + } + }, + "WirelessDeviceIdEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the wireless device id join event topic is enabled or disabled.

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

Join event configuration object for enabling or disabling topic.

" + } + }, + "com.amazonaws.iotwireless#JoinResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANJoinResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Join resource type event configuration object for enabling or disabling LoRaWAN related\n event topics.

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

Join resource type event configuration object for enabling or disabling topic.

" + } + }, "com.amazonaws.iotwireless#ListDestinations": { "type": "operation", "input": { @@ -4845,19 +5285,93 @@ } } }, - "com.amazonaws.iotwireless#ListDeviceProfilesResponse": { + "com.amazonaws.iotwireless#ListDeviceProfilesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "DeviceProfileList": { + "target": "com.amazonaws.iotwireless#DeviceProfileList", + "traits": { + "smithy.api#documentation": "

The list of device profiles.

" + } + } + } + }, + "com.amazonaws.iotwireless#ListEventConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListEventConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListEventConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List event configurations where at least one event topic has been enabled.

", + "smithy.api#http": { + "method": "GET", + "uri": "/event-configurations", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#ListEventConfigurationsRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.iotwireless#EventNotificationResourceType", + "traits": { + "smithy.api#documentation": "

Resource type to filter event configurations.

", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response;\n otherwise null to receive the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.iotwireless#ListEventConfigurationsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.iotwireless#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response;\n otherwise null to receive the first set of results.

" } }, - "DeviceProfileList": { - "target": "com.amazonaws.iotwireless#DeviceProfileList", + "EventConfigurationsList": { + "target": "com.amazonaws.iotwireless#EventConfigurationsList", "traits": { - "smithy.api#documentation": "

The list of device profiles.

" + "smithy.api#documentation": "

Event configurations of all events for a single resource.

" } } } @@ -5076,6 +5590,77 @@ } } }, + "com.amazonaws.iotwireless#ListNetworkAnalyzerConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListNetworkAnalyzerConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListNetworkAnalyzerConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the network analyzer configurations.

", + "smithy.api#http": { + "method": "GET", + "uri": "/network-analyzer-configurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListNetworkAnalyzerConfigurationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.iotwireless#ListNetworkAnalyzerConfigurationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "NetworkAnalyzerConfigurationList": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationList", + "traits": { + "smithy.api#documentation": "

The list of network analyzer configurations.

" + } + } + } + }, "com.amazonaws.iotwireless#ListPartnerAccounts": { "type": "operation", "input": { @@ -5169,7 +5754,7 @@ } ], "traits": { - "smithy.api#documentation": "

The operation to list queued messages.

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

List queued messages in the downlink queue.

", "smithy.api#http": { "method": "GET", "uri": "/wireless-devices/{Id}/data", @@ -5188,7 +5773,7 @@ "Id": { "target": "com.amazonaws.iotwireless#WirelessDeviceId", "traits": { - "smithy.api#documentation": "

Id of a given wireless device which the downlink packets are targeted

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

The ID of a given wireless device which the downlink message packets are being sent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5196,7 +5781,7 @@ "NextToken": { "target": "com.amazonaws.iotwireless#NextToken", "traits": { - "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

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

To retrieve the next set of results, the nextToken value from a previous response; otherwise \n null to receive the first set of results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5210,7 +5795,7 @@ "WirelessDeviceType": { "target": "com.amazonaws.iotwireless#WirelessDeviceType", "traits": { - "smithy.api#documentation": "

The wireless device type, it is either Sidewalk or LoRaWAN.

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

The wireless device type, whic can be either Sidewalk or LoRaWAN.

", "smithy.api#httpQuery": "WirelessDeviceType" } } @@ -5222,13 +5807,13 @@ "NextToken": { "target": "com.amazonaws.iotwireless#NextToken", "traits": { - "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

" + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; \n otherwise null to receive the first set of results.

" } }, "DownlinkQueueMessagesList": { "target": "com.amazonaws.iotwireless#DownlinkQueueMessagesList", "traits": { - "smithy.api#documentation": "

The messages in downlink queue.

" + "smithy.api#documentation": "

The messages in the downlink queue.

" } } } @@ -5621,6 +6206,34 @@ } } }, + "com.amazonaws.iotwireless#LoRaWANConnectionStatusEventNotificationConfigurations": { + "type": "structure", + "members": { + "GatewayEuiEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the gateway eui connection status event topic is enabled or disabled.

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

Object for LoRaWAN connection status resource type event configuration.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANConnectionStatusResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "WirelessGatewayEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the wireless gateway connection status event topic is enabled or disabled.

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

Object for LoRaWAN connection status resource type event configuration.

" + } + }, "com.amazonaws.iotwireless#LoRaWANDevice": { "type": "structure", "members": { @@ -6088,6 +6701,34 @@ "smithy.api#documentation": "

LoRaWANGetServiceProfileInfo object.

" } }, + "com.amazonaws.iotwireless#LoRaWANJoinEventNotificationConfigurations": { + "type": "structure", + "members": { + "DevEuiEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the dev eui join event topic is enabled or disabled.

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

Object for LoRaWAN join resource type event configuration.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANJoinResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "WirelessDeviceEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the wireless device join event topic is enabled or disabled.

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

Object for LoRaWAN join resource type event configuration.

" + } + }, "com.amazonaws.iotwireless#LoRaWANListDevice": { "type": "structure", "members": { @@ -6217,6 +6858,18 @@ "traits": { "smithy.api#documentation": "

The ID of the service profile.

" } + }, + "AbpV1_1": { + "target": "com.amazonaws.iotwireless#UpdateAbpV1_1", + "traits": { + "smithy.api#documentation": "

ABP device object for update APIs for v1.1

" + } + }, + "AbpV1_0_x": { + "target": "com.amazonaws.iotwireless#UpdateAbpV1_0_x", + "traits": { + "smithy.api#documentation": "

ABP device object for update APIs for v1.0.x

" + } } }, "traits": { @@ -6278,7 +6931,7 @@ "com.amazonaws.iotwireless#LogLevel": { "type": "string", "traits": { - "smithy.api#documentation": "

The log level for a log message.

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

The log level for a log message. The log levels can be disabled, or set to ERROR to display\n less verbose logs containing only error information, or to INFO for more detailed logs.

", "smithy.api#enum": [ { "value": "INFO", @@ -6536,15 +7189,47 @@ } } }, + "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1124 + } + } + }, + "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurations" + } + }, "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationName": { "type": "string", "traits": { - "smithy.api#documentation": "

NetworkAnalyzer configuration name.

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

Name of the network analyzer configuration.

", "smithy.api#length": { "min": 1, "max": 1024 }, - "smithy.api#pattern": "^NetworkAnalyzerConfig_Default$" + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.iotwireless#NetworkAnalyzerConfigurations": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#NetworkAnalyzerConfigurationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

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

Network analyzer configurations.

" } }, "com.amazonaws.iotwireless#NextToken": { @@ -6736,12 +7421,32 @@ "traits": { "smithy.api#documentation": "

Proximity event configuration object for enabling or disabling Sidewalk related event topics.

" } + }, + "WirelessDeviceIdEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the wireless device id proximity event topic is enabled or disabled.

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

Proximity event configuration object for enabling and disabling relevant topics.

" } }, + "com.amazonaws.iotwireless#ProximityResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Proximity resource type event configuration object for enabling and disabling wireless device topic.

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

Proximity resource type event configuration object for enabling or disabling topic.

" + } + }, "com.amazonaws.iotwireless#PutResourceLogLevel": { "type": "operation", "input": { @@ -7503,6 +8208,20 @@ } } }, + "com.amazonaws.iotwireless#SidewalkResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "WirelessDeviceEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether the wireless device join event topic is enabled or disabled.

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

Sidewalk resource type event configuration object for enabling or disabling topic.

" + } + }, "com.amazonaws.iotwireless#SidewalkSendDataToDevice": { "type": "structure", "members": { @@ -8094,7 +8813,7 @@ } }, "traits": { - "smithy.api#documentation": "

Trace Content for resources.

" + "smithy.api#documentation": "

Trace content for your wireless gateway and wireless device resources.

" } }, "com.amazonaws.iotwireless#TransmitMode": { @@ -8195,6 +8914,34 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#UpdateAbpV1_0_x": { + "type": "structure", + "members": { + "FCntStart": { + "target": "com.amazonaws.iotwireless#FCntStart", + "traits": { + "smithy.api#documentation": "

The FCnt init value.

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

ABP device object for LoRaWAN specification v1.0.x

" + } + }, + "com.amazonaws.iotwireless#UpdateAbpV1_1": { + "type": "structure", + "members": { + "FCntStart": { + "target": "com.amazonaws.iotwireless#FCntStart", + "traits": { + "smithy.api#documentation": "

The FCnt init value.

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

ABP device object for LoRaWAN specification v1.1

" + } + }, "com.amazonaws.iotwireless#UpdateDataSource": { "type": "string", "traits": { @@ -8279,6 +9026,70 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#UpdateEventConfigurationByResourceTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdateEventConfigurationByResourceTypesRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdateEventConfigurationByResourceTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the event configuration by resource types.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/event-configurations-resource-types", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdateEventConfigurationByResourceTypesRequest": { + "type": "structure", + "members": { + "DeviceRegistrationState": { + "target": "com.amazonaws.iotwireless#DeviceRegistrationStateResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Device registration state resource type event configuration object for enabling and disabling wireless\n gateway topic.

" + } + }, + "Proximity": { + "target": "com.amazonaws.iotwireless#ProximityResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Proximity resource type event configuration object for enabling and disabling wireless gateway topic.

" + } + }, + "Join": { + "target": "com.amazonaws.iotwireless#JoinResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Join resource type event configuration object for enabling and disabling wireless device topic.

" + } + }, + "ConnectionStatus": { + "target": "com.amazonaws.iotwireless#ConnectionStatusResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "

Connection status resource type event configuration object for enabling and disabling wireless gateway topic.

" + } + } + } + }, + "com.amazonaws.iotwireless#UpdateEventConfigurationByResourceTypesResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#UpdateFuotaTask": { "type": "operation", "input": { @@ -8490,7 +9301,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update NetworkAnalyzer configuration.

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

Update network analyzer configuration.

", "smithy.api#http": { "method": "PATCH", "uri": "/network-analyzer-configurations/{ConfigurationName}", @@ -8514,26 +9325,29 @@ "WirelessDevicesToAdd": { "target": "com.amazonaws.iotwireless#WirelessDeviceList", "traits": { - "smithy.api#documentation": "

WirelessDevices to add into NetworkAnalyzerConfiguration.

" + "smithy.api#documentation": "

Wireless device resources to add to the network analyzer configuration. Provide the \n WirelessDeviceId of the resource to add in the input array.

" } }, "WirelessDevicesToRemove": { "target": "com.amazonaws.iotwireless#WirelessDeviceList", "traits": { - "smithy.api#documentation": "

WirelessDevices to remove from NetworkAnalyzerConfiguration.

" + "smithy.api#documentation": "

Wireless device resources to remove from the network analyzer configuration. Provide the \n WirelessDeviceId of the resources to remove in the input array.

" } }, "WirelessGatewaysToAdd": { "target": "com.amazonaws.iotwireless#WirelessGatewayList", "traits": { - "smithy.api#documentation": "

WirelessGateways to add into NetworkAnalyzerConfiguration.

" + "smithy.api#documentation": "

Wireless gateway resources to add to the network analyzer configuration. Provide the \n WirelessGatewayId of the resource to add in the input array.

" } }, "WirelessGatewaysToRemove": { "target": "com.amazonaws.iotwireless#WirelessGatewayList", "traits": { - "smithy.api#documentation": "

WirelessGateways to remove from NetworkAnalyzerConfiguration.

" + "smithy.api#documentation": "

Wireless gateway resources to remove from the network analyzer configuration. Provide the \n WirelessGatewayId of the resources to remove in the input array.

" } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description" } } }, @@ -8678,6 +9492,18 @@ "traits": { "smithy.api#documentation": "

Event configuration for the Proximity event

" } + }, + "Join": { + "target": "com.amazonaws.iotwireless#JoinEventConfiguration", + "traits": { + "smithy.api#documentation": "

Event configuration for the join event

" + } + }, + "ConnectionStatus": { + "target": "com.amazonaws.iotwireless#ConnectionStatusEventConfiguration", + "traits": { + "smithy.api#documentation": "

Event configuration for the connection status event

" + } } } }, @@ -8966,7 +9792,7 @@ "com.amazonaws.iotwireless#WirelessDeviceFrameInfo": { "type": "string", "traits": { - "smithy.api#documentation": "

WirelessDevice FrameInfo for trace content.

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

FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug\n the communication between your LoRaWAN end devices and the network server.

", "smithy.api#enum": [ { "value": "ENABLED", @@ -9500,6 +10326,9 @@ { "target": "com.amazonaws.iotwireless#CreateMulticastGroup" }, + { + "target": "com.amazonaws.iotwireless#CreateNetworkAnalyzerConfiguration" + }, { "target": "com.amazonaws.iotwireless#CreateServiceProfile" }, @@ -9527,6 +10356,9 @@ { "target": "com.amazonaws.iotwireless#DeleteMulticastGroup" }, + { + "target": "com.amazonaws.iotwireless#DeleteNetworkAnalyzerConfiguration" + }, { "target": "com.amazonaws.iotwireless#DeleteQueuedMessages" }, @@ -9572,6 +10404,9 @@ { "target": "com.amazonaws.iotwireless#GetDeviceProfile" }, + { + "target": "com.amazonaws.iotwireless#GetEventConfigurationByResourceTypes" + }, { "target": "com.amazonaws.iotwireless#GetFuotaTask" }, @@ -9632,6 +10467,9 @@ { "target": "com.amazonaws.iotwireless#ListDeviceProfiles" }, + { + "target": "com.amazonaws.iotwireless#ListEventConfigurations" + }, { "target": "com.amazonaws.iotwireless#ListFuotaTasks" }, @@ -9641,6 +10479,9 @@ { "target": "com.amazonaws.iotwireless#ListMulticastGroupsByFuotaTask" }, + { + "target": "com.amazonaws.iotwireless#ListNetworkAnalyzerConfigurations" + }, { "target": "com.amazonaws.iotwireless#ListPartnerAccounts" }, @@ -9701,6 +10542,9 @@ { "target": "com.amazonaws.iotwireless#UpdateDestination" }, + { + "target": "com.amazonaws.iotwireless#UpdateEventConfigurationByResourceTypes" + }, { "target": "com.amazonaws.iotwireless#UpdateFuotaTask" }, diff --git a/aws/sdk/aws-models/kendra.json b/aws/sdk/aws-models/kendra.json index f2dcdc80ae..7101e463c5 100644 --- a/aws/sdk/aws-models/kendra.json +++ b/aws/sdk/aws-models/kendra.json @@ -1009,7 +1009,7 @@ "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for an Amazon VPC to connect to your Box. For \n more information, see Configuring a VPC.

" + "smithy.api#documentation": "

Configuration information for an Amazon VPC to connect to your Box. For \n more information, see Configuring a VPC.

" } } }, @@ -1066,6 +1066,9 @@ "input": { "target": "com.amazonaws.kendra#ClearQuerySuggestionsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -2660,6 +2663,12 @@ "traits": { "smithy.api#documentation": "

Provides the configuration information to connect to Box as your data source.

" } + }, + "QuipConfiguration": { + "target": "com.amazonaws.kendra#QuipConfiguration", + "traits": { + "smithy.api#documentation": "

Provides the configuration information to connect to Quip as your \n data source.

" + } } }, "traits": { @@ -3121,6 +3130,10 @@ { "value": "BOX", "name": "BOX" + }, + { + "value": "QUIP", + "name": "QUIP" } ] } @@ -3248,6 +3261,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteDataSourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3351,6 +3367,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteFaqRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3399,6 +3418,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteIndexRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3440,6 +3462,9 @@ "input": { "target": "com.amazonaws.kendra#DeletePrincipalMappingRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3500,6 +3525,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteQuerySuggestionsBlockListRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -3548,6 +3576,9 @@ "input": { "target": "com.amazonaws.kendra#DeleteThesaurusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -5166,6 +5197,16 @@ "smithy.api#documentation": "

Document metadata files that contain information such as the\n document access control information, source URI, document author,\n and custom attributes. Each metadata file contains metadata about a\n single document.

" } }, + "com.amazonaws.kendra#Domain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^(?!-)[A-Za-z0-9-].*(?The configuration information to connect to your Quip data source domain.

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

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the\n key-value pairs\n that are\n required to connect to your Quip file system. Windows is currently the\n only supported type. The secret must contain a JSON structure with the following\n keys:

\n ", + "smithy.api#required": {} + } + }, + "CrawlFileComments": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

Specify whether to crawl file comments in your Quip data source. \n You can specify one or more of these options.

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

Specify whether to crawl chat rooms in your Quip data source. \n You can specify one or more of these options.

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

Specify whether to crawl attachments in your Quip data source. \n You can specify one or more of these options.

" + } + }, + "FolderIds": { + "target": "com.amazonaws.kendra#FolderIdList", + "traits": { + "smithy.api#documentation": "

The identifier of the Quip folder IDs to index.

" + } + }, + "ThreadFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip threads.

" + } + }, + "MessageFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip messages.

" + } + }, + "AttachmentFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip attachments.

" + } + }, + "InclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to include certain files in your Quip file\n system. Files that match the patterns are included in the index. Files that don't match\n the patterns are excluded from the index. If a file matches both an inclusion pattern\n and an exclusion pattern, the exclusion pattern takes\n precedence,\n and the file isn't included in the index.

" + } + }, + "ExclusionPatterns": { + "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain files in your Quip file\n system. Files that match the patterns are excluded from the index. Files that don’t\n match the patterns are included in the index. If a file matches both an inclusion\n pattern and an exclusion pattern, the exclusion pattern takes\n precedence,\n and the file isn't included in the index.

" + } + }, + "VpcConfiguration": { + "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for connecting to an Amazon Virtual Private Cloud\n (VPC)\n for your Quip. Your Quip instance must reside inside your VPC.

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

Provides the configuration information to connect to Quip as your data source.

" + } + }, "com.amazonaws.kendra#ReadAccessType": { "type": "string", "traits": { @@ -10273,6 +10414,9 @@ "input": { "target": "com.amazonaws.kendra#StopDataSourceSyncJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -10336,6 +10480,9 @@ "input": { "target": "com.amazonaws.kendra#SubmitFeedbackRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -10903,6 +11050,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateDataSourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -10993,6 +11143,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateExperienceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -11065,6 +11218,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateIndexRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -11157,6 +11313,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateQuerySuggestionsBlockListRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -11229,6 +11388,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateQuerySuggestionsConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" @@ -11300,6 +11462,9 @@ "input": { "target": "com.amazonaws.kendra#UpdateThesaurusRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kendra#AccessDeniedException" diff --git a/aws/sdk/aws-models/kms.json b/aws/sdk/aws-models/kms.json index 96064356c9..6808c45563 100644 --- a/aws/sdk/aws-models/kms.json +++ b/aws/sdk/aws-models/kms.json @@ -160,7 +160,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS\n key is Disabled. To enable the KMS key, use EnableKey.

\n

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" + "smithy.api#documentation": "

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS\n key is Disabled. To enable the KMS key, use EnableKey.

\n

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" } }, "com.amazonaws.kms#CancelKeyDeletionRequest": { @@ -409,6 +409,9 @@ "input": { "target": "com.amazonaws.kms#CreateAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#AlreadyExistsException" @@ -433,7 +436,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a friendly name for a KMS key.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and\n GenerateDataKey. You can also change the KMS key that's associated with\n the alias (UpdateAlias) or delete the alias (DeleteAlias)\n at any time. These operations don't affect the underlying KMS key.

\n

You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each\n alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.\n A valid KMS key is required. You can't create an alias without a KMS key.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Creates a friendly name for a KMS key.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and\n GenerateDataKey. You can also change the KMS key that's associated with\n the alias (UpdateAlias) or delete the alias (DeleteAlias)\n at any time. These operations don't affect the underlying KMS key.

\n

You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each\n alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.\n A valid KMS key is required. You can't create an alias without a KMS key.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateAliasRequest": { @@ -569,7 +572,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a grant to a KMS key.

\n

A grant is a policy instrument that allows Amazon Web Services principals to use\n KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key,\n grants are considered along with key policies and IAM policies. Grants are often used for\n temporary permissions because you can create one, use its permissions, and delete it without\n changing your key policies or IAM policies.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

The CreateGrant operation returns a GrantToken and a\n GrantId.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

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

Adds a grant to a KMS key.

\n

A grant is a policy instrument that allows Amazon Web Services principals to use\n KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key,\n grants are considered along with key policies and IAM policies. Grants are often used for\n temporary permissions because you can create one, use its permissions, and delete it without\n changing your key policies or IAM policies.

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

The CreateGrant operation returns a GrantToken and a\n GrantId.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateGrantRequest": { @@ -598,14 +601,14 @@ "Operations": { "target": "com.amazonaws.kms#GrantOperationList", "traits": { - "smithy.api#documentation": "

A list of operations that the grant permits.

\n

The operation must be supported on the KMS key. For example, you cannot create a grant for\n a symmetric KMS key that allows the Sign operation, or a grant for an\n asymmetric KMS key that allows the GenerateDataKey operation. If you try,\n KMS returns a ValidationError exception. For details, see Grant\n operations in the Key Management Service Developer Guide.

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

A list of operations that the grant permits.

\n

This list must include only operations that are permitted in a grant. Also, the operation\n must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key\n that allows the GenerateDataKey operation. If you try, KMS returns a\n ValidationError exception. For details, see Grant operations in the\n Key Management Service Developer Guide.

", "smithy.api#required": {} } }, "Constraints": { "target": "com.amazonaws.kms#GrantConstraints", "traits": { - "smithy.api#documentation": "

Specifies a grant constraint.

\n

KMS supports the EncryptionContextEquals and\n EncryptionContextSubset grant constraints. Each constraint value can include up\n to 8 encryption context pairs. The encryption context value in each constraint cannot exceed\n 384 characters.

\n

These grant constraints allow the permissions in the grant only when the encryption\n context in the request matches (EncryptionContextEquals) or includes\n (EncryptionContextSubset) the encryption context specified in this structure.\n For information about grant constraints, see Using grant\n constraints in the Key Management Service Developer Guide. For more information about encryption context,\n see Encryption\n Context in the \n Key Management Service Developer Guide\n .

\n

The encryption context grant constraints are supported only on operations that include an\n encryption context. You cannot use an encryption context grant constraint for cryptographic\n operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

" + "smithy.api#documentation": "

Specifies a grant constraint.

\n

KMS supports the EncryptionContextEquals and\n EncryptionContextSubset grant constraints. Each constraint value can include up\n to 8 encryption context pairs. The encryption context value in each constraint cannot exceed\n 384 characters. For information about grant constraints, see Using grant\n constraints in the Key Management Service Developer Guide. For more information about encryption context,\n see Encryption\n context in the \n Key Management Service Developer Guide\n .

\n

The encryption context grant constraints allow the permissions in the grant only when the\n encryption context in the request matches (EncryptionContextEquals) or includes\n (EncryptionContextSubset) the encryption context specified in this structure.

\n

The encryption context grant constraints are supported only on grant operations that\n include an EncryptionContext parameter, such as cryptographic operations on\n symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint\n doesn't apply to these operations. If a grant with a grant constraint includes the\n CreateGrant operation, the constraint requires that any grants created with the\n CreateGrant permission have an equally strict or stricter encryption context\n constraint.

\n

You cannot use an encryption context grant constraint for cryptographic operations with\n asymmetric KMS keys or HMAC KMS keys. These keys don't support an encryption context.

\n

" } }, "GrantTokens": { @@ -680,7 +683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a unique customer managed KMS key in your Amazon Web Services account and\n Region.

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n \n\n

You can use the CreateKey operation to create symmetric or asymmetric KMS\n keys.

\n \n

For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n\n\n

To create different types of KMS keys, use the following guidance:

\n\n
\n
Asymmetric KMS keys
\n
\n

To create an asymmetric KMS key, use the KeySpec parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.

\n

\n
\n
Symmetric KMS keys
\n
\n

When creating a symmetric KMS key, you don't need to specify the\n KeySpec or KeyUsage parameters. The default value for\n KeySpec, SYMMETRIC_DEFAULT, and the default value for\n KeyUsage, ENCRYPT_DECRYPT, are the only valid values for\n symmetric KMS keys.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a KMS key with the same key ID\n and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

You can create symmetric and asymmetric multi-Region keys and multi-Region keys with\n imported key material. You cannot create multi-Region keys in a custom key store.

\n

\n
\n
\n

To import your own key material, begin by creating a symmetric KMS key with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n . You\n cannot import the key material into an asymmetric KMS key.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

To create a symmetric KMS key in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the Amazon Web Services Region.

\n

You cannot create an asymmetric KMS key in a custom key store. For information about\n custom key stores in KMS see Using Custom Key Stores in\n the \n Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n KMS keys in the Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Creates a unique customer managed KMS key in your Amazon Web Services account and\n Region.

\n

In addition to the required parameters, you can use the optional parameters to specify a key policy, description, tags, and other useful elements for any key type.

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n \n\n \n

To create different types of KMS keys, use the following guidance:

\n\n
\n
Symmetric encryption KMS key
\n
\n

To create a symmetric encryption KMS key, you aren't required to specify any parameters. The default value for\n KeySpec, SYMMETRIC_DEFAULT, and the default value for\n KeyUsage, ENCRYPT_DECRYPT, create a symmetric encryption KMS key.

\n

If you need a key for basic encryption and decryption or you \n are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.

\n

\n
\n
Asymmetric KMS keys
\n
\n

To create an asymmetric KMS key, use the KeySpec parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.

\n

Asymmetric KMS keys contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric \n KMS key never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key\n so it can be used outside of AWS KMS. KMS keys with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). \n KMS keys with ECC key pairs can be used only to sign and verify messages. \n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

\n
\n
HMAC KMS key
\n
\n

To create an HMAC KMS key, set the KeySpec parameter to a\n key spec value for HMAC KMS keys. Then set the KeyUsage parameter to\n GENERATE_VERIFY_MAC. You must set the key usage even though\n GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys.\n You can't change these properties after the KMS key is created.

\n

HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use\n HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes.

\n

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC\n KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the\n CreateKey operation returns an\n UnsupportedOperationException. For a list of Regions in which HMAC KMS keys\n are supported, see HMAC keys in\n KMS in the Key Management Service Developer Guide.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a KMS key with the same key ID\n and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

You can create multi-Region KMS keys for all supported KMS key types: symmetric\n encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric\n signing KMS keys. You can also create multi-Region keys with imported key material.\n However, you can't create multi-Region keys in a custom key store.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

\n
\n
\n

To import your own key material, begin by creating a symmetric encryption KMS key with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n .

\n

This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key\n material into any other type of KMS key.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

To create a symmetric encryption KMS key in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the Amazon Web Services Region.

\n

Custom key stores support only symmetric encryption KMS keys. You cannot create an\n HMAC KMS key or an asymmetric KMS key in a custom key store. For information about\n custom key stores in KMS see Custom key stores in KMS in\n the \n Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n KMS keys in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateKeyRequest": { @@ -701,7 +704,7 @@ "KeyUsage": { "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You\n can't change the KeyUsage value after the KMS key is created.

\n

Select only one valid value.

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

Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric\n encryption KMS key; otherwise, it is required. You\n can't change the KeyUsage value after the KMS key is created.

\n

Select only one valid value.

\n " } }, "CustomerMasterKeySpec": { @@ -716,19 +719,19 @@ "KeySpec": { "target": "com.amazonaws.kms#KeySpec", "traits": { - "smithy.api#documentation": "

Specifies the type of KMS key to create. The default value,\n SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption\n and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key\n Configuration in the \n Key Management Service Developer Guide\n .

\n

The KeySpec determines whether the KMS key contains a symmetric key or an\n asymmetric key pair. It also determines the encryption algorithms or signing algorithms that\n the KMS key supports. You can't change the KeySpec after the KMS key is created.\n To further restrict the algorithms that can be used with the KMS key, use a condition key in\n its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the \n Key Management Service Developer Guide\n .

\n \n

\n Amazon Web Services services that\n are integrated with KMS use symmetric KMS keys to protect your data. These\n services do not support asymmetric KMS keys. For help determining whether a KMS key is\n symmetric or asymmetric, see Identifying Symmetric and Asymmetric\n KMS keys in the Key Management Service Developer Guide.

\n \n

KMS supports the following key specs for KMS keys:

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

Specifies the type of KMS key to create. The default value,\n SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption\n and decryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in\n the \n Key Management Service Developer Guide\n .

\n

The KeySpec determines whether the KMS key contains a symmetric key or an\n asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't\n change the KeySpec after the KMS key is created. To further restrict the\n algorithms that can be used with the KMS key, use a condition key in its key policy or IAM\n policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the \n Key Management Service Developer Guide\n .

\n \n

\n Amazon Web Services services that\n are integrated with KMS use symmetric encryption KMS keys to protect your data.\n These services do not support asymmetric KMS keys or HMAC KMS keys.

\n \n

KMS supports the following key specs for KMS keys:

\n " } }, "Origin": { "target": "com.amazonaws.kms#OriginType", "traits": { - "smithy.api#documentation": "

The source of the key material for the KMS key. You cannot change the origin after you\n create the KMS key. The default is AWS_KMS, which means that KMS creates the\n key material.

\n

To create a KMS key with no key material (for imported key material), set the value to\n EXTERNAL. For more information about importing key material into KMS, see\n Importing Key\n Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS\n keys.

\n

To create a KMS key in an KMS custom key store and create its key material in the\n associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the\n CustomKeyStoreId parameter to identify the custom key store. This value is\n valid only for symmetric KMS keys.

" + "smithy.api#documentation": "

The source of the key material for the KMS key. You cannot change the origin after you\n create the KMS key. The default is AWS_KMS, which means that KMS creates the\n key material.

\n

To create a KMS key with no key material (for imported key material), set the value to\n EXTERNAL. For more information about importing key material into KMS, see\n Importing Key\n Material in the Key Management Service Developer Guide. This value is valid only for symmetric encryption KMS keys.

\n

To create a KMS key in an KMS custom key store and create its key material in the\n associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the\n CustomKeyStoreId parameter to identify the custom key store. This value is\n valid only for symmetric encryption KMS keys.

" } }, "CustomKeyStoreId": { "target": "com.amazonaws.kms#CustomKeyStoreIdType", "traits": { - "smithy.api#documentation": "

Creates the KMS key in the specified custom key store and the key material in its\n associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric KMS keys and regional KMS keys. You cannot\n create an asymmetric KMS key or a multi-Region key in a custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the CloudHSM cluster.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

" + "smithy.api#documentation": "

Creates the KMS key in the specified custom key store and the key material in its\n associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric encryption KMS keys in a single Region. You \n cannot create any other type of KMS key in a custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the CloudHSM cluster.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

" } }, "BypassPolicyLockoutSafetyCheck": { @@ -740,13 +743,13 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is\n created. To tag an existing KMS key, use the TagResource operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag\n value, KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" + "smithy.api#documentation": "

Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is\n created. To tag an existing KMS key, use the TagResource operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag\n value, KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" } }, "MultiRegion": { "target": "com.amazonaws.kms#NullableBooleanType", "traits": { - "smithy.api#documentation": "

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You\n cannot change this value after you create the KMS key.

\n

For a multi-Region key, set this parameter to True. For a single-Region KMS\n key, omit this parameter or set it to False. The default value is\n False.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

This value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.

\n

You can create a symmetric or asymmetric multi-Region key, and you can create a\n multi-Region key with imported key material. However, you cannot create a multi-Region key in\n a custom key store.

" + "smithy.api#documentation": "

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You\n cannot change this value after you create the KMS key.

\n

For a multi-Region key, set this parameter to True. For a single-Region KMS\n key, omit this parameter or set it to False. The default value is\n False.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

This value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.

\n

You can create a symmetric or asymmetric multi-Region key, and you can create a\n multi-Region key with imported key material. However, you cannot create a multi-Region key in\n a custom key store.

" } } } @@ -942,6 +945,22 @@ { "value": "SYMMETRIC_DEFAULT", "name": "SYMMETRIC_DEFAULT" + }, + { + "value": "HMAC_224", + "name": "HMAC_224" + }, + { + "value": "HMAC_256", + "name": "HMAC_256" + }, + { + "value": "HMAC_384", + "name": "HMAC_384" + }, + { + "value": "HMAC_512", + "name": "HMAC_512" } ] } @@ -1040,7 +1059,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a KMS key using any of the following\n operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or\n asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the\n encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the\n public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by\n other libraries, such as the Amazon Web Services\n Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.

\n

If the ciphertext was encrypted under a symmetric KMS key, the KeyId\n parameter is optional. KMS can get this information from metadata that it adds to the\n symmetric ciphertext blob. This feature adds durability to your implementation by ensuring\n that authorized users can decrypt ciphertext decades after it was encrypted, even if they've\n lost track of the key ID. However, specifying the KMS key is always recommended as a best\n practice. When you use the KeyId parameter to specify a KMS key, KMS only uses\n the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the\n Decrypt operation fails. This practice ensures that you use the KMS key that\n you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys\n in other accounts if the key policy for the cross-account KMS key permits it. If you must use\n an IAM policy for Decrypt permissions, limit the user to particular KMS keys or\n particular trusted accounts. For details, see Best practices for IAM\n policies in the Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

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

Decrypts ciphertext that was encrypted by a KMS key using any of the following\n operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an\n asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the\n encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the\n public key in an KMS asymmetric KMS key. However, it cannot decrypt symmetric ciphertext produced by\n other libraries, such as the Amazon Web Services\n Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.

\n

If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId\n parameter is optional. KMS can get this information from metadata that it adds to the\n symmetric ciphertext blob. This feature adds durability to your implementation by ensuring\n that authorized users can decrypt ciphertext decades after it was encrypted, even if they've\n lost track of the key ID. However, specifying the KMS key is always recommended as a best\n practice. When you use the KeyId parameter to specify a KMS key, KMS only uses\n the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the\n Decrypt operation fails. This practice ensures that you use the KMS key that\n you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys\n in other accounts if the key policy for the cross-account KMS key permits it. If you must use\n an IAM policy for Decrypt permissions, limit the user to particular KMS keys or\n particular trusted accounts. For details, see Best practices for IAM\n policies in the Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DecryptRequest": { @@ -1056,7 +1075,7 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context to use when decrypting the data.\n An encryption context is valid only for cryptographic operations with a symmetric KMS key. The standard asymmetric encryption algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context to use when decrypting the data.\n An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "GrantTokens": { @@ -1068,13 +1087,13 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the KMS key that KMS uses to decrypt the ciphertext. Enter a key ID of the KMS\n key that was used to encrypt the ciphertext.

\n\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the KMS key that KMS uses to decrypt the ciphertext.

\n \n

Enter a key ID of the KMS\n key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

\n\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "EncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify\n the same algorithm that was used to encrypt the data. If you specify a different algorithm,\n the Decrypt operation fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. The default value, SYMMETRIC_DEFAULT, represents the only supported\n algorithm that is valid for symmetric KMS keys.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify\n the same algorithm that was used to encrypt the data. If you specify a different algorithm,\n the Decrypt operation fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. The default value, SYMMETRIC_DEFAULT, represents the only supported\n algorithm that is valid for symmetric encryption KMS keys.

" } } } @@ -1107,6 +1126,9 @@ "input": { "target": "com.amazonaws.kms#DeleteAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1122,7 +1144,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alias.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Because an alias is not a property of a KMS key, you can delete and change the aliases of\n a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the\n DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

\n

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Deletes the specified alias.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Because an alias is not a property of a KMS key, you can delete and change the aliases of\n a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the\n DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

\n

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteAliasRequest": { @@ -1184,6 +1206,9 @@ "input": { "target": "com.amazonaws.kms#DeleteImportedKeyMaterialRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1205,7 +1230,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes key material that you previously imported. This operation makes the specified KMS\n key unusable. For more information about importing key material into KMS, see Importing Key Material\n in the Key Management Service Developer Guide.

\n

When the specified KMS key is in the PendingDeletion state, this operation\n does not change the KMS key's state. Otherwise, it changes the KMS key's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the KMS key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

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

Deletes key material that you previously imported. This operation makes the specified KMS\n key unusable. For more information about importing key material into KMS, see Importing Key Material\n in the Key Management Service Developer Guide.

\n

When the specified KMS key is in the PendingDeletion state, this operation\n does not change the KMS key's state. Otherwise, it changes the KMS key's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the KMS key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteImportedKeyMaterialRequest": { @@ -1335,7 +1360,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides detailed information about a KMS key. You can run DescribeKey on a\n customer managed\n key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish symmetric from\n asymmetric KMS keys. It also provides information that is particularly important to asymmetric\n keys, such as the key usage (encryption or signing) and the encryption algorithms or signing\n algorithms that the KMS key supports. For KMS keys in custom key stores, it includes\n information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For\n multi-Region keys, it displays the primary key and all related replica keys.

\n

\n DescribeKey does not return the following information:

\n \n

If you call the DescribeKey operation on a predefined Amazon Web Services\n alias, that is, an Amazon Web Services alias with no key ID, KMS creates an Amazon Web Services managed\n key. Then, it associates the alias with the new KMS key, and returns the\n KeyId and Arn of the new KMS key in the response.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

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

Provides detailed information about a KMS key. You can run DescribeKey on a\n customer managed\n key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish different types of KMS keys. It also displays the key usage (encryption, signing, or generating and verifying MACs) and the algorithms that the KMS key supports. For KMS keys in custom key stores, it includes\n information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For\n multi-Region keys, it displays the primary key and all related replica keys.

\n

\n DescribeKey does not return the following information:

\n \n

In general, DescribeKey is a non-mutating operation. It returns data about\n KMS keys, but doesn't change them. However, Amazon Web Services services use DescribeKey to\n create Amazon Web Services\n managed keys from a predefined Amazon Web Services alias with no key\n ID.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DescribeKeyRequest": { @@ -1381,6 +1406,9 @@ "input": { "target": "com.amazonaws.kms#DisableKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1399,7 +1427,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS\n key for cryptographic operations.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS\n key in the \n Key Management Service Developer Guide\n .

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" + "smithy.api#documentation": "

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS\n key for cryptographic operations.

\n

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the \n Key Management Service Developer Guide\n .

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" } }, "com.amazonaws.kms#DisableKeyRequest": { @@ -1419,6 +1447,9 @@ "input": { "target": "com.amazonaws.kms#DisableKeyRotationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1443,7 +1474,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables automatic\n rotation of the key material for the specified symmetric KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

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

Disables automatic\n rotation of the key material for the specified symmetric encryption KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DisableKeyRotationRequest": { @@ -1452,7 +1483,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric KMS key. You cannot enable or disable automatic rotation of asymmetric\n KMS keys, KMS keys with imported key material, or KMS keys in a\n custom key store.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric\n KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a\n custom key store.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1519,6 +1550,9 @@ "input": { "target": "com.amazonaws.kms#EnableKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1540,7 +1574,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for\n cryptographic operations.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" + "smithy.api#documentation": "

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for\n cryptographic operations.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" } }, "com.amazonaws.kms#EnableKeyRequest": { @@ -1560,6 +1594,9 @@ "input": { "target": "com.amazonaws.kms#EnableKeyRotationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -1584,7 +1621,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables automatic rotation\n of the key material for the specified symmetric KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

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

Enables automatic rotation\n of the key material for the specified symmetric encryption KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EnableKeyRotationRequest": { @@ -1593,7 +1630,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric KMS key. You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Encrypts plaintext into ciphertext by using a KMS key. The Encrypt operation\n has two primary use cases:

\n \n\n

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

When you encrypt data, you must specify a symmetric or asymmetric KMS key to use in the\n encryption operation. The KMS key must have a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

\n\n

If you use a symmetric KMS key, you can use an encryption context to add additional\n security to your encryption operation. If you specify an EncryptionContext when\n encrypting data, you must specify the same encryption context (a case-sensitive exact match)\n when decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the Key Management Service Developer Guide.

\n

If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The\n algorithm must be compatible with the KMS key type.

\n \n

When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of KMS key and the\n encryption algorithm that you choose.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

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

Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or\n asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT.

\n

You can use this operation to encrypt small amounts of arbitrary data, such as a personal identifier or\n database password, or other sensitive information. You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

If you use a symmetric encryption KMS key, you can use an encryption context to add additional\n security to your encryption operation. If you specify an EncryptionContext when\n encrypting data, you must specify the same encryption context (a case-sensitive exact match)\n when decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the Key Management Service Developer Guide.

\n

If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The\n algorithm must be compatible with the KMS key type.

\n \n

When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of KMS key and the\n encryption algorithm that you choose.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EncryptRequest": { @@ -1643,7 +1680,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the KMS key to use in the encryption operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Identifies the KMS key to use in the encryption operation. The KMS key must have a\n KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of\n a KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1657,7 +1694,7 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used to encrypt the data.\n An encryption context is valid only for cryptographic operations with a symmetric KMS key. The standard asymmetric encryption algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used to encrypt the data.\n An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "GrantTokens": { @@ -1669,7 +1706,7 @@ "EncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.\n The algorithm must be compatible with the KMS key that you specify.

\n

This parameter is required only for asymmetric KMS keys. The default value,\n SYMMETRIC_DEFAULT, is the algorithm used for symmetric KMS keys. If you are\n using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.\n The algorithm must be compatible with the KMS key that you specify.

\n

This parameter is required only for asymmetric KMS keys. The default value,\n SYMMETRIC_DEFAULT, is the algorithm used for symmetric encryption KMS keys. If you are\n using an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

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

Generates a unique symmetric data key for client-side encryption. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a KMS key that you specify.\n You can use the plaintext key to encrypt your data outside of KMS and store the encrypted\n data key with the encrypted data.

\n\n

\n GenerateDataKey returns a unique data key for each request. The bytes in the\n plaintext key are not related to the caller or the KMS key.

\n\n

To generate a data key, specify the symmetric KMS key that will be used to encrypt the\n data key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your\n KMS key, use the DescribeKey operation. You must also specify the length of\n the data key. Use either the KeySpec or NumberOfBytes parameters\n (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n How to use your data\n key\n

\n

We recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n Amazon Web Services Encryption SDK, the\n Amazon DynamoDB Encryption Client,\n or Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

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

Returns a unique symmetric data key for use outside of KMS. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS\n key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS\n key. You can use the plaintext key to encrypt your data outside of KMS and store the\n encrypted data key with the encrypted data.

\n\n

To generate a data key, specify the symmetric encryption KMS key that will be used to\n encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the\n type of your KMS key, use the DescribeKey operation. You must also specify\n the length of the data key. Use either the KeySpec or NumberOfBytes\n parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec\n parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n How to use your data\n key\n

\n

We recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n Amazon Web Services Encryption SDK, the\n Amazon DynamoDB Encryption Client,\n or Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPair": { @@ -1848,7 +1885,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The GenerateDataKeyPair\n operation returns a plaintext public key, a plaintext private key, and a copy of the private\n key that is encrypted under the symmetric KMS key you specify. You can use the data key pair\n to perform asymmetric cryptography and implement digital signatures outside of KMS.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric KMS key to encrypt the private\n key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key\n store. To get the type and origin of your KMS key, use the DescribeKey\n operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are not related to the caller or the KMS key that is used to encrypt the\n private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280. The private key is a\n DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

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

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key, a plaintext private key, and a copy of the private key that is\n encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to\n perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes\n in the keys are random; they not related to the caller or to the KMS key that is used to encrypt the\n private key.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are random; they are not related to the caller or the KMS key that is used to encrypt the\n private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280. The private key is a\n DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC 5958.

\n\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairRequest": { @@ -1857,13 +1894,13 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the symmetric KMS key that encrypts the private key in the data key pair. You\n cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and\n origin of your KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Specifies the symmetric encryption KMS key that encrypts the private key in the data key\n pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the\n type and origin of your KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1900,7 +1937,7 @@ "PublicKey": { "target": "com.amazonaws.kms#PublicKeyType", "traits": { - "smithy.api#documentation": "

The public key (in plaintext).

" + "smithy.api#documentation": "

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "KeyId": { @@ -1955,7 +1992,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The\n GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key\n and a copy of the private key that is encrypted under the symmetric KMS key you specify.\n Unlike GenerateDataKeyPair, this operation does not return a plaintext\n private key.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

To generate a data key pair, you must specify a symmetric KMS key to encrypt the private\n key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key\n store. To get the type and origin of your KMS key, use the DescribeKey\n operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or KMS key that is used to encrypt\n the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key\n policy)

\n

\n Related operations:\n

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

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns\n a plaintext public key and a copy of the private key that is encrypted under the symmetric\n encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation\n does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller\n or to the KMS key that is used to encrypt the private key.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt\n the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for\n either encryption or signing, but not both. However, KMS cannot enforce any restrictions on\n the use of data key pairs outside of KMS.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or KMS key that is used to encrypt\n the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280.

\n\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key\n policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairWithoutPlaintextRequest": { @@ -1964,13 +2001,13 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the KMS key that encrypts the private key in the data key pair. You must specify\n a symmetric KMS key. You cannot use an asymmetric KMS key or a KMS key in a custom key store.\n To get the type and origin of your KMS key, use the DescribeKey operation.\n

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Specifies the symmetric encryption KMS key that encrypts the private key in the data key\n pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the\n type and origin of your KMS key, use the DescribeKey operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -2001,7 +2038,7 @@ "PublicKey": { "target": "com.amazonaws.kms#PublicKeyType", "traits": { - "smithy.api#documentation": "

The public key (in plaintext).

" + "smithy.api#documentation": "

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "KeyId": { @@ -2024,14 +2061,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the symmetric KMS key that encrypts the data key.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify\n an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your\n KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "NumberOfBytes": { @@ -2112,7 +2149,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique symmetric data key. This operation returns a data key that is encrypted\n under a KMS key that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext\n operations.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the\n data key. This operation is useful for systems that need to encrypt data at some point, but\n not immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.

\n

It's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.

\n

\n GenerateDataKeyWithoutPlaintext returns a unique data key for each request.\n The bytes in the keys are not related to the caller or KMS key that is used to encrypt the\n private key.

\n\n

To generate a data key, you must specify the symmetric KMS key that is used to encrypt the\n data key. You cannot use an asymmetric KMS key to generate a data key. To get the type of your\n KMS key, use the DescribeKey operation.

\n\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key\n policy)

\n

\n Related operations:\n

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

Returns a unique symmetric data key for use outside of KMS. This operation returns a\n data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in\n the key are random; they are not related to the caller or to the KMS key.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that it does not return a plaintext copy of the\n data key.

\n

This operation is useful for systems that need to encrypt data at some point, but not\n immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key. It's also useful in distributed systems with\n different levels of trust. For example, you might store encrypted data in containers. One\n component of your system creates new containers and stores an encrypted data key with each\n container. Then, a different component puts the data into the containers. That component first\n decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data\n into the container, and then destroys the plaintext data key. In this system, the component\n that creates the containers never sees the plaintext data key.

\n

To request an asymmetric data key pair, use the GenerateDataKeyPair or\n GenerateDataKeyPairWithoutPlaintext operations.

\n\n

To generate a data key, you must specify the symmetric encryption KMS key that is used to\n encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the\n type of your KMS key, use the DescribeKey operation.

\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use an optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key\n policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyWithoutPlaintextRequest": { @@ -2121,14 +2158,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric KMS key that encrypts the data key.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify\n an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your\n KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "KeySpec": { @@ -2168,6 +2205,96 @@ } } }, + "com.amazonaws.kms#GenerateMac": { + "type": "operation", + "input": { + "target": "com.amazonaws.kms#GenerateMacRequest" + }, + "output": { + "target": "com.amazonaws.kms#GenerateMacResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kms#DisabledException" + }, + { + "target": "com.amazonaws.kms#InvalidGrantTokenException" + }, + { + "target": "com.amazonaws.kms#InvalidKeyUsageException" + }, + { + "target": "com.amazonaws.kms#KeyUnavailableException" + }, + { + "target": "com.amazonaws.kms#KMSInternalException" + }, + { + "target": "com.amazonaws.kms#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.kms#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS\n key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the\n message and the key as described in RFC 2104.

\n

You can use the HMAC that this operation generates with the VerifyMac\n operation to demonstrate that the original message has not changed. Also, because a secret key\n is used to create the hash, you can verify that the party that generated the hash has the\n required secret key. This operation is part of KMS support for HMAC KMS keys.\n For details, see HMAC keys in KMS in the \n Key Management Service Developer Guide\n .

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:GenerateMac (key policy)

\n

\n Related operations: VerifyMac\n

" + } + }, + "com.amazonaws.kms#GenerateMacRequest": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kms#PlaintextType", + "traits": { + "smithy.api#documentation": "

The message to be hashed. Specify a message of up to 4,096 bytes.

\n

\n GenerateMac and VerifyMac do not provide special handling\n for message digests. If you generate an HMAC for a hash digest of a message, you must verify\n the HMAC of the same hash digest.

", + "smithy.api#required": {} + } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

\n

To identify an HMAC KMS key, use the DescribeKey operation and see the\n KeySpec field in the response.

", + "smithy.api#required": {} + } + }, + "MacAlgorithm": { + "target": "com.amazonaws.kms#MacAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The MAC algorithm used in the operation.

\n

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC\n algorithms that your HMAC KMS key supports, use the DescribeKey operation\n and see the MacAlgorithms field in the DescribeKey response.

", + "smithy.api#required": {} + } + }, + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", + "traits": { + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" + } + } + } + }, + "com.amazonaws.kms#GenerateMacResponse": { + "type": "structure", + "members": { + "Mac": { + "target": "com.amazonaws.kms#CiphertextType", + "traits": { + "smithy.api#documentation": "

The hash-based message authentication code (HMAC) for the given message, key, and MAC\n algorithm.

" + } + }, + "MacAlgorithm": { + "target": "com.amazonaws.kms#MacAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The MAC algorithm that was used to generate the HMAC.

" + } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The HMAC KMS key used in the operation.

" + } + } + } + }, "com.amazonaws.kms#GenerateRandom": { "type": "operation", "input": { @@ -2310,7 +2437,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these KMS keys is always\n false.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

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

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these KMS keys is always\n false.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetKeyRotationStatusRequest": { @@ -2365,7 +2492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the items you need to import key material into a symmetric, customer managed KMS\n key. For more information about importing key material into KMS, see Importing Key Material\n in the Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric KMS key into which you will import key\n material. This KMS key's Origin must be EXTERNAL. You must also\n specify the wrapping algorithm and type of wrapping key (public key) that you will use to\n encrypt the key material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

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

Returns the items you need to import key material into a symmetric encryption KMS key. For\n more information about importing key material into KMS, see Importing key material in the\n Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric encryption KMS key into which you will import\n key material. This KMS key's Origin must be EXTERNAL. You must also\n specify the wrapping algorithm and type of wrapping key (public key) that you will use to\n encrypt the key material. You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetParametersForImportRequest": { @@ -2374,7 +2501,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric KMS key into which you will import key material. The\n Origin of the KMS key must be EXTERNAL.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

The identifier of the symmetric encryption KMS key into which you will import key material. The\n Origin of the KMS key must be EXTERNAL.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric\n KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey\n permission can download the public key of an asymmetric KMS key. You can share the public key\n to allow others to encrypt messages and verify signatures outside of KMS.\n For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric KMS key. When you use the\n public key within KMS, you benefit from the authentication, authorization, and logging that\n are part of every KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of KMS. For details, see Special\n Considerations for Downloading Public Keys.

\n

To help you use the public key safely outside of KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use:\n Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" + "smithy.api#documentation": "

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric\n KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey\n permission can download the public key of an asymmetric KMS key. You can share the public key\n to allow others to encrypt messages and verify signatures outside of KMS.\n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric KMS key. When you use the\n public key within KMS, you benefit from the authentication, authorization, and logging that\n are part of every KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of KMS. For details, see Special\n Considerations for Downloading Public Keys.

\n

To help you use the public key safely outside of KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use:\n Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" } }, "com.amazonaws.kms#GetPublicKeyRequest": { @@ -2552,7 +2679,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use this structure to allow cryptographic operations in the grant only when the operation request\n includes the specified encryption context.

\n

KMS applies the grant constraints only to cryptographic operations that support an\n encryption context, that is, all cryptographic operations with a symmetric KMS key. Grant\n constraints are not applied to operations that do not support an encryption context, such as\n cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant.

\n \n

In a cryptographic operation, the encryption context in the decryption operation must be\n an exact, case-sensitive match for the keys and values in the encryption context of the\n encryption operation. Only the order of the pairs can vary.

\n

However, in a grant constraint, the key in each key-value pair is not case sensitive,\n but the value is case sensitive.

\n

To avoid confusion, do not use multiple encryption context pairs that differ only by\n case. To require a fully case-sensitive encryption context, use the\n kms:EncryptionContext: and kms:EncryptionContextKeys conditions\n in an IAM or key policy. For details, see kms:EncryptionContext: in the \n Key Management Service Developer Guide\n .

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

Use this structure to allow cryptographic operations in the grant only when the operation request\n includes the specified encryption context.

\n

KMS applies the grant constraints only to cryptographic operations that support an\n encryption context, that is, all cryptographic operations with a symmetric encryption KMS key. Grant\n constraints are not applied to operations that do not support an encryption context, such as\n cryptographic operations with HMAC KMS keys or asymmetric KMS keys, and management operations, such as DescribeKey or RetireGrant.

\n \n

In a cryptographic operation, the encryption context in the decryption operation must be\n an exact, case-sensitive match for the keys and values in the encryption context of the\n encryption operation. Only the order of the pairs can vary.

\n

However, in a grant constraint, the key in each key-value pair is not case sensitive,\n but the value is case sensitive.

\n

To avoid confusion, do not use multiple encryption context pairs that differ only by\n case. To require a fully case-sensitive encryption context, use the\n kms:EncryptionContext: and kms:EncryptionContextKeys conditions\n in an IAM or key policy. For details, see kms:EncryptionContext: in the \n Key Management Service Developer Guide\n .

\n " } }, "com.amazonaws.kms#GrantIdType": { @@ -2701,6 +2828,14 @@ { "value": "GenerateDataKeyPairWithoutPlaintext", "name": "GenerateDataKeyPairWithoutPlaintext" + }, + { + "value": "GenerateMac", + "name": "GenerateMac" + }, + { + "value": "VerifyMac", + "name": "VerifyMac" } ] } @@ -2773,7 +2908,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports key material into an existing symmetric KMS KMS key that was created without key\n material. After you successfully import key material into a KMS key, you can reimport\n the same key material into that KMS key, but you cannot import different key\n material.

\n

You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material\n and then importing key material, see Importing Key Material in the\n Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the KMS key changes from\n PendingImport to Enabled, and you can use the KMS key.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key\n and repeat the import procedure. For help, see How To Import Key\n Material in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

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

Imports key material into an existing symmetric encryption KMS key that was created\n without key material. After you successfully import key material into a KMS key, you can\n reimport the same key material into that KMS key, but you cannot import different\n key material.

\n

You cannot perform this operation on an asymmetric KMS key, an HMAC KMS key, or on any KMS key in a different Amazon Web Services account. For more information about\n creating KMS keys with no key material and then importing key material, see Importing Key Material\n in the Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the KMS key changes from\n PendingImport to Enabled, and you can use the KMS key.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key\n and repeat the import procedure. For help, see How To Import Key\n Material in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ImportKeyMaterialRequest": { @@ -2782,7 +2917,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric KMS key that receives the imported key material. The KMS\n key's Origin must be EXTERNAL. This must be the same KMS key\n specified in the KeyID parameter of the corresponding GetParametersForImport request.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

The identifier of the symmetric encryption KMS key that receives the imported key\n material. This must be the same KMS key specified in the KeyID parameter of the\n corresponding GetParametersForImport request. The Origin of the\n KMS key must be EXTERNAL. You cannot perform this operation on an asymmetric KMS\n key, an HMAC KMS key, a KMS key in a custom key store, or on a KMS key in a different\n Amazon Web Services account

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -2830,7 +2965,7 @@ "code": "IncorrectKeyException", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The request was rejected because the specified KMS key cannot decrypt the data. The\n KeyId in a Decrypt request and the SourceKeyId\n in a ReEncrypt request must identify the same KMS key that was used to\n encrypt the ciphertext.

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

The request was rejected because the specified KMS key cannot decrypt the data. The\n KeyId in a Decrypt request and the SourceKeyId\n in a ReEncrypt request must identify the same KMS key that was used to\n encrypt the ciphertext.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2983,7 +3118,7 @@ "code": "InvalidKeyUsage", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The request was rejected for one of the following reasons:

\n \n

For encrypting, decrypting, re-encrypting, and generating data keys, the\n KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the\n KeyUsage must be SIGN_VERIFY. To find the KeyUsage of\n a KMS key, use the DescribeKey operation.

\n

To find the encryption or signing algorithms supported for a particular KMS key, use the\n DescribeKey operation.

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

The request was rejected for one of the following reasons:

\n \n

For encrypting, decrypting, re-encrypting, and generating data keys, the\n KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying\n messages, the KeyUsage must be SIGN_VERIFY. For generating and\n verifying message authentication codes (MACs), the KeyUsage must be\n GENERATE_VERIFY_MAC. To find the KeyUsage of a KMS key, use the\n DescribeKey operation.

\n

To find the encryption or signing algorithms supported for a particular KMS key, use the\n DescribeKey operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3022,6 +3157,23 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.kms#KMSInvalidMacException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.kms#ErrorMessageType" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSInvalidMac", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the HMAC verification failed. HMAC verification\n fails when the HMAC computed by using the specified message, HMAC KMS key, and MAC algorithm does not match the HMAC specified in the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.kms#KMSInvalidSignatureException": { "type": "structure", "members": { @@ -3051,7 +3203,7 @@ "code": "KMSInvalidStateException", "httpResponseCode": 409 }, - "smithy.api#documentation": "

The request was rejected because the state of the specified resource is not valid for this\n request.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS\n key in the \n Key Management Service Developer Guide\n .

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

The request was rejected because the state of the specified resource is not valid for this\n request.

\n

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the \n Key Management Service Developer Guide\n .

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -3155,7 +3307,7 @@ "KeyState": { "target": "com.amazonaws.kms#KeyState", "traits": { - "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS\n key in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

" } }, "DeletionDate": { @@ -3230,7 +3382,7 @@ "MultiRegion": { "target": "com.amazonaws.kms#NullableBooleanType", "traits": { - "smithy.api#documentation": "

Indicates whether the KMS key is a multi-Region (True) or regional\n (False) key. This value is True for multi-Region primary and\n replica keys and False for regional KMS keys.

\n

For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Indicates whether the KMS key is a multi-Region (True) or regional\n (False) key. This value is True for multi-Region primary and\n replica keys and False for regional KMS keys.

\n

For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

" } }, "MultiRegionConfiguration": { @@ -3244,6 +3396,12 @@ "traits": { "smithy.api#documentation": "

The waiting period before the primary key in a multi-Region key is deleted. This waiting\n period begins when the last of its replica keys is deleted. This value is present only when\n the KeyState of the KMS key is PendingReplicaDeletion. That\n indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for\n deletion, and it still has existing replica keys.

\n

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its\n deletion date is displayed in the DeletionDate field. However, when the primary\n key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until\n all of its replica keys are deleted. This value displays that waiting period. When the last\n replica key in the multi-Region key is deleted, the KeyState of the scheduled\n primary key changes from PendingReplicaDeletion to PendingDeletion\n and the deletion date appears in the DeletionDate field.

" } + }, + "MacAlgorithms": { + "target": "com.amazonaws.kms#MacAlgorithmSpecList", + "traits": { + "smithy.api#documentation": "

The message authentication code (MAC) algorithm that the HMAC KMS key supports.

\n

This value is present only when the KeyUsage of the KMS key is\n GENERATE_VERIFY_MAC.

" + } } }, "traits": { @@ -3285,6 +3443,22 @@ { "value": "SYMMETRIC_DEFAULT", "name": "SYMMETRIC_DEFAULT" + }, + { + "value": "HMAC_224", + "name": "HMAC_224" + }, + { + "value": "HMAC_256", + "name": "HMAC_256" + }, + { + "value": "HMAC_384", + "name": "HMAC_384" + }, + { + "value": "HMAC_512", + "name": "HMAC_512" } ] } @@ -3366,6 +3540,10 @@ { "value": "ENCRYPT_DECRYPT", "name": "ENCRYPT_DECRYPT" + }, + { + "value": "GENERATE_VERIFY_MAC", + "name": "GENERATE_VERIFY_MAC" } ] } @@ -3510,7 +3688,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all grants for the specified KMS key.

\n

You must specify the KMS key in all requests. You can filter the grant list by grant ID or\n grantee principal.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n \n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:ListGrants (key policy)

\n

\n Related operations:\n

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

Gets a list of all grants for the specified KMS key.

\n

You must specify the KMS key in all requests. You can filter the grant list by grant ID or\n grantee principal.

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n \n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:ListGrants (key policy)

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3785,7 +3963,7 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

A list of tags. Each tag consists of a tag key and a tag value.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

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

A list of tags. Each tag consists of a tag key and a tag value.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n " } }, "NextMarker": { @@ -3828,7 +4006,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about all grants in the Amazon Web Services account and Region that have the\n specified retiring principal.

\n

You can specify any principal in your Amazon Web Services account. The grants that are returned include\n grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this\n operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: You must specify a principal in your\n Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n Amazon Web Services account other than your own.

\n\n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your\n Amazon Web Services account.

\n

\n Related operations:\n

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

Returns information about all grants in the Amazon Web Services account and Region that have the\n specified retiring principal.

\n

You can specify any principal in your Amazon Web Services account. The grants that are returned include\n grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this\n operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: You must specify a principal in your\n Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n Amazon Web Services account other than your own.

\n\n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your\n Amazon Web Services account.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ListRetirableGrantsRequest": { @@ -3855,6 +4033,35 @@ } } }, + "com.amazonaws.kms#MacAlgorithmSpec": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HMAC_SHA_224", + "name": "HMAC_SHA_224" + }, + { + "value": "HMAC_SHA_256", + "name": "HMAC_SHA_256" + }, + { + "value": "HMAC_SHA_384", + "name": "HMAC_SHA_384" + }, + { + "value": "HMAC_SHA_512", + "name": "HMAC_SHA_512" + } + ] + } + }, + "com.amazonaws.kms#MacAlgorithmSpecList": { + "type": "list", + "member": { + "target": "com.amazonaws.kms#MacAlgorithmSpec" + } + }, "com.amazonaws.kms#MalformedPolicyDocumentException": { "type": "structure", "members": { @@ -4086,6 +4293,9 @@ "input": { "target": "com.amazonaws.kms#PutKeyPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -4189,7 +4399,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this\n operation to change the KMS key under which data is encrypted, such as when you manually\n rotate a KMS key or change the KMS key that protects a ciphertext. You can also use\n it to reencrypt ciphertext under the same KMS key, such as to change the encryption\n context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an\n KMS KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric KMS key\n outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as\n the Amazon Web Services Encryption SDK or\n Amazon S3\n client-side encryption. These libraries return a ciphertext format that is\n incompatible with KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both\n KMS keys can be in a different account than the caller. To specify a KMS key in a different\n account, you must use its key ARN or alias ARN.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a KMS key, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a KMS key. But you\n must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n\n

\n Related operations:\n

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

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this\n operation to change the KMS key under which data is encrypted, such as when you manually\n rotate a KMS key or change the KMS key that protects a ciphertext. You can also use\n it to reencrypt ciphertext under the same KMS key, such as to change the encryption\n context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using a\n KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric KMS key\n outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as\n the Amazon Web Services Encryption SDK or\n Amazon S3\n client-side encryption. These libraries return a ciphertext format that is\n incompatible with KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes.\n The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both\n KMS keys can be in a different account than the caller. To specify a KMS key in a different\n account, you must use its key ARN or alias ARN.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a KMS key, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a KMS key. But you\n must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ReEncryptRequest": { @@ -4205,38 +4415,38 @@ "SourceEncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context to use to decrypt the ciphertext. Enter the same\n encryption context that was used to encrypt the ciphertext.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context to use to decrypt the ciphertext. Enter the same\n encryption context that was used to encrypt the ciphertext.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "SourceKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the KMS key that KMS will use to decrypt the ciphertext before it is\n re-encrypted. Enter a key ID of the KMS key that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to\n the symmetric ciphertext blob. However, it is always recommended as a best practice. This\n practice ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the KMS key that KMS will use to decrypt the ciphertext before it is\n re-encrypted.

\n

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt operation throws an IncorrectKeyException.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that\n it adds to the symmetric ciphertext blob. However, it is always recommended as a best\n practice. This practice ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "DestinationKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the KMS key that is used to reencrypt the data. Specify a\n symmetric or asymmetric KMS key with a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the\n DescribeKey operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

A unique identifier for the KMS key that is used to reencrypt the data. Specify a\n symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the\n DescribeKey operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "DestinationEncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies that encryption context to use when the reencrypting the data.

\n

A destination encryption context is valid only when the destination KMS key is a symmetric\n KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for\n metadata.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies that encryption context to use when the reencrypting the data.

\n

A destination encryption context is valid only when the destination KMS key is a symmetric encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for\n metadata.

\n

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. \nWhen you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported\nonly on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

\n

For more information, see\nEncryption context in the Key Management Service Developer Guide.

" } }, "SourceEncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it\n is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm\n used for symmetric KMS keys.

\n

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a\n different algorithm, the decrypt attempt fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it\n is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm\n used for symmetric encryption KMS keys.

\n

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a\n different algorithm, the decrypt attempt fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS\n key.

" } }, "DestinationEncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has\n decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption\n algorithm used for symmetric KMS keys.

\n

This parameter is required only when the destination KMS key is an asymmetric KMS\n key.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has\n decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption\n algorithm used for symmetric encryption KMS keys.

\n

This parameter is required only when the destination KMS key is an asymmetric KMS\n key.

" } }, "GrantTokens": { @@ -4333,7 +4543,7 @@ } ], "traits": { - "smithy.api#documentation": "

Replicates a multi-Region key into the specified Region. This operation creates a\n multi-Region replica key based on a multi-Region primary key in a different Region of the same\n Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a\n different Region. To create a multi-Region primary key, use the CreateKey\n operation.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

A replica key is a fully-functional KMS key that can be used\n independently of its primary and peer replica keys. A primary key and its replica keys share\n properties that make them interoperable. They have the same key ID and key material. They also\n have the same key\n spec, key\n usage, key\n material origin, and automatic key rotation status. KMS automatically synchronizes these shared\n properties among related multi-Region keys. All other properties of a replica key can differ,\n including its key\n policy, tags, aliases, and key\n state. KMS pricing and quotas for KMS keys apply to each primary key and replica\n key.

\n

When this operation completes, the new replica key has a transient key state of\n Creating. This key state changes to Enabled (or\n PendingImport) after a few seconds when the process of creating the new replica\n key is complete. While the key state is Creating, you can manage key, but you\n cannot yet use it in cryptographic operations. If you are creating and using the replica key\n programmatically, retry on KMSInvalidStateException or call\n DescribeKey to check its KeyState value before using it. For\n details about the Creating key state, see Key state: Effect on your KMS key in the\n Key Management Service Developer Guide.

\n

The CloudTrail log of a ReplicateKey operation records a\n ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

\n

If you replicate a multi-Region primary key with imported key material, the replica key is\n created with no key material. You must import the same key material that you imported into the\n primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide.

\n

To convert a replica key to a primary key, use the UpdatePrimaryRegion\n operation.

\n \n

\n ReplicateKey uses different default values for the KeyPolicy\n and Tags parameters than those used in the KMS console. For details, see the\n parameter descriptions.

\n \n

\n Cross-account use: No. You cannot use this operation to\n create a replica key in a different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

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

Replicates a multi-Region key into the specified Region. This operation creates a\n multi-Region replica key based on a multi-Region primary key in a different Region of the same\n Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a\n different Region. To create a multi-Region primary key, use the CreateKey\n operation.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

A replica key is a fully-functional KMS key that can be used\n independently of its primary and peer replica keys. A primary key and its replica keys share\n properties that make them interoperable. They have the same key ID and key material. They also\n have the same key\n spec, key\n usage, key\n material origin, and automatic key rotation status. KMS automatically synchronizes these shared\n properties among related multi-Region keys. All other properties of a replica key can differ,\n including its key\n policy, tags, aliases, and Key states of KMS keys. KMS pricing and quotas for KMS keys apply to each primary key and replica\n key.

\n

When this operation completes, the new replica key has a transient key state of\n Creating. This key state changes to Enabled (or\n PendingImport) after a few seconds when the process of creating the new replica\n key is complete. While the key state is Creating, you can manage key, but you\n cannot yet use it in cryptographic operations. If you are creating and using the replica key\n programmatically, retry on KMSInvalidStateException or call\n DescribeKey to check its KeyState value before using it. For\n details about the Creating key state, see Key states of KMS keys in the\n Key Management Service Developer Guide.

\n

You cannot create more than one replica of a primary key in any Region. If the Region\n already includes a replica of the key you're trying to replicate, ReplicateKey\n returns an AlreadyExistsException error. If the key state of the existing replica\n is PendingDeletion, you can cancel the scheduled key deletion (CancelKeyDeletion) or wait for the key to be deleted. The new replica key you create\n will have the same shared properties as the original replica key.

\n

The CloudTrail log of a ReplicateKey operation records a\n ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

\n

If you replicate a multi-Region primary key with imported key material, the replica key is\n created with no key material. You must import the same key material that you imported into the\n primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide.

\n

To convert a replica key to a primary key, use the UpdatePrimaryRegion\n operation.

\n \n

\n ReplicateKey uses different default values for the KeyPolicy\n and Tags parameters than those used in the KMS console. For details, see the\n parameter descriptions.

\n \n

\n Cross-account use: No. You cannot use this operation to\n create a replica key in a different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ReplicateKeyRequest": { @@ -4349,7 +4559,7 @@ "ReplicaRegion": { "target": "com.amazonaws.kms#RegionType", "traits": { - "smithy.api#documentation": "

The Region ID of the Amazon Web Services Region for this replica key.

\n

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a\n list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the\n Amazon Web Services General Reference.

\n

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of\n that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica\n Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the\n Region.

\n

For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the\n Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a\n Region and Disabling a Region in the\n Amazon Web Services General Reference.

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

The Region ID of the Amazon Web Services Region for this replica key.

\n

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a\n list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the\n Amazon Web Services General Reference.

\n \n

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to replicate an HMAC\n KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the\n ReplicateKey operation returns an UnsupportedOperationException.\n For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide.

\n \n

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of\n that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica\n Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the\n Region. For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the\n Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a\n Region and Disabling a Region in the\n Amazon Web Services General Reference.

", "smithy.api#required": {} } }, @@ -4374,7 +4584,7 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it\n is created. To tag an existing KMS key, use the TagResource\n operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Tags are not a shared property of multi-Region keys. You can specify the same tags or\n different tags for each key in a set of related multi-Region keys. KMS does not synchronize\n this property.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag\n value, KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" + "smithy.api#documentation": "

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it\n is created. To tag an existing KMS key, use the TagResource\n operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Tags are not a shared property of multi-Region keys. You can specify the same tags or\n different tags for each key in a set of related multi-Region keys. KMS does not synchronize\n this property.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag\n value, KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" } } } @@ -4385,7 +4595,7 @@ "ReplicaKeyMetadata": { "target": "com.amazonaws.kms#KeyMetadata", "traits": { - "smithy.api#documentation": "

Displays details about the new replica key, including its Amazon Resource Name (key ARN) and\n key state. It also\n includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

" + "smithy.api#documentation": "

Displays details about the new replica key, including its Amazon Resource Name (key ARN) and\n Key states of KMS keys. It also\n includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

" } }, "ReplicaPolicy": { @@ -4407,6 +4617,9 @@ "input": { "target": "com.amazonaws.kms#RetireGrantRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -4431,7 +4644,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To\n identify the grant to retire, use a grant token, or both the grant ID and a\n key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation\n returns both values.

\n

This operation can be called by the retiring principal for a grant,\n by the grantee principal if the grant allows the RetireGrant\n operation, and by the Amazon Web Services account (root user) in which the grant is created. It can also be\n called by principals to whom permission for retiring a grant is delegated. For details, see\n Retiring and\n revoking grants in the Key Management Service Developer Guide.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. You can retire a grant on a KMS\n key in a different Amazon Web Services account.

\n

\n Required permissions::Permission to retire a grant is\n determined primarily by the grant. For details, see Retiring and revoking grants in\n the Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To\n identify the grant to retire, use a grant token, or both the grant ID and a\n key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation\n returns both values.

\n

This operation can be called by the retiring principal for a grant,\n by the grantee principal if the grant allows the RetireGrant\n operation, and by the Amazon Web Services account in which the grant is created. It can also be called by\n principals to whom permission for retiring a grant is delegated. For details, see Retiring and revoking\n grants in the Key Management Service Developer Guide.

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. You can retire a grant on a KMS\n key in a different Amazon Web Services account.

\n

\n Required permissions::Permission to retire a grant is\n determined primarily by the grant. For details, see Retiring and revoking grants in\n the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RetireGrantRequest": { @@ -4462,6 +4675,9 @@ "input": { "target": "com.amazonaws.kms#RevokeGrantRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -4483,7 +4699,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified grant. You revoke a grant to terminate the permissions that the\n grant allows. For more information, see Retiring and revoking grants in\n the \n Key Management Service Developer Guide\n .

\n

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in\n the \n Key Management Service Developer Guide\n .

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:RevokeGrant (key policy).

\n

\n Related operations:\n

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

Deletes the specified grant. You revoke a grant to terminate the permissions that the\n grant allows. For more information, see Retiring and revoking grants in\n the \n Key Management Service Developer Guide\n .

\n

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in\n the \n Key Management Service Developer Guide\n .

\n

For detailed information about grants, including grant terminology, see Grants in KMS in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:RevokeGrant (key policy).

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RevokeGrantRequest": { @@ -4531,7 +4747,7 @@ } ], "traits": { - "smithy.api#documentation": "

Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30\n days, but you can specify a waiting period of 7-30 days. When this operation is successful,\n the key state of the KMS key changes to PendingDeletion and the key can't be used\n in any cryptographic operations. It remains in this state for the duration of the waiting\n period. Before the waiting period ends, you can use CancelKeyDeletion to\n cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,\n its key material, and all KMS data associated with it, including all aliases that refer to\n it.

\n \n

Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key\n is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only\n exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting\n it, use DisableKey.

\n \n

If you schedule deletion of a KMS key from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the KMS key from KMS. Then KMS makes a\n best effort to delete the key material from the associated CloudHSM cluster. However, you might\n need to manually delete the orphaned key\n material from the cluster and its backups.

\n

You can schedule the deletion of a multi-Region primary key and its replica keys at any\n time. However, KMS will not delete a multi-Region primary key with existing replica keys. If\n you schedule the deletion of a primary key with replicas, its key state changes to\n PendingReplicaDeletion and it cannot be replicated or used in cryptographic\n operations. This status can continue indefinitely. When the last of its replicas keys is\n deleted (not just scheduled), the key state of the primary key changes to\n PendingDeletion and its waiting period (PendingWindowInDays)\n begins. For details, see Deleting multi-Region keys in the\n Key Management Service Developer Guide.

\n

For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n\n

\n Required permissions: kms:ScheduleKeyDeletion (key\n policy)

\n

\n Related operations\n

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

Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30\n days, but you can specify a waiting period of 7-30 days. When this operation is successful,\n the key state of the KMS key changes to PendingDeletion and the key can't be used\n in any cryptographic operations. It remains in this state for the duration of the waiting\n period. Before the waiting period ends, you can use CancelKeyDeletion to\n cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,\n its key material, and all KMS data associated with it, including all aliases that refer to\n it.

\n \n

Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key\n is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only\n exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting\n it, use DisableKey.

\n \n

If you schedule deletion of a KMS key from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the KMS key from KMS. Then KMS makes a\n best effort to delete the key material from the associated CloudHSM cluster. However, you might\n need to manually delete the orphaned key\n material from the cluster and its backups.

\n

You can schedule the deletion of a multi-Region primary key and its replica keys at any\n time. However, KMS will not delete a multi-Region primary key with existing replica keys. If\n you schedule the deletion of a primary key with replicas, its key state changes to\n PendingReplicaDeletion and it cannot be replicated or used in cryptographic\n operations. This status can continue indefinitely. When the last of its replicas keys is\n deleted (not just scheduled), the key state of the primary key changes to\n PendingDeletion and its waiting period (PendingWindowInDays)\n begins. For details, see Deleting multi-Region keys in the\n Key Management Service Developer Guide.

\n

For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n\n

\n Required permissions: kms:ScheduleKeyDeletion (key\n policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ScheduleKeyDeletionRequest": { @@ -4570,7 +4786,7 @@ "KeyState": { "target": "com.amazonaws.kms#KeyState", "traits": { - "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS\n key in the Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

" } }, "PendingWindowInDays": { @@ -4616,7 +4832,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n KMS key. To verify the signature, use the Verify operation, or use the\n public key in the same asymmetric KMS key outside of KMS. For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized\n user) uses their private key to sign a message. Anyone with the public key can verify that the\n message was signed with that particular private key and that the message hasn't changed since\n it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the KMS key and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of KMS.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" + "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n signing KMS key. To verify the signature, use the Verify operation, or use\n the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized\n user) uses their private key to sign a message. Anyone with the public key can verify that the\n message was signed with that particular private key and that the message hasn't changed since\n it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the KMS key and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of KMS.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" } }, "com.amazonaws.kms#SignRequest": { @@ -4794,6 +5010,9 @@ "input": { "target": "com.amazonaws.kms#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#InvalidArnException" @@ -4815,7 +5034,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or edits tags on a customer managed key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed key, but you cannot\n tag an Amazon Web Services\n managed key, an Amazon Web Services owned key, a custom key\n store, or an alias.

\n

You can also add tags to a KMS key while creating it (CreateKey) or\n replicating it (ReplicateKey).

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

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

Adds or edits tags on a customer managed key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed key, but you cannot\n tag an Amazon Web Services\n managed key, an Amazon Web Services owned key, a custom key\n store, or an alias.

\n

You can also add tags to a KMS key while creating it (CreateKey) or\n replicating it (ReplicateKey).

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#TagResourceRequest": { @@ -4848,6 +5067,24 @@ }, "com.amazonaws.kms#TrentService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "KMS", + "arnNamespace": "kms", + "cloudFormationName": "KMS", + "cloudTrailEventSource": "kms.amazonaws.com", + "endpointPrefix": "kms" + }, + "aws.auth#sigv4": { + "name": "kms" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Key Management Service\n

Key Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a\n convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,\n the SDKs take care of tasks such as signing requests (see below), managing errors, and\n retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to\n download and install them, see Tools for Amazon Web\n Services.

\n \n

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

\n

If you need to use FIPS 140-2 validated cryptographic modules when communicating with\n Amazon Web Services, use the FIPS endpoint in your preferred Amazon Web Services Region. For more information about the\n available FIPS endpoints, see Service endpoints in the Key Management Service topic of the Amazon Web Services General Reference.

\n

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients\n must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral\n Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems\n such as Java 7 and later support these modes.

\n

\n Signing Requests\n

\n

Requests must be signed by using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account (root) access key ID and\n secret key for everyday work with KMS. Instead, use the access key ID and secret access key\n for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary\n security credentials that you can use to sign requests.

\n

All KMS operations require Signature Version 4.

\n

\n Logging API Requests\n

\n

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your\n Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the\n information collected by CloudTrail, you can determine what requests were made to KMS, who made\n the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.

\n

\n Additional Resources\n

\n

For more information about credentials and request signing, see the following:

\n \n

\n Commonly Used API Operations\n

\n

Of the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.

\n ", + "smithy.api#title": "AWS Key Management Service", + "smithy.api#xmlNamespace": { + "uri": "https://trent.amazonaws.com/doc/2014-11-01/" + } + }, "version": "2014-11-01", "operations": [ { @@ -4916,6 +5153,9 @@ { "target": "com.amazonaws.kms#GenerateDataKeyWithoutPlaintext" }, + { + "target": "com.amazonaws.kms#GenerateMac" + }, { "target": "com.amazonaws.kms#GenerateRandom" }, @@ -4993,26 +5233,11 @@ }, { "target": "com.amazonaws.kms#Verify" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "KMS", - "arnNamespace": "kms", - "cloudFormationName": "KMS", - "cloudTrailEventSource": "kms.amazonaws.com", - "endpointPrefix": "kms" - }, - "aws.auth#sigv4": { - "name": "kms" }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Key Management Service\n

Key Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a\n convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,\n the SDKs take care of tasks such as signing requests (see below), managing errors, and\n retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to\n download and install them, see Tools for Amazon Web\n Services.

\n \n

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

\n

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients\n must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral\n Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems\n such as Java 7 and later support these modes.

\n

\n Signing Requests\n

\n

Requests must be signed by using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account (root) access key ID and\n secret key for everyday work with KMS. Instead, use the access key ID and secret access key\n for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary\n security credentials that you can use to sign requests.

\n

All KMS operations require Signature Version 4.

\n

\n Logging API Requests\n

\n

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your\n Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the\n information collected by CloudTrail, you can determine what requests were made to KMS, who made\n the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.

\n

\n Additional Resources\n

\n

For more information about credentials and request signing, see the following:

\n \n

\n Commonly Used API Operations\n

\n

Of the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.

\n ", - "smithy.api#title": "AWS Key Management Service", - "smithy.api#xmlNamespace": { - "uri": "https://trent.amazonaws.com/doc/2014-11-01/" + { + "target": "com.amazonaws.kms#VerifyMac" } - } + ] }, "com.amazonaws.kms#TrustAnchorCertificateType": { "type": "string", @@ -5045,6 +5270,9 @@ "input": { "target": "com.amazonaws.kms#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#InvalidArnException" @@ -5063,7 +5291,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes tags from a customer managed key. To delete a tag,\n specify the tag key and the KMS key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or\n return a response. To confirm that the operation worked, use the ListResourceTags operation.

\n\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

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

Deletes tags from a customer managed key. To delete a tag,\n specify the tag key and the KMS key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or\n return a response. To confirm that the operation worked, use the ListResourceTags operation.

\n\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UntagResourceRequest": { @@ -5090,6 +5318,9 @@ "input": { "target": "com.amazonaws.kms#UpdateAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -5108,7 +5339,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an existing KMS alias with a different KMS key. Each alias is associated with\n only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the\n KMS key must be in the same Amazon Web Services account and Region.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

The current and new KMS key must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a KMS key, you can create, update, and delete the\n aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the\n response from the DescribeKey operation. To get the aliases of all KMS keys\n in the account, use the ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Associates an existing KMS alias with a different KMS key. Each alias is associated with\n only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the\n KMS key must be in the same Amazon Web Services account and Region.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

\n \n

The current and new KMS key must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a KMS key, you can create, update, and delete the\n aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the\n response from the DescribeKey operation. To get the aliases of all KMS keys\n in the account, use the ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the\n Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#UpdateAliasRequest": { @@ -5207,6 +5438,9 @@ "input": { "target": "com.amazonaws.kms#UpdateKeyDescriptionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DependencyTimeoutException" @@ -5225,7 +5459,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

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

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account\n use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UpdateKeyDescriptionRequest": { @@ -5252,6 +5486,9 @@ "input": { "target": "com.amazonaws.kms#UpdatePrimaryRegionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kms#DisabledException" @@ -5273,7 +5510,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the primary key of a multi-Region key.

\n

This operation changes the replica key in the specified Region to a primary key and\n changes the former primary key to a replica key. For example, suppose you have a primary key\n in us-east-1 and a replica key in eu-west-2. If you run\n UpdatePrimaryRegion with a PrimaryRegion value of\n eu-west-2, the primary key is now the key in eu-west-2, and the\n key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

The primary key of a multi-Region key is the source for properties\n that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material\n origin, and automatic\n key rotation. It's the only key that can be replicated. You cannot delete the primary\n key until all replica keys are deleted.

\n

The key ID and primary Region that you specify uniquely identify the replica key that will\n become the primary key. The primary Region must already have a replica key. This operation\n does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica\n key, use the ReplicateKey operation.

\n

You can run this operation while using the affected multi-Region keys in cryptographic\n operations. This operation should not delay, interrupt, or cause failures in cryptographic\n operations.

\n

Even after this operation completes, the process of updating the primary Region might\n still be in progress for a few more seconds. Operations such as DescribeKey might\n display both the old and new primary keys as replicas. The old and new primary keys have a\n transient key state of Updating. The original key state is restored when the\n update is complete. While the key state is Updating, you can use the keys in\n cryptographic operations, but you cannot replicate the new primary key or perform certain\n management operations, such as enabling or disabling these keys. For details about the\n Updating key state, see Key state:\n Effect on your KMS key in the Key Management Service Developer Guide.

\n

This operation does not return any output. To verify that primary key is changed, use the\n DescribeKey operation.

\n

\n Cross-account use: No. You cannot use this operation in a\n different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

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

Changes the primary key of a multi-Region key.

\n

This operation changes the replica key in the specified Region to a primary key and\n changes the former primary key to a replica key. For example, suppose you have a primary key\n in us-east-1 and a replica key in eu-west-2. If you run\n UpdatePrimaryRegion with a PrimaryRegion value of\n eu-west-2, the primary key is now the key in eu-west-2, and the\n key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

\n

The primary key of a multi-Region key is the source for properties\n that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material\n origin, and automatic\n key rotation. It's the only key that can be replicated. You cannot delete the primary\n key until all replica keys are deleted.

\n

The key ID and primary Region that you specify uniquely identify the replica key that will\n become the primary key. The primary Region must already have a replica key. This operation\n does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica\n key, use the ReplicateKey operation.

\n

You can run this operation while using the affected multi-Region keys in cryptographic\n operations. This operation should not delay, interrupt, or cause failures in cryptographic\n operations.

\n

Even after this operation completes, the process of updating the primary Region might\n still be in progress for a few more seconds. Operations such as DescribeKey might\n display both the old and new primary keys as replicas. The old and new primary keys have a\n transient key state of Updating. The original key state is restored when the\n update is complete. While the key state is Updating, you can use the keys in\n cryptographic operations, but you cannot replicate the new primary key or perform certain\n management operations, such as enabling or disabling these keys. For details about the\n Updating key state, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

This operation does not return any output. To verify that primary key is changed, use the\n DescribeKey operation.

\n

\n Cross-account use: No. You cannot use this operation in a\n different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UpdatePrimaryRegionRequest": { @@ -5333,7 +5570,107 @@ } ], "traits": { - "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified KMS\n key and signing algorithm, and the message hasn't changed since it was signed. If the\n signature is verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric KMS key. The\n signature is verified by using the public key in the same asymmetric KMS key.\n For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric KMS key, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the KMS key outside\n of KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric KMS key and then use the public key to verify the signature outside of KMS. The\n advantage of using the Verify operation is that it is performed within KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the KMS key to verify signatures.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" + "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified KMS\n key and signing algorithm, and the message hasn't changed since it was signed. If the\n signature is verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric KMS key. The\n signature is verified by using the public key in the same asymmetric KMS key.\n For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric KMS key, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the KMS key outside\n of KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric KMS key and then use the public key to verify the signature outside of KMS. The\n advantage of using the Verify operation is that it is performed within KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the KMS key to verify signatures.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n\n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" + } + }, + "com.amazonaws.kms#VerifyMac": { + "type": "operation", + "input": { + "target": "com.amazonaws.kms#VerifyMacRequest" + }, + "output": { + "target": "com.amazonaws.kms#VerifyMacResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kms#DisabledException" + }, + { + "target": "com.amazonaws.kms#InvalidGrantTokenException" + }, + { + "target": "com.amazonaws.kms#InvalidKeyUsageException" + }, + { + "target": "com.amazonaws.kms#KeyUnavailableException" + }, + { + "target": "com.amazonaws.kms#KMSInternalException" + }, + { + "target": "com.amazonaws.kms#KMSInvalidMacException" + }, + { + "target": "com.amazonaws.kms#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.kms#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC\n KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using\n the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC\n to the HMAC that you specify. If the HMACs are identical, the verification succeeds;\n otherwise, it fails.

\n \n

Verification indicates that the message hasn't changed since the HMAC was calculated, and\n the specified key was used to generate and verify the HMAC.

\n

This operation is part of KMS support for HMAC KMS keys. For details, see\n HMAC keys in KMS in the Key Management Service Developer Guide.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key states of KMS keys in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:VerifyMac (key policy)

\n

\n Related operations: GenerateMac\n

" + } + }, + "com.amazonaws.kms#VerifyMacRequest": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kms#PlaintextType", + "traits": { + "smithy.api#documentation": "

The message that will be used in the verification. Enter the same message that was used to\n generate the HMAC.

\n

\n GenerateMac and VerifyMac do not provide special handling\n for message digests. If you generated an HMAC for a hash digest of a message, you must verify\n the HMAC for the same hash digest.

", + "smithy.api#required": {} + } + }, + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The KMS key that will be used in the verification.

\n \n

Enter a key ID of the KMS\n key that was used to generate the HMAC. If you identify a different KMS key, the VerifyMac operation fails.

", + "smithy.api#required": {} + } + }, + "MacAlgorithm": { + "target": "com.amazonaws.kms#MacAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.

", + "smithy.api#required": {} + } + }, + "Mac": { + "target": "com.amazonaws.kms#CiphertextType", + "traits": { + "smithy.api#documentation": "

The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.

", + "smithy.api#required": {} + } + }, + "GrantTokens": { + "target": "com.amazonaws.kms#GrantTokenList", + "traits": { + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" + } + } + } + }, + "com.amazonaws.kms#VerifyMacResponse": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.kms#KeyIdType", + "traits": { + "smithy.api#documentation": "

The HMAC KMS key used in the verification.

" + } + }, + "MacValid": { + "target": "com.amazonaws.kms#BooleanType", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the HMAC was verified. A value of \n True indicates that the HMAC (Mac) was generated with the specified\n Message, HMAC KMS key (KeyID) and\n MacAlgorithm..

\n

If the HMAC is not verified, the VerifyMac operation fails with a\n KMSInvalidMacException exception. This exception indicates that one or more of\n the inputs changed since the HMAC was computed.

" + } + }, + "MacAlgorithm": { + "target": "com.amazonaws.kms#MacAlgorithmSpec", + "traits": { + "smithy.api#documentation": "

The MAC algorithm used in the verification.

" + } + } } }, "com.amazonaws.kms#VerifyRequest": { diff --git a/aws/sdk/aws-models/lightsail.json b/aws/sdk/aws-models/lightsail.json index 7b61e4d6b8..3e888844b1 100644 --- a/aws/sdk/aws-models/lightsail.json +++ b/aws/sdk/aws-models/lightsail.json @@ -177,6 +177,61 @@ ] } }, + "com.amazonaws.lightsail#AccountLevelBpaSync": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.lightsail#AccountLevelBpaSyncStatus", + "traits": { + "smithy.api#documentation": "

The status of the account-level BPA synchronization.

\n\n

The following statuses are possible:

\n \n \n

You might need to complete further actions if the status is Failed or\n Defaulted. The message parameter provides more information for\n those statuses.

\n " + } + }, + "lastSyncedAt": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The timestamp of when the account-level BPA configuration was last synchronized. This\n value is null when the account-level BPA configuration has not been synchronized.

" + } + }, + "message": { + "target": "com.amazonaws.lightsail#BPAStatusMessage", + "traits": { + "smithy.api#documentation": "

A message that provides a reason for a Failed or Defaulted\n synchronization status.

\n\n

The following messages are possible:

\n " + } + }, + "bpaImpactsLightsail": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether account-level block public access is affecting your\n Lightsail buckets.

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

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access (BPA) feature for your Lightsail buckets.

\n\n

The account-level BPA feature of Amazon S3 provides centralized controls to limit\n public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and\n object permissions that are configured. Lightsail buckets take into account the\n Amazon S3 account-level BPA configuration when allowing or denying public access. To\n do this, Lightsail periodically fetches the account-level BPA configuration\n from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail\n buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects\n Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + } + }, + "com.amazonaws.lightsail#AccountLevelBpaSyncStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InSync", + "name": "InSync" + }, + { + "value": "Failed", + "name": "Failed" + }, + { + "value": "NeverSynced", + "name": "NeverSynced" + }, + { + "value": "Defaulted", + "name": "Defaulted" + } + ] + } + }, "com.amazonaws.lightsail#AccountSetupInProgressException": { "type": "structure", "members": { @@ -520,7 +575,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.

\n

Use the CreateCertificate action to create a certificate that you can attach\n to your distribution.

\n \n

Only certificates created in the us-east-1 AWS Region can be attached to\n Lightsail distributions. Lightsail distributions are global resources that can reference\n an origin in any AWS Region, and distribute its content globally. However, all\n distributions are located in the us-east-1 Region.

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

Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.

\n

Use the CreateCertificate action to create a certificate that you can attach\n to your distribution.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/AttachCertificateToDistribution", @@ -987,6 +1042,29 @@ "target": "com.amazonaws.lightsail#AvailabilityZone" } }, + "com.amazonaws.lightsail#BPAStatusMessage": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEFAULTED_FOR_SLR_MISSING", + "name": "DEFAULTED_FOR_SLR_MISSING" + }, + { + "value": "SYNC_ON_HOLD", + "name": "SYNC_ON_HOLD" + }, + { + "value": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD", + "name": "DEFAULTED_FOR_SLR_MISSING_ON_HOLD" + }, + { + "value": "Unknown", + "name": "Unknown" + } + ] + } + }, "com.amazonaws.lightsail#Base64": { "type": "string" }, @@ -1146,7 +1224,10 @@ } }, "location": { - "target": "com.amazonaws.lightsail#ResourceLocation" + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the bucket, such as the Amazon Web Services Region\n and Availability Zone.

" + } }, "name": { "target": "com.amazonaws.lightsail#BucketName", @@ -1175,13 +1256,13 @@ "ableToUpdateBundle": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n\n

You can update a bucket's bundle only one time within a monthly AWS billing\n cycle.

\n\n

Use the UpdateBucketBundle action to change a\n bucket's bundle.

" + "smithy.api#documentation": "

Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.

\n\n

You can update a bucket's bundle only one time within a monthly Amazon Web Services billing\n cycle.

\n\n

Use the UpdateBucketBundle action to change a\n bucket's bundle.

" } }, "readonlyAccessAccounts": { "target": "com.amazonaws.lightsail#PartnerIdList", "traits": { - "smithy.api#documentation": "

An array of strings that specify the AWS account IDs that have read-only access to the\n bucket.

" + "smithy.api#documentation": "

An array of strings that specify the Amazon Web Services account IDs that have read-only\n access to the bucket.

" } }, "resourcesReceivingAccess": { @@ -1220,7 +1301,7 @@ "destination": { "target": "com.amazonaws.lightsail#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket where the access is saved. The destination can be a Lightsail\n bucket in the same account, and in the same AWS Region as the source bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

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

The name of the bucket where the access logs are saved. The destination can be a\n Lightsail bucket in the same account, and in the same Amazon Web Services Region as the\n source bucket.

\n \n

This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.

\n " } }, "prefix": { @@ -1837,7 +1918,7 @@ "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

A list of objects describing the Availability Zone and AWS Region of the CloudFormation\n stack record.

" + "smithy.api#documentation": "

A list of objects describing the Availability Zone and Amazon Web Services Region of the\n CloudFormation stack record.

" } }, "resourceType": { @@ -1981,7 +2062,10 @@ } }, "location": { - "target": "com.amazonaws.lightsail#ResourceLocation" + "target": "com.amazonaws.lightsail#ResourceLocation", + "traits": { + "smithy.api#documentation": "

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

" + } }, "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", @@ -2174,7 +2258,7 @@ "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

An object that describes the location of the container service, such as the AWS Region\n and Availability Zone.

" + "smithy.api#documentation": "

An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.

" } }, "resourceType": { @@ -2240,7 +2324,7 @@ "principalArn": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The principal ARN of the container service.

\n\n

The principal ARN can be used to create a trust relationship between your standard AWS\n account and your Lightsail container service. This allows you to give your service\n permission to access resources in your standard AWS account.

" + "smithy.api#documentation": "

The principal ARN of the container service.

\n\n

The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your\n service permission to access resources in your standard Amazon Web Services account.

" } }, "privateDomainName": { @@ -2817,7 +2901,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an\n automatic snapshot of an instance or disk as a manual snapshot. This operation can also be\n used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to\n another in Amazon Lightsail.

\n

When copying a manual snapshot, be sure to define the source\n region, source snapshot name, and target snapshot name\n parameters.

\n

When copying an automatic snapshot, be sure to define the\n source region, source resource name, target snapshot\n name, and either the restore date or the use latest restorable\n auto snapshot parameters.

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

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an\n automatic snapshot of an instance or disk as a manual snapshot. This operation can also be\n used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

\n

When copying a manual snapshot, be sure to define the source\n region, source snapshot name, and target snapshot name\n parameters.

\n

When copying an automatic snapshot, be sure to define the\n source region, source resource name, target snapshot\n name, and either the restore date or the use latest restorable\n auto snapshot parameters.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CopySnapshot", @@ -2862,7 +2946,7 @@ "sourceRegion": { "target": "com.amazonaws.lightsail#RegionName", "traits": { - "smithy.api#documentation": "

The AWS Region where the source manual or automatic snapshot is located.

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

The Amazon Web Services Region where the source manual or automatic snapshot is\n located.

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

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.

\n

After the certificate is valid, use the AttachCertificateToDistribution\n action to use the certificate and its domains with your distribution. Or use the\n UpdateContainerService action to use the certificate and its domains with your\n container service.

\n \n

Only certificates created in the us-east-1 AWS Region can be attached to\n Lightsail distributions. Lightsail distributions are global resources that can reference\n an origin in any AWS Region, and distribute its content globally. However, all\n distributions are located in the us-east-1 Region.

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

Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.

\n

After the certificate is valid, use the AttachCertificateToDistribution\n action to use the certificate and its domains with your distribution. Or use the\n UpdateContainerService action to use the certificate and its domains with your\n container service.

\n \n

Only certificates created in the us-east-1\n Amazon Web Services Region can be attached to Lightsail distributions. Lightsail\n distributions are global resources that can reference an origin in any Amazon Web Services\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

\n ", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateCertificate", @@ -3195,7 +3279,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an email or SMS text message contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each AWS Region.\n However, SMS text messaging is not supported in some AWS Regions, and SMS text messages\n cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

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

Creates an email or SMS text message contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/CreateContactMethod", @@ -3209,7 +3293,7 @@ "protocol": { "target": "com.amazonaws.lightsail#ContactProtocol", "traits": { - "smithy.api#documentation": "

The protocol of the contact method, such as Email or SMS (text\n messaging).

\n

The SMS protocol is supported only in the following AWS Regions.

\n \n

For a list of countries/regions where SMS text messages can be sent, and the latest AWS\n Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer\n Guide.

\n

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

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

The protocol of the contact method, such as Email or SMS (text\n messaging).

\n

The SMS protocol is supported only in the following Amazon Web Services\n Regions.

\n \n

For a list of countries/regions where SMS text messages can be sent, and the latest\n Amazon Web Services Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer\n Guide.

\n

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

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

Creates a deployment for your Amazon Lightsail container service.

\n\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n\n

You can deploy containers to your container service using container images from a public\n registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

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

Creates a deployment for your Amazon Lightsail container service.

\n\n

A deployment specifies the containers that will be launched on the container service and\n their settings, such as the ports to open, the environment variables to apply, and the launch\n command to run. It also specifies the container that will serve as the public endpoint of the\n deployment and its settings, such as the HTTP or HTTPS port to use, and the health check\n configuration.

\n\n

You can deploy containers to your container service using container images from a public\n registry such as Amazon ECR Public, or from your local machine. For more information, see\n Creating container images for your Amazon Lightsail container services in the\n Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/container-services/{serviceName}/deployments", @@ -3392,7 +3476,7 @@ "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { - "smithy.api#documentation": "

The name for the container service.

\n\n

The name that you specify for your container service will make up part of its default\n domain. The default domain of a container service is typically\n https://...cs.amazonlightsail.com.\n If the name of your container service is container-service-1, and it's located in\n the US East (Ohio) AWS region (us-east-2), then the domain for your container\n service will be like the following example:\n https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com\n

\n\n

The following are the requirements for container service names:

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

The name for the container service.

\n\n

The name that you specify for your container service will make up part of its default\n domain. The default domain of a container service is typically\n https://...cs.amazonlightsail.com.\n If the name of your container service is container-service-1, and it's located in\n the US East (Ohio) AWS region (us-east-2), then the domain for your container\n service will be like the following example:\n https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com\n

\n\n

The following are the requirements for container service names:

\n\n ", "smithy.api#required": {} } }, @@ -4487,6 +4571,12 @@ "traits": { "smithy.api#documentation": "

The IP address type for the load balancer.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

\n\n

The default value is dualstack.

" } + }, + "tlsPolicyName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the TLS policy to apply to the load balancer.

\n\n

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can\n specify.

\n\n

For more information about load balancer TLS policies, see Load balancer TLS security policies in the Amazon Lightsail Developer\n Guide.

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

Deletes a Amazon Lightsail bucket.

\n\n \n

When you delete your bucket, the bucket name is released and can be reused for a new\n bucket in your account or another AWS account.

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

Deletes a Amazon Lightsail bucket.

\n\n \n

When you delete your bucket, the bucket name is released and can be reused for a new\n bucket in your account or another Amazon Web Services account.

\n ", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteBucket", @@ -5244,7 +5334,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each AWS Region.\n However, SMS text messaging is not supported in some AWS Regions, and SMS text messages\n cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

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

Deletes a contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/DeleteContactMethod", @@ -7393,7 +7483,7 @@ } ], "traits": { - "smithy.api#documentation": "

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).\n This operation results in an export snapshot record that can be used with the create\n cloud formation stack operation to create new Amazon EC2 instances.

\n

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the\n instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in\n Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the\n source Lightsail snapshot.

\n

\n

The export snapshot operation supports tag-based access control via resource\n tags applied to the resource identified by source snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

\n \n

Use the get instance snapshots or get disk snapshots\n operations to get a list of snapshots that you can export to Amazon EC2.

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

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).\n This operation results in an export snapshot record that can be used with the create\n cloud formation stack operation to create new Amazon EC2 instances.

\n

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the\n instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in\n Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in\n Amazon EC2 as the source Lightsail snapshot.

\n

\n

The export snapshot operation supports tag-based access control via resource\n tags applied to the resource identified by source snapshot name. For more\n information, see the Amazon Lightsail Developer Guide.

\n \n

Use the get instance snapshots or get disk snapshots\n operations to get a list of snapshots that you can export to Amazon EC2.

\n ", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/ExportSnapshot", @@ -8108,7 +8198,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about one or more Amazon Lightsail buckets.

\n\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide..

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

Returns information about one or more Amazon Lightsail buckets. The information returned\n includes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access feature for your Lightsail buckets.

\n\n

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetBuckets", @@ -8122,7 +8212,7 @@ "bucketName": { "target": "com.amazonaws.lightsail#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket for which to return information.

\n\n

When omitted, the response includes all of your buckets in the AWS Region where the\n request is made.

" + "smithy.api#documentation": "

The name of the bucket for which to return information.

\n\n

When omitted, the response includes all of your buckets in the Amazon Web Services Region\n where the request is made.

" } }, "pageToken": { @@ -8153,6 +8243,12 @@ "traits": { "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

A next page token is not returned if there are no more results to display.

\n\n

To get the next page of results, perform another GetBuckets request and\n specify the next page token using the pageToken parameter.

" } + }, + "accountLevelBpaSync": { + "target": "com.amazonaws.lightsail#AccountLevelBpaSync", + "traits": { + "smithy.api#documentation": "

An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.

\n\n

For more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.

" + } } } }, @@ -8270,7 +8366,7 @@ "certificateStatuses": { "target": "com.amazonaws.lightsail#CertificateStatusList", "traits": { - "smithy.api#documentation": "

The status of the certificates for which to return information.

\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n

When omitted, the response includes all of your certificates in the AWS Region where the\n request is made, regardless of their current status.

" + "smithy.api#documentation": "

The status of the certificates for which to return information.

\n

For example, specify ISSUED to return only certificates with an\n ISSUED status.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made, regardless of their current status.

" } }, "includeCertificateDetails": { @@ -8282,7 +8378,7 @@ "certificateName": { "target": "com.amazonaws.lightsail#CertificateName", "traits": { - "smithy.api#documentation": "

The name for the certificate for which to return information.

\n

When omitted, the response includes all of your certificates in the AWS Region where the\n request is made.

" + "smithy.api#documentation": "

The name for the certificate for which to return information.

\n

When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made.

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

Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each AWS Region.\n However, SMS text messaging is not supported in some AWS Regions, and SMS text messages\n cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

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

Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

", "smithy.api#http": { "method": "GET", "uri": "/ls/api/2016-11-28/GetContactMethods", @@ -8877,7 +8973,7 @@ "serviceName": { "target": "com.amazonaws.lightsail#ContainerServiceName", "traits": { - "smithy.api#documentation": "

The name of the container service for which to return information.

\n\n

When omitted, the response includes all of your container services in the AWS Region\n where the request is made.

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

The name of the container service for which to return information.

\n\n

When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.

", "smithy.api#httpQuery": "serviceName" } } @@ -9174,7 +9270,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your dsitribution.

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

Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetDistributionBundles", @@ -9413,7 +9509,7 @@ "distributionName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the distribution for which to return information.

\n \n

When omitted, the response includes all of your distributions in the AWS Region where\n the request is made.

" + "smithy.api#documentation": "

The name of the distribution for which to return information.

\n \n

When omitted, the response includes all of your distributions in the Amazon Web Services\n Region where the request is made.

" } }, "pageToken": { @@ -10582,6 +10678,68 @@ } } }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult" + }, + "errors": [ + { + "target": "com.amazonaws.lightsail#AccessDeniedException" + }, + { + "target": "com.amazonaws.lightsail#AccountSetupInProgressException" + }, + { + "target": "com.amazonaws.lightsail#InvalidInputException" + }, + { + "target": "com.amazonaws.lightsail#ServiceException" + }, + { + "target": "com.amazonaws.lightsail#UnauthenticatedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.

\n\n

For more information about load balancer TLS security policies, see Load balancer TLS security policies in the Amazon Lightsail Developer\n Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsPolicies", + "code": 200 + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesRequest": { + "type": "structure", + "members": { + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

To get a page token, perform an initial GetLoadBalancerTlsPolicies request.\n If your results are paginated, the response will return a next page token that you can specify\n as the page token in a subsequent request.

" + } + } + } + }, + "com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult": { + "type": "structure", + "members": { + "tlsPolicies": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicyList", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the TLS security policies that are available.

" + } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The token to advance to the next page of results from your request.

\n\n

A next page token is not returned if there are no more results to display.

\n\n

To get the next page of results, perform another GetLoadBalancerTlsPolicies\n request and specify the next page token using the pageToken parameter.

" + } + } + } + }, "com.amazonaws.lightsail#GetLoadBalancers": { "type": "operation", "input": { @@ -13046,7 +13204,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lightsail throws this exception when user input does not conform to the validation rules\n of an input field.

\n \n

Domain and distribution APIs are only available in the N. Virginia\n (us-east-1) AWS Region. Please set your AWS Region configuration to\n us-east-1 to create, view, or edit these resources.

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

Lightsail throws this exception when user input does not conform to the validation rules\n of an input field.

\n \n

Domain and distribution APIs are only available in the N. Virginia\n (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services\n Region configuration to us-east-1 to create, view, or edit these\n resources.

\n ", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -13240,7 +13398,7 @@ "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

An object that describes the location of the distribution, such as the AWS Region and\n Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any AWS\n Region, and distribute its content globally. However, all distributions are located in the\n us-east-1 Region.

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

An object that describes the location of the distribution, such as the Amazon Web Services\n Region and Availability Zone.

\n \n

Lightsail distributions are global resources that can reference an origin in any\n Amazon Web Services Region, and distribute its content globally. However, all distributions\n are located in the us-east-1 Region.

\n " } }, "resourceType": { @@ -13352,7 +13510,7 @@ "name": "lightsail" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers\n who need to build websites or web applications. It includes everything you need to launch your\n project quickly - instances (virtual private servers), container services, storage buckets,\n managed databases, SSD-based block storage, static IP addresses, load balancers, content\n delivery network (CDN) distributions, DNS management of registered domains, and resource\n snapshots (backups) - for a low, predictable monthly price.

\n\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts\n and tasks, see the Amazon Lightsail Developer Guide.

\n\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n AWS Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and\n Quotas in the AWS General Reference.

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

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes\n everything you need to launch your project quickly - instances (virtual private servers),\n container services, storage buckets, managed databases, SSD-based block storage, static IP\n addresses, load balancers, content delivery network (CDN) distributions, DNS management of\n registered domains, and resource snapshots (backups) - for a low, predictable monthly\n price.

\n\n

You can manage your Lightsail resources using the Lightsail console, Lightsail API,\n AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts\n and tasks, see the Amazon Lightsail Developer Guide.

\n\n

This API Reference provides detailed information about the actions, data types,\n parameters, and errors of the Lightsail service. For more information about the supported\n Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see\n Amazon Lightsail Endpoints\n and Quotas in the Amazon Web Services General Reference.

", "smithy.api#title": "Amazon Lightsail" }, "version": "2016-11-28", @@ -13669,6 +13827,9 @@ { "target": "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates" }, + { + "target": "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies" + }, { "target": "com.amazonaws.lightsail#GetOperation" }, @@ -13922,6 +14083,18 @@ "traits": { "smithy.api#documentation": "

The IP address type of the load balancer.

\n\n

The possible values are ipv4 for IPv4 only, and dualstack for\n IPv4 and IPv6.

" } + }, + "httpsRedirectionEnabled": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether HTTPS redirection is enabled for the load\n balancer.

" + } + }, + "tlsPolicyName": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the TLS security policy for the load balancer.

\n\n

The following TLS security policy names are possible:

\n " + } } }, "traits": { @@ -13943,6 +14116,14 @@ { "value": "SessionStickiness_LB_CookieDurationSeconds", "name": "SessionStickiness_LB_CookieDurationSeconds" + }, + { + "value": "HttpsRedirectionEnabled", + "name": "HttpsRedirectionEnabled" + }, + { + "value": "TlsPolicyName", + "name": "TlsPolicyName" } ] } @@ -14494,6 +14675,50 @@ "target": "com.amazonaws.lightsail#LoadBalancerTlsCertificateSummary" } }, + "com.amazonaws.lightsail#LoadBalancerTlsPolicy": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lightsail#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the TLS security policy.

\n\n

The following TLS security policy names are possible:

\n\n \n\n

You can specify either of these values for the tlsSecurityPolicyName request\n parameter in the CreateLoadBalancer action, and the attributeValue request parameter in\n the UpdateLoadBalancerAttribute action.

" + } + }, + "isDefault": { + "target": "com.amazonaws.lightsail#boolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the TLS security policy is the default.

" + } + }, + "description": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The description of the TLS security policy.

" + } + }, + "protocols": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The protocols used in a given TLS security policy.

\n\n

The following protocols are possible:

\n " + } + }, + "ciphers": { + "target": "com.amazonaws.lightsail#StringList", + "traits": { + "smithy.api#documentation": "

The ciphers used by the TLS security policy.

\n

The ciphers are listed in order of preference.

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

Describes the TLS security policies that are available for Lightsail load\n balancers.

\n\n

For more information about load balancer TLS security policies, see Load balancer TLS security policies in the Amazon Lightsail\n Developer Guide.

" + } + }, + "com.amazonaws.lightsail#LoadBalancerTlsPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lightsail#LoadBalancerTlsPolicy" + } + }, "com.amazonaws.lightsail#LogEvent": { "type": "structure", "members": { @@ -15037,7 +15262,7 @@ "location": { "target": "com.amazonaws.lightsail#ResourceLocation", "traits": { - "smithy.api#documentation": "

The AWS Region and Availability Zone.

" + "smithy.api#documentation": "

The Amazon Web Services Region and Availability Zone.

" } }, "isTerminal": { @@ -15881,7 +16106,7 @@ "contactProtocols": { "target": "com.amazonaws.lightsail#ContactProtocolsList", "traits": { - "smithy.api#documentation": "

The contact protocols to use for the alarm, such as Email, SMS\n (text messaging), or both.

\n

A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.

\n

A notification is not sent if a contact protocol is not specified, if the specified\n contact protocol is not configured in the AWS Region, or if notifications are not enabled\n for the alarm using the notificationEnabled paramater.

\n

Use the CreateContactMethod action to configure a contact protocol in an\n AWS Region.

" + "smithy.api#documentation": "

The contact protocols to use for the alarm, such as Email, SMS\n (text messaging), or both.

\n

A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.

\n

A notification is not sent if a contact protocol is not specified, if the specified\n contact protocol is not configured in the Amazon Web Services Region, or if notifications are\n not enabled for the alarm using the notificationEnabled paramater.

\n

Use the CreateContactMethod action to configure a contact protocol in an\n Amazon Web Services Region.

" } }, "notificationTriggers": { @@ -16326,7 +16551,10 @@ "type": "structure", "members": { "containerImage": { - "target": "com.amazonaws.lightsail#ContainerImage" + "target": "com.amazonaws.lightsail#ContainerImage", + "traits": { + "smithy.api#documentation": "

An object that describes a container image that is registered to a Lightsail container\n service

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

Sends a verification request to an email contact method to ensure it's owned by the\n requester. SMS contact methods don't need to be verified.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each AWS Region.\n However, SMS text messaging is not supported in some AWS Regions, and SMS text messages\n cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

\n

A verification request is sent to the contact method when you initially create it. Use\n this action to send another verification request if a previous verification request was\n deleted, or has expired.

\n \n

Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.

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

Sends a verification request to an email contact method to ensure it's owned by the\n requester. SMS contact methods don't need to be verified.

\n

A contact method is used to send you notifications about your Amazon Lightsail resources.\n You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services\n Regions, and SMS text messages cannot be sent to some countries/regions. For more information,\n see Notifications in Amazon Lightsail.

\n

A verification request is sent to the contact method when you initially create it. Use\n this action to send another verification request if a previous verification request was\n deleted, or has expired.

\n \n

Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.

\n ", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/SendContactMethodVerification", @@ -17450,7 +17678,7 @@ "resourceType": { "target": "com.amazonaws.lightsail#ResourceType", "traits": { - "smithy.api#documentation": "

The resource type.

\n

The possible values are Distribution, Instance, and\n LoadBalancer.

\n \n

Distribution-related APIs are available only in the N. Virginia (us-east-1)\n AWS Region. Set your AWS Region configuration to us-east-1 to create, view,\n or edit distributions.

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

The resource type.

\n

The possible values are Distribution, Instance, and\n LoadBalancer.

\n \n

Distribution-related APIs are available only in the N. Virginia (us-east-1)\n Amazon Web Services Region. Set your Amazon Web Services Region configuration to\n us-east-1 to create, view, or edit distributions.

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

Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.

\n\n

Lightsail buckets currently support setting access for Lightsail instances in the same\n AWS Region.

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

Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.

\n\n

Lightsail buckets currently support setting access for Lightsail instances in the same\n Amazon Web Services Region.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/SetResourceAccessForBucket", @@ -18309,7 +18537,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing Amazon Lightsail bucket.

\n\n

Use this action to update the configuration of an existing bucket, such as versioning,\n public accessibility, and the AWS accounts that can access the bucket.

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

Updates an existing Amazon Lightsail bucket.

\n\n

Use this action to update the configuration of an existing bucket, such as versioning,\n public accessibility, and the Amazon Web Services accounts that can access the bucket.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateBucket", @@ -18406,7 +18634,7 @@ "readonlyAccessAccounts": { "target": "com.amazonaws.lightsail#PartnerIdList", "traits": { - "smithy.api#documentation": "

An array of strings to specify the AWS account IDs that can access the bucket.

\n\n

You can give a maximum of 10 AWS accounts access to a bucket.

" + "smithy.api#documentation": "

An array of strings to specify the Amazon Web Services account IDs that can access the\n bucket.

\n\n

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

" } }, "accessLogConfig": { @@ -18582,7 +18810,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your dsitribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly AWS billing\n cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

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

Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.

\n

A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.

\n

Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.

\n

You can update your distribution's bundle only one time within your monthly AWS billing\n cycle. To determine if you can update your distribution's bundle, use the\n GetDistributions action. The ableToUpdateBundle parameter in the\n result will indicate whether you can currently update your distribution's bundle.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/UpdateDistributionBundle", @@ -18611,7 +18839,10 @@ "type": "structure", "members": { "operation": { - "target": "com.amazonaws.lightsail#Operation" + "target": "com.amazonaws.lightsail#Operation", + "traits": { + "smithy.api#documentation": "

An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.

" + } } } }, @@ -18791,14 +19022,14 @@ "attributeName": { "target": "com.amazonaws.lightsail#LoadBalancerAttributeName", "traits": { - "smithy.api#documentation": "

The name of the attribute you want to update. Valid values are below.

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

The name of the attribute you want to update.

", "smithy.api#required": {} } }, "attributeValue": { "target": "com.amazonaws.lightsail#StringMax256", "traits": { - "smithy.api#documentation": "

The value that you want to specify for the attribute name.

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

The value that you want to specify for the attribute name.

\n

The following values are supported depending on what you specify for the\n attributeName request parameter:

\n ", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/lookoutequipment.json b/aws/sdk/aws-models/lookoutequipment.json index 4b3b74ec7a..aadba7a216 100644 --- a/aws/sdk/aws-models/lookoutequipment.json +++ b/aws/sdk/aws-models/lookoutequipment.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.lookoutequipment#AWSLookoutEquipmentFrontendService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "LookoutEquipment", + "arnNamespace": "lookoutequipment", + "cloudFormationName": "LookoutEquipment", + "cloudTrailEventSource": "lookoutequipment.amazonaws.com", + "endpointPrefix": "lookoutequipment" + }, + "aws.auth#sigv4": { + "name": "lookoutequipment" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify\n anomalies in machines from sensor data for use in predictive maintenance.

", + "smithy.api#title": "Amazon Lookout for Equipment" + }, "version": "2020-12-15", "operations": [ { @@ -78,6 +93,9 @@ { "target": "com.amazonaws.lookoutequipment#ListModels" }, + { + "target": "com.amazonaws.lookoutequipment#ListSensorStatistics" + }, { "target": "com.amazonaws.lookoutequipment#ListTagsForResource" }, @@ -99,22 +117,7 @@ { "target": "com.amazonaws.lookoutequipment#UpdateInferenceScheduler" } - ], - "traits": { - "aws.api#service": { - "sdkId": "LookoutEquipment", - "arnNamespace": "lookoutequipment", - "cloudFormationName": "LookoutEquipment", - "cloudTrailEventSource": "lookoutequipment.amazonaws.com", - "endpointPrefix": "lookoutequipment" - }, - "aws.auth#sigv4": { - "name": "lookoutequipment" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify\n anomalies in machines from sensor data for use in predictive maintenance.

", - "smithy.api#title": "Amazon Lookout for Equipment" - } + ] }, "com.amazonaws.lookoutequipment#AccessDeniedException": { "type": "structure", @@ -141,6 +144,9 @@ } } }, + "com.amazonaws.lookoutequipment#Boolean": { + "type": "boolean" + }, "com.amazonaws.lookoutequipment#BoundedLengthString": { "type": "string", "traits": { @@ -151,6 +157,37 @@ "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,5000}$" } }, + "com.amazonaws.lookoutequipment#CategoricalValues": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", + "traits": { + "smithy.api#documentation": "

\nIndicates whether there is a potential data issue related to categorical values.\n

", + "smithy.api#required": {} + } + }, + "NumberOfCategory": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\nIndicates the number of categories in the data.\n

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

\nEntity that comprises information on categorical values in data.\n

" + } + }, + "com.amazonaws.lookoutequipment#ComponentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._\\-]{1,200}$" + } + }, "com.amazonaws.lookoutequipment#ComponentTimestampDelimiter": { "type": "string", "traits": { @@ -177,6 +214,28 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.lookoutequipment#CountPercent": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the count of occurences of the given statistic.\n\n

", + "smithy.api#required": {} + } + }, + "Percentage": { + "target": "com.amazonaws.lookoutequipment#Float", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the percentage of occurances of the given statistic.\n\n

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

\n\nEntity that comprises information of count and percentage.\n\n

" + } + }, "com.amazonaws.lookoutequipment#CreateDataset": { "type": "operation", "input": { @@ -222,8 +281,7 @@ "DatasetSchema": { "target": "com.amazonaws.lookoutequipment#DatasetSchema", "traits": { - "smithy.api#documentation": "

A JSON description of the data that is in each time series dataset, including names,\n column names, and data types.

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

A JSON description of the data that is in each time series dataset, including names,\n column names, and data types.

" } }, "ServerSideKmsKeyId": { @@ -587,7 +645,7 @@ "IngestionInputConfiguration": { "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", "traits": { - "smithy.api#documentation": "

Specifies information for the input data for the data inference job, including data S3\n location parameters.

" + "smithy.api#documentation": "

Specifies information for the input data for the data inference job, including data Amazon S3\n location parameters.

" } }, "Status": { @@ -615,6 +673,58 @@ "smithy.api#documentation": "

The configuration is the TargetSamplingRate, which is the sampling rate of \n the data after post processing by \n Amazon Lookout for Equipment. For example, if you provide data that \n has been collected at a 1 second level and you want the system to resample \n the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

\n

When providing a value for the TargetSamplingRate, you must \n attach the prefix \"PT\" to the rate you want. The value for a 1 second rate \n is therefore PT1S, the value for a 15 minute rate \n is PT15M, and the value for a 1 hour rate \n is PT1H\n

" } }, + "com.amazonaws.lookoutequipment#DataQualitySummary": { + "type": "structure", + "members": { + "InsufficientSensorData": { + "target": "com.amazonaws.lookoutequipment#InsufficientSensorData", + "traits": { + "smithy.api#documentation": "

\n\nParameter that gives information about insufficient data for sensors in the dataset. This includes information about those sensors that have complete data missing and those with a short date range.\n\n

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

\n\nParameter that gives information about data that is missing over all the sensors in the input data.\n\n

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

\n\nParameter that gives information about data that is invalid over all the sensors in the input data.\n\n

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

\n\nParameter that gives information about unsupported timestamps in the input data.\n\n

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

\n\nParameter that gives information about duplicate timestamps in the input data.\n\n

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

\n\nDataQualitySummary gives aggregated statistics over all the sensors about a completed ingestion job. It primarily gives more information about statistics over different incorrect data like MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, DuplicateTimeStamps.\n\n

" + } + }, + "com.amazonaws.lookoutequipment#DataSizeInBytes": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.lookoutequipment#DataUploadFrequency": { "type": "string", "traits": { @@ -886,7 +996,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information on a specific data ingestion job such as creation time, dataset\n ARN, status, and so on.

" + "smithy.api#documentation": "

Provides information on a specific data ingestion job such as creation time, dataset\n ARN, and status.

" } }, "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest": { @@ -945,6 +1055,39 @@ "traits": { "smithy.api#documentation": "

Specifies the reason for failure when a data ingestion job has failed.

" } + }, + "DataQualitySummary": { + "target": "com.amazonaws.lookoutequipment#DataQualitySummary", + "traits": { + "smithy.api#documentation": "

\nGives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.\n

" + } + }, + "IngestedFilesSummary": { + "target": "com.amazonaws.lookoutequipment#IngestedFilesSummary" + }, + "StatusDetail": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "

\n Provides details about status of the ingestion job that is currently in progress.\n

" + } + }, + "IngestedDataSize": { + "target": "com.amazonaws.lookoutequipment#DataSizeInBytes", + "traits": { + "smithy.api#documentation": "

\n Indicates the size of the ingested dataset.\n

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

\n Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.\n

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

\n Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.\n

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

Provides a JSON description of the data that is in each time series dataset, including names, column names, and data types.

" + "smithy.api#documentation": "

Provides a JSON description of the data in each time series dataset, including names, column names, and data types.

" } }, "com.amazonaws.lookoutequipment#DescribeDatasetRequest": { @@ -1039,6 +1182,36 @@ "traits": { "smithy.api#documentation": "

Specifies the S3 location configuration for the data input for the data ingestion job.

" } + }, + "DataQualitySummary": { + "target": "com.amazonaws.lookoutequipment#DataQualitySummary", + "traits": { + "smithy.api#documentation": "

\nGives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.\n

" + } + }, + "IngestedFilesSummary": { + "target": "com.amazonaws.lookoutequipment#IngestedFilesSummary", + "traits": { + "smithy.api#documentation": "

\nIngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.\n

" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job. \n

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

\n Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.\n

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

\n Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.\n

" + } } } }, @@ -1338,12 +1511,30 @@ } } }, + "com.amazonaws.lookoutequipment#DuplicateTimestamps": { + "type": "structure", + "members": { + "TotalNumberOfDuplicateTimestamps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\nIndicates the total number of duplicate timestamps.\n

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

\n\nEntity that comprises information abount duplicate timestamps in the dataset.\n\n

" + } + }, "com.amazonaws.lookoutequipment#FileNameTimestampFormat": { "type": "string", "traits": { "smithy.api#pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$" } }, + "com.amazonaws.lookoutequipment#Float": { + "type": "float" + }, "com.amazonaws.lookoutequipment#IamRoleArn": { "type": "string", "traits": { @@ -1443,7 +1634,7 @@ "DataOutputConfiguration": { "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", "traits": { - "smithy.api#documentation": "

Specifies configuration information for the output results from for the inference\n execution, including the output S3 location.

" + "smithy.api#documentation": "

Specifies configuration information for the output results from for the inference\n execution, including the output Amazon S3 location.

" } }, "CustomerResultObject": { @@ -1475,13 +1666,13 @@ "S3InputConfiguration": { "target": "com.amazonaws.lookoutequipment#InferenceS3InputConfiguration", "traits": { - "smithy.api#documentation": "

Specifies configuration information for the input data for the inference, including S3\n location of input data..

" + "smithy.api#documentation": "

Specifies configuration information for the input data for the inference, including Amazon S3\n location of input data.

" } }, "InputTimeZoneOffset": { "target": "com.amazonaws.lookoutequipment#TimeZoneOffset", "traits": { - "smithy.api#documentation": "

Indicates the difference between your time zone and Greenwich Mean Time (GMT).

" + "smithy.api#documentation": "

Indicates the difference between your time zone and Coordinated Universal Time (UTC).

" } }, "InferenceInputNameConfiguration": { @@ -1492,7 +1683,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies configuration information for the input data for the inference, including S3\n location of input data..

" + "smithy.api#documentation": "

Specifies configuration information for the input data for the inference, including Amazon S3\n location of input data..

" } }, "com.amazonaws.lookoutequipment#InferenceInputNameConfiguration": { @@ -1687,6 +1878,34 @@ "smithy.api#documentation": "

Contains information about the specific inference scheduler, including data delay\n offset, model name and ARN, status, and so on.

" } }, + "com.amazonaws.lookoutequipment#IngestedFilesSummary": { + "type": "structure", + "members": { + "TotalNumberOfFiles": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the total number of files that were submitted for ingestion.

", + "smithy.api#required": {} + } + }, + "IngestedNumberOfFiles": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

Indicates the number of files that were successfully ingested.

", + "smithy.api#required": {} + } + }, + "DiscardedFiles": { + "target": "com.amazonaws.lookoutequipment#ListOfDiscardedFiles", + "traits": { + "smithy.api#documentation": "

Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.

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

Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.

" + } + }, "com.amazonaws.lookoutequipment#IngestionInputConfiguration": { "type": "structure", "members": { @@ -1746,12 +1965,46 @@ "traits": { "smithy.api#documentation": "

The prefix for the S3 location being used for the input data for the data ingestion.\n

" } + }, + "KeyPattern": { + "target": "com.amazonaws.lookoutequipment#KeyPattern", + "traits": { + "smithy.api#documentation": "

\nPattern for matching the Amazon S3 files which will be used for ingestion.\nIf no KeyPattern is provided, we will use the default hierarchy file structure, which is same as KeyPattern {prefix}/{component_name}/*\n

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

Specifies S3 configuration information for the input data for the data ingestion job.\n

" } }, + "com.amazonaws.lookoutequipment#InsufficientSensorData": { + "type": "structure", + "members": { + "MissingCompleteSensorData": { + "target": "com.amazonaws.lookoutequipment#MissingCompleteSensorData", + "traits": { + "smithy.api#documentation": "

\n\nParameter that describes the total number of sensors that have data completely missing for it.\n\n

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

\n\nParameter that describes the total number of sensors that have a short date range of less than 90 days of data overall.\n\n

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

\n\nEntity that comprises aggregated information on sensors having insufficient data.\n\n

" + } + }, + "com.amazonaws.lookoutequipment#Integer": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.lookoutequipment#InternalServerException": { "type": "structure", "members": { @@ -1768,6 +2021,37 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.lookoutequipment#InvalidSensorData": { + "type": "structure", + "members": { + "AffectedSensorCount": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the number of sensors that have at least some invalid values.\n\n

", + "smithy.api#required": {} + } + }, + "TotalNumberOfInvalidValues": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the total number of invalid values across all the sensors.\n\n

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

\n\nEntity that comprises aggregated information on sensors having insufficient data.\n\n

" + } + }, + "com.amazonaws.lookoutequipment#KeyPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.lookoutequipment#KmsKeyArn": { "type": "string", "traits": { @@ -1814,6 +2098,33 @@ "smithy.api#documentation": "

The location information (prefix and bucket name) for the s3 location being used for\n label data.

" } }, + "com.amazonaws.lookoutequipment#LargeTimestampGaps": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", + "traits": { + "smithy.api#documentation": "

\nIndicates whether there is a potential data issue related to large gaps in timestamps.\n

", + "smithy.api#required": {} + } + }, + "NumberOfLargeTimestampGaps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\nIndicates the number of large timestamp gaps, if there are any.\n

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

\nIndicates the size of the largest timestamp gap, in days.\n

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

\nEntity that comprises information on large gaps between consecutive timestamps in data.\n

" + } + }, "com.amazonaws.lookoutequipment#ListDataIngestionJobs": { "type": "operation", "input": { @@ -2215,6 +2526,98 @@ } } }, + "com.amazonaws.lookoutequipment#ListOfDiscardedFiles": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#S3Object" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.lookoutequipment#ListSensorStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListSensorStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListSensorStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\nLists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListSensorStatisticsRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "

\nThe name of the dataset associated with the list of Sensor Statistics.\n

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

\nThe ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs.\n

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

\nSpecifies the maximum number of sensors for which to retrieve statistics.\n

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

\nAn opaque pagination token indicating where to continue the listing of sensor statistics.\n

" + } + } + } + }, + "com.amazonaws.lookoutequipment#ListSensorStatisticsResponse": { + "type": "structure", + "members": { + "SensorStatisticsSummaries": { + "target": "com.amazonaws.lookoutequipment#SensorStatisticsSummaries", + "traits": { + "smithy.api#documentation": "

\nProvides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.\n

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

\nAn opaque pagination token indicating where to continue the listing of sensor statistics.\n

" + } + } + } + }, "com.amazonaws.lookoutequipment#ListTagsForResource": { "type": "operation", "input": { @@ -2277,6 +2680,43 @@ } } }, + "com.amazonaws.lookoutequipment#MissingCompleteSensorData": { + "type": "structure", + "members": { + "AffectedSensorCount": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the number of sensors that have data missing completely.\n\n

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

\n\nEntity that comprises information on sensors that have sensor data completely missing.\n\n

" + } + }, + "com.amazonaws.lookoutequipment#MissingSensorData": { + "type": "structure", + "members": { + "AffectedSensorCount": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the number of sensors that have atleast some data missing.\n\n

", + "smithy.api#required": {} + } + }, + "TotalNumberOfMissingValues": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the total number of missing values across all the sensors.\n\n

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

\n\nEntity that comprises aggregated information on sensors having missing data.\n\n

" + } + }, "com.amazonaws.lookoutequipment#ModelArn": { "type": "string", "traits": { @@ -2366,6 +2806,61 @@ "smithy.api#documentation": "

Provides information about the specified ML model, including dataset and model names and\n ARNs, as well as status.

" } }, + "com.amazonaws.lookoutequipment#MonotonicValues": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", + "traits": { + "smithy.api#documentation": "

\nIndicates whether there is a potential data issue related to having monotonic values.\n

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

\nIndicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.\n

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

\nEntity that comprises information on monotonic values in the data.\n

" + } + }, + "com.amazonaws.lookoutequipment#Monotonicity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DECREASING", + "name": "DECREASING" + }, + { + "value": "INCREASING", + "name": "INCREASING" + }, + { + "value": "STATIC", + "name": "STATIC" + } + ] + } + }, + "com.amazonaws.lookoutequipment#MultipleOperatingModes": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", + "traits": { + "smithy.api#documentation": "

\n Indicates whether there is a potential data issue related to having multiple operating modes.\n

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

\nEntity that comprises information on operating modes in data.\n

" + } + }, "com.amazonaws.lookoutequipment#NameOrArn": { "type": "string", "traits": { @@ -2463,6 +2958,123 @@ "smithy.api#pattern": "^(^$)|([\\P{M}\\p{M}]{1,1023}/$)$" } }, + "com.amazonaws.lookoutequipment#SensorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z:#$.\\-_]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#SensorStatisticsSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#SensorStatisticsSummary" + } + }, + "com.amazonaws.lookoutequipment#SensorStatisticsSummary": { + "type": "structure", + "members": { + "ComponentName": { + "target": "com.amazonaws.lookoutequipment#ComponentName", + "traits": { + "smithy.api#documentation": "

\n\nName of the component to which the particular sensor belongs for which the statistics belong to.\n\n

" + } + }, + "SensorName": { + "target": "com.amazonaws.lookoutequipment#SensorName", + "traits": { + "smithy.api#documentation": "

\n\nName of the sensor that the statistics belong to.\n\n

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

\n\nParameter that indicates whether data exists for the sensor that the statistics belong to.\n\n

" + } + }, + "MissingValues": { + "target": "com.amazonaws.lookoutequipment#CountPercent", + "traits": { + "smithy.api#documentation": "

\n\nParameter that describes the total number of, and percentage of, values that are missing for the sensor that the statistics belong to.\n\n

" + } + }, + "InvalidValues": { + "target": "com.amazonaws.lookoutequipment#CountPercent", + "traits": { + "smithy.api#documentation": "

\n\nParameter that describes the total number of, and percentage of, values that are invalid for the sensor that the statistics belong to.\n\n

" + } + }, + "InvalidDateEntries": { + "target": "com.amazonaws.lookoutequipment#CountPercent", + "traits": { + "smithy.api#documentation": "

\n\nParameter that describes the total number of invalid date entries associated with the sensor that the statistics belong to.\n\n

" + } + }, + "DuplicateTimestamps": { + "target": "com.amazonaws.lookoutequipment#CountPercent", + "traits": { + "smithy.api#documentation": "

\nParameter that describes the total number of duplicate timestamp records associated with the sensor that the statistics belong to.\n

" + } + }, + "CategoricalValues": { + "target": "com.amazonaws.lookoutequipment#CategoricalValues", + "traits": { + "smithy.api#documentation": "

\nParameter that describes potential risk about whether data associated with the sensor is categorical.\n

" + } + }, + "MultipleOperatingModes": { + "target": "com.amazonaws.lookoutequipment#MultipleOperatingModes", + "traits": { + "smithy.api#documentation": "

\nParameter that describes potential risk about whether data associated with the sensor has more than one operating mode.\n

" + } + }, + "LargeTimestampGaps": { + "target": "com.amazonaws.lookoutequipment#LargeTimestampGaps", + "traits": { + "smithy.api#documentation": "

\nParameter that describes potential risk about whether data associated with the sensor contains one or more large gaps between consecutive timestamps.\n

" + } + }, + "MonotonicValues": { + "target": "com.amazonaws.lookoutequipment#MonotonicValues", + "traits": { + "smithy.api#documentation": "

\nParameter that describes potential risk about whether data associated with the sensor is mostly monotonic.\n

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

\nIndicates the time reference to indicate the beginning of valid data associated with the sensor that the statistics belong to.\n

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

\nIndicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.\n

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

\n\nSummary of ingestion statistics like whether data exists, number of missing values, number of invalid values and so on related to the particular sensor.\n\n

" + } + }, + "com.amazonaws.lookoutequipment#SensorsWithShortDateRange": { + "type": "structure", + "members": { + "AffectedSensorCount": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the number of sensors that have less than 90 days of data.\n\n

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

\n\nEntity that comprises information on sensors that have shorter date range.\n\n

" + } + }, "com.amazonaws.lookoutequipment#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -2644,6 +3256,21 @@ } } }, + "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "POTENTIAL_ISSUE_DETECTED", + "name": "POTENTIAL_ISSUE_DETECTED" + }, + { + "value": "NO_ISSUE_DETECTED", + "name": "NO_ISSUE_DETECTED" + } + ] + } + }, "com.amazonaws.lookoutequipment#StopInferenceScheduler": { "type": "operation", "input": { @@ -2940,6 +3567,21 @@ "com.amazonaws.lookoutequipment#Timestamp": { "type": "timestamp" }, + "com.amazonaws.lookoutequipment#UnsupportedTimestamps": { + "type": "structure", + "members": { + "TotalNumberOfUnsupportedTimestamps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "

\n\nIndicates the total number of unsupported timestamps across the ingested data.\n\n

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

\n\nEntity that comprises information abount unsupported timestamps in the dataset.\n\n

" + } + }, "com.amazonaws.lookoutequipment#UntagResource": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/lookoutmetrics.json b/aws/sdk/aws-models/lookoutmetrics.json index f16c167faf..adcc54b210 100644 --- a/aws/sdk/aws-models/lookoutmetrics.json +++ b/aws/sdk/aws-models/lookoutmetrics.json @@ -728,6 +728,84 @@ "smithy.api#pattern": "^arn:([a-z\\d-]+):.*:.*:.*:.+$" } }, + "com.amazonaws.lookoutmetrics#AttributeValue": { + "type": "structure", + "members": { + "S": { + "target": "com.amazonaws.lookoutmetrics#StringAttributeValue", + "traits": { + "smithy.api#documentation": "

A string.

" + } + }, + "N": { + "target": "com.amazonaws.lookoutmetrics#NumberAttributeValue", + "traits": { + "smithy.api#documentation": "

A number.

" + } + }, + "B": { + "target": "com.amazonaws.lookoutmetrics#BinaryAttributeValue", + "traits": { + "smithy.api#documentation": "

A binary value.

" + } + }, + "SS": { + "target": "com.amazonaws.lookoutmetrics#StringListAttributeValue", + "traits": { + "smithy.api#documentation": "

A list of strings.

" + } + }, + "NS": { + "target": "com.amazonaws.lookoutmetrics#NumberListAttributeValue", + "traits": { + "smithy.api#documentation": "

A list of numbers.

" + } + }, + "BS": { + "target": "com.amazonaws.lookoutmetrics#BinaryListAttributeValue", + "traits": { + "smithy.api#documentation": "

A list of binary values.

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

An attribute value.

" + } + }, + "com.amazonaws.lookoutmetrics#AutoDetectionMetricSource": { + "type": "structure", + "members": { + "S3SourceConfig": { + "target": "com.amazonaws.lookoutmetrics#AutoDetectionS3SourceConfig", + "traits": { + "smithy.api#documentation": "

The source's source config.

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

An auto detection metric source.

" + } + }, + "com.amazonaws.lookoutmetrics#AutoDetectionS3SourceConfig": { + "type": "structure", + "members": { + "TemplatedPathList": { + "target": "com.amazonaws.lookoutmetrics#TemplatedPathList", + "traits": { + "smithy.api#documentation": "

The config's templated path list.

" + } + }, + "HistoricalDataPathList": { + "target": "com.amazonaws.lookoutmetrics#HistoricalDataPathList", + "traits": { + "smithy.api#documentation": "

The config's historical data path list.

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

An auto detection source config.

" + } + }, "com.amazonaws.lookoutmetrics#BackTestAnomalyDetector": { "type": "operation", "input": { @@ -778,6 +856,15 @@ "type": "structure", "members": {} }, + "com.amazonaws.lookoutmetrics#BinaryAttributeValue": { + "type": "string" + }, + "com.amazonaws.lookoutmetrics#BinaryListAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#BinaryAttributeValue" + } + }, "com.amazonaws.lookoutmetrics#Boolean": { "type": "boolean", "traits": { @@ -833,6 +920,25 @@ "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" } }, + "com.amazonaws.lookoutmetrics#Confidence": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HIGH", + "name": "HIGH" + }, + { + "value": "LOW", + "name": "LOW" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.lookoutmetrics#ConflictException": { "type": "structure", "members": { @@ -1810,6 +1916,234 @@ } } }, + "com.amazonaws.lookoutmetrics#DetectMetricSetConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfigRequest" + }, + "output": { + "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfigResponse" + }, + "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": "

Detects an Amazon S3 dataset's file format, interval, and offset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/DetectMetricSetConfig", + "code": 200 + } + } + }, + "com.amazonaws.lookoutmetrics#DetectMetricSetConfigRequest": { + "type": "structure", + "members": { + "AnomalyDetectorArn": { + "target": "com.amazonaws.lookoutmetrics#Arn", + "traits": { + "smithy.api#documentation": "

An anomaly detector ARN.

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

A data source.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.lookoutmetrics#DetectMetricSetConfigResponse": { + "type": "structure", + "members": { + "DetectedMetricSetConfig": { + "target": "com.amazonaws.lookoutmetrics#DetectedMetricSetConfig", + "traits": { + "smithy.api#documentation": "

The inferred dataset configuration for the datasource.

" + } + } + } + }, + "com.amazonaws.lookoutmetrics#DetectedCsvFormatDescriptor": { + "type": "structure", + "members": { + "FileCompression": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's file compression.

" + } + }, + "Charset": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's charset.

" + } + }, + "ContainsHeader": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

Whether the format includes a header.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's delimiter.

" + } + }, + "HeaderList": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's header list.

" + } + }, + "QuoteSymbol": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's quote symbol.

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

Properties of an inferred CSV format.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedField": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.lookoutmetrics#AttributeValue", + "traits": { + "smithy.api#documentation": "

The field's value.

" + } + }, + "Confidence": { + "target": "com.amazonaws.lookoutmetrics#Confidence", + "traits": { + "smithy.api#documentation": "

The field's confidence.

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

The field's message.

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

An inferred field.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedFileFormatDescriptor": { + "type": "structure", + "members": { + "CsvFormatDescriptor": { + "target": "com.amazonaws.lookoutmetrics#DetectedCsvFormatDescriptor", + "traits": { + "smithy.api#documentation": "

Details about a CSV format.

" + } + }, + "JsonFormatDescriptor": { + "target": "com.amazonaws.lookoutmetrics#DetectedJsonFormatDescriptor", + "traits": { + "smithy.api#documentation": "

Details about a JSON format.

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

Properties of an inferred data format.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedJsonFormatDescriptor": { + "type": "structure", + "members": { + "FileCompression": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's file compression.

" + } + }, + "Charset": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The format's character set.

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

A detected JSON format descriptor.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedMetricSetConfig": { + "type": "structure", + "members": { + "Offset": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The dataset's offset.

" + } + }, + "MetricSetFrequency": { + "target": "com.amazonaws.lookoutmetrics#DetectedField", + "traits": { + "smithy.api#documentation": "

The dataset's interval.

" + } + }, + "MetricSource": { + "target": "com.amazonaws.lookoutmetrics#DetectedMetricSource", + "traits": { + "smithy.api#documentation": "

The dataset's data source.

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

An inferred dataset configuration.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedMetricSource": { + "type": "structure", + "members": { + "S3SourceConfig": { + "target": "com.amazonaws.lookoutmetrics#DetectedS3SourceConfig", + "traits": { + "smithy.api#documentation": "

The data source's source configuration.

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

An inferred data source.

" + } + }, + "com.amazonaws.lookoutmetrics#DetectedS3SourceConfig": { + "type": "structure", + "members": { + "FileFormatDescriptor": { + "target": "com.amazonaws.lookoutmetrics#DetectedFileFormatDescriptor", + "traits": { + "smithy.api#documentation": "

The source's file format descriptor.

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

An inferred source configuration.

" + } + }, "com.amazonaws.lookoutmetrics#DimensionContribution": { "type": "structure", "members": { @@ -3046,6 +3380,9 @@ { "target": "com.amazonaws.lookoutmetrics#DescribeMetricSet" }, + { + "target": "com.amazonaws.lookoutmetrics#DetectMetricSetConfig" + }, { "target": "com.amazonaws.lookoutmetrics#GetAnomalyGroup" }, @@ -3339,6 +3676,15 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.lookoutmetrics#NumberAttributeValue": { + "type": "string" + }, + "com.amazonaws.lookoutmetrics#NumberListAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#NumberAttributeValue" + } + }, "com.amazonaws.lookoutmetrics#Offset": { "type": "integer", "traits": { @@ -3808,6 +4154,15 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.lookoutmetrics#StringAttributeValue": { + "type": "string" + }, + "com.amazonaws.lookoutmetrics#StringListAttributeValue": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#StringAttributeValue" + } + }, "com.amazonaws.lookoutmetrics#SubnetId": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/macie2.json b/aws/sdk/aws-models/macie2.json index a5804c15f6..689b53c614 100644 --- a/aws/sdk/aws-models/macie2.json +++ b/aws/sdk/aws-models/macie2.json @@ -1110,6 +1110,13 @@ "smithy.api#jsonName": "jobId" } }, + "originType": { + "target": "com.amazonaws.macie2#OriginType", + "traits": { + "smithy.api#documentation": "

Specifies how Amazon Macie found the sensitive data that produced the finding: SENSITIVE_DATA_DISCOVERY_JOB, for a classification job.

", + "smithy.api#jsonName": "originType" + } + }, "result": { "target": "com.amazonaws.macie2#ClassificationResult", "traits": { @@ -1119,7 +1126,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about a sensitive data finding, including the classification job that produced the finding.

" + "smithy.api#documentation": "

Provides information about a sensitive data finding and the details of the finding.

" } }, "com.amazonaws.macie2#ClassificationExportConfiguration": { @@ -4423,7 +4430,7 @@ "findingIds": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array of strings that lists the unique identifiers for the findings to retrieve.

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

An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.

", "smithy.api#jsonName": "findingIds", "smithy.api#required": {} } @@ -5262,7 +5269,7 @@ "com.amazonaws.macie2#JobComparator": { "type": "string", "traits": { - "smithy.api#documentation": "

The operator to use in a condition. Valid values are:

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

The operator to use in a condition. Depending on the type of condition, possible values are:

", "smithy.api#enum": [ { "value": "EQ", @@ -7009,6 +7016,18 @@ ] } }, + "com.amazonaws.macie2#OriginType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Specifies how Amazon Macie found the sensitive data that produced a finding. The only possible value is:

", + "smithy.api#enum": [ + { + "value": "SENSITIVE_DATA_DISCOVERY_JOB", + "name": "SENSITIVE_DATA_DISCOVERY_JOB" + } + ] + } + }, "com.amazonaws.macie2#Page": { "type": "structure", "members": { @@ -7231,6 +7250,9 @@ "type": "list", "member": { "target": "com.amazonaws.macie2#Range" + }, + "traits": { + "smithy.api#documentation": "

Specifies the locations of occurrences of sensitive data in a non-binary text file.

" } }, "com.amazonaws.macie2#Record": { @@ -7259,6 +7281,9 @@ "type": "list", "member": { "target": "com.amazonaws.macie2#Record" + }, + "traits": { + "smithy.api#documentation": "

Specifies the locations of occurrences of sensitive data in an Apache Avro object container or a structured data file.

" } }, "com.amazonaws.macie2#RelationshipStatus": { @@ -8909,7 +8934,7 @@ "tagKeys": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

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

One or more tags (keys) to remove from the resource. In an HTTP request to remove multiple tags, append the tagKeys parameter and argument for each tag to remove, and separate them with an ampersand (&).

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } diff --git a/aws/sdk/aws-models/mediatailor.json b/aws/sdk/aws-models/mediatailor.json index 48783982f2..e6301ccd19 100644 --- a/aws/sdk/aws-models/mediatailor.json +++ b/aws/sdk/aws-models/mediatailor.json @@ -234,7 +234,7 @@ "AdSegmentUrlPrefix": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

" + "smithy.api#documentation": "

A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

" } }, "ContentSegmentUrlPrefix": { @@ -310,6 +310,13 @@ "smithy.api#documentation": "

The tags to assign to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The tier for this channel. STANDARD tier channels can contain live programs.

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

The tags to assign to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#Tier", + "traits": { + "smithy.api#documentation": "

The tier of the channel.

" + } } } }, @@ -537,6 +550,112 @@ "smithy.api#documentation": "

The tags assigned to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The channel's tier.

" + } + } + } + }, + "com.amazonaws.mediatailor#CreateLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#CreateLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#CreateLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "

Creates name for a specific live source in a source location.

", + "smithy.api#http": { + "method": "POST", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#CreateLiveSourceRequest": { + "type": "structure", + "members": { + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

A list of HTTP package configuration parameters for this live source.

", + "smithy.api#required": {} + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the live source you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The tags to assign to the live source.

", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#CreateLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The ARN of the live source.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was created.

" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

The HTTP package configurations.

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

The timestamp that indicates when the live source was modified.

" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the live source.

" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location associated with the VOD source.

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

The tags assigned to the live source.

", + "smithy.api#jsonName": "tags" + } } } }, @@ -673,6 +792,12 @@ "smithy.api#required": {} } }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the LiveSource for this Program.

" + } + }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -698,8 +823,7 @@ "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The name that's used to refer to a VOD source.

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

The name that's used to refer to a VOD source.

" } } } @@ -731,6 +855,12 @@ "smithy.api#documentation": "

The timestamp of when the program was created.

" } }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the LiveSource for this Program.

" + } + }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -797,7 +927,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -856,7 +989,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -896,7 +1032,7 @@ "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { - "smithy.api#documentation": "

An array of HTTP package configuration parameters for this VOD source.

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

A list of HTTP package configuration parameters for this VOD source.

", "smithy.api#required": {} } }, @@ -949,7 +1085,7 @@ "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { - "smithy.api#documentation": "

The ARN for the VOD source.

" + "smithy.api#documentation": "

The last modified time of the VOD source.

" } }, "SourceLocationName": { @@ -1133,6 +1269,48 @@ "type": "structure", "members": {} }, + "com.amazonaws.mediatailor#DeleteLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeleteLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeleteLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "

Deletes a specific live source in a specific source location.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#DeleteLiveSourceRequest": { + "type": "structure", + "members": { + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the live source you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeleteLiveSourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.mediatailor#DeletePlaybackConfiguration": { "type": "operation", "input": { @@ -1414,6 +1592,98 @@ "smithy.api#documentation": "

The tags assigned to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The channel's tier.

" + } + } + } + }, + "com.amazonaws.mediatailor#DescribeLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DescribeLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DescribeLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "

Provides details about a specific live source in a specific source location.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#DescribeLiveSourceRequest": { + "type": "structure", + "members": { + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the live source you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DescribeLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The ARN of the live source.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was created.

" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

The HTTP package configurations.

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

The timestamp that indicates when the live source was modified.

" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the live source.

" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location associated with the VOD source.

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

The tags assigned to the live source.

", + "smithy.api#jsonName": "tags" + } } } }, @@ -1482,6 +1752,12 @@ "smithy.api#documentation": "

The timestamp of when the program was created.

" } }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the LiveSource for this Program.

" + } + }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -1578,7 +1854,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -1657,7 +1936,7 @@ "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { - "smithy.api#documentation": "

The ARN for the VOD source.

" + "smithy.api#documentation": "

The last modified time of the VOD source.

" } }, "SourceLocationName": { @@ -1785,7 +2064,7 @@ "Items": { "target": "com.amazonaws.mediatailor#__listOfScheduleEntry", "traits": { - "smithy.api#documentation": "

An array of schedule entries for the channel.

" + "smithy.api#documentation": "

A list of schedule entries for the channel.

" } }, "NextToken": { @@ -2162,7 +2441,7 @@ "Items": { "target": "com.amazonaws.mediatailor#__listOfAlert", "traits": { - "smithy.api#documentation": "

An array of alerts that are associated with this resource.

" + "smithy.api#documentation": "

A list of alerts that are associated with this resource.

" } }, "NextToken": { @@ -2221,7 +2500,7 @@ "Items": { "target": "com.amazonaws.mediatailor#__listOfChannel", "traits": { - "smithy.api#documentation": "

An array of channels that are associated with this account.

" + "smithy.api#documentation": "

A list of channels that are associated with this account.

" } }, "NextToken": { @@ -2232,6 +2511,73 @@ } } }, + "com.amazonaws.mediatailor#ListLiveSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListLiveSourcesRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListLiveSourcesResponse" + }, + "traits": { + "smithy.api#documentation": "

lists all the live sources in a source location.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}/liveSources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.mediatailor#ListLiveSourcesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": "

Upper bound on number of records to return. The maximum number of results is 100.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

Pagination token from the GET list request. Use the token to fetch the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#ListLiveSourcesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfLiveSource", + "traits": { + "smithy.api#documentation": "

Lists the live sources.

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

Pagination token from the list request. Use the token to fetch the next page of results.

" + } + } + } + }, "com.amazonaws.mediatailor#ListPlaybackConfigurations": { "type": "operation", "input": { @@ -2410,7 +2756,7 @@ "Items": { "target": "com.amazonaws.mediatailor#__listOfSourceLocation", "traits": { - "smithy.api#documentation": "

An array of source locations.

" + "smithy.api#documentation": "

A list of source locations.

" } }, "NextToken": { @@ -2555,6 +2901,61 @@ "smithy.api#documentation": "

The configuration for pre-roll ad insertion.

" } }, + "com.amazonaws.mediatailor#LiveSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The ARN for the live source.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was created.

" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

The HTTP package configurations for the live source.

", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was last modified.

" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name that's used to refer to a live source.

", + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "

The tags assigned to the live source.

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

Live source configuration parameters.

" + } + }, "com.amazonaws.mediatailor#LogConfiguration": { "type": "structure", "members": { @@ -2618,6 +3019,9 @@ { "target": "com.amazonaws.mediatailor#CreateChannel" }, + { + "target": "com.amazonaws.mediatailor#CreateLiveSource" + }, { "target": "com.amazonaws.mediatailor#CreatePrefetchSchedule" }, @@ -2636,6 +3040,9 @@ { "target": "com.amazonaws.mediatailor#DeleteChannelPolicy" }, + { + "target": "com.amazonaws.mediatailor#DeleteLiveSource" + }, { "target": "com.amazonaws.mediatailor#DeletePlaybackConfiguration" }, @@ -2654,6 +3061,9 @@ { "target": "com.amazonaws.mediatailor#DescribeChannel" }, + { + "target": "com.amazonaws.mediatailor#DescribeLiveSource" + }, { "target": "com.amazonaws.mediatailor#DescribeProgram" }, @@ -2681,6 +3091,9 @@ { "target": "com.amazonaws.mediatailor#ListChannels" }, + { + "target": "com.amazonaws.mediatailor#ListLiveSources" + }, { "target": "com.amazonaws.mediatailor#ListPlaybackConfigurations" }, @@ -2717,6 +3130,9 @@ { "target": "com.amazonaws.mediatailor#UpdateChannel" }, + { + "target": "com.amazonaws.mediatailor#UpdateLiveSource" + }, { "target": "com.amazonaws.mediatailor#UpdateSourceLocation" }, @@ -3467,6 +3883,12 @@ "smithy.api#required": {} } }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the live source used for the program.

" + } + }, "ProgramName": { "target": "com.amazonaws.mediatailor#__string", "traits": { @@ -3496,8 +3918,7 @@ "VodSourceName": { "target": "com.amazonaws.mediatailor#__string", "traits": { - "smithy.api#documentation": "

The name of the VOD source.

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

The name of the VOD source.

" } } }, @@ -3550,11 +3971,20 @@ "type": "structure", "members": { "BaseUrl": { - "target": "com.amazonaws.mediatailor#__string" + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.

" + } }, "Name": { - "target": "com.amazonaws.mediatailor#__string" + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

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

The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.

" } }, "com.amazonaws.mediatailor#SlateSource": { @@ -3619,7 +4049,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

The segment delivery configurations for the source location.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -3780,9 +4213,30 @@ } } }, + "com.amazonaws.mediatailor#Tier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BASIC", + "name": "BASIC" + }, + { + "value": "STANDARD", + "name": "STANDARD" + } + ] + } + }, "com.amazonaws.mediatailor#Transition": { "type": "structure", "members": { + "DurationMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "

The duration of the live program in seconds.

" + } + }, "RelativePosition": { "target": "com.amazonaws.mediatailor#RelativePosition", "traits": { @@ -3969,6 +4423,105 @@ "smithy.api#documentation": "

The tags assigned to the channel.

", "smithy.api#jsonName": "tags" } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The channel's tier.

" + } + } + } + }, + "com.amazonaws.mediatailor#UpdateLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#UpdateLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#UpdateLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "

Updates a specific live source in a specific source location.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#UpdateLiveSourceRequest": { + "type": "structure", + "members": { + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

A list of HTTP package configurations for the live source on this account.

", + "smithy.api#required": {} + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the live source you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The identifier for the source location you are working on.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#UpdateLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The ARN of the live source.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "

The timestamp that indicates when the live source was created.

" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "

The HTTP package configurations.

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

The timestamp that indicates when the live source was modified.

" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the live source.

" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "

The name of the source location associated with the VOD source.

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

The tags assigned to the live source.

", + "smithy.api#jsonName": "tags" + } } } }, @@ -4012,7 +4565,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -4064,7 +4620,10 @@ } }, "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration" + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "

A list of the segment delivery configurations associated with this resource.

" + } }, "SourceLocationName": { "target": "com.amazonaws.mediatailor#__string", @@ -4104,7 +4663,7 @@ "HttpPackageConfigurations": { "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", "traits": { - "smithy.api#documentation": "

An array of HTTP package configurations for the VOD source on this account.

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

A list of HTTP package configurations for the VOD source on this account.

", "smithy.api#required": {} } }, @@ -4150,7 +4709,7 @@ "LastModifiedTime": { "target": "com.amazonaws.mediatailor#__timestampUnix", "traits": { - "smithy.api#documentation": "

The ARN for the VOD source.

" + "smithy.api#documentation": "

The last modified time of the VOD source.

" } }, "SourceLocationName": { @@ -4276,6 +4835,12 @@ "target": "com.amazonaws.mediatailor#Channel" } }, + "com.amazonaws.mediatailor#__listOfLiveSource": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#LiveSource" + } + }, "com.amazonaws.mediatailor#__listOfPlaybackConfiguration": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/mgn.json b/aws/sdk/aws-models/mgn.json index 8e91c899b4..1c761d1211 100644 --- a/aws/sdk/aws-models/mgn.json +++ b/aws/sdk/aws-models/mgn.json @@ -50,9 +50,8 @@ "aws.api#service": { "sdkId": "mgn", "arnNamespace": "mgn", - "cloudFormationName": "ApplicationMigrationService", - "cloudTrailEventSource": "mgn.amazonaws.com", - "endpointPrefix": "mgn" + "awsProductName": "mgn", + "cloudTrailEventSource": "mgn.amazonaws.com" }, "aws.auth#sigv4": { "name": "mgn" @@ -60,16 +59,16 @@ "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ + "content-type", "x-amz-content-sha256", - "x-amzn-trace-id", "x-amz-user-agent", - "content-type" + "x-amzn-trace-id" ], "additionalExposedHeaders": [ - "x-amz-apigw-id", - "x-amzn-trace-id", "x-amzn-errortype", - "x-amzn-requestid" + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amz-apigw-id" ] }, "smithy.api#documentation": "

The Application Migration Service service.

", @@ -113,12 +112,12 @@ "traits": { "smithy.api#enum": [ { - "value": "LEGACY_BIOS", - "name": "LEGACY_BIOS" + "name": "LEGACY_BIOS", + "value": "LEGACY_BIOS" }, { - "value": "UEFI", - "name": "UEFI" + "name": "UEFI", + "value": "UEFI" } ] } @@ -177,8 +176,8 @@ "traits": { "smithy.api#documentation": "

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER. This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

", "smithy.api#http": { - "method": "POST", "uri": "/ChangeServerLifeCycleState", + "method": "POST", "code": 200 } } @@ -222,16 +221,16 @@ "traits": { "smithy.api#enum": [ { - "value": "READY_FOR_TEST", - "name": "READY_FOR_TEST" + "name": "READY_FOR_TEST", + "value": "READY_FOR_TEST" }, { - "value": "READY_FOR_CUTOVER", - "name": "READY_FOR_CUTOVER" + "name": "READY_FOR_CUTOVER", + "value": "READY_FOR_CUTOVER" }, { - "value": "CUTOVER", - "name": "CUTOVER" + "name": "CUTOVER", + "value": "CUTOVER" } ] } @@ -298,8 +297,8 @@ "traits": { "smithy.api#documentation": "

Creates a new ReplicationConfigurationTemplate.

", "smithy.api#http": { - "method": "POST", "uri": "/CreateReplicationConfigurationTemplate", + "method": "POST", "code": 201 } } @@ -423,68 +422,68 @@ "traits": { "smithy.api#enum": [ { - "value": "AGENT_NOT_SEEN", - "name": "AGENT_NOT_SEEN" + "name": "AGENT_NOT_SEEN", + "value": "AGENT_NOT_SEEN" }, { - "value": "SNAPSHOTS_FAILURE", - "name": "SNAPSHOTS_FAILURE" + "name": "SNAPSHOTS_FAILURE", + "value": "SNAPSHOTS_FAILURE" }, { - "value": "NOT_CONVERGING", - "name": "NOT_CONVERGING" + "name": "NOT_CONVERGING", + "value": "NOT_CONVERGING" }, { - "value": "UNSTABLE_NETWORK", - "name": "UNSTABLE_NETWORK" + "name": "UNSTABLE_NETWORK", + "value": "UNSTABLE_NETWORK" }, { - "value": "FAILED_TO_CREATE_SECURITY_GROUP", - "name": "FAILED_TO_CREATE_SECURITY_GROUP" + "name": "FAILED_TO_CREATE_SECURITY_GROUP", + "value": "FAILED_TO_CREATE_SECURITY_GROUP" }, { - "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER", - "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER" + "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER", + "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER" }, { - "value": "FAILED_TO_BOOT_REPLICATION_SERVER", - "name": "FAILED_TO_BOOT_REPLICATION_SERVER" + "name": "FAILED_TO_BOOT_REPLICATION_SERVER", + "value": "FAILED_TO_BOOT_REPLICATION_SERVER" }, { - "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", - "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" + "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", + "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" }, { - "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", - "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" }, { - "value": "FAILED_TO_CREATE_STAGING_DISKS", - "name": "FAILED_TO_CREATE_STAGING_DISKS" + "name": "FAILED_TO_CREATE_STAGING_DISKS", + "value": "FAILED_TO_CREATE_STAGING_DISKS" }, { - "value": "FAILED_TO_ATTACH_STAGING_DISKS", - "name": "FAILED_TO_ATTACH_STAGING_DISKS" + "name": "FAILED_TO_ATTACH_STAGING_DISKS", + "value": "FAILED_TO_ATTACH_STAGING_DISKS" }, { - "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", - "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" + "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", + "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" }, { - "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", - "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" + "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", + "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" }, { - "value": "FAILED_TO_START_DATA_TRANSFER", - "name": "FAILED_TO_START_DATA_TRANSFER" + "name": "FAILED_TO_START_DATA_TRANSFER", + "value": "FAILED_TO_START_DATA_TRANSFER" }, { - "value": "UNSUPPORTED_VM_CONFIGURATION", - "name": "UNSUPPORTED_VM_CONFIGURATION" + "name": "UNSUPPORTED_VM_CONFIGURATION", + "value": "UNSUPPORTED_VM_CONFIGURATION" }, { - "value": "LAST_SNAPSHOT_JOB_FAILED", - "name": "LAST_SNAPSHOT_JOB_FAILED" + "name": "LAST_SNAPSHOT_JOB_FAILED", + "value": "LAST_SNAPSHOT_JOB_FAILED" } ] } @@ -691,24 +690,24 @@ "traits": { "smithy.api#enum": [ { - "value": "NOT_STARTED", - "name": "NOT_STARTED" + "name": "NOT_STARTED", + "value": "NOT_STARTED" }, { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" }, { - "value": "SUCCEEDED", - "name": "SUCCEEDED" + "name": "SUCCEEDED", + "value": "SUCCEEDED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" }, { - "value": "SKIPPED", - "name": "SKIPPED" + "name": "SKIPPED", + "value": "SKIPPED" } ] } @@ -724,52 +723,52 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "INITIATING", - "name": "INITIATING" + "name": "INITIATING", + "value": "INITIATING" }, { - "value": "INITIAL_SYNC", - "name": "INITIAL_SYNC" + "name": "INITIAL_SYNC", + "value": "INITIAL_SYNC" }, { - "value": "BACKLOG", - "name": "BACKLOG" + "name": "BACKLOG", + "value": "BACKLOG" }, { - "value": "CREATING_SNAPSHOT", - "name": "CREATING_SNAPSHOT" + "name": "CREATING_SNAPSHOT", + "value": "CREATING_SNAPSHOT" }, { - "value": "CONTINUOUS", - "name": "CONTINUOUS" + "name": "CONTINUOUS", + "value": "CONTINUOUS" }, { - "value": "PAUSED", - "name": "PAUSED" + "name": "PAUSED", + "value": "PAUSED" }, { - "value": "RESCAN", - "name": "RESCAN" + "name": "RESCAN", + "value": "RESCAN" }, { - "value": "STALLED", - "name": "STALLED" + "name": "STALLED", + "value": "STALLED" }, { - "value": "DISCONNECTED", - "name": "DISCONNECTED" + "name": "DISCONNECTED", + "value": "DISCONNECTED" }, { - "value": "PENDING_SNAPSHOT_SHIPPING", - "name": "PENDING_SNAPSHOT_SHIPPING" + "name": "PENDING_SNAPSHOT_SHIPPING", + "value": "PENDING_SNAPSHOT_SHIPPING" }, { - "value": "SHIPPING_SNAPSHOT", - "name": "SHIPPING_SNAPSHOT" + "name": "SHIPPING_SNAPSHOT", + "value": "SHIPPING_SNAPSHOT" } ] } @@ -796,8 +795,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single Job by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteJob", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -841,8 +840,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single Replication Configuration Template by ID

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteReplicationConfigurationTemplate", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -886,8 +885,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single source server by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteSourceServer", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -931,8 +930,8 @@ "traits": { "smithy.api#documentation": "

Deletes a given vCenter client by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteVcenterClient", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -969,15 +968,15 @@ "traits": { "smithy.api#documentation": "

Retrieves detailed job log items with paging.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeJobLogItems", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1042,15 +1041,15 @@ "traits": { "smithy.api#documentation": "

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeJobs", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1061,8 +1060,7 @@ "filters": { "target": "com.amazonaws.mgn#DescribeJobsRequestFilters", "traits": { - "smithy.api#documentation": "

Request to describe Job log filters.

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

Request to describe Job log filters.

" } }, "maxResults": { @@ -1156,15 +1154,15 @@ "traits": { "smithy.api#documentation": "

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeReplicationConfigurationTemplates", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1175,8 +1173,7 @@ "replicationConfigurationTemplateIDs": { "target": "com.amazonaws.mgn#ReplicationConfigurationTemplateIDs", "traits": { - "smithy.api#documentation": "

Request to describe Replication Configuration template by template IDs.

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

Request to describe Replication Configuration template by template IDs.

" } }, "maxResults": { @@ -1229,15 +1226,15 @@ "traits": { "smithy.api#documentation": "

Retrieves all SourceServers or multiple SourceServers by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeSourceServers", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1248,8 +1245,7 @@ "filters": { "target": "com.amazonaws.mgn#DescribeSourceServersRequestFilters", "traits": { - "smithy.api#documentation": "

Request to filter Source Servers list.

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

Request to filter Source Servers list.

" } }, "maxResults": { @@ -1349,15 +1345,15 @@ "traits": { "smithy.api#documentation": "

Returns a list of the installed vCenter clients.

", "smithy.api#http": { - "method": "GET", "uri": "/DescribeVcenterClients", + "method": "GET", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1420,8 +1416,8 @@ "traits": { "smithy.api#documentation": "

Disconnects specific Source Servers from Application Migration Service. Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", "smithy.api#http": { - "method": "POST", "uri": "/DisconnectFromService", + "method": "POST", "code": 200 } } @@ -1514,8 +1510,8 @@ "traits": { "smithy.api#documentation": "

Finalizes the cutover immediately for specific Source Servers. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", "smithy.api#http": { - "method": "POST", "uri": "/FinalizeCutover", + "method": "POST", "code": 200 } } @@ -1574,8 +1570,8 @@ "traits": { "smithy.api#documentation": "

Lists all LaunchConfigurations available, filtered by Source Server IDs.

", "smithy.api#http": { - "method": "POST", "uri": "/GetLaunchConfiguration", + "method": "POST", "code": 200 }, "smithy.api#readonly": {} @@ -1612,8 +1608,8 @@ "traits": { "smithy.api#documentation": "

Lists all ReplicationConfigurations, filtered by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/GetReplicationConfiguration", + "method": "POST", "code": 200 }, "smithy.api#readonly": {} @@ -1704,8 +1700,8 @@ "traits": { "smithy.api#documentation": "

Initialize Application Migration Service.

", "smithy.api#http": { - "method": "POST", "uri": "/InitializeService", + "method": "POST", "code": 204 } } @@ -1868,68 +1864,68 @@ "traits": { "smithy.api#enum": [ { - "value": "JOB_START", - "name": "JOB_START" + "name": "JOB_START", + "value": "JOB_START" }, { - "value": "SERVER_SKIPPED", - "name": "SERVER_SKIPPED" + "name": "SERVER_SKIPPED", + "value": "SERVER_SKIPPED" }, { - "value": "CLEANUP_START", - "name": "CLEANUP_START" + "name": "CLEANUP_START", + "value": "CLEANUP_START" }, { - "value": "CLEANUP_END", - "name": "CLEANUP_END" + "name": "CLEANUP_END", + "value": "CLEANUP_END" }, { - "value": "CLEANUP_FAIL", - "name": "CLEANUP_FAIL" + "name": "CLEANUP_FAIL", + "value": "CLEANUP_FAIL" }, { - "value": "SNAPSHOT_START", - "name": "SNAPSHOT_START" + "name": "SNAPSHOT_START", + "value": "SNAPSHOT_START" }, { - "value": "SNAPSHOT_END", - "name": "SNAPSHOT_END" + "name": "SNAPSHOT_END", + "value": "SNAPSHOT_END" }, { - "value": "SNAPSHOT_FAIL", - "name": "SNAPSHOT_FAIL" + "name": "SNAPSHOT_FAIL", + "value": "SNAPSHOT_FAIL" }, { - "value": "USING_PREVIOUS_SNAPSHOT", - "name": "USING_PREVIOUS_SNAPSHOT" + "name": "USING_PREVIOUS_SNAPSHOT", + "value": "USING_PREVIOUS_SNAPSHOT" }, { - "value": "CONVERSION_START", - "name": "CONVERSION_START" + "name": "CONVERSION_START", + "value": "CONVERSION_START" }, { - "value": "CONVERSION_END", - "name": "CONVERSION_END" + "name": "CONVERSION_END", + "value": "CONVERSION_END" }, { - "value": "CONVERSION_FAIL", - "name": "CONVERSION_FAIL" + "name": "CONVERSION_FAIL", + "value": "CONVERSION_FAIL" }, { - "value": "LAUNCH_START", - "name": "LAUNCH_START" + "name": "LAUNCH_START", + "value": "LAUNCH_START" }, { - "value": "LAUNCH_FAILED", - "name": "LAUNCH_FAILED" + "name": "LAUNCH_FAILED", + "value": "LAUNCH_FAILED" }, { - "value": "JOB_CANCEL", - "name": "JOB_CANCEL" + "name": "JOB_CANCEL", + "value": "JOB_CANCEL" }, { - "value": "JOB_END", - "name": "JOB_END" + "name": "JOB_END", + "value": "JOB_END" } ] } @@ -1992,10 +1988,7 @@ ], "traits": { "aws.api#arn": { - "template": "job/{jobID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "job/{jobID}" } } }, @@ -2112,12 +2105,12 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "STARTED", - "name": "STARTED" + "name": "STARTED", + "value": "STARTED" } ] } @@ -2392,40 +2385,40 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "NOT_READY", - "name": "NOT_READY" + "name": "NOT_READY", + "value": "NOT_READY" }, { - "value": "READY_FOR_TEST", - "name": "READY_FOR_TEST" + "name": "READY_FOR_TEST", + "value": "READY_FOR_TEST" }, { - "value": "TESTING", - "name": "TESTING" + "name": "TESTING", + "value": "TESTING" }, { - "value": "READY_FOR_CUTOVER", - "name": "READY_FOR_CUTOVER" + "name": "READY_FOR_CUTOVER", + "value": "READY_FOR_CUTOVER" }, { - "value": "CUTTING_OVER", - "name": "CUTTING_OVER" + "name": "CUTTING_OVER", + "value": "CUTTING_OVER" }, { - "value": "CUTOVER", - "name": "CUTOVER" + "name": "CUTOVER", + "value": "CUTOVER" }, { - "value": "DISCONNECTED", - "name": "DISCONNECTED" + "name": "DISCONNECTED", + "value": "DISCONNECTED" }, { - "value": "DISCOVERED", - "name": "DISCOVERED" + "name": "DISCOVERED", + "value": "DISCOVERED" } ] } @@ -2471,8 +2464,7 @@ "smithy.api#documentation": "

List all tags for your Application Migration Service resources.

", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -2523,8 +2515,8 @@ "traits": { "smithy.api#documentation": "

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID. This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

", "smithy.api#http": { - "method": "POST", "uri": "/MarkAsArchived", + "method": "POST", "code": 200 } } @@ -3008,10 +3000,7 @@ }, "traits": { "aws.api#arn": { - "template": "replication-configuration-template/{replicationConfigurationTemplateID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "replication-configuration-template/{replicationConfigurationTemplateID}" } } }, @@ -3038,12 +3027,12 @@ "traits": { "smithy.api#enum": [ { - "value": "AGENT_BASED", - "name": "AGENT_BASED" + "name": "AGENT_BASED", + "value": "AGENT_BASED" }, { - "value": "SNAPSHOT_SHIPPING", - "name": "SNAPSHOT_SHIPPING" + "name": "SNAPSHOT_SHIPPING", + "value": "SNAPSHOT_SHIPPING" } ] } @@ -3110,8 +3099,8 @@ "traits": { "smithy.api#documentation": "

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started. This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

", "smithy.api#http": { - "method": "POST", "uri": "/RetryDataReplication", + "method": "POST", "code": 200 } } @@ -3170,6 +3159,12 @@ "traits": { "smithy.api#documentation": "

Exceeded the service quota code.

" } + }, + "quotaValue": { + "target": "com.amazonaws.mgn#StrictlyPositiveInteger", + "traits": { + "smithy.api#documentation": "

Exceeded the service quota value.

" + } } }, "traits": { @@ -3386,10 +3381,7 @@ ], "traits": { "aws.api#arn": { - "template": "source-server/{sourceServerID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "source-server/{sourceServerID}" } } }, @@ -3421,8 +3413,8 @@ "traits": { "smithy.api#documentation": "

Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

", "smithy.api#http": { - "method": "POST", "uri": "/StartCutover", + "method": "POST", "code": 202 } } @@ -3496,8 +3488,8 @@ "traits": { "smithy.api#documentation": "

Starts replication for SNAPSHOT_SHIPPING agents.

", "smithy.api#http": { - "method": "POST", "uri": "/StartReplication", + "method": "POST", "code": 200 } } @@ -3536,8 +3528,8 @@ "traits": { "smithy.api#documentation": "

Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

", "smithy.api#http": { - "method": "POST", "uri": "/StartTest", + "method": "POST", "code": 202 } } @@ -3648,8 +3640,7 @@ "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -3700,12 +3691,12 @@ "traits": { "smithy.api#enum": [ { - "value": "NONE", - "name": "NONE" + "name": "NONE", + "value": "NONE" }, { - "value": "BASIC", - "name": "BASIC" + "name": "BASIC", + "value": "BASIC" } ] } @@ -3732,8 +3723,8 @@ "traits": { "smithy.api#documentation": "

Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

", "smithy.api#http": { - "method": "POST", "uri": "/TerminateTargetInstances", + "method": "POST", "code": 202 } } @@ -3859,8 +3850,7 @@ "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of Application Migration Service resources.

", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -3911,8 +3901,8 @@ "traits": { "smithy.api#documentation": "

Updates multiple LaunchConfigurations by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateLaunchConfiguration", + "method": "POST", "code": 200 }, "smithy.api#idempotent": {} @@ -4000,8 +3990,8 @@ "traits": { "smithy.api#documentation": "

Allows you to update multiple ReplicationConfigurations by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateReplicationConfiguration", + "method": "POST", "code": 200 }, "smithy.api#idempotent": {} @@ -4128,8 +4118,8 @@ "traits": { "smithy.api#documentation": "

Updates multiple ReplicationConfigurationTemplates by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateReplicationConfigurationTemplate", + "method": "POST", "code": 200 } } @@ -4249,8 +4239,8 @@ "traits": { "smithy.api#documentation": "

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateSourceServerReplicationType", + "method": "POST", "code": 200 } } @@ -4438,10 +4428,7 @@ }, "traits": { "aws.api#arn": { - "template": "vcenter-client/{vcenterClientID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "vcenter-client/{vcenterClientID}" } } } diff --git a/aws/sdk/aws-models/monitoring.json b/aws/sdk/aws-models/monitoring.json index 230a6a986e..51733b6f5c 100644 --- a/aws/sdk/aws-models/monitoring.json +++ b/aws/sdk/aws-models/monitoring.json @@ -737,6 +737,9 @@ "input": { "target": "com.amazonaws.cloudwatch#DeleteAlarmsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#ResourceNotFound" @@ -1412,7 +1415,7 @@ "Name": { "target": "com.amazonaws.cloudwatch#DimensionName", "traits": { - "smithy.api#documentation": "

The name of the dimension. Dimension names must contain only ASCII characters and must include \n\t\t\tat least one non-whitespace character.

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

The name of the dimension. Dimension names must contain only ASCII characters, must include \n\t\t\tat least one non-whitespace character, and cannot start with a colon (:).

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

A dimension is a name/value pair that is part of the identity of a metric. You \n\t\t\tcan assign up to 10 dimensions to a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric.

" + "smithy.api#documentation": "

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n\t\t\tidentifier for a metric, whenever you add a unique name/value pair to one of \n\t\t\tyour metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n\t\tInstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n\t\t

You \n\t\tcan assign up to 10 dimensions to a metric.

" } }, "com.amazonaws.cloudwatch#DimensionFilter": { @@ -1496,6 +1499,9 @@ "input": { "target": "com.amazonaws.cloudwatch#DisableAlarmActionsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Disables the actions for the specified alarms. When an alarm's actions are disabled, the\n\t\t\talarm actions do not execute when the alarm state changes.

" } @@ -1560,6 +1566,9 @@ "input": { "target": "com.amazonaws.cloudwatch#EnableAlarmActionsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Enables the actions for the specified alarms.

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

You can use the GetMetricData API to retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.

\n\t\t\n\t\t

Calls to the GetMetricData API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.

\n\n\t\t

Amazon CloudWatch retains metric data as follows:

\n\t\t \n\t\t

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.

\n\t\t\n\t\t

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

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

You can use the GetMetricData API to retrieve CloudWatch metric values. The operation \n\t\t\tcan also include a CloudWatch Metrics Insights query, and one or more metric math functions.

\n\t\t

A GetMetricData operation that does not include a query can retrieve as many as 500 different\n\t\t\tmetrics in a single request, with a total of as many as 100,800 data points. You can also\n\t\t\toptionally perform metric math expressions on the values of the returned statistics, to create\n\t\t\tnew time series that represent new insights into your data. For example, using Lambda\n\t\t\tmetrics, you could divide the Errors metric by the Invocations metric to get an error\n\t\t\trate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\t\tGuide.

\n\t\t\n\t\t\t\t\n\t\t

If you include a Metrics Insights query, each GetMetricData operation can include only one\n\t\t\tquery. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries\n\t\tcan query only the most recent three hours of metric data. For more information about Metrics Insights, \n\t\tsee Query your metrics with CloudWatch Metrics Insights.

\n\t\t\n\t\t

Calls to the GetMetricData API have a different pricing structure than \n\t\t\tcalls to GetMetricStatistics. For more information about pricing, see \n\t\t\tAmazon CloudWatch Pricing.

\n\n\t\t

Amazon CloudWatch retains metric data as follows:

\n\t\t \n\t\t

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect \n\t\t\tdata using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, \n\t\t\tbut is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with \n\t\t\ta resolution of 1 hour.

\n\t\t\n\t\t

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified\n\t\t\twhen the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n\t\t\tIf you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

\n\t\n\t\t

\n Using Metrics Insights queries with metric math\n

\n\t\t

You can't mix a Metric Insights query and metric math syntax in the same expression, but \n\t\t\tyou can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights \n\t\t\tquery without a GROUP BY clause returns a single time-series (TS), \n\t\t\tand can be used as input for a metric math expression that expects a single time series. A Metrics Insights \n\t\t\tquery with a GROUP BY clause returns an array of time-series (TS[]), \n\t\t\tand can be used as input for a metric math expression that expects an array of time series.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1883,7 +1892,7 @@ "MetricDataQueries": { "target": "com.amazonaws.cloudwatch#MetricDataQueries", "traits": { - "smithy.api#documentation": "

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

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

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery\n\t\tstructures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query,\n\t\tor a math expression to perform on retrieved data.

", "smithy.api#required": {} } }, @@ -2167,7 +2176,13 @@ "OutputFormat": { "target": "com.amazonaws.cloudwatch#MetricStreamOutputFormat", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The output format for the stream. Valid values are json\n\t\t\tand opentelemetry0.7. For more information about metric stream\n\t\t\toutput formats, see \n\t\t\t\n\t\t\t\tMetric streams output formats.

" + } + }, + "StatisticsConfigurations": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations", + "traits": { + "smithy.api#documentation": "

Each entry in this array displays information about one or more metrics that include additional statistics\n\t\t\tin the metric stream. For more information about the additional statistics, see \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.

" } } } @@ -3293,7 +3308,7 @@ "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

" + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. The valid values\n \tare breaching, notBreaching, ignore, and \n \tmissing. For more information, see\n \tConfiguring how CloudWatch alarms treat missing data.

\n\t\t

If this parameter is omitted, the default \n \tbehavior of missing is used.

" } }, "EvaluateLowSampleCountPercentile": { @@ -3356,7 +3371,7 @@ "Expression": { "target": "com.amazonaws.cloudwatch#MetricExpression", "traits": { - "smithy.api#documentation": "

The math expression to be performed on the returned data, if this object is performing a math expression. This expression\n\t\t\tcan use the Id of the other metrics to refer to those metrics, and can also use the Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" + "smithy.api#documentation": "

This field can contain either a Metrics Insights query, or a metric math expression to be performed on the \n\t\t\treturned data. For more information about Metrics Insights queries, see \n\t\t\tMetrics Insights query components and syntax in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

A math expression\n\t\t\tcan use the Id of the other metrics or queries to refer to those metrics, and can also use \n\t\t\tthe Id of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\tMetric Math Syntax and Functions in the\n\t\t\tAmazon CloudWatch User Guide.

\n\t\t

Within each MetricDataQuery object, you must specify either \n\t\t\tExpression or MetricStat but not both.

" } }, "Label": { @@ -3385,7 +3400,7 @@ } }, "traits": { - "smithy.api#documentation": "

This structure is used in both GetMetricData and PutMetricAlarm. The supported\n\t\t\tuse of this structure is different for those two operations.

\n\t\t

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a math expression on metric data. A\n\t\t\tsingle GetMetricData call can include up to 500 MetricDataQuery\n\t\t\tstructures.

\n\t\t

When used in PutMetricAlarm, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm call can include up to 20\n\t\t\t\tMetricDataQuery structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression parameter\n\t\t\tto perform a math expression. Of those Expression structures, one must have True\n\t\tas the value for ReturnData. The result of this expression is the value the alarm watches.

\n\n\t\t

Any expression used in a PutMetricAlarm\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.

\n\n\t\t

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData\n\t\t\toperation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

" + "smithy.api#documentation": "

This structure is used in both GetMetricData and PutMetricAlarm. The supported\n\t\t\tuse of this structure is different for those two operations.

\n\t\t

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving\n\t\t\ta batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A\n\t\t\tsingle GetMetricData call can include up to 500 MetricDataQuery\n\t\t\tstructures.

\n\t\t

When used in PutMetricAlarm, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each MetricDataQuery in the array specifies either\n\t\t\ta metric to retrieve, or a math expression to be performed on retrieved metrics. A\n\t\t\tsingle PutMetricAlarm call can include up to 20\n\t\t\t\tMetricDataQuery structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a MetricStat parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the Expression parameter\n\t\t\tto perform a math expression. Of those Expression structures, one must have True\n\t\tas the value for ReturnData. The result of this expression is the value the alarm watches.

\n\n\t\t

Any expression used in a PutMetricAlarm\n\t\t\toperation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User\n\t\t\t\tGuide.

\n\n\t\t

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData\n\t\t\toperation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

" } }, "com.amazonaws.cloudwatch#MetricDataResult": { @@ -3699,6 +3714,71 @@ "com.amazonaws.cloudwatch#MetricStreamState": { "type": "string" }, + "com.amazonaws.cloudwatch#MetricStreamStatistic": { + "type": "string" + }, + "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatistic" + } + }, + "com.amazonaws.cloudwatch#MetricStreamStatisticsConfiguration": { + "type": "structure", + "members": { + "IncludeMetrics": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsIncludeMetrics", + "traits": { + "smithy.api#documentation": "

An array of metric name and namespace pairs that stream the additional statistics listed\n\t\tin the value of the AdditionalStatistics parameter. There can be as many as \n\t\t100 pairs in the array.

\n\t\t

All metrics that match the combination of metric name and namespace will be streamed\n\t\twith the additional statistics, no matter their dimensions.

", + "smithy.api#required": {} + } + }, + "AdditionalStatistics": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics", + "traits": { + "smithy.api#documentation": "

The list of additional statistics that are to be streamed for the metrics listed\n\t\tin the IncludeMetrics array in this structure. This list can include as many as 20 statistics.

\n\t\t

If the OutputFormat for the stream is opentelemetry0.7, the only \n\t\t\tvalid values are p??\n percentile statistics such as p90, p99 and so on.

\n\t\t

If the OutputFormat for the stream is json, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. For example, this includes\n\t\ttm98, \n wm90, PR(:300), and so on.

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

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for\n\t\t\tone metric that includes additional statistics in the stream. For more information about statistics, \n\t\t\tsee CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions.

" + } + }, + "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfiguration" + } + }, + "com.amazonaws.cloudwatch#MetricStreamStatisticsIncludeMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsMetric" + } + }, + "com.amazonaws.cloudwatch#MetricStreamStatisticsMetric": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric.

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

The name of the metric.

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

This object contains the information for one metric that is to be streamed with \n\t\tadditional statistics.

" + } + }, "com.amazonaws.cloudwatch#MetricWidget": { "type": "string" }, @@ -3885,13 +3965,16 @@ "input": { "target": "com.amazonaws.cloudwatch#PutCompositeAlarmInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#LimitExceededFault" } ], "traits": { - "smithy.api#documentation": "

Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.

\n\t\t

The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms.

\n\t\t

Using composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.

\n\t\t

Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.

\n\t\t \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n\t\t\t

To get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to False.

\n\t\t\t

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t

\n \n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.

\n\t\t\n\t\t

To use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

\n\t\t\n\t\t

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.

" + "smithy.api#documentation": "

Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.

\n\t\t

The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. \n\t\t\tAny single alarm can be included in the rule expressions of as many as 150 composite alarms.

\n\t\t

Using composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.

\n\t\t

Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.

\n\t\t \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n\t\t\t

To get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to False.

\n\t\t\t

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t

\n \n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.

\n\t\t\n\t\t

To use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

\n\t\t\n\t\t

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.

" } }, "com.amazonaws.cloudwatch#PutCompositeAlarmInput": { @@ -4062,6 +4145,9 @@ "input": { "target": "com.amazonaws.cloudwatch#PutMetricAlarmInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#LimitExceededFault" @@ -4182,7 +4268,7 @@ "TreatMissingData": { "target": "com.amazonaws.cloudwatch#TreatMissingData", "traits": { - "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n\t\t

Valid Values: breaching | notBreaching | ignore | missing\n

" + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. \n\t\t\tFor more information, see Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data.

\n\t\t

Valid Values: breaching | notBreaching | ignore | missing\n

\n\t\t \n

Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\n\t\t\tmissing data even if you choose a different option for TreatMissingData. When an \n\t\t\tAWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

\n\t\t " } }, "EvaluateLowSampleCountPercentile": { @@ -4216,6 +4302,9 @@ "input": { "target": "com.amazonaws.cloudwatch#PutMetricDataInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" @@ -4279,7 +4368,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto Amazon Web Services destinations including\n\t\t\tAmazon S3 and to many third-party solutions.

\n\t\t

For more information, see \n\t\tUsing Metric Streams.

\n\t\t

To create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole permission\n\t\t\tand either the CloudWatchFullAccess\n\t\tpolicy or the cloudwatch:PutMetricStream \n\t\tpermission.

\n\t\t

When you create or update a metric stream, you choose one of the following:

\n\t\t \n\t\t\n\t\t

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" + "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto Amazon Web Services destinations including\n\t\t\tAmazon S3 and to many third-party solutions.

\n\t\t

For more information, see \n\t\tUsing Metric Streams.

\n\t\t

To create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole permission\n\t\t\tand either the CloudWatchFullAccess\n\t\tpolicy or the cloudwatch:PutMetricStream \n\t\tpermission.

\n\t\t

When you create or update a metric stream, you choose one of the following:

\n\t\t \n\t\t\n\t\t

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use the\n\t\t\tStatisticsConfigurations parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. Streaming additional statistics incurs\n\t\t\tadditional costs. For more information, see Amazon CloudWatch Pricing.

\n\t\t\n\t\t

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" } }, "com.amazonaws.cloudwatch#PutMetricStreamInput": { @@ -4330,6 +4419,12 @@ "traits": { "smithy.api#documentation": "

A list of key-value pairs to associate with the metric stream. You can associate as \n\t\t\tmany as 50 tags with a metric stream.

\n\t\t

Tags can help you organize and categorize your resources. You can also use them to scope user\n\t\t\tpermissions by granting a user\n\t\t\tpermission to access or change only resources with certain tag values.

\n\t\t

You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags\n\t\t\tyou specify in this parameter are ignored. To change the tags of an existing metric stream, use\n\t\t\tTagResource\n\t\t\tor UntagResource.

" } + }, + "StatisticsConfigurations": { + "target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations", + "traits": { + "smithy.api#documentation": "

By default, a metric stream always sends the MAX, MIN, SUM, \n\t\t\tand SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have \n\t\t\tthe metric stream also send additional statistics in the stream. This \n\t\t\tarray can have up to 100 members.

\n\t\t

For each entry in this array, you specify one or more metrics and the list of additional statistics to stream\n\t\t\tfor those metrics. The additional statistics that you can stream depend on the stream's OutputFormat.\n\t\t\tIf the OutputFormat is json, you can stream any additional statistic that is supported \n\t\t\tby CloudWatch, listed in \n\t\t\t\n\t\t\t\tCloudWatch statistics definitions. If the OutputFormat is \n\t\t\topentelemetry0.7, you can stream percentile statistics such as p95, p99.9 and so on.

" + } } } }, @@ -4473,6 +4568,9 @@ "input": { "target": "com.amazonaws.cloudwatch#SetAlarmStateInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.cloudwatch#InvalidFormatFault" diff --git a/aws/sdk/aws-models/mq.json b/aws/sdk/aws-models/mq.json index 2c5941459b..dc66e1558e 100644 --- a/aws/sdk/aws-models/mq.json +++ b/aws/sdk/aws-models/mq.json @@ -29,6 +29,28 @@ ] }, "shapes": { + "com.amazonaws.mq#ActionRequired": { + "type": "structure", + "members": { + "ActionRequiredCode": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

The code you can use to resolve your broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state. You can find instructions by choosing the link for your code from the list of action required codes in Amazon MQ action required codes. Each code references a topic with detailed information, instructions, and recommendations for how to resolve the issue and prevent future occurrences.

", + "smithy.api#jsonName": "actionRequiredCode" + } + }, + "ActionRequiredInfo": { + "target": "com.amazonaws.mq#__string", + "traits": { + "smithy.api#documentation": "

Information about the action required to resolve your broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.

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

The action required to resolve a broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.

" + } + }, "com.amazonaws.mq#AuthenticationStrategy": { "type": "string", "traits": { @@ -209,6 +231,10 @@ { "value": "REBOOT_IN_PROGRESS", "name": "REBOOT_IN_PROGRESS" + }, + { + "value": "CRITICAL_ACTION_REQUIRED", + "name": "CRITICAL_ACTION_REQUIRED" } ] } @@ -841,6 +867,9 @@ "input": { "target": "com.amazonaws.mq#CreateTagsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.mq#BadRequestException" @@ -1067,6 +1096,9 @@ "input": { "target": "com.amazonaws.mq#DeleteTagsRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.mq#BadRequestException" @@ -1408,6 +1440,13 @@ "com.amazonaws.mq#DescribeBrokerResponse": { "type": "structure", "members": { + "ActionsRequired": { + "target": "com.amazonaws.mq#__listOfActionRequired", + "traits": { + "smithy.api#documentation": "

A list of actions required for a broker.

", + "smithy.api#jsonName": "actionsRequired" + } + }, "AuthenticationStrategy": { "target": "com.amazonaws.mq#AuthenticationStrategy", "traits": { @@ -3327,6 +3366,12 @@ } } }, + "com.amazonaws.mq#__listOfActionRequired": { + "type": "list", + "member": { + "target": "com.amazonaws.mq#ActionRequired" + } + }, "com.amazonaws.mq#__listOfAvailabilityZone": { "type": "list", "member": { @@ -3431,6 +3476,21 @@ }, "com.amazonaws.mq#mq": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "mq", + "arnNamespace": "mq", + "cloudFormationName": "AmazonMQ", + "cloudTrailEventSource": "mq.amazonaws.com", + "endpointPrefix": "mq" + }, + "aws.auth#sigv4": { + "name": "mq" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

", + "smithy.api#title": "AmazonMQ" + }, "version": "2017-11-27", "operations": [ { @@ -3499,22 +3559,7 @@ { "target": "com.amazonaws.mq#UpdateUser" } - ], - "traits": { - "aws.api#service": { - "sdkId": "mq", - "arnNamespace": "mq", - "cloudFormationName": "AmazonMQ", - "cloudTrailEventSource": "mq.amazonaws.com", - "endpointPrefix": "mq" - }, - "aws.auth#sigv4": { - "name": "mq" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

", - "smithy.api#title": "AmazonMQ" - } + ] } } } diff --git a/aws/sdk/aws-models/network-firewall.json b/aws/sdk/aws-models/network-firewall.json index 3fccf706bb..c9a228b398 100644 --- a/aws/sdk/aws-models/network-firewall.json +++ b/aws/sdk/aws-models/network-firewall.json @@ -207,7 +207,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one\n subnet for each of the Availability Zones that the VPC spans.

\n

This request creates an AWS Network Firewall firewall endpoint in each of the subnets. To\n enable the firewall's protections, you must also modify the VPC's route tables for each\n subnet's Availability Zone, to redirect the traffic that's coming into and going out of the\n zone through the firewall endpoint.

" + "smithy.api#documentation": "

Associates the specified subnets in the Amazon VPC to the firewall. You can specify one\n subnet for each of the Availability Zones that the VPC spans.

\n

This request creates an Network Firewall firewall endpoint in each of the subnets. To\n enable the firewall's protections, you must also modify the VPC's route tables for each\n subnet's Availability Zone, to redirect the traffic that's coming into and going out of the\n zone through the firewall endpoint.

" } }, "com.amazonaws.networkfirewall#AssociateSubnetsRequest": { @@ -292,7 +292,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration and status for a single subnet that you've specified for use by the\n AWS Network Firewall firewall. This is part of the FirewallStatus.

" + "smithy.api#documentation": "

The configuration and status for a single subnet that you've specified for use by the\n Network Firewall firewall. This is part of the FirewallStatus.

" } }, "com.amazonaws.networkfirewall#AttachmentStatus": { @@ -387,7 +387,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an AWS Network Firewall Firewall and accompanying FirewallStatus for a VPC.

\n

The firewall defines the configuration settings for an AWS Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.

\n

After you create a firewall, you can provide additional settings, like the logging configuration.

\n

To update the settings for a firewall, you use the operations that apply to the settings\n themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

\n

To manage a firewall's tags, use the standard AWS resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

\n

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

" + "smithy.api#documentation": "

Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.

\n

The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

\n

After you create a firewall, you can provide additional settings, like the logging configuration.

\n

To update the settings for a firewall, you use the operations that apply to the settings\n themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

\n

To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

\n

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

" } }, "com.amazonaws.networkfirewall#CreateFirewallPolicy": { @@ -416,7 +416,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates the firewall policy for the firewall according to the specifications.

\n

An AWS Network Firewall firewall policy defines the behavior of a firewall, in a collection of\n stateless and stateful rule groups and other settings. You can use one firewall policy for\n multiple firewalls.

" + "smithy.api#documentation": "

Creates the firewall policy for the firewall according to the specifications.

\n

An Network Firewall firewall policy defines the behavior of a firewall, in a collection of\n stateless and stateful rule groups and other settings. You can use one firewall policy for\n multiple firewalls.

" } }, "com.amazonaws.networkfirewall#CreateFirewallPolicyRequest": { @@ -451,7 +451,13 @@ "DryRun": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

\n

If set to TRUE, Network Firewall checks whether the request can run successfully, \n but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with \n dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have \n the required permissions to run the request and that your request parameters are valid.

\n

If set to FALSE, Network Firewall makes the requested changes to your resources.

" + "smithy.api#documentation": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

\n

If set to TRUE, Network Firewall checks whether the request can run successfully,\n but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with\n dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have\n the required permissions to run the request and that your request parameters are valid.

\n

If set to FALSE, Network Firewall makes the requested changes to your resources.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for encryption of your firewall policy resources.

" } } } @@ -515,13 +521,13 @@ "SubnetChangeProtection": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

A setting indicating whether the firewall is protected against changes to the subnet associations. \n Use this setting to protect against\n accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" + "smithy.api#documentation": "

A setting indicating whether the firewall is protected against changes to the subnet associations.\n Use this setting to protect against\n accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

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

A setting indicating whether the firewall is protected against a change to the firewall policy association. \n Use this setting to protect against\n accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" + "smithy.api#documentation": "

A setting indicating whether the firewall is protected against a change to the firewall policy association.\n Use this setting to protect against\n accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" } }, "Description": { @@ -535,6 +541,12 @@ "traits": { "smithy.api#documentation": "

The key:value pairs to associate with the resource.

" } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for encryption of your firewall resources.

" + } } } }, @@ -603,13 +615,13 @@ "Rules": { "target": "com.amazonaws.networkfirewall#RulesString", "traits": { - "smithy.api#documentation": "

A string containing stateful rule group rules specifications in Suricata flat format, with one rule\nper line. Use this to import your existing Suricata compatible rule groups.

\n \n

You must provide either this rules setting or a populated RuleGroup setting, but not both.

\n \n

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call \nresponse returns a RuleGroup object that Network Firewall has populated from your string.

" + "smithy.api#documentation": "

A string containing stateful rule group rules specifications in Suricata flat format, with one rule\nper line. Use this to import your existing Suricata compatible rule groups.

\n \n

You must provide either this rules setting or a populated RuleGroup setting, but not both.

\n \n

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call\nresponse returns a RuleGroup object that Network Firewall has populated from your string.

" } }, "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.

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

", "smithy.api#required": {} } }, @@ -622,7 +634,7 @@ "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.

\n \n

You can't change or exceed this capacity when you update the rule group, so leave\n room for your rule group to grow.

\n \n

\n Capacity for a stateless rule group\n

\n

For a stateless rule group, the capacity required is the sum of the capacity\n requirements of the individual rules that you expect to have in the rule group.

\n

To calculate the capacity requirement of a single rule, multiply the capacity\n requirement values of each of the rule's match settings:

\n \n

A rule with no criteria specified in any of its match settings has a capacity\n requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting\n [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification\n for each of the other match settings has a capacity requirement of 6.

\n

\n Capacity for a stateful rule group\n

\n

For\n a stateful rule group, the minimum capacity required is the number of individual rules that\n you expect to have in the rule group.

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

\n \n

You can't change or exceed this capacity when you update the rule group, so leave\n room for your rule group to grow.

\n \n

\n Capacity for a stateless rule group\n

\n

For a stateless rule group, the capacity required is the sum of the capacity\n requirements of the individual rules that you expect to have in the rule group.

\n

To calculate the capacity requirement of a single rule, multiply the capacity\n requirement values of each of the rule's match settings:

\n \n

A rule with no criteria specified in any of its match settings has a capacity\n requirement of 1. A rule with protocol setting [\"UDP\",\"TCP\"], source setting\n [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"], and a single specification or no specification\n for each of the other match settings has a capacity requirement of 6.

\n

\n Capacity for a stateful rule group\n

\n

For\n a stateful rule group, the minimum capacity required is the number of individual rules that\n you expect to have in the rule group.

", "smithy.api#required": {} } }, @@ -635,7 +647,19 @@ "DryRun": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

\n

If set to TRUE, Network Firewall checks whether the request can run successfully, \n but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with \n dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have \n the required permissions to run the request and that your request parameters are valid.

\n

If set to FALSE, Network Firewall makes the requested changes to your resources.

" + "smithy.api#documentation": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

\n

If set to TRUE, Network Firewall checks whether the request can run successfully,\n but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with\n dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have\n the required permissions to run the request and that your request parameters are valid.

\n

If set to FALSE, Network Firewall makes the requested changes to your resources.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for encryption of your rule group resources.

" + } + }, + "SourceMetadata": { + "target": "com.amazonaws.networkfirewall#SourceMetadata", + "traits": { + "smithy.api#documentation": "

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

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

Deletes the specified Firewall and its FirewallStatus. \n This operation requires the firewall's DeleteProtection flag to be\n FALSE. You can't revert this operation.

\n

You can check whether a firewall is\n in use by reviewing the route tables for the Availability Zones where you have \n firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall.\n You define and update the route tables through Amazon VPC. As needed, update the route tables for the \n zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, \n you can remove the firewall safely.

\n

To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection,\n then delete the firewall by calling DeleteFirewall.

" + "smithy.api#documentation": "

Deletes the specified Firewall and its FirewallStatus.\n This operation requires the firewall's DeleteProtection flag to be\n FALSE. You can't revert this operation.

\n

You can check whether a firewall is\n in use by reviewing the route tables for the Availability Zones where you have\n firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall.\n You define and update the route tables through Amazon VPC. As needed, update the route tables for the\n zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints,\n you can remove the firewall safely.

\n

To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection,\n then delete the firewall by calling DeleteFirewall.

" } }, "com.amazonaws.networkfirewall#DeleteFirewallPolicy": { @@ -903,7 +927,7 @@ "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 " + "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 " } } } @@ -1155,7 +1179,7 @@ "Policy": { "target": "com.amazonaws.networkfirewall#PolicyString", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management policy for the resource.

" + "smithy.api#documentation": "

The IAM policy for the resource.

" } } } @@ -1209,7 +1233,7 @@ } ], "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

" + "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": { @@ -1230,7 +1254,7 @@ "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 " + "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 " } } } @@ -1261,17 +1285,23 @@ "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 " + "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.

" + "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" + }, + "LastModifiedTime": { + "target": "com.amazonaws.networkfirewall#LastUpdateTime", + "traits": { + "smithy.api#documentation": "

The last time that the rule group was changed.

" + } } } }, @@ -1293,7 +1323,7 @@ "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 " + "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 " } } } @@ -1311,7 +1341,7 @@ "RuleGroup": { "target": "com.amazonaws.networkfirewall#RuleGroup", "traits": { - "smithy.api#documentation": "

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

\n

AWS Network Firewall uses a rule group to inspect and control network traffic. \n You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their\n traffic flow.

\n

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from \n more than one firewall policy, and you can use a firewall policy in more than one firewall.

" + "smithy.api#documentation": "

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

\n

Network Firewall uses a rule group to inspect and control network traffic.\n You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their\n traffic flow.

\n

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from\n more than one firewall policy, and you can use a firewall policy in more than one firewall.

" } }, "RuleGroupResponse": { @@ -1355,7 +1385,7 @@ } }, "traits": { - "smithy.api#documentation": "

The value to use in an Amazon CloudWatch custom metric dimension. This is used in the\n PublishMetrics\n CustomAction. A CloudWatch custom metric dimension is a name/value pair that's\n part of the identity of a metric.

\n

AWS Network Firewall sets the dimension name to CustomAction and you provide the\n dimension value.

\n

For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User\n Guide.

" + "smithy.api#documentation": "

The value to use in an Amazon CloudWatch custom metric dimension. This is used in the\n PublishMetrics\n CustomAction. A CloudWatch custom metric dimension is a name/value pair that's\n part of the identity of a metric.

\n

Network Firewall sets the dimension name to CustomAction and you provide the\n dimension value.

\n

For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User\n Guide.

" } }, "com.amazonaws.networkfirewall#DimensionValue": { @@ -1471,6 +1501,42 @@ } } }, + "com.amazonaws.networkfirewall#EncryptionConfiguration": { + "type": "structure", + "members": { + "KeyId": { + "target": "com.amazonaws.networkfirewall#KeyId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.

" + } + }, + "Type": { + "target": "com.amazonaws.networkfirewall#EncryptionType", + "traits": { + "smithy.api#documentation": "

The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

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

A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.

" + } + }, + "com.amazonaws.networkfirewall#EncryptionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CUSTOMER_KMS", + "name": "CUSTOMER_KMS" + }, + { + "value": "AWS_OWNED_KMS_KEY", + "name": "AWS_OWNED_KMS_KEY" + } + ] + } + }, "com.amazonaws.networkfirewall#EndpointId": { "type": "string" }, @@ -1522,13 +1588,13 @@ "SubnetChangeProtection": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

A setting indicating whether the firewall is protected against changes to the subnet associations. \n Use this setting to protect against\n accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" + "smithy.api#documentation": "

A setting indicating whether the firewall is protected against changes to the subnet associations.\n Use this setting to protect against\n accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

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

A setting indicating whether the firewall is protected against a change to the firewall policy association. \n Use this setting to protect against\n accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" + "smithy.api#documentation": "

A setting indicating whether the firewall is protected against a change to the firewall policy association.\n Use this setting to protect against\n accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" } }, "Description": { @@ -1549,10 +1615,16 @@ "traits": { "smithy.api#documentation": "

" } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

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

The firewall defines the configuration settings for an AWS Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.

\n

The status of the firewall, for example whether it's ready to filter network traffic,\n is provided in the corresponding FirewallStatus. You can retrieve both\n objects by calling DescribeFirewall.

" + "smithy.api#documentation": "

The firewall defines the configuration settings for an Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

\n

The status of the firewall, for example whether it's ready to filter network traffic,\n is provided in the corresponding FirewallStatus. You can retrieve both\n objects by calling DescribeFirewall.

" } }, "com.amazonaws.networkfirewall#FirewallMetadata": { @@ -1600,7 +1672,7 @@ "StatelessFragmentDefaultActions": { "target": "com.amazonaws.networkfirewall#StatelessActions", "traits": { - "smithy.api#documentation": "

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless\n rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. \n If you want non-matching fragmented UDP packets to be forwarded for\n stateful inspection, specify aws:forward_to_sfe.

\n

You must specify one of the standard actions: aws:pass,\n aws:drop, or aws:forward_to_sfe. In addition, you can specify\n custom actions that are compatible with your standard section choice.

\n

For example, you could specify [\"aws:pass\"] or you could specify\n [\"aws:pass\", “customActionName”]. For information about compatibility, see\n the custom action descriptions under CustomAction.

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

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless\n rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols.\n If you want non-matching fragmented UDP packets to be forwarded for\n stateful inspection, specify aws:forward_to_sfe.

\n

You must specify one of the standard actions: aws:pass,\n aws:drop, or aws:forward_to_sfe. In addition, you can specify\n custom actions that are compatible with your standard section choice.

\n

For example, you could specify [\"aws:pass\"] or you could specify\n [\"aws:pass\", “customActionName”]. For information about compatibility, see\n the custom action descriptions under CustomAction.

", "smithy.api#required": {} } }, @@ -1619,13 +1691,13 @@ "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. 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

For more information, see \n Strict evaluation order in the AWS Network Firewall Developer Guide.\n

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

For more information, see\n Strict evaluation order in the Network Firewall Developer Guide.\n

" } }, "StatefulEngineOptions": { "target": "com.amazonaws.networkfirewall#StatefulEngineOptions", "traits": { - "smithy.api#documentation": "

Additional options governing how Network Firewall handles stateful rules. The stateful \n rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

" + "smithy.api#documentation": "

Additional options governing how Network Firewall handles stateful rules. The stateful\n rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.

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

The number of firewalls that are associated with this firewall policy.

" } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

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

The last time that the firewall policy was changed.

" + } } }, "traits": { @@ -1818,21 +1902,21 @@ "Protocol": { "target": "com.amazonaws.networkfirewall#StatefulRuleProtocol", "traits": { - "smithy.api#documentation": "

The protocol to inspect for. To specify all, you can use IP, because all traffic on AWS and on the internet is IP.

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

The protocol to inspect for. To specify all, you can use IP, because all traffic on Amazon Web Services and on the internet is IP.

", "smithy.api#required": {} } }, "Source": { "target": "com.amazonaws.networkfirewall#Source", "traits": { - "smithy.api#documentation": "

The source IP address or address range to inspect for, in CIDR notation. \n To match with any address, specify ANY.

\n

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

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

The source IP address or address range to inspect for, in CIDR notation.\n To match with any address, specify ANY.

\n

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", "smithy.api#required": {} } }, "SourcePort": { "target": "com.amazonaws.networkfirewall#Port", "traits": { - "smithy.api#documentation": "

The source port to inspect for. You can specify an individual port, for \n example 1994 and you can specify a port\n range, for example 1990:1994.\n To match with any port, specify ANY.

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

The source port to inspect for. You can specify an individual port, for\n example 1994 and you can specify a port\n range, for example 1990:1994.\n To match with any port, specify ANY.

", "smithy.api#required": {} } }, @@ -1846,20 +1930,20 @@ "Destination": { "target": "com.amazonaws.networkfirewall#Destination", "traits": { - "smithy.api#documentation": "

The destination IP address or address range to inspect for, in CIDR notation. \n To match with any address, specify ANY.

\n

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

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

The destination IP address or address range to inspect for, in CIDR notation.\n To match with any address, specify ANY.

\n

Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4.

\n

Examples:

\n \n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", "smithy.api#required": {} } }, "DestinationPort": { "target": "com.amazonaws.networkfirewall#Port", "traits": { - "smithy.api#documentation": "

The destination port to inspect for. You can specify an individual port, for \n example 1994 and you can specify\n a port range, for example 1990:1994.\n To match with any port, specify ANY.

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

The destination port to inspect for. You can specify an individual port, for\n example 1994 and you can specify\n a port range, for example 1990:1994.\n To match with any port, specify ANY.

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

The basic rule criteria for AWS Network Firewall to use to inspect packet headers in stateful\n traffic flow inspection. Traffic flows that match the criteria are a match for the\n corresponding StatefulRule.

" + "smithy.api#documentation": "

The basic rule criteria for Network Firewall to use to inspect packet headers in stateful\n traffic flow inspection. Traffic flows that match the criteria are a match for the\n corresponding StatefulRule.

" } }, "com.amazonaws.networkfirewall#IPSet": { @@ -1894,7 +1978,7 @@ } }, "traits": { - "smithy.api#documentation": "

AWS doesn't currently have enough available capacity to fulfill your request. Try your\n request later.

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

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your\n request later.

", "smithy.api#error": "server" } }, @@ -1958,6 +2042,16 @@ "smithy.api#error": "client" } }, + "com.amazonaws.networkfirewall#KeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, "com.amazonaws.networkfirewall#Keyword": { "type": "string", "traits": { @@ -1968,6 +2062,9 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.networkfirewall#LastUpdateTime": { + "type": "timestamp" + }, "com.amazonaws.networkfirewall#LimitExceededException": { "type": "structure", "members": { @@ -2004,6 +2101,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "FirewallPolicies", "pageSize": "MaxResults" } } @@ -2014,13 +2112,13 @@ "NextToken": { "target": "com.amazonaws.networkfirewall#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } }, "MaxResults": { "target": "com.amazonaws.networkfirewall#PaginationMaxResults", "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.

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

" } } } @@ -2031,7 +2129,7 @@ "NextToken": { "target": "com.amazonaws.networkfirewall#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } }, "FirewallPolicies": { @@ -2066,6 +2164,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Firewalls", "pageSize": "MaxResults" } } @@ -2076,7 +2175,7 @@ "NextToken": { "target": "com.amazonaws.networkfirewall#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } }, "VpcIds": { @@ -2088,7 +2187,7 @@ "MaxResults": { "target": "com.amazonaws.networkfirewall#PaginationMaxResults", "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.

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

" } } } @@ -2099,7 +2198,7 @@ "NextToken": { "target": "com.amazonaws.networkfirewall#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } }, "Firewalls": { @@ -2134,6 +2233,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "RuleGroups", "pageSize": "MaxResults" } } @@ -2144,19 +2244,31 @@ "NextToken": { "target": "com.amazonaws.networkfirewall#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } }, "MaxResults": { "target": "com.amazonaws.networkfirewall#PaginationMaxResults", "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.

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

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

" + } + }, + "ManagedType": { + "target": "com.amazonaws.networkfirewall#ResourceManagedType", + "traits": { + "smithy.api#documentation": "

Indicates the general category of the Amazon Web Services managed rule group.

" + } + }, + "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 stateless rules. If it is stateful, it contains stateful rules.

" } } } @@ -2167,7 +2279,7 @@ "NextToken": { "target": "com.amazonaws.networkfirewall#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } }, "RuleGroups": { @@ -2201,10 +2313,11 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the tags associated with the specified resource. Tags are key:value pairs that\n you can use to categorize and manage your resources, for purposes like billing. For\n example, you might set the tag key to \"customer\" and the value to the customer name or ID.\n You can specify one or more tags to add to each AWS resource, up to 50 tags for a\n resource.

\n

You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall\n policies, and rule groups.

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

Retrieves the tags associated with the specified resource. Tags are key:value pairs that\n you can use to categorize and manage your resources, for purposes like billing. For\n example, you might set the tag key to \"customer\" and the value to the customer name or ID.\n You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall\n policies, and rule groups.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Tags", "pageSize": "MaxResults" } } @@ -2215,13 +2328,13 @@ "NextToken": { "target": "com.amazonaws.networkfirewall#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } }, "MaxResults": { "target": "com.amazonaws.networkfirewall#TagsPaginationMaxResults", "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.

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

" } }, "ResourceArn": { @@ -2239,7 +2352,7 @@ "NextToken": { "target": "com.amazonaws.networkfirewall#PaginationToken", "traits": { - "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" + "smithy.api#documentation": "

When you request a list of objects with a MaxResults setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

" } }, "Tags": { @@ -2276,7 +2389,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines where AWS Network Firewall sends logs for the firewall for one log type. This is used\n in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.

\n

Network Firewall generates logs for stateful rule groups. You can save alert and flow log\n types. The stateful rules engine records flow logs for all network traffic that it receives. \n It records alert logs for traffic that matches stateful rules that have the rule\n action set to DROP or ALERT.

" + "smithy.api#documentation": "

Defines where Network Firewall sends logs for the firewall for one log type. This is used\n in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.

\n

Network Firewall generates logs for stateful rule groups. You can save alert and flow log\n types. The stateful rules engine records flow logs for all network traffic that it receives.\n It records alert logs for traffic that matches stateful rules that have the rule\n action set to DROP or ALERT.

" } }, "com.amazonaws.networkfirewall#LogDestinationConfigs": { @@ -2357,7 +2470,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines how AWS Network Firewall performs logging for a Firewall.

" + "smithy.api#documentation": "

Defines how Network Firewall performs logging for a Firewall.

" } }, "com.amazonaws.networkfirewall#MatchAttributes": { @@ -2418,7 +2531,7 @@ "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

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

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
  2. \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
    3. \n
  3. \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
    4. \n
  4. \n

    In Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior.

    \n
    5. \n
  5. \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
    6. \n
  6. \n

    In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.

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

This is the API Reference for Network Firewall. This guide is for developers who need\n detailed information about the Network Firewall API actions, data types, and errors.

\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 Direct Connect. Network Firewall uses rules that are compatible\n with Suricata, a free, open source intrusion detection system (IDS) engine.\n 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

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
  2. \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
    3. \n
  3. \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
    4. \n
  4. \n

    In Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior.

    \n
    5. \n
  5. \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
    6. \n
  6. \n

    In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.

    \n
    7. \n
", "smithy.api#title": "AWS Network Firewall" }, "version": "2020-11-12", @@ -2498,6 +2611,9 @@ { "target": "com.amazonaws.networkfirewall#UpdateFirewallDescription" }, + { + "target": "com.amazonaws.networkfirewall#UpdateFirewallEncryptionConfiguration" + }, { "target": "com.amazonaws.networkfirewall#UpdateFirewallPolicy" }, @@ -2732,7 +2848,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates an AWS Identity and Access Management policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the AWS Resource Access Manager (RAM) service\n to manage resource sharing for Network Firewall.

\n

Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.

\n

When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.

\n \n

For additional information about resource sharing using RAM, see AWS Resource Access Manager User Guide.

" + "smithy.api#documentation": "

Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service\n to manage resource sharing for Network Firewall.

\n

Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.

\n

When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.

\n \n

For additional information about resource sharing using RAM, see Resource Access Manager User Guide.

" } }, "com.amazonaws.networkfirewall#PutResourcePolicyRequest": { @@ -2748,7 +2864,7 @@ "Policy": { "target": "com.amazonaws.networkfirewall#PolicyString", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management policy statement that lists the accounts that you want to share your rule group or firewall policy with \n and the operations that you want the accounts to be able to perform.

\n

For a rule group resource, you can specify the following operations in the Actions section of the statement:

\n \n

For a firewall policy resource, you can specify the following operations in the Actions section of the statement:

\n \n

In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in Arn.

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

The IAM policy statement that lists the accounts that you want to share your rule group or firewall policy with\n and the operations that you want the accounts to be able to perform.

\n

For a rule group resource, you can specify the following operations in the Actions section of the statement:

\n \n

For a firewall policy resource, you can specify the following operations in the Actions section of the statement:

\n \n

In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in Arn.

", "smithy.api#required": {} } } @@ -2793,6 +2909,21 @@ ] } }, + "com.amazonaws.networkfirewall#ResourceManagedType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_MANAGED_THREAT_SIGNATURES", + "name": "AWS_MANAGED_THREAT_SIGNATURES" + }, + { + "value": "AWS_MANAGED_DOMAIN_LISTS", + "name": "AWS_MANAGED_DOMAIN_LISTS" + } + ] + } + }, "com.amazonaws.networkfirewall#ResourceName": { "type": "string", "traits": { @@ -2867,7 +2998,7 @@ } }, "traits": { - "smithy.api#documentation": "

The inspection criteria and action for a single stateless rule. AWS Network Firewall inspects each packet for the specified matching\n criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on\n the packet.

" + "smithy.api#documentation": "

The inspection criteria and action for a single stateless rule. Network Firewall inspects each packet for the specified matching\n criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on\n the packet.

" } }, "com.amazonaws.networkfirewall#RuleGroup": { @@ -2889,12 +3020,12 @@ "StatefulRuleOptions": { "target": "com.amazonaws.networkfirewall#StatefulRuleOptions", "traits": { - "smithy.api#documentation": "

Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful \n rule group must have stateful rule options settings that are compatible with these settings.

" + "smithy.api#documentation": "

Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful\n rule group must have stateful rule options settings that are compatible with these settings.

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

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

\n

AWS Network Firewall uses a rule group to inspect and control network traffic. \n You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their\n traffic flow.

\n

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from \n more than one firewall policy, and you can use a firewall policy in more than one firewall.

" + "smithy.api#documentation": "

The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

\n

Network Firewall uses a rule group to inspect and control network traffic.\n You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their\n traffic flow.

\n

To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from\n more than one firewall policy, and you can use a firewall policy in more than one firewall.

" } }, "com.amazonaws.networkfirewall#RuleGroupMetadata": { @@ -2950,13 +3081,13 @@ "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.

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

" } }, "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.

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

" } }, "RuleGroupStatus": { @@ -2982,6 +3113,30 @@ "traits": { "smithy.api#documentation": "

The number of firewall policies that use this rule group.

" } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.

" + } + }, + "SourceMetadata": { + "target": "com.amazonaws.networkfirewall#SourceMetadata", + "traits": { + "smithy.api#documentation": "

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.

" + } + }, + "SnsTopic": { + "target": "com.amazonaws.networkfirewall#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's\nused to record changes to the managed rule group. You can subscribe to the SNS topic to receive\nnotifications when the managed rule group is modified, such as for new versions and for version\nexpiration. For more information, see the Amazon Simple Notification Service Developer Guide..

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

The last time that the rule group was changed.

" + } } }, "traits": { @@ -3105,7 +3260,7 @@ "StatefulRules": { "target": "com.amazonaws.networkfirewall#StatefulRules", "traits": { - "smithy.api#documentation": "

An array of individual stateful rules inspection criteria to be used together in a stateful rule group. \n Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. \n For information about the Suricata Rules format, see\n Rules Format.

" + "smithy.api#documentation": "

An array of individual stateful rules inspection criteria to be used together in a stateful rule group.\n Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.

" } }, "StatelessRulesAndCustomActions": { @@ -3145,7 +3300,7 @@ } }, "traits": { - "smithy.api#documentation": "

Stateful inspection criteria for a domain list rule group.

\n

For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.

\n

By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in AWS Network Firewall in the Network Firewall Developer Guide.

" + "smithy.api#documentation": "

Stateful inspection criteria for a domain list rule group.

\n

For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.

\n

By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.

" } }, "com.amazonaws.networkfirewall#RulesString": { @@ -3183,6 +3338,26 @@ "smithy.api#pattern": "^.*$" } }, + "com.amazonaws.networkfirewall#SourceMetadata": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.networkfirewall#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.

" + } + }, + "SourceUpdateToken": { + "target": "com.amazonaws.networkfirewall#UpdateToken", + "traits": { + "smithy.api#documentation": "

The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.

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

High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

" + } + }, "com.amazonaws.networkfirewall#StatefulAction": { "type": "string", "traits": { @@ -3214,7 +3389,7 @@ "RuleOrder": { "target": "com.amazonaws.networkfirewall#RuleOrder", "traits": { - "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

" + "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 Network Firewall Developer Guide.\n

" } } }, @@ -3248,7 +3423,7 @@ } }, "traits": { - "smithy.api#documentation": "

A single Suricata rules specification, for use in a stateful rule group. \n Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. \n For information about the Suricata Rules format, see\n Rules Format.

" + "smithy.api#documentation": "

A single Suricata rules specification, for use in a stateful rule group.\n Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.

" } }, "com.amazonaws.networkfirewall#StatefulRuleDirection": { @@ -3320,7 +3495,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. 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

" + "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 Network Firewall Developer Guide.\n

" } } }, @@ -3512,7 +3687,7 @@ } }, "traits": { - "smithy.api#documentation": "

The ID for a subnet that you want to associate with the firewall. This is used with\n CreateFirewall and AssociateSubnets. AWS Network Firewall\n creates an instance of the associated firewall in each subnet that you specify, to filter\n traffic in the subnet's Availability Zone.

" + "smithy.api#documentation": "

The ID for a subnet that you want to associate with the firewall. This is used with\n CreateFirewall and AssociateSubnets. Network Firewall\n creates an instance of the associated firewall in each subnet that you specify, to filter\n traffic in the subnet's Availability Zone.

" } }, "com.amazonaws.networkfirewall#SubnetMappings": { @@ -3538,7 +3713,7 @@ } }, "traits": { - "smithy.api#documentation": "

The status of the firewall endpoint and firewall policy configuration for a single VPC\n subnet.

\n

For each VPC subnet that you associate with a firewall, AWS Network Firewall does the\n following:

\n \n

When you update a firewall, for example to add a subnet association or change a rule\n group in the firewall policy, the affected sync states reflect out-of-sync or not ready\n status until the changes are complete.

" + "smithy.api#documentation": "

The status of the firewall endpoint and firewall policy configuration for a single VPC\n subnet.

\n

For each VPC subnet that you associate with a firewall, Network Firewall does the\n following:

\n \n

When you update a firewall, for example to add a subnet association or change a rule\n group in the firewall policy, the affected sync states reflect out-of-sync or not ready\n status until the changes are complete.

" } }, "com.amazonaws.networkfirewall#SyncStateConfig": { @@ -3644,7 +3819,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key:value pair associated with an AWS resource. The key:value pair can be anything you\n define. Typically, the tag key represents a category (such as \"environment\") and the tag\n value represents a specific value within that category (such as \"test,\" \"development,\" or\n \"production\"). You can add up to 50 tags to each AWS resource.

" + "smithy.api#documentation": "

A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you\n define. Typically, the tag key represents a category (such as \"environment\") and the tag\n value represents a specific value within that category (such as \"test,\" \"development,\" or\n \"production\"). You can add up to 50 tags to each Amazon Web Services resource.

" } }, "com.amazonaws.networkfirewall#TagKey": { @@ -3704,7 +3879,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource. Tags are key:value pairs that you can\n use to categorize and manage your resources, for purposes like billing. For example, you\n might set the tag key to \"customer\" and the value to the customer name or ID. You can\n specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

\n

You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall\n policies, and rule groups.

" + "smithy.api#documentation": "

Adds the specified tags to the specified resource. Tags are key:value pairs that you can\n use to categorize and manage your resources, for purposes like billing. For example, you\n might set the tag key to \"customer\" and the value to the customer name or ID. You can\n specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall\n policies, and rule groups.

" } }, "com.amazonaws.networkfirewall#TagResourceRequest": { @@ -3818,7 +3993,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the tags with the specified keys from the specified resource. Tags are key:value\n pairs that you can use to categorize and manage your resources, for purposes like billing.\n For example, you might set the tag key to \"customer\" and the value to the customer name or\n ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a\n resource.

\n

You can manage tags for the AWS resources that you manage through AWS Network Firewall:\n firewalls, firewall policies, and rule groups.

" + "smithy.api#documentation": "

Removes the tags with the specified keys from the specified resource. Tags are key:value\n pairs that you can use to categorize and manage your resources, for purposes like billing.\n For example, you might set the tag key to \"customer\" and the value to the customer name or\n ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can manage tags for the Amazon Web Services resources that you manage through Network Firewall:\n firewalls, firewall policies, and rule groups.

" } }, "com.amazonaws.networkfirewall#UntagResourceRequest": { @@ -4022,6 +4197,90 @@ } } }, + "com.amazonaws.networkfirewall#UpdateFirewallEncryptionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkfirewall#UpdateFirewallEncryptionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.networkfirewall#UpdateFirewallEncryptionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkfirewall#InternalServerError" + }, + { + "target": "com.amazonaws.networkfirewall#InvalidRequestException" + }, + { + "target": "com.amazonaws.networkfirewall#InvalidTokenException" + }, + { + "target": "com.amazonaws.networkfirewall#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkfirewall#ResourceOwnerCheckException" + }, + { + "target": "com.amazonaws.networkfirewall#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for encryption of your firewall resources.

" + } + }, + "com.amazonaws.networkfirewall#UpdateFirewallEncryptionConfigurationRequest": { + "type": "structure", + "members": { + "UpdateToken": { + "target": "com.amazonaws.networkfirewall#UpdateToken", + "traits": { + "smithy.api#documentation": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

\n

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

\n

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" + } + }, + "FirewallArn": { + "target": "com.amazonaws.networkfirewall#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the firewall.

" + } + }, + "FirewallName": { + "target": "com.amazonaws.networkfirewall#ResourceName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration" + } + } + }, + "com.amazonaws.networkfirewall#UpdateFirewallEncryptionConfigurationResponse": { + "type": "structure", + "members": { + "FirewallArn": { + "target": "com.amazonaws.networkfirewall#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the firewall.

" + } + }, + "FirewallName": { + "target": "com.amazonaws.networkfirewall#ResourceName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

" + } + }, + "UpdateToken": { + "target": "com.amazonaws.networkfirewall#UpdateToken", + "traits": { + "smithy.api#documentation": "

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

\n

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

\n

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration" + } + } + }, "com.amazonaws.networkfirewall#UpdateFirewallPolicy": { "type": "operation", "input": { @@ -4080,7 +4339,7 @@ } ], "traits": { - "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.

" + "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": { @@ -4107,7 +4366,7 @@ "FirewallPolicyChangeProtection": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

A setting indicating whether the firewall is protected against a change to the firewall policy association. \n Use this setting to protect against\n accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

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

A setting indicating whether the firewall is protected against a change to the firewall policy association.\n Use this setting to protect against\n accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", "smithy.api#required": {} } } @@ -4137,7 +4396,7 @@ "FirewallPolicyChangeProtection": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

A setting indicating whether the firewall is protected against a change to the firewall policy association. \n Use this setting to protect against\n accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" + "smithy.api#documentation": "

A setting indicating whether the firewall is protected against a change to the firewall policy association.\n Use this setting to protect against\n accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" } } } @@ -4180,7 +4439,13 @@ "DryRun": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

\n

If set to TRUE, Network Firewall checks whether the request can run successfully, \n but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with \n dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have \n the required permissions to run the request and that your request parameters are valid.

\n

If set to FALSE, Network Firewall makes the requested changes to your resources.

" + "smithy.api#documentation": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

\n

If set to TRUE, Network Firewall checks whether the request can run successfully,\n but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with\n dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have\n the required permissions to run the request and that your request parameters are valid.

\n

If set to FALSE, Network Firewall makes the requested changes to your resources.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for encryption of your firewall policy resources.

" } } } @@ -4339,13 +4604,13 @@ "Rules": { "target": "com.amazonaws.networkfirewall#RulesString", "traits": { - "smithy.api#documentation": "

A string containing stateful rule group rules specifications in Suricata flat format, with one rule\nper line. Use this to import your existing Suricata compatible rule groups.

\n \n

You must provide either this rules setting or a populated RuleGroup setting, but not both.

\n \n

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call \nresponse returns a RuleGroup object that Network Firewall has populated from your string.

" + "smithy.api#documentation": "

A string containing stateful rule group rules specifications in Suricata flat format, with one rule\nper line. Use this to import your existing Suricata compatible rule groups.

\n \n

You must provide either this rules setting or a populated RuleGroup setting, but not both.

\n \n

You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call\nresponse returns a RuleGroup object that Network Firewall has populated from your string.

" } }, "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 " + "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 " } }, "Description": { @@ -4357,7 +4622,19 @@ "DryRun": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

\n

If set to TRUE, Network Firewall checks whether the request can run successfully, \n but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with \n dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have \n the required permissions to run the request and that your request parameters are valid.

\n

If set to FALSE, Network Firewall makes the requested changes to your resources.

" + "smithy.api#documentation": "

Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

\n

If set to TRUE, Network Firewall checks whether the request can run successfully,\n but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with\n dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have\n the required permissions to run the request and that your request parameters are valid.

\n

If set to FALSE, Network Firewall makes the requested changes to your resources.

" + } + }, + "EncryptionConfiguration": { + "target": "com.amazonaws.networkfirewall#EncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

A complex type that contains settings for encryption of your rule group resources.

" + } + }, + "SourceMetadata": { + "target": "com.amazonaws.networkfirewall#SourceMetadata", + "traits": { + "smithy.api#documentation": "

A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.

" } } } @@ -4437,7 +4714,7 @@ "SubnetChangeProtection": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

A setting indicating whether the firewall is protected against changes to the subnet associations. \n Use this setting to protect against\n accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

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

A setting indicating whether the firewall is protected against changes to the subnet associations.\n Use this setting to protect against\n accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

", "smithy.api#required": {} } } @@ -4467,7 +4744,7 @@ "SubnetChangeProtection": { "target": "com.amazonaws.networkfirewall#Boolean", "traits": { - "smithy.api#documentation": "

A setting indicating whether the firewall is protected against changes to the subnet associations. \n Use this setting to protect against\n accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" + "smithy.api#documentation": "

A setting indicating whether the firewall is protected against changes to the subnet associations.\n Use this setting to protect against\n accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.

" } } } diff --git a/aws/sdk/aws-models/personalize.json b/aws/sdk/aws-models/personalize.json index 27b34408db..d83c69b677 100644 --- a/aws/sdk/aws-models/personalize.json +++ b/aws/sdk/aws-models/personalize.json @@ -305,6 +305,12 @@ { "target": "com.amazonaws.personalize#ListTagsForResource" }, + { + "target": "com.amazonaws.personalize#StartRecommender" + }, + { + "target": "com.amazonaws.personalize#StopRecommender" + }, { "target": "com.amazonaws.personalize#StopSolutionVersionCreation" }, @@ -2871,6 +2877,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteCampaignRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -2904,6 +2913,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteDatasetRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -2925,6 +2937,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteDatasetGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -2970,6 +2985,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteEventTrackerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -3003,6 +3021,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteFilterRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -3035,6 +3056,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteRecommenderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -3068,6 +3092,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteSchemaRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -3101,6 +3128,9 @@ "input": { "target": "com.amazonaws.personalize#DeleteSolutionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -6386,6 +6416,53 @@ } } }, + "com.amazonaws.personalize#StartRecommender": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#StartRecommenderRequest" + }, + "output": { + "target": "com.amazonaws.personalize#StartRecommenderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceInUseException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a recommender that is INACTIVE. Starting a recommender does not\n create any new models, but resumes billing and automatic retraining for the recommender.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#StartRecommenderRequest": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommender to start.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalize#StartRecommenderResponse": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommender you started.

" + } + } + } + }, "com.amazonaws.personalize#Status": { "type": "string", "traits": { @@ -6395,11 +6472,61 @@ } } }, + "com.amazonaws.personalize#StopRecommender": { + "type": "operation", + "input": { + "target": "com.amazonaws.personalize#StopRecommenderRequest" + }, + "output": { + "target": "com.amazonaws.personalize#StopRecommenderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.personalize#InvalidInputException" + }, + { + "target": "com.amazonaws.personalize#ResourceInUseException" + }, + { + "target": "com.amazonaws.personalize#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.personalize#StopRecommenderRequest": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommender to stop.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.personalize#StopRecommenderResponse": { + "type": "structure", + "members": { + "recommenderArn": { + "target": "com.amazonaws.personalize#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommender you stopped.

" + } + } + } + }, "com.amazonaws.personalize#StopSolutionVersionCreation": { "type": "operation", "input": { "target": "com.amazonaws.personalize#StopSolutionVersionCreationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" @@ -6709,7 +6836,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a campaign by either deploying a new solution or changing the value of the\n campaign's minProvisionedTPS parameter.

\n

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the DescribeCampaign operation.

\n \n

You must wait until the status of the\n updated campaign is ACTIVE before asking the campaign for recommendations.

\n \n

For more information on campaigns, see CreateCampaign.

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

Updates a campaign by either deploying a new solution or changing the value of the\n campaign's minProvisionedTPS parameter.

\n

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the DescribeCampaign operation.

\n\n \n

You can still get recommendations from a campaign while an update is in progress.\n The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.\n

\n \n \n

For more information on campaigns, see CreateCampaign.

", "smithy.api#idempotent": {} } }, diff --git a/aws/sdk/aws-models/polly.json b/aws/sdk/aws-models/polly.json index 4112e4878d..75f282b23f 100644 --- a/aws/sdk/aws-models/polly.json +++ b/aws/sdk/aws-models/polly.json @@ -558,6 +558,10 @@ { "value": "ca-ES", "name": "ca_ES" + }, + { + "value": "de-AT", + "name": "de_AT" } ] } @@ -1951,6 +1955,10 @@ { "value": "Arlet", "name": "Arlet" + }, + { + "value": "Hannah", + "name": "Hannah" } ] } diff --git a/aws/sdk/aws-models/pricing.json b/aws/sdk/aws-models/pricing.json index 5582f43c42..268e5ceee5 100644 --- a/aws/sdk/aws-models/pricing.json +++ b/aws/sdk/aws-models/pricing.json @@ -31,18 +31,6 @@ "shapes": { "com.amazonaws.pricing#AWSPriceListService": { "type": "service", - "version": "2017-10-15", - "operations": [ - { - "target": "com.amazonaws.pricing#DescribeServices" - }, - { - "target": "com.amazonaws.pricing#GetAttributeValues" - }, - { - "target": "com.amazonaws.pricing#GetProducts" - } - ], "traits": { "aws.api#service": { "sdkId": "Pricing", @@ -55,9 +43,21 @@ "name": "pricing" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Web Services Price List Service API (Amazon Web Services Price List Service) is a centralized and convenient way to\n programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List Service\n uses standardized product attributes such as Location, Storage\n Class, and Operating System, and provides prices at the SKU\n level. You can use the Amazon Web Services Price List Service to build cost control and scenario planning tools, reconcile\n billing data, forecast future spend for budgeting purposes, and provide cost benefit\n analysis that compare your internal workloads with Amazon Web Services.

\n

Use GetServices without a service code to retrieve the service codes for all AWS services, then \n GetServices with a service code to retreive the attribute names for \n that service. After you have the service code and attribute names, you can use GetAttributeValues\n to see what values are available for an attribute. With the service code and an attribute name and value, \n you can use GetProducts to find specific products that you're interested in, such as \n an AmazonEC2 instance, with a Provisioned IOPS \n volumeType.

\n

Service Endpoint

\n

Amazon Web Services Price List Service API provides the following two endpoints:

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

Amazon Web Services Price List Service API (Amazon Web Services Price List Service) is a centralized and convenient way to\n programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List Service\n uses standardized product attributes such as Location, Storage\n Class, and Operating System, and provides prices at the SKU\n level. You can use the Amazon Web Services Price List Service to build cost control and scenario planning tools, reconcile\n billing data, forecast future spend for budgeting purposes, and provide cost benefit\n analysis that compare your internal workloads with Amazon Web Services.

\n

Use GetServices without a service code to retrieve the service codes for all AWS services, then \n GetServices with a service code to retrieve the attribute names for \n that service. After you have the service code and attribute names, you can use GetAttributeValues\n to see what values are available for an attribute. With the service code and an attribute name and value, \n you can use GetProducts to find specific products that you're interested in, such as \n an AmazonEC2 instance, with a Provisioned IOPS \n volumeType.

\n

Service Endpoint

\n

Amazon Web Services Price List Service API provides the following two endpoints:

\n ", "smithy.api#title": "AWS Price List Service" - } + }, + "version": "2017-10-15", + "operations": [ + { + "target": "com.amazonaws.pricing#DescribeServices" + }, + { + "target": "com.amazonaws.pricing#GetAttributeValues" + }, + { + "target": "com.amazonaws.pricing#GetProducts" + } + ] }, "com.amazonaws.pricing#AttributeNameList": { "type": "list", @@ -176,7 +176,7 @@ "NextToken": { "target": "com.amazonaws.pricing#String", "traits": { - "smithy.api#documentation": "

The pagination token for the next set of retreivable results.

" + "smithy.api#documentation": "

The pagination token for the next set of retrievable results.

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

Returns a list of attribute values. Attibutes are similar to the details \n in a Price List API offer file. For a list of available attributes, see \n Offer File Definitions\n in the Amazon Web Services Billing and Cost Management User Guide.

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

Returns a list of attribute values. Attributes are similar to the details \n in a Price List API offer file. For a list of available attributes, see \n Offer File Definitions\n in the Amazon Web Services Billing and Cost Management User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", diff --git a/aws/sdk/aws-models/rds-data.json b/aws/sdk/aws-models/rds-data.json index 2e3e75b220..1a1d0a768a 100644 --- a/aws/sdk/aws-models/rds-data.json +++ b/aws/sdk/aws-models/rds-data.json @@ -1,6 +1,19 @@ { "smithy": "1.0", "shapes": { + "com.amazonaws.rdsdata#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rdsdata#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.rdsdata#Arn": { "type": "string", "traits": { @@ -31,13 +44,13 @@ "longValues": { "target": "com.amazonaws.rdsdata#LongArray", "traits": { - "smithy.api#documentation": "

An array of floating point numbers.

" + "smithy.api#documentation": "

An array of integers.

" } }, "doubleValues": { "target": "com.amazonaws.rdsdata#DoubleArray", "traits": { - "smithy.api#documentation": "

An array of integers.

" + "smithy.api#documentation": "

An array of floating-point numbers.

" } }, "stringValues": { @@ -88,6 +101,9 @@ "target": "com.amazonaws.rdsdata#BatchExecuteStatementResponse" }, "errors": [ + { + "target": "com.amazonaws.rdsdata#AccessDeniedException" + }, { "target": "com.amazonaws.rdsdata#BadRequestException" }, @@ -107,9 +123,9 @@ "traits": { "smithy.api#documentation": "

Runs a batch SQL statement over an array of data.

\n

You can run bulk update and insert operations for multiple records using a DML \n statement with different parameter sets. Bulk operations can provide a significant \n performance improvement over individual insert and update operations.

\n \n

If a call isn't part of a transaction because it doesn't include the\n transactionID parameter, changes that result from the call are\n committed automatically.

\n ", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/BatchExecute", - "code": 200 + "uri": "/BatchExecute" } } }, @@ -189,6 +205,9 @@ "target": "com.amazonaws.rdsdata#BeginTransactionResponse" }, "errors": [ + { + "target": "com.amazonaws.rdsdata#AccessDeniedException" + }, { "target": "com.amazonaws.rdsdata#BadRequestException" }, @@ -208,9 +227,9 @@ "traits": { "smithy.api#documentation": "

Starts a SQL transaction.

\n \n \n

A transaction can run for a maximum of 24 hours. A transaction is terminated and \n rolled back automatically after 24 hours.

\n

A transaction times out if no calls use its transaction ID in three minutes. \n If a transaction times out before it's committed, it's rolled back\n automatically.

\n

DDL statements inside a transaction cause an implicit commit. We recommend \n that you run each DDL statement in a separate ExecuteStatement call with \n continueAfterTimeout enabled.

\n ", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/BeginTransaction", - "code": 200 + "uri": "/BeginTransaction" } } }, @@ -408,6 +427,9 @@ "target": "com.amazonaws.rdsdata#CommitTransactionResponse" }, "errors": [ + { + "target": "com.amazonaws.rdsdata#AccessDeniedException" + }, { "target": "com.amazonaws.rdsdata#BadRequestException" }, @@ -430,9 +452,9 @@ "traits": { "smithy.api#documentation": "

Ends a SQL transaction started with the BeginTransaction operation and\n commits the changes.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/CommitTransaction", - "code": 200 + "uri": "/CommitTransaction" } } }, @@ -508,7 +530,7 @@ "target": "com.amazonaws.rdsdata#BoxedDouble" }, "traits": { - "smithy.api#documentation": "

An array of floating point numbers.

\n \n

Some array entries can be null.

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

An array of floating-point numbers.

\n \n

Some array entries can be null.

\n " } }, "com.amazonaws.rdsdata#ErrorMessage": { @@ -523,6 +545,9 @@ "target": "com.amazonaws.rdsdata#ExecuteSqlResponse" }, "errors": [ + { + "target": "com.amazonaws.rdsdata#AccessDeniedException" + }, { "target": "com.amazonaws.rdsdata#BadRequestException" }, @@ -538,14 +563,14 @@ ], "traits": { "smithy.api#deprecated": { - "since": "2019-03-21", - "message": "The ExecuteSql API is deprecated, please use the ExecuteStatement API." + "message": "The ExecuteSql API is deprecated, please use the ExecuteStatement API.", + "since": "2019-03-21" }, "smithy.api#documentation": "

Runs one or more SQL statements.

\n \n

This operation is deprecated. Use the BatchExecuteStatement or\n ExecuteStatement operation.

\n ", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/ExecuteSql", - "code": 200 + "uri": "/ExecuteSql" } } }, @@ -613,6 +638,9 @@ "target": "com.amazonaws.rdsdata#ExecuteStatementResponse" }, "errors": [ + { + "target": "com.amazonaws.rdsdata#AccessDeniedException" + }, { "target": "com.amazonaws.rdsdata#BadRequestException" }, @@ -630,11 +658,11 @@ } ], "traits": { - "smithy.api#documentation": "

Runs a SQL statement against a database.

\n \n

If a call isn't part of a transaction because it doesn't include the\n transactionID parameter, changes that result from the call are\n committed automatically.

\n \n

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

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

Runs a SQL statement against a database.

\n \n

If a call isn't part of a transaction because it doesn't include the\n transactionID parameter, changes that result from the call are\n committed automatically.

\n \n

If the binary response data from the database is more than 1 MB, the call is terminated.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/Execute", - "code": 200 + "uri": "/Execute" } } }, @@ -703,6 +731,12 @@ "traits": { "smithy.api#documentation": "

Options that control how the result set is returned.

" } + }, + "formatRecordsAs": { + "target": "com.amazonaws.rdsdata#RecordsFormatType", + "traits": { + "smithy.api#documentation": "

A value that indicates whether to format the result set as a single JSON string.\n This parameter only applies to SELECT statements and is ignored for\n other types of statements. Allowed values are NONE and JSON.\n The default value is NONE. The result is returned in the formattedRecords field.

\n

For usage information about the JSON format for result sets, see\n Using the Data API\n in the Amazon Aurora User Guide.

" + } } }, "traits": { @@ -715,13 +749,13 @@ "records": { "target": "com.amazonaws.rdsdata#SqlRecords", "traits": { - "smithy.api#documentation": "

The records returned by the SQL statement.

" + "smithy.api#documentation": "

The records returned by the SQL statement. This field is blank if the\n formatRecordsAs parameter is set to JSON.

" } }, "columnMetadata": { "target": "com.amazonaws.rdsdata#Metadata", "traits": { - "smithy.api#documentation": "

Metadata for the columns included in the results.

" + "smithy.api#documentation": "

Metadata for the columns included in the results. This field is blank if the\n formatRecordsAs parameter is set to JSON.

" } }, "numberOfRecordsUpdated": { @@ -733,7 +767,13 @@ "generatedFields": { "target": "com.amazonaws.rdsdata#FieldList", "traits": { - "smithy.api#documentation": "

Values for fields generated during the request.

\n \n \n

The generatedFields data isn't supported by Aurora PostgreSQL.\n To get the values of generated fields, use the RETURNING clause. For\n more information, see Returning Data From\n Modified Rows in the PostgreSQL documentation.

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

Values for fields generated during a DML request.

\n \n \n

The generatedFields data isn't supported by Aurora PostgreSQL.\n To get the values of generated fields, use the RETURNING clause. For\n more information, see Returning Data From\n Modified Rows in the PostgreSQL documentation.

\n " + } + }, + "formattedRecords": { + "target": "com.amazonaws.rdsdata#FormattedSqlRecords", + "traits": { + "smithy.api#documentation": "

A string value that represents the result set of a SELECT statement\n in JSON format. This value is only present when the formatRecordsAs\n parameter is set to JSON.

\n

The size limit for this field is currently 10 MB. If the JSON-formatted string representing the\n result set requires more than 10 MB, the call returns an error.

" } } }, @@ -813,6 +853,9 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.rdsdata#FormattedSqlRecords": { + "type": "string" + }, "com.amazonaws.rdsdata#Id": { "type": "string", "traits": { @@ -845,6 +888,21 @@ "smithy.api#documentation": "

An array of integers.

\n \n

Some array entries can be null.

\n " } }, + "com.amazonaws.rdsdata#LongReturnType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "LONG", + "name": "LONG" + } + ] + } + }, "com.amazonaws.rdsdata#Metadata": { "type": "list", "member": { @@ -872,6 +930,19 @@ }, "com.amazonaws.rdsdata#RdsDataService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "RDS Data", + "arnNamespace": "rds-data" + }, + "aws.auth#sigv4": { + "name": "rds-data" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "Amazon RDS Data Service\n

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora\n Serverless DB cluster. To run these statements, you work with the Data Service\n API.

\n

For more information about the Data Service API, see\n Using the Data API\n in the Amazon Aurora User Guide.

", + "smithy.api#title": "AWS RDS DataService" + }, "version": "2018-08-01", "operations": [ { @@ -892,23 +963,7 @@ { "target": "com.amazonaws.rdsdata#RollbackTransaction" } - ], - "traits": { - "aws.api#service": { - "sdkId": "RDS Data", - "arnNamespace": "rds-data", - "cloudFormationName": "RdsDataService", - "cloudTrailEventSource": "rds-data.amazonaws.com", - "endpointPrefix": "rds-data" - }, - "aws.auth#sigv4": { - "name": "rds-data" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": {}, - "smithy.api#documentation": "Amazon RDS Data Service\n

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora\n Serverless DB cluster. To run these statements, you work with the Data Service\n API.

\n

For more information about the Data Service API, see Using the Data API for Aurora\n Serverless in the Amazon Aurora User Guide.

", - "smithy.api#title": "AWS RDS DataService" - } + ] }, "com.amazonaws.rdsdata#Record": { "type": "structure", @@ -921,7 +976,7 @@ } }, "traits": { - "smithy.api#documentation": "

A record returned by a call.

" + "smithy.api#documentation": "

A record returned by a call.

\n \n

This data structure is only used with the deprecated ExecuteSql operation.\n Use the BatchExecuteStatement or ExecuteStatement operation instead.

\n " } }, "com.amazonaws.rdsdata#Records": { @@ -930,6 +985,21 @@ "target": "com.amazonaws.rdsdata#Record" } }, + "com.amazonaws.rdsdata#RecordsFormatType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, "com.amazonaws.rdsdata#RecordsUpdated": { "type": "long" }, @@ -950,7 +1020,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result set returned by a SQL statement.

" + "smithy.api#documentation": "

The result set returned by a SQL statement.

\n \n

This data structure is only used with the deprecated ExecuteSql operation.\n Use the BatchExecuteStatement or ExecuteStatement operation instead.

\n " } }, "com.amazonaws.rdsdata#ResultSetMetadata": { @@ -981,6 +1051,12 @@ "traits": { "smithy.api#documentation": "

A value that indicates how a field of DECIMAL type is represented\n in the response. The value of STRING, the default, specifies that\n it is converted to a String value. The value of DOUBLE_OR_LONG\n specifies that it is converted to a Long value if its scale is 0, or to a Double\n value otherwise.

\n \n

Conversion to Double or Long can result in roundoff errors due to precision loss.\n We recommend converting to String, especially when working with currency values.

\n " } + }, + "longReturnType": { + "target": "com.amazonaws.rdsdata#LongReturnType", + "traits": { + "smithy.api#documentation": "

A value that indicates how a field of LONG type is represented.\n Allowed values are LONG and STRING. The default\n is LONG. Specify STRING if the length or\n precision of numeric values might cause truncation or rounding errors.\n

" + } } }, "traits": { @@ -996,6 +1072,9 @@ "target": "com.amazonaws.rdsdata#RollbackTransactionResponse" }, "errors": [ + { + "target": "com.amazonaws.rdsdata#AccessDeniedException" + }, { "target": "com.amazonaws.rdsdata#BadRequestException" }, @@ -1018,9 +1097,9 @@ "traits": { "smithy.api#documentation": "

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/RollbackTransaction", - "code": 200 + "uri": "/RollbackTransaction" } } }, @@ -1151,7 +1230,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result of a SQL statement.

\n \n \n

This data type is deprecated.

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

The result of a SQL statement.

\n \n \n

This data structure is only used with the deprecated ExecuteSql operation.\n Use the BatchExecuteStatement or ExecuteStatement operation instead.

\n " } }, "com.amazonaws.rdsdata#SqlStatementResults": { @@ -1205,7 +1284,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure value returned by a call.

" + "smithy.api#documentation": "

A structure value returned by a call.

\n \n

This data structure is only used with the deprecated ExecuteSql operation.\n Use the BatchExecuteStatement or ExecuteStatement operation instead.

\n " } }, "com.amazonaws.rdsdata#TransactionStatus": { @@ -1332,7 +1411,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the value of a column.

\n \n \n

This data type is deprecated.

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

Contains the value of a column.

\n \n \n

This data structure is only used with the deprecated ExecuteSql operation.\n Use the BatchExecuteStatement or ExecuteStatement operation instead.

\n " } } } diff --git a/aws/sdk/aws-models/rds.json b/aws/sdk/aws-models/rds.json index 9a44a1ad8d..46309b7981 100644 --- a/aws/sdk/aws-models/rds.json +++ b/aws/sdk/aws-models/rds.json @@ -127,6 +127,9 @@ "input": { "target": "com.amazonaws.rds#AddRoleToDBClusterMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" @@ -175,6 +178,9 @@ "input": { "target": "com.amazonaws.rds#AddRoleToDBInstanceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" @@ -274,6 +280,9 @@ "input": { "target": "com.amazonaws.rds#AddTagsToResourceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" @@ -378,9 +387,6 @@ { "target": "com.amazonaws.rds#CopyOptionGroup" }, - { - "target": "com.amazonaws.rds#CreateCustomAvailabilityZone" - }, { "target": "com.amazonaws.rds#CreateCustomDBEngineVersion" }, @@ -429,9 +435,6 @@ { "target": "com.amazonaws.rds#CreateOptionGroup" }, - { - "target": "com.amazonaws.rds#DeleteCustomAvailabilityZone" - }, { "target": "com.amazonaws.rds#DeleteCustomDBEngineVersion" }, @@ -477,9 +480,6 @@ { "target": "com.amazonaws.rds#DeleteGlobalCluster" }, - { - "target": "com.amazonaws.rds#DeleteInstallationMedia" - }, { "target": "com.amazonaws.rds#DeleteOptionGroup" }, @@ -492,9 +492,6 @@ { "target": "com.amazonaws.rds#DescribeCertificates" }, - { - "target": "com.amazonaws.rds#DescribeCustomAvailabilityZones" - }, { "target": "com.amazonaws.rds#DescribeDBClusterBacktracks" }, @@ -579,9 +576,6 @@ { "target": "com.amazonaws.rds#DescribeGlobalClusters" }, - { - "target": "com.amazonaws.rds#DescribeInstallationMedia" - }, { "target": "com.amazonaws.rds#DescribeOptionGroupOptions" }, @@ -615,9 +609,6 @@ { "target": "com.amazonaws.rds#FailoverGlobalCluster" }, - { - "target": "com.amazonaws.rds#ImportInstallationMedia" - }, { "target": "com.amazonaws.rds#ListTagsForResource" }, @@ -1816,70 +1807,6 @@ } } }, - "com.amazonaws.rds#CreateCustomAvailabilityZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#CreateCustomAvailabilityZoneMessage" - }, - "output": { - "target": "com.amazonaws.rds#CreateCustomAvailabilityZoneResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneAlreadyExistsFault" - }, - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneQuotaExceededFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a custom Availability Zone (AZ).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" - } - }, - "com.amazonaws.rds#CreateCustomAvailabilityZoneMessage": { - "type": "structure", - "members": { - "CustomAvailabilityZoneName": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The name of the custom Availability Zone (AZ).

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

The ID of an existing virtual private network (VPN) between the Amazon RDS website and\n the VMware vSphere cluster.

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

The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.

\n

Specify this parameter only if ExistingVpnId isn't specified.

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

The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

\n

Specify this parameter only if ExistingVpnId isn't specified.

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

" - } - }, - "com.amazonaws.rds#CreateCustomAvailabilityZoneResult": { - "type": "structure", - "members": { - "CustomAvailabilityZone": { - "target": "com.amazonaws.rds#CustomAvailabilityZone" - } - } - }, "com.amazonaws.rds#CreateCustomDBEngineVersion": { "type": "operation", "input": { @@ -2370,6 +2297,9 @@ "traits": { "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

Valid for: Multi-AZ DB clusters only

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } }, "traits": { @@ -2646,7 +2576,7 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Not applicable. Availability Zones are managed by the DB cluster.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

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

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

\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": { @@ -3864,81 +3794,6 @@ } } }, - "com.amazonaws.rds#CustomAvailabilityZone": { - "type": "structure", - "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the custom AZ.

\n

Amazon RDS generates a unique identifier when a custom AZ is created.

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

The name of the custom AZ.

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

The status of the custom AZ.

" - } - }, - "VpnDetails": { - "target": "com.amazonaws.rds#VpnDetails", - "traits": { - "smithy.api#documentation": "

Information about the virtual private network (VPN) between the VMware vSphere cluster\n and the Amazon Web Services website.

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

A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" - } - }, - "com.amazonaws.rds#CustomAvailabilityZoneAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomAvailabilityZoneAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

\n CustomAvailabilityZoneName is already used by an existing custom\n Availability Zone.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#CustomAvailabilityZoneList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#CustomAvailabilityZone", - "traits": { - "smithy.api#xmlName": "CustomAvailabilityZone" - } - } - }, - "com.amazonaws.rds#CustomAvailabilityZoneMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeCustomAvailabilityZones request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "CustomAvailabilityZones": { - "target": "com.amazonaws.rds#CustomAvailabilityZoneList", - "traits": { - "smithy.api#documentation": "

The list of CustomAvailabilityZone objects for the Amazon Web Services account.

" - } - } - } - }, "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault": { "type": "structure", "members": { @@ -3956,23 +3811,6 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.rds#CustomAvailabilityZoneQuotaExceededFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CustomAvailabilityZoneQuotaExceeded", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

You have exceeded the maximum number of custom Availability Zones.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault": { "type": "structure", "members": { @@ -4471,6 +4309,9 @@ "traits": { "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo" } }, "traits": { @@ -7869,46 +7710,6 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.rds#DeleteCustomAvailabilityZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteCustomAvailabilityZoneMessage" - }, - "output": { - "target": "com.amazonaws.rds#DeleteCustomAvailabilityZoneResult" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" - }, - { - "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a custom Availability Zone (AZ).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" - } - }, - "com.amazonaws.rds#DeleteCustomAvailabilityZoneMessage": { - "type": "structure", - "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The custom AZ identifier.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#DeleteCustomAvailabilityZoneResult": { - "type": "structure", - "members": { - "CustomAvailabilityZone": { - "target": "com.amazonaws.rds#CustomAvailabilityZone" - } - } - }, "com.amazonaws.rds#DeleteCustomDBEngineVersion": { "type": "operation", "input": { @@ -8044,6 +7845,9 @@ "input": { "target": "com.amazonaws.rds#DeleteDBClusterParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" @@ -8248,6 +8052,9 @@ "input": { "target": "com.amazonaws.rds#DeleteDBParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBParameterGroupNotFoundFault" @@ -8366,6 +8173,9 @@ "input": { "target": "com.amazonaws.rds#DeleteDBSecurityGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBSecurityGroupNotFoundFault" @@ -8441,6 +8251,9 @@ "input": { "target": "com.amazonaws.rds#DeleteDBSubnetGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBSubnetGroupNotFoundFault" @@ -8554,40 +8367,14 @@ } } }, - "com.amazonaws.rds#DeleteInstallationMedia": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DeleteInstallationMediaMessage" - }, - "output": { - "target": "com.amazonaws.rds#InstallationMedia" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InstallationMediaNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the installation medium for a DB engine that requires an on-premises customer provided license,\n such as Microsoft SQL Server.

" - } - }, - "com.amazonaws.rds#DeleteInstallationMediaMessage": { - "type": "structure", - "members": { - "InstallationMediaId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The installation medium ID.

", - "smithy.api#required": {} - } - } - } - }, "com.amazonaws.rds#DeleteOptionGroup": { "type": "operation", "input": { "target": "com.amazonaws.rds#DeleteOptionGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#InvalidOptionGroupStateFault" @@ -8749,58 +8536,6 @@ "smithy.api#documentation": "

" } }, - "com.amazonaws.rds#DescribeCustomAvailabilityZones": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeCustomAvailabilityZonesMessage" - }, - "output": { - "target": "com.amazonaws.rds#CustomAvailabilityZoneMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about custom Availability Zones (AZs).

\n

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "CustomAvailabilityZones", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeCustomAvailabilityZonesMessage": { - "type": "structure", - "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more custom AZs to describe.

" - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so you can retrieve the remaining results.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

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

An optional pagination token provided by a previous\n DescribeCustomAvailabilityZones request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, "com.amazonaws.rds#DescribeDBClusterBacktracks": { "type": "operation", "input": { @@ -10685,7 +10420,7 @@ "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name of the DB parameter group family.

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

The name of the DB parameter group family.

\n

Valid Values:

\n ", "smithy.api#required": {} } }, @@ -10997,58 +10732,6 @@ } } }, - "com.amazonaws.rds#DescribeInstallationMedia": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#DescribeInstallationMediaMessage" - }, - "output": { - "target": "com.amazonaws.rds#InstallationMediaMessage" - }, - "errors": [ - { - "target": "com.amazonaws.rds#InstallationMediaNotFoundFault" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available installation media for a DB engine that requires an \n on-premises customer provided license, such as Microsoft SQL Server.

", - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "Marker", - "items": "InstallationMedia", - "pageSize": "MaxRecords" - } - } - }, - "com.amazonaws.rds#DescribeInstallationMediaMessage": { - "type": "structure", - "members": { - "InstallationMediaId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The installation medium ID.

" - } - }, - "Filters": { - "target": "com.amazonaws.rds#FilterList", - "traits": { - "smithy.api#documentation": "

A filter that specifies one or more installation media to describe. Supported filters\n include the following:

\n " - } - }, - "MaxRecords": { - "target": "com.amazonaws.rds#IntegerOptional", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker, up to the value specified by MaxRecords.

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

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - } - } - }, "com.amazonaws.rds#DescribeOptionGroupOptions": { "type": "operation", "input": { @@ -12765,196 +12448,6 @@ "smithy.api#httpError": 404 } }, - "com.amazonaws.rds#ImportInstallationMedia": { - "type": "operation", - "input": { - "target": "com.amazonaws.rds#ImportInstallationMediaMessage" - }, - "output": { - "target": "com.amazonaws.rds#InstallationMedia" - }, - "errors": [ - { - "target": "com.amazonaws.rds#CustomAvailabilityZoneNotFoundFault" - }, - { - "target": "com.amazonaws.rds#InstallationMediaAlreadyExistsFault" - } - ], - "traits": { - "smithy.api#documentation": "

Imports the installation media for a DB engine that requires an on-premises \n customer provided license, such as SQL Server.

" - } - }, - "com.amazonaws.rds#ImportInstallationMediaMessage": { - "type": "structure", - "members": { - "CustomAvailabilityZoneId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The identifier of the custom Availability Zone (AZ) to import the installation media to.

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

The name of the database engine to be used for this instance.

\n

The list only includes supported DB engines that require an on-premises \n customer provided license.

\n

Valid Values:

\n ", - "smithy.api#required": {} - } - }, - "EngineVersion": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, call DescribeDBEngineVersions.

\n

The following are the database engines and links to information about the major and minor \n versions. The list only includes DB engines that require an on-premises \n customer provided license.

\n

\n Microsoft SQL Server\n

\n

See \n Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

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

The path to the installation medium for the specified DB engine.

\n

Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso\n

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

The path to the installation medium for the operating system associated with the specified DB engine.

\n

Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso\n

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.rds#InstallationMedia": { - "type": "structure", - "members": { - "InstallationMediaId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The installation medium ID.

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

The custom Availability Zone (AZ) that contains the installation media.

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

The DB engine.

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

The engine version of the DB engine.

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

The path to the installation medium for the DB engine.

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

The path to the installation medium for the operating system associated with the DB engine.

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

The status of the installation medium.

" - } - }, - "FailureCause": { - "target": "com.amazonaws.rds#InstallationMediaFailureCause", - "traits": { - "smithy.api#documentation": "

If an installation media failure occurred, the cause of the failure.

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

Contains the installation media for a DB engine that requires an on-premises \n customer provided license, such as Microsoft SQL Server.

" - } - }, - "com.amazonaws.rds#InstallationMediaAlreadyExistsFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InstallationMediaAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified installation medium has already been imported.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.rds#InstallationMediaFailureCause": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The reason that an installation media import failed.

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

Contains the cause of an installation media failure. Installation media is used \n for a DB engine that requires an on-premises \n customer provided license, such as Microsoft SQL Server.

" - } - }, - "com.amazonaws.rds#InstallationMediaList": { - "type": "list", - "member": { - "target": "com.amazonaws.rds#InstallationMedia", - "traits": { - "smithy.api#xmlName": "InstallationMedia" - } - } - }, - "com.amazonaws.rds#InstallationMediaMessage": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous\n DescribeInstallationMedia request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

" - } - }, - "InstallationMedia": { - "target": "com.amazonaws.rds#InstallationMediaList", - "traits": { - "smithy.api#documentation": "

The list of InstallationMedia objects for the Amazon Web Services account.

" - } - } - } - }, - "com.amazonaws.rds#InstallationMediaNotFoundFault": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.rds#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InstallationMediaNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "

\n InstallationMediaID doesn't refer to an existing installation medium.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, "com.amazonaws.rds#InstanceQuotaExceededFault": { "type": "structure", "members": { @@ -13625,7 +13118,7 @@ } ], "traits": { - "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances temporarily, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" + "smithy.api#documentation": "

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS)\n certificate for Amazon RDS for new DB instances, or remove the override.

\n

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB\n instances that is different from the default certificate provided by RDS. You can also\n use this operation to remove the override, so that new DB instances use the default\n certificate provided by RDS.

\n

You might need to override the default certificate in the following situations:

\n \n

For more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

\n

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

" } }, "com.amazonaws.rds#ModifyCertificatesMessage": { @@ -14073,6 +13566,9 @@ "traits": { "smithy.api#documentation": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

\n

Valid for: Multi-AZ DB clusters only

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } }, "traits": { @@ -16898,6 +16394,9 @@ "input": { "target": "com.amazonaws.rds#RemoveRoleFromDBClusterMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" @@ -16943,6 +16442,9 @@ "input": { "target": "com.amazonaws.rds#RemoveRoleFromDBInstanceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBInstanceNotFoundFault" @@ -17039,6 +16541,9 @@ "input": { "target": "com.amazonaws.rds#RemoveTagsFromResourceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.rds#DBClusterNotFoundFault" @@ -17775,6 +17280,9 @@ "traits": { "smithy.api#documentation": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } } }, @@ -18012,6 +17520,9 @@ "traits": { "smithy.api#documentation": "

A value that indicates whether the DB cluster is publicly accessible.

\n

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address \n from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. \n Access to the DB cluster is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

\n

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n \n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } }, "traits": { @@ -18245,6 +17756,9 @@ "traits": { "smithy.api#documentation": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for \n each DB instance in the Multi-AZ DB cluster.

\n

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

\n

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

\n

Valid for: Multi-AZ DB clusters only

" } + }, + "ServerlessV2ScalingConfiguration": { + "target": "com.amazonaws.rds#ServerlessV2ScalingConfiguration" } }, "traits": { @@ -19422,6 +18936,46 @@ "smithy.api#documentation": "

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

\n

For more information, see Using Amazon Aurora Serverless v1 in the\n Amazon Aurora User Guide.

" } }, + "com.amazonaws.rds#ServerlessV2ScalingConfiguration": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

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

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } + }, + "com.amazonaws.rds#ServerlessV2ScalingConfigurationInfo": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value\n that you can use is 0.5.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.rds#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster.\n You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value\n that you can use is 128.

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

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

\n

For more information, see Using Amazon Aurora Serverless v2 in the\n Amazon Aurora User Guide.

" + } + }, "com.amazonaws.rds#SharedSnapshotQuotaExceededFault": { "type": "structure", "members": { @@ -20224,12 +19778,6 @@ "target": "com.amazonaws.rds#String" } }, - "com.amazonaws.rds#StringSensitive": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, "com.amazonaws.rds#Subnet": { "type": "structure", "members": { @@ -20812,50 +20360,6 @@ } } }, - "com.amazonaws.rds#VpnDetails": { - "type": "structure", - "members": { - "VpnId": { - "target": "com.amazonaws.rds#String", - "traits": { - "smithy.api#documentation": "

The ID of the VPN.

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

The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

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

The IP address of network traffic from Amazon Web Services to your on-premises data center.

" - } - }, - "VpnPSK": { - "target": "com.amazonaws.rds#StringSensitive", - "traits": { - "smithy.api#documentation": "

The preshared key (PSK) for the VPN.

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

The name of the VPN.

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

The state of the VPN.

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

Information about the virtual private network (VPN) between the VMware vSphere cluster and the Amazon Web Services website.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

" - } - }, "com.amazonaws.rds#WriteForwardingStatus": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/redshift.json b/aws/sdk/aws-models/redshift.json index c2781befee..c9d6a84f6f 100644 --- a/aws/sdk/aws-models/redshift.json +++ b/aws/sdk/aws-models/redshift.json @@ -3554,6 +3554,9 @@ "input": { "target": "com.amazonaws.redshift#CreateTagsMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidClusterStateFault" @@ -4115,6 +4118,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteClusterParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ClusterParameterGroupNotFoundFault" @@ -4155,6 +4161,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteClusterSecurityGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ClusterSecurityGroupNotFoundFault" @@ -4245,6 +4254,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteClusterSubnetGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ClusterSubnetGroupNotFoundFault" @@ -4321,6 +4333,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteEventSubscriptionMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidSubscriptionStateFault" @@ -4353,6 +4368,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteHsmClientCertificateMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#HsmClientCertificateNotFoundFault" @@ -4385,6 +4403,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteHsmConfigurationMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#HsmConfigurationNotFoundFault" @@ -4440,6 +4461,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteScheduledActionMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ScheduledActionNotFoundFault" @@ -4469,6 +4493,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteSnapshotCopyGrantMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidSnapshotCopyGrantStateFault" @@ -4501,6 +4528,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteSnapshotScheduleMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidClusterSnapshotScheduleStateFault" @@ -4530,6 +4560,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteTagsMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#InvalidTagFault" @@ -4569,6 +4602,9 @@ "input": { "target": "com.amazonaws.redshift#DeleteUsageLimitMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#UnsupportedOperationFault" @@ -6724,6 +6760,9 @@ }, "com.amazonaws.redshift#DescribeStorage": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.redshift#CustomerStorageMessage" }, @@ -7190,8 +7229,7 @@ "BucketName": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The name of an existing S3 bucket where the log files are to be stored.

\n

Constraints:

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

The name of an existing S3 bucket where the log files are to be stored.

\n

Constraints:

\n " } }, "S3KeyPrefix": { @@ -7199,6 +7237,18 @@ "traits": { "smithy.api#documentation": "

The prefix applied to the log file names.

\n

Constraints:

\n " } + }, + "LogDestinationType": { + "target": "com.amazonaws.redshift#LogDestinationType", + "traits": { + "smithy.api#documentation": "

The log destination type. An enum with possible values of s3 and cloudwatch.

" + } + }, + "LogExports": { + "target": "com.amazonaws.redshift#LogTypeList", + "traits": { + "smithy.api#documentation": "

The collection of exported log types. Log types include the connection log, user log and user activity log.

" + } } }, "traits": { @@ -9074,6 +9124,27 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshift#LogDestinationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "s3", + "name": "S3" + }, + { + "value": "cloudwatch", + "name": "CLOUDWATCH" + } + ] + } + }, + "com.amazonaws.redshift#LogTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#String" + } + }, "com.amazonaws.redshift#LoggingStatus": { "type": "structure", "members": { @@ -9112,6 +9183,18 @@ "traits": { "smithy.api#documentation": "

The message indicating that logs failed to be delivered.

" } + }, + "LogDestinationType": { + "target": "com.amazonaws.redshift#LogDestinationType", + "traits": { + "smithy.api#documentation": "

The log destination type. An enum with possible values of s3 and cloudwatch.

" + } + }, + "LogExports": { + "target": "com.amazonaws.redshift#LogTypeList", + "traits": { + "smithy.api#documentation": "

The collection of exported log types. Log types include the connection log, user log and user activity log.

" + } } }, "traits": { @@ -9800,6 +9883,9 @@ "input": { "target": "com.amazonaws.redshift#ModifyClusterSnapshotScheduleMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.redshift#ClusterNotFoundFault" @@ -12554,7 +12640,7 @@ "KmsKeyId": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The Key Management Service (KMS) key ID of the encryption key to encrypt data in the cluster \n restored from a shared snapshot. You can also provide \n the key ID when you restore from an unencrypted snapshot to an encrypted cluster in \n the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted \n snapshot in the same account in order to change it. In that case, the restored cluster is encrypted \n with the new KMS key ID.

" + "smithy.api#documentation": "

The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster \n restored from a shared snapshot. You can also provide \n the key ID when you restore from an unencrypted snapshot to an encrypted cluster in \n the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted \n snapshot in the same account in order to change it. In that case, the restored cluster is encrypted \n with the new KMS key ID.

" } }, "NodeType": { @@ -12632,7 +12718,7 @@ "Encrypted": { "target": "com.amazonaws.redshift#BooleanOptional", "traits": { - "smithy.api#documentation": "

Enables support for restoring an unencrypted snapshot to a cluster encrypted \n with Key Management Service (KMS) and a CMK.

" + "smithy.api#documentation": "

Enables support for restoring an unencrypted snapshot to a cluster encrypted \n with Key Management Service (KMS) and a customer managed key.

" } } }, diff --git a/aws/sdk/aws-models/rekognition.json b/aws/sdk/aws-models/rekognition.json index 6882826d79..5ce8b08206 100644 --- a/aws/sdk/aws-models/rekognition.json +++ b/aws/sdk/aws-models/rekognition.json @@ -247,7 +247,7 @@ } }, "traits": { - "smithy.api#documentation": "

Identifies the bounding box around the label, face, text or personal protective equipment.\n The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and\n left sides of the bounding box. Note that the upper-left corner of the image is the origin\n (0,0).

\n

The top and left values returned are ratios of the overall\n image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of\n the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700)\n and a top value of 0.25 (50/200).

\n

The width and height values represent the dimensions of the\n bounding box as a ratio of the overall image dimension. For example, if the input image is\n 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

\n \n

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is\n able to detect a face that is at the image edge and is only partially visible, the service\n can return coordinates that are outside the image bounds and, depending on the image edge,\n you might get negative values or values greater than 1 for the left or\n top values.

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

Identifies the bounding box around the label, face, text, object of interest, or personal protective equipment.\n The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and\n left sides of the bounding box. Note that the upper-left corner of the image is the origin\n (0,0).

\n

The top and left values returned are ratios of the overall\n image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of\n the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700)\n and a top value of 0.25 (50/200).

\n

The width and height values represent the dimensions of the\n bounding box as a ratio of the overall image dimension. For example, if the input image is\n 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

\n \n

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is\n able to detect a face that is at the image edge and is only partially visible, the service\n can return coordinates that are outside the image bounds and, depending on the image edge,\n you might get negative values or values greater than 1 for the left or\n top values.

\n " } }, "com.amazonaws.rekognition#BoundingBoxHeight": { @@ -646,6 +646,62 @@ "smithy.api#documentation": "

Type that describes the face Amazon Rekognition chose to compare with the faces in the target.\n This contains a bounding box for the selected face and confidence level that the bounding box\n contains a face. Note that Amazon Rekognition selects the largest face in the source image for this\n comparison.

" } }, + "com.amazonaws.rekognition#ConnectedHomeLabel": { + "type": "string" + }, + "com.amazonaws.rekognition#ConnectedHomeLabels": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#ConnectedHomeLabel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.rekognition#ConnectedHomeSettings": { + "type": "structure", + "members": { + "Labels": { + "target": "com.amazonaws.rekognition#ConnectedHomeLabels", + "traits": { + "smithy.api#documentation": "

\n Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\".\n

", + "smithy.api#required": {} + } + }, + "MinConfidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

\n The minimum confidence required to label an object in the video. \n

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

\n Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for CreateStreamProcessor.\n Including this setting in the CreateStreamProcessor request enables you to use the stream processor for label detection. \n You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification\n is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected \n and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary. \n

" + } + }, + "com.amazonaws.rekognition#ConnectedHomeSettingsForUpdate": { + "type": "structure", + "members": { + "Labels": { + "target": "com.amazonaws.rekognition#ConnectedHomeLabels", + "traits": { + "smithy.api#documentation": "

\n Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\".\n

" + } + }, + "MinConfidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

\n The minimum confidence required to label an object in the video. \n

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

\n The label detection settings you want to use in your stream processor. This includes the labels you want the stream processor to detect and the minimum confidence level allowed to label objects. \n

" + } + }, "com.amazonaws.rekognition#ContentClassifier": { "type": "string", "traits": { @@ -805,7 +861,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" + "smithy.api#documentation": "

Version number of the face detection model associated with the collection you are creating.

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

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.

\n

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.

\n

You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the\n face recognition criteria in Settings. For example, the collection containing faces that you want to recognize.\n Use Name to assign an identifier for the stream processor. You use Name\n to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with\n the Name field.

\n

After you have finished analyzing a streaming video, use StopStreamProcessor to\n stop processing. You can delete the stream processor by calling DeleteStreamProcessor.

\n

This operation requires permissions to perform the\n rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

" + "smithy.api#documentation": "

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

\n

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.

\n \n \n

\n Use Name to assign an identifier for the stream processor. You use Name\n to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with\n the Name field.

\n

This operation requires permissions to perform the\n rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

" } }, "com.amazonaws.rekognition#CreateStreamProcessorRequest": { @@ -1091,35 +1147,35 @@ "Input": { "target": "com.amazonaws.rekognition#StreamProcessorInput", "traits": { - "smithy.api#documentation": "

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

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

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.

", "smithy.api#required": {} } }, "Output": { "target": "com.amazonaws.rekognition#StreamProcessorOutput", "traits": { - "smithy.api#documentation": "

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

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

Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. \n This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.rekognition#StreamProcessorName", "traits": { - "smithy.api#documentation": "

An identifier you assign to the stream processor. You can use Name to\n manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor.\n Name is idempotent.\n

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

An identifier you assign to the stream processor. You can use Name to\n manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor.\n Name is idempotent. This is required for both face search and label detection stream processors.\n

", "smithy.api#required": {} } }, "Settings": { "target": "com.amazonaws.rekognition#StreamProcessorSettings", "traits": { - "smithy.api#documentation": "

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face\n attributes to detect.

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

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.rekognition#RoleArn", "traits": { - "smithy.api#documentation": "

ARN of the IAM role that allows access to the stream processor.

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

The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. \n The IAM role provides Rekognition read permissions for a Kinesis stream. \n It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

", "smithy.api#required": {} } }, @@ -1128,6 +1184,27 @@ "traits": { "smithy.api#documentation": "

\n A set of tags (key-value pairs) that you want to attach to the stream processor.\n

" } + }, + "NotificationChannel": { + "target": "com.amazonaws.rekognition#StreamProcessorNotificationChannel" + }, + "KmsKeyId": { + "target": "com.amazonaws.rekognition#KmsKeyId", + "traits": { + "smithy.api#documentation": "

\n The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. \n The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected. \n

\n

\n

" + } + }, + "RegionsOfInterest": { + "target": "com.amazonaws.rekognition#RegionsOfInterest", + "traits": { + "smithy.api#documentation": "

\n Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.\n

" + } + }, + "DataSharingPreference": { + "target": "com.amazonaws.rekognition#StreamProcessorDataSharingPreference", + "traits": { + "smithy.api#documentation": "

\n Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.\n Note that if you opt out at the account level this setting is ignored on individual streams.\n

" + } } } }, @@ -1137,7 +1214,7 @@ "StreamProcessorArn": { "target": "com.amazonaws.rekognition#StreamProcessorArn", "traits": { - "smithy.api#documentation": "

ARN for the newly create stream processor.

" + "smithy.api#documentation": "

Amazon Resource Number for the newly created stream processor.

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

Deletes the specified collection. Note that this operation\n removes all faces in the collection. For an example, see delete-collection-procedure.

\n\n

This operation requires permissions to perform the\n rekognition:DeleteCollection action.

" + "smithy.api#documentation": "

Deletes the specified collection. Note that this operation\n removes all faces in the collection. For an example, see Deleting a collection.

\n\n

This operation requires permissions to perform the\n rekognition:DeleteCollection action.

" } }, "com.amazonaws.rekognition#DeleteCollectionRequest": { @@ -1902,7 +1979,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

The version of the face model that's used by the collection for face detection.

\n \n

For more information, see Model Versioning in the \n Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

The version of the face model that's used by the collection for face detection.

\n \n

For more information, see Model versioning in the \n Amazon Rekognition Developer Guide.

" } }, "CollectionARN": { @@ -2298,7 +2375,28 @@ "Settings": { "target": "com.amazonaws.rekognition#StreamProcessorSettings", "traits": { - "smithy.api#documentation": "

Face recognition input parameters that are being used by the stream processor.\n Includes the collection to use for face recognition and the face\n attributes to detect.

" + "smithy.api#documentation": "

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces\n in a streaming video, or you can use ConnectedHome to detect labels.

" + } + }, + "NotificationChannel": { + "target": "com.amazonaws.rekognition#StreamProcessorNotificationChannel" + }, + "KmsKeyId": { + "target": "com.amazonaws.rekognition#KmsKeyId", + "traits": { + "smithy.api#documentation": "

\n The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.\n

" + } + }, + "RegionsOfInterest": { + "target": "com.amazonaws.rekognition#RegionsOfInterest", + "traits": { + "smithy.api#documentation": "

\n Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.\n

" + } + }, + "DataSharingPreference": { + "target": "com.amazonaws.rekognition#StreamProcessorDataSharingPreference", + "traits": { + "smithy.api#documentation": "

\n Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.\n Note that if you opt out at the account level this setting is ignored on individual streams.\n

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

Detects instances of real-world entities within an image (JPEG or PNG)\n provided as input. This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.\n

\n \n

For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

\n \n

\n DetectLabels does not support the detection of activities. However, activity detection\n is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

\n \n \n

You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n

For each object, scene, and concept the API returns one or more labels. Each label\n provides the object name, and the level of confidence that the image contains the object. For\n example, suppose the input image has a lighthouse, the sea, and a rock. The response includes\n all three labels, one for each object.

\n \n

\n {Name: lighthouse, Confidence: 98.4629}\n

\n

\n {Name: rock,Confidence: 79.2097}\n

\n

\n {Name: sea,Confidence: 75.061}\n

\n

In the preceding example, the operation returns one label for each of the three\n objects. The operation can also return multiple labels for the same object in the image. For\n example, if the input image shows a flower (for example, a tulip), the operation might return\n the following three labels.

\n

\n {Name: flower,Confidence: 99.0562}\n

\n

\n {Name: plant,Confidence: 99.0562}\n

\n

\n {Name: tulip,Confidence: 99.0562}\n

\n\n

In this example, the detection algorithm more precisely identifies the flower as a\n tulip.

\n

In response, the API returns an array of labels. In addition, the response also\n includes the orientation correction. Optionally, you can specify MinConfidence to\n control the confidence threshold for the labels returned. The default is 55%. You can also add\n the MaxLabels parameter to limit the number of labels returned.

\n \n

If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.

\n \n

\n DetectLabels returns bounding boxes for instances of common object labels in an array of\n Instance objects. An Instance object contains a \n BoundingBox object, for the location of the label on the image. It also includes \n the confidence by which the bounding box was detected.

\n

\n DetectLabels also returns a hierarchical taxonomy of detected labels. For example,\n a detected car might be assigned the label car. The label car\n has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). \n The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.\n In the previous example, Car, Vehicle, and Transportation\n are returned as unique labels in the response.\n

\n

This is a stateless API operation. That is, the operation does not persist any\n data.

\n

This operation requires permissions to perform the\n rekognition:DetectLabels action.

" + "smithy.api#documentation": "

Detects instances of real-world entities within an image (JPEG or PNG)\n provided as input. This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.\n

\n \n

For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.

\n \n

\n DetectLabels does not support the detection of activities. However, activity detection\n is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

\n \n \n

You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n

For each object, scene, and concept the API returns one or more labels. Each label\n provides the object name, and the level of confidence that the image contains the object. For\n example, suppose the input image has a lighthouse, the sea, and a rock. The response includes\n all three labels, one for each object.

\n \n

\n {Name: lighthouse, Confidence: 98.4629}\n

\n

\n {Name: rock,Confidence: 79.2097}\n

\n

\n {Name: sea,Confidence: 75.061}\n

\n

In the preceding example, the operation returns one label for each of the three\n objects. The operation can also return multiple labels for the same object in the image. For\n example, if the input image shows a flower (for example, a tulip), the operation might return\n the following three labels.

\n

\n {Name: flower,Confidence: 99.0562}\n

\n

\n {Name: plant,Confidence: 99.0562}\n

\n

\n {Name: tulip,Confidence: 99.0562}\n

\n\n

In this example, the detection algorithm more precisely identifies the flower as a\n tulip.

\n

In response, the API returns an array of labels. In addition, the response also\n includes the orientation correction. Optionally, you can specify MinConfidence to\n control the confidence threshold for the labels returned. The default is 55%. You can also add\n the MaxLabels parameter to limit the number of labels returned.

\n \n

If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.

\n \n

\n DetectLabels returns bounding boxes for instances of common object labels in an array of\n Instance objects. An Instance object contains a \n BoundingBox object, for the location of the label on the image. It also includes \n the confidence by which the bounding box was detected.

\n

\n DetectLabels also returns a hierarchical taxonomy of detected labels. For example,\n a detected car might be assigned the label car. The label car\n has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). \n The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.\n In the previous example, Car, Vehicle, and Transportation\n are returned as unique labels in the response.\n

\n

This is a stateless API operation. That is, the operation does not persist any\n data.

\n

This operation requires permissions to perform the\n rekognition:DetectLabels action.

" } }, "com.amazonaws.rekognition#DetectLabelsRequest": { @@ -2751,7 +2849,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects text in the input image and converts it into machine-readable text.

\n

Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal 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 Detecting text in the Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#DetectTextFilters": { @@ -2812,7 +2910,7 @@ "MinConfidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

Sets the confidence of word detection. Words with detection confidence below this will be excluded \n from the result. Values should be between 50 and 100 as Text in Video will not return any result below \n 50.

" + "smithy.api#documentation": "

Sets the confidence of word detection. Words with detection confidence below this will be\n excluded from the result. Values should be between 0 and 100. The default MinConfidence is\n 80.

" } }, "MinBoundingBoxHeight": { @@ -3384,7 +3482,7 @@ } }, "traits": { - "smithy.api#documentation": "

Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings is a request\n parameter for CreateStreamProcessor.

" + "smithy.api#documentation": "

Input face recognition parameters for an Amazon Rekognition stream processor. \n Includes the collection to use for face recognition and the face attributes to detect. \n Defining the settings is required in the request parameter for CreateStreamProcessor.

" } }, "com.amazonaws.rekognition#FaceSearchSortBy": { @@ -3434,7 +3532,7 @@ } }, "traits": { - "smithy.api#documentation": "

The predicted gender of a detected face. \n

\n \n \n

Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance\n of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender\n identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor\n wearing a long-haired wig and earrings for a role might be predicted as female.

\n \n

Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be \n analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.

\n \n

We don't recommend using gender binary predictions to make decisions that impact\u2028 an individual's rights, privacy, or access to services.

" + "smithy.api#documentation": "

The predicted gender of a detected face. \n

\n \n \n

Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance\n of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender\n identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor\n wearing a long-haired wig and earrings for a role might be predicted as female.

\n \n

Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be \n analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.

\n \n

We don't recommend using gender binary predictions to make decisions that impact an individual's rights, privacy, or access to services.

" } }, "com.amazonaws.rekognition#GenderType": { @@ -3501,7 +3599,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.

\n \n

For more information, see Recognizing Celebrities in an Image in\n the Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the\n rekognition:GetCelebrityInfo action.

" + "smithy.api#documentation": "

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.

\n \n

For more information, see Getting information about a celebrity in\n the Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the\n rekognition:GetCelebrityInfo action.

" } }, "com.amazonaws.rekognition#GetCelebrityInfoRequest": { @@ -3676,7 +3774,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by\n StartContentModeration. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n\n

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling\n StartContentModeration which returns a job identifier (JobId).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartContentModeration.\n To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.

\n

\n GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels,\n and the time they are detected, in an array, ModerationLabels, of\n ContentModerationDetection objects.\n

\n

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying NAME for the SortBy\n input parameter.

\n

Since video analysis can return a large number of results, use the MaxResults parameter to limit\n the number of labels returned in a single call to GetContentModeration. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetContentModeration\n and populate the NextToken request parameter with the value of NextToken\n returned from the previous call to GetContentModeration.

\n \n

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

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

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by\n StartContentModeration. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n\n

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling\n StartContentModeration which returns a job identifier (JobId).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartContentModeration.\n To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.

\n

\n GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels,\n and the time they are detected, in an array, ModerationLabels, of\n ContentModerationDetection objects.\n

\n

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying NAME for the SortBy\n input parameter.

\n

Since video analysis can return a large number of results, use the MaxResults parameter to limit\n the number of labels returned in a single call to GetContentModeration. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetContentModeration\n and populate the NextToken request parameter with the value of NextToken\n returned from the previous call to GetContentModeration.

\n \n

For more information, see moderating content in the Amazon Rekognition Developer Guide.

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

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

\n

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling StartSegmentDetection which returns a job identifier (JobId).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartSegmentDetection. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call\n of StartSegmentDetection.

\n

\n GetSegmentDetection returns detected segments in an array (Segments)\n of SegmentDetection objects. Segments is sorted by the segment types \n specified in the SegmentTypes input parameter of StartSegmentDetection. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.

\n

Use SelectedSegmentTypes to find out the type of segment detection requested in the \n call to StartSegmentDetection.

\n

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetSegmentDetection.

\n \n

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

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

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

\n

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling StartSegmentDetection which returns a job identifier (JobId).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartSegmentDetection. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call\n of StartSegmentDetection.

\n

\n GetSegmentDetection returns detected segments in an array (Segments)\n of SegmentDetection objects. Segments is sorted by the segment types \n specified in the SegmentTypes input parameter of StartSegmentDetection. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.

\n

Use SelectedSegmentTypes to find out the type of segment detection requested in the \n call to StartSegmentDetection.

\n

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetSegmentDetection.

\n \n

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4593,7 +4691,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the input image either as bytes or an S3 object.

\n

You pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.

\n \n

For more information, see Analyzing an Image Loaded from a Local File System \n in the Amazon Rekognition Developer Guide.

\n

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n

If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3\n object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.\n

" + "smithy.api#documentation": "

Provides the input image either as bytes or an S3 object.

\n

You pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.

\n \n

For more information, see Analyzing an Image Loaded from a Local File System \n in the Amazon Rekognition Developer Guide.

\n

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n

If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3\n object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.\n

" } }, "com.amazonaws.rekognition#ImageBlob": { @@ -4648,7 +4746,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input image size exceeds the allowed limit. If you are calling\n DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see \n Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

The input image size exceeds the allowed limit. If you are calling\n DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see \n Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", "smithy.api#error": "client" } }, @@ -4693,7 +4791,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects faces in the input image and adds them to the specified collection.

\n

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage\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

In response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:

\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.

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

In response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:

\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.

" } }, "com.amazonaws.rekognition#IndexFacesModelVersion": { @@ -4763,7 +4861,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" + "smithy.api#documentation": "

The version number of the face detection model that's associated with the input\n collection (CollectionId).

" } }, "UnindexedFaces": { @@ -4980,6 +5078,36 @@ "smithy.api#documentation": "

Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see\n CreateStreamProcessor in the Amazon Rekognition Developer Guide.

" } }, + "com.amazonaws.rekognition#KinesisVideoStreamFragmentNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.rekognition#KinesisVideoStreamStartSelector": { + "type": "structure", + "members": { + "ProducerTimestamp": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "

\n The timestamp from the producer corresponding to the fragment.\n

" + } + }, + "FragmentNumber": { + "target": "com.amazonaws.rekognition#KinesisVideoStreamFragmentNumber", + "traits": { + "smithy.api#documentation": "

\n The unique identifier of the fragment. This value monotonically increases based on the ingestion order.\n

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

\n Specifies the starting point in a Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number.\n For more information, see Fragment. \n

" + } + }, "com.amazonaws.rekognition#KmsKeyId": { "type": "string", "traits": { @@ -5319,7 +5447,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns list of collection IDs in your account.\n If the result is truncated, the response also provides a NextToken\n that you can use in the subsequent request to fetch the next set of collection IDs.

\n \n

For an example, see Listing Collections in the Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the rekognition:ListCollections action.

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

Returns list of collection IDs in your account.\n If the result is truncated, the response also provides a NextToken\n that you can use in the subsequent request to fetch the next set of collection IDs.

\n \n

For an example, see Listing collections in the Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the rekognition:ListCollections action.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5363,7 +5491,7 @@ "FaceModelVersions": { "target": "com.amazonaws.rekognition#FaceModelVersionList", "traits": { - "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].

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

" } } } @@ -5671,7 +5799,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" + "smithy.api#documentation": "

Version number of the face detection model associated with the input collection (CollectionId).

" } } } @@ -5802,6 +5930,16 @@ } } }, + "com.amazonaws.rekognition#MaxDurationInSecondsULong": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 120 + } + } + }, "com.amazonaws.rekognition#MaxFaces": { "type": "integer", "traits": { @@ -5928,7 +6066,7 @@ "SNSTopicArn": { "target": "com.amazonaws.rekognition#SNSTopicArn", "traits": { - "smithy.api#documentation": "

The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

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

The Amazon SNS topic to which Amazon Rekognition posts the completion status.

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

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see\n api-video. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.\n For more information, see Giving access to multiple Amazon SNS topics.

" + "smithy.api#documentation": "

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see\n Calling Amazon Rekognition Video operations. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.\n For more information, see Giving access to multiple Amazon SNS topics.

" } }, "com.amazonaws.rekognition#OrientationCorrection": { @@ -6155,7 +6293,7 @@ } }, "traits": { - "smithy.api#documentation": "

The X and Y coordinates of a point on an image. The X and Y values returned are ratios\n of the overall image size. For example, if the input image is 700x200 and the \n operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.

\n \n

An array of Point objects,\n Polygon, is returned by DetectText and by DetectCustomLabels. Polygon\n represents a fine-grained polygon around a detected item. For more information, see Geometry in the\n Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

The X and Y coordinates of a point on an image or video frame. The X and Y values are ratios\n of the overall image size or video resolution. For example, if an input image is 700x200 and the \n values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.

\n \n

An array of Point objects makes up a Polygon.\n A Polygon is returned by DetectText and by DetectCustomLabels\n Polygon\n represents a fine-grained polygon around a detected item. For more information, see Geometry in the\n Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#Polygon": { @@ -6721,7 +6859,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities\n in the Amazon Rekognition Developer Guide.

\n

\n RecognizeCelebrities returns the 64 largest faces in the image. It lists the\n recognized celebrities in the CelebrityFaces array and any unrecognized faces in\n the UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.

\n\n

For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.

\n

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.

\n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n\n\n\n \n

For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.

" + "smithy.api#documentation": "

Returns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities\n in the Amazon Rekognition Developer Guide.

\n

\n RecognizeCelebrities returns the 64 largest faces in the image. It lists the\n recognized celebrities in the CelebrityFaces array and any unrecognized faces in\n the UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.

\n\n

For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.

\n

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.

\n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n\n\n\n \n

For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.

\n

This operation requires permissions to perform the\n rekognition:RecognizeCelebrities operation.

" } }, "com.amazonaws.rekognition#RecognizeCelebritiesRequest": { @@ -6767,10 +6905,16 @@ "traits": { "smithy.api#documentation": "

The box representing a region of interest on screen.

" } + }, + "Polygon": { + "target": "com.amazonaws.rekognition#Polygon", + "traits": { + "smithy.api#documentation": "

\n Specifies a shape made up of up to 10 Point objects to define a region of interest.\n

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

Specifies a location within the frame that Rekognition checks for text. Uses a BoundingBox\n object to set a region of the screen.

\n

A word is included in the region if the word is more than half in that region. If there is more than\n one region, the word will be compared with all regions of the screen. Any word more than half in a region\n is kept in the results.

" + "smithy.api#documentation": "

Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox\n or object or Polygon to set a region of the screen.

\n

A word, face, or label is included in the region if it is more than half in that region. If there is more than\n one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region\n is kept in the results.

" } }, "com.amazonaws.rekognition#RegionsOfInterest": { @@ -6799,7 +6943,7 @@ "name": "rekognition" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

This is the Amazon Rekognition API reference.

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

This is the API Reference for Amazon Rekognition Image, \n Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored Video, \n Amazon Rekognition Streaming Video.\n It provides descriptions of actions, data types, common parameters,\n and common errors.

\n\n

\n Amazon Rekognition Image \n

\n\n \n \n \n \n\n\n

\n Amazon Rekognition Custom Labels \n

\n \n \n

\n Amazon Rekognition Video Stored Video \n

\n\n \n \n

\n Amazon Rekognition Video Streaming Video \n

\n\n ", "smithy.api#title": "Amazon Rekognition" }, "version": "2016-06-27", @@ -6977,6 +7121,9 @@ }, { "target": "com.amazonaws.rekognition#UpdateDatasetEntries" + }, + { + "target": "com.amazonaws.rekognition#UpdateStreamProcessor" } ] }, @@ -7095,6 +7242,26 @@ "smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*$" } }, + "com.amazonaws.rekognition#S3Destination": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.rekognition#S3Bucket", + "traits": { + "smithy.api#documentation": "

\n The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.\n

" + } + }, + "KeyPrefix": { + "target": "com.amazonaws.rekognition#S3KeyPrefix", + "traits": { + "smithy.api#documentation": "

\n The prefix value of the location within the bucket that you want the information to be published to. \n For more information, see Using prefixes.\n

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

\n The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.\n These results include the name of the stream processor resource, the session ID of the stream processing session, \n and labeled timestamps and bounding boxes for detected labels. \n

" + } + }, "com.amazonaws.rekognition#S3KeyPrefix": { "type": "string", "traits": { @@ -7127,7 +7294,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the S3 bucket name and object name.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition\n Developer Guide.

" + "smithy.api#documentation": "

Provides the S3 bucket name and object name.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition\n Developer Guide.

" } }, "com.amazonaws.rekognition#S3ObjectName": { @@ -7183,7 +7350,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.

\n \n

You can also search faces without indexing faces by using the\n SearchFacesByImage operation.

\n \n\n

\n The operation response returns\n an array of faces that match, ordered by similarity score with the highest\n similarity first. More specifically, it is an\n array of metadata for each face match that is found. Along with the metadata, the response also\n includes a confidence value for each face match, indicating the confidence\n that the specific face matches the input face.\n

\n \n

For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.

\n\n

This operation requires permissions to perform the rekognition:SearchFaces\n action.

" + "smithy.api#documentation": "

For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.

\n \n

You can also search faces without indexing faces by using the\n SearchFacesByImage operation.

\n \n\n

\n The operation response returns\n an array of faces that match, ordered by similarity score with the highest\n similarity first. More specifically, it is an\n array of metadata for each face match that is found. Along with the metadata, the response also\n includes a confidence value for each face match, indicating the confidence\n that the specific face matches the input face.\n

\n \n

For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.

\n\n

This operation requires permissions to perform the rekognition:SearchFaces\n action.

" } }, "com.amazonaws.rekognition#SearchFacesByImage": { @@ -7288,7 +7455,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" + "smithy.api#documentation": "

Version number of the face detection model associated with the input collection (CollectionId).

" } } } @@ -7342,7 +7509,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Latest face model being used with the collection. For more information, see Model versioning.

" + "smithy.api#documentation": "

Version number of the face detection model associated with the input collection (CollectionId).

" } } } @@ -7512,7 +7679,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n \n \n

The size of the collection exceeds the allowed limit. For more information, see \n Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

\n \n \n

The size of the collection exceeds the allowed limit. For more information, see \n Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", "smithy.api#error": "client" } }, @@ -7594,7 +7761,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous recognition of celebrities in a stored video.

\n

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartCelebrityRecognition\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier\n (JobId) from the initial call to StartCelebrityRecognition.

\n \n

For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

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

Starts asynchronous recognition of celebrities in a stored video.

\n

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video.\n StartCelebrityRecognition\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier\n (JobId) from the initial call to StartCelebrityRecognition.

\n \n

For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -7677,7 +7844,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartContentModeration\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

\n

To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

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

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartContentModeration\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

\n

To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Moderating content in the Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -7766,7 +7933,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of faces in a stored video.

\n

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.\n Use Video to specify the bucket name and the filename of the video.\n StartFaceDetection returns a job identifier (JobId) that you\n use to get the results of the operation.\n When face detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the face detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier\n (JobId) from the initial call to StartFaceDetection.

\n \n

For more information, see Detecting Faces in a Stored Video in the \n Amazon Rekognition Developer Guide.

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

Starts asynchronous detection of faces in a stored video.

\n

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.\n Use Video to specify the bucket name and the filename of the video.\n StartFaceDetection returns a job identifier (JobId) that you\n use to get the results of the operation.\n When face detection is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the results of the face detection operation, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier\n (JobId) from the initial call to StartFaceDetection.

\n \n

For more information, see Detecting faces in a stored video in the \n Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -7858,7 +8025,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

\n

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartFaceSearch\n returns a job identifier (JobId) which you use to get the search results once the search has completed.\n When searching is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier\n (JobId) from the initial call to StartFaceSearch. For more information, see\n procedure-person-search-videos.

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

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

\n

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartFaceSearch\n returns a job identifier (JobId) which you use to get the search results once the search has completed.\n When searching is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier\n (JobId) from the initial call to StartFaceSearch. For more information, see\n Searching stored videos for faces.\n

", "smithy.api#idempotent": {} } }, @@ -8194,7 +8361,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of segment detection in a stored video.

\n

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and \n the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in NotificationChannel.

\n

You can use the Filters (StartSegmentDetectionFilters) \n input parameter to specify the minimum detection confidence returned in the response. \n Within Filters, use ShotFilter (StartShotDetectionFilter)\n to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter)\n to filter technical cues.

\n

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) \n from the initial call to StartSegmentDetection.

\n\n \n

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

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

Starts asynchronous detection of segment detection in a stored video.

\n

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and \n the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in NotificationChannel.

\n

You can use the Filters (StartSegmentDetectionFilters) \n input parameter to specify the minimum detection confidence returned in the response. \n Within Filters, use ShotFilter (StartShotDetectionFilter)\n to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter)\n to filter technical cues.

\n

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) \n from the initial call to StartSegmentDetection.

\n\n \n

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -8317,7 +8484,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor.\n To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to\n CreateStreamProcessor.

" + "smithy.api#documentation": "

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor.\n To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to\n CreateStreamProcessor.

\n

If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.

" } }, "com.amazonaws.rekognition#StartStreamProcessorRequest": { @@ -8329,12 +8496,34 @@ "smithy.api#documentation": "

The name of the stream processor to start processing.

", "smithy.api#required": {} } + }, + "StartSelector": { + "target": "com.amazonaws.rekognition#StreamProcessingStartSelector", + "traits": { + "smithy.api#documentation": "

\n Specifies the starting point in the Kinesis stream to start processing. \n You can use the producer timestamp or the fragment number. \n For more information, see Fragment. \n

\n

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

" + } + }, + "StopSelector": { + "target": "com.amazonaws.rekognition#StreamProcessingStopSelector", + "traits": { + "smithy.api#documentation": "

\n Specifies when to stop processing the stream. You can specify a \n maximum amount of time to process the video. \n

\n

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

" + } } } }, "com.amazonaws.rekognition#StartStreamProcessorResponse": { "type": "structure", - "members": {} + "members": { + "SessionId": { + "target": "com.amazonaws.rekognition#StartStreamProcessorSessionId", + "traits": { + "smithy.api#documentation": "

\n A unique identifier for the stream processing session. \n

" + } + } + } + }, + "com.amazonaws.rekognition#StartStreamProcessorSessionId": { + "type": "string" }, "com.amazonaws.rekognition#StartTechnicalCueDetectionFilter": { "type": "structure", @@ -8573,6 +8762,34 @@ "type": "structure", "members": {} }, + "com.amazonaws.rekognition#StreamProcessingStartSelector": { + "type": "structure", + "members": { + "KVSStreamStartSelector": { + "target": "com.amazonaws.rekognition#KinesisVideoStreamStartSelector", + "traits": { + "smithy.api#documentation": "

\n Specifies the starting point in the stream to start processing. This can be done with a timestamp or a fragment number in a Kinesis stream.\n

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

" + } + }, + "com.amazonaws.rekognition#StreamProcessingStopSelector": { + "type": "structure", + "members": { + "MaxDurationInSeconds": { + "target": "com.amazonaws.rekognition#MaxDurationInSecondsULong", + "traits": { + "smithy.api#documentation": "

\n Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest amount of time is 2 minutes. The default is 10 seconds.\n

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

\n Specifies when to stop processing the stream. You can specify a maximum amount\n of time to process the video. \n

" + } + }, "com.amazonaws.rekognition#StreamProcessor": { "type": "structure", "members": { @@ -8590,7 +8807,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request\n parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.\n\n

" + "smithy.api#documentation": "

An object that recognizes faces or labels in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request\n parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.\n\n

" } }, "com.amazonaws.rekognition#StreamProcessorArn": { @@ -8599,6 +8816,21 @@ "smithy.api#pattern": "^(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:streamprocessor\\/.+$)$" } }, + "com.amazonaws.rekognition#StreamProcessorDataSharingPreference": { + "type": "structure", + "members": { + "OptIn": { + "target": "com.amazonaws.rekognition#Boolean", + "traits": { + "smithy.api#documentation": "

\n If this option is set to true, you choose to share data with Rekognition to improve model performance.\n

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

\n Allows you to opt in or opt out to share data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.\n Note that if you opt out at the account level this setting is ignored on individual streams.\n \n

" + } + }, "com.amazonaws.rekognition#StreamProcessorInput": { "type": "structure", "members": { @@ -8629,6 +8861,21 @@ "smithy.api#pattern": "^[a-zA-Z0-9_.\\-]+$" } }, + "com.amazonaws.rekognition#StreamProcessorNotificationChannel": { + "type": "structure", + "members": { + "SNSTopicArn": { + "target": "com.amazonaws.rekognition#SNSTopicArn", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.\n

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

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

\n

Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition\n detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,\n one for a person at second 2 and one for a pet at second 4.

\n

Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

" + } + }, "com.amazonaws.rekognition#StreamProcessorOutput": { "type": "structure", "members": { @@ -8637,12 +8884,39 @@ "traits": { "smithy.api#documentation": "

The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.

" } + }, + "S3Destination": { + "target": "com.amazonaws.rekognition#S3Destination", + "traits": { + "smithy.api#documentation": "

\n The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.\n

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

Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more\n information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.

" } }, + "com.amazonaws.rekognition#StreamProcessorParameterToDelete": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ConnectedHomeMinConfidence", + "name": "ConnectedHomeMinConfidence" + }, + { + "value": "RegionsOfInterest", + "name": "RegionsOfInterest" + } + ] + } + }, + "com.amazonaws.rekognition#StreamProcessorParametersToDelete": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#StreamProcessorParameterToDelete" + } + }, "com.amazonaws.rekognition#StreamProcessorSettings": { "type": "structure", "members": { @@ -8651,10 +8925,27 @@ "traits": { "smithy.api#documentation": "

Face search settings to use on a streaming video.

" } + }, + "ConnectedHome": { + "target": "com.amazonaws.rekognition#ConnectedHomeSettings" } }, "traits": { - "smithy.api#documentation": "

Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.

" + "smithy.api#documentation": "

Input parameters used in a streaming video analyzed by a Amazon Rekognition stream processor. \n You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

" + } + }, + "com.amazonaws.rekognition#StreamProcessorSettingsForUpdate": { + "type": "structure", + "members": { + "ConnectedHomeForUpdate": { + "target": "com.amazonaws.rekognition#ConnectedHomeSettingsForUpdate", + "traits": { + "smithy.api#documentation": "

\n The label detection settings you want to use for your stream processor.\n

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

\n The stream processor settings that you want to update. ConnectedHome settings can be updated to detect different labels with a different minimum confidence.\n

" } }, "com.amazonaws.rekognition#StreamProcessorStatus": { @@ -8680,6 +8971,10 @@ { "value": "STOPPING", "name": "STOPPING" + }, + { + "value": "UPDATING", + "name": "UPDATING" } ] } @@ -8975,7 +9270,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a word or line of text detected by DetectText.

\n

The DetectedText field contains the text that Amazon Rekognition detected in the\n image.

\n

Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.

\n \n

For more information, see Detecting Text in the Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Information about a word or line of text detected by DetectText.

\n

The DetectedText field contains the text that Amazon Rekognition detected in the\n image.

\n

Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.

\n \n

For more information, see Detecting text in the Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#TextDetectionList": { @@ -9252,6 +9547,78 @@ "type": "structure", "members": {} }, + "com.amazonaws.rekognition#UpdateStreamProcessor": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#UpdateStreamProcessorRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#UpdateStreamProcessorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.\n

" + } + }, + "com.amazonaws.rekognition#UpdateStreamProcessorRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.rekognition#StreamProcessorName", + "traits": { + "smithy.api#documentation": "

\n Name of the stream processor that you want to update.\n

", + "smithy.api#required": {} + } + }, + "SettingsForUpdate": { + "target": "com.amazonaws.rekognition#StreamProcessorSettingsForUpdate", + "traits": { + "smithy.api#documentation": "

\n The stream processor settings that you want to update. Label detection settings can be updated to detect different labels with a different minimum confidence.\n

" + } + }, + "RegionsOfInterestForUpdate": { + "target": "com.amazonaws.rekognition#RegionsOfInterest", + "traits": { + "smithy.api#documentation": "

\n Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.\n

" + } + }, + "DataSharingPreferenceForUpdate": { + "target": "com.amazonaws.rekognition#StreamProcessorDataSharingPreference", + "traits": { + "smithy.api#documentation": "

\n Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.\n Note that if you opt out at the account level this setting is ignored on individual streams.\n

" + } + }, + "ParametersToDelete": { + "target": "com.amazonaws.rekognition#StreamProcessorParametersToDelete", + "traits": { + "smithy.api#documentation": "

\n A list of parameters you want to delete from the stream processor.\n

" + } + } + } + }, + "com.amazonaws.rekognition#UpdateStreamProcessorResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.rekognition#Url": { "type": "string" }, diff --git a/aws/sdk/aws-models/sagemaker.json b/aws/sdk/aws-models/sagemaker.json index fae06a2008..9c07492f05 100644 --- a/aws/sdk/aws-models/sagemaker.json +++ b/aws/sdk/aws-models/sagemaker.json @@ -240,7 +240,7 @@ "target": "com.amazonaws.sagemaker#AddTagsOutput" }, "traits": { - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services\n Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.

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

Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.

\n

Each tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services\n Tagging Strategies.

\n \n

Tags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n

\n \n \n

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.

\n " } }, "com.amazonaws.sagemaker#AddTagsInput": { @@ -268,7 +268,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "

A list of tags associated with the Amazon SageMaker resource.

" + "smithy.api#documentation": "

A list of tags associated with the SageMaker resource.

" } } } @@ -454,7 +454,7 @@ "TrainingImage": { "target": "com.amazonaws.sagemaker#AlgorithmImage", "traits": { - "smithy.api#documentation": "

The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

" + "smithy.api#documentation": "

The registry path of the Docker image\n that contains the training algorithm.\n For information about docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

" } }, "AlgorithmName": { @@ -472,18 +472,18 @@ "MetricDefinitions": { "target": "com.amazonaws.sagemaker#MetricDefinitionList", "traits": { - "smithy.api#documentation": "

A list of metric definition objects. Each object specifies the metric name and regular\n expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

" + "smithy.api#documentation": "

A list of metric definition objects. Each object specifies the metric name and regular\n expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

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

To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:

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

To generate and save time-series metrics during training, set to true.\n The default is false and time-series metrics aren't generated except in the\n following cases:

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

Specifies the training algorithm to use in a CreateTrainingJob\n request.

\n

For more information about algorithms provided by Amazon SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with Amazon\n SageMaker.

" + "smithy.api#documentation": "

Specifies the training algorithm to use in a CreateTrainingJob\n request.

\n

For more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with Amazon\n SageMaker.

" } }, "com.amazonaws.sagemaker#AlgorithmStatus": { @@ -628,19 +628,19 @@ "TrainingJobDefinition": { "target": "com.amazonaws.sagemaker#TrainingJobDefinition", "traits": { - "smithy.api#documentation": "

The TrainingJobDefinition object that describes the training job that\n Amazon SageMaker runs to validate your algorithm.

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

The TrainingJobDefinition object that describes the training job that\n SageMaker runs to validate your algorithm.

", "smithy.api#required": {} } }, "TransformJobDefinition": { "target": "com.amazonaws.sagemaker#TransformJobDefinition", "traits": { - "smithy.api#documentation": "

The TransformJobDefinition object that describes the transform job that\n Amazon SageMaker runs to validate your algorithm.

" + "smithy.api#documentation": "

The TransformJobDefinition object that describes the transform job that\n SageMaker runs to validate your algorithm.

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

Defines a training job and a batch transform job that Amazon SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.

" + "smithy.api#documentation": "

Defines a training job and a batch transform job that SageMaker runs to validate your\n algorithm.

\n

The data provided in the validation profile is made available to your buyers on Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#AlgorithmValidationProfiles": { @@ -661,20 +661,20 @@ "ValidationRole": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM roles that Amazon SageMaker uses to run the training jobs.

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

The IAM roles that SageMaker uses to run the training jobs.

", "smithy.api#required": {} } }, "ValidationProfiles": { "target": "com.amazonaws.sagemaker#AlgorithmValidationProfiles", "traits": { - "smithy.api#documentation": "

An array of AlgorithmValidationProfile objects, each of which specifies a\n training job and batch transform job that Amazon SageMaker runs to validate your algorithm.

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

An array of AlgorithmValidationProfile objects, each of which specifies a\n training job and batch transform job that SageMaker runs to validate your algorithm.

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

Specifies configurations for one or more training jobs that Amazon SageMaker runs to test the\n algorithm.

" + "smithy.api#documentation": "

Specifies configurations for one or more training jobs that SageMaker runs to test the\n algorithm.

" } }, "com.amazonaws.sagemaker#AnnotationConsolidationConfig": { @@ -1506,12 +1506,12 @@ "MaxConcurrentInvocationsPerInstance": { "target": "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance", "traits": { - "smithy.api#documentation": "

The maximum number of concurrent requests sent by the SageMaker client to the \n model container. If no value is provided, Amazon SageMaker will choose an optimal value for you.

" + "smithy.api#documentation": "

The maximum number of concurrent requests sent by the SageMaker client to the \n model container. If no value is provided, SageMaker chooses an optimal value.

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

Configures the behavior of the client used by Amazon SageMaker to interact with the \n model container during asynchronous inference.

" + "smithy.api#documentation": "

Configures the behavior of the client used by SageMaker to interact with the \n model container during asynchronous inference.

" } }, "com.amazonaws.sagemaker#AsyncInferenceConfig": { @@ -1520,7 +1520,7 @@ "ClientConfig": { "target": "com.amazonaws.sagemaker#AsyncInferenceClientConfig", "traits": { - "smithy.api#documentation": "

Configures the behavior of the client used by Amazon SageMaker to interact \n with the model container during asynchronous inference.

" + "smithy.api#documentation": "

Configures the behavior of the client used by SageMaker to interact \n with the model container during asynchronous inference.

" } }, "OutputConfig": { @@ -1561,7 +1561,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that\n Amazon SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

\n

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that\n SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

\n

" } }, "S3OutputPath": { @@ -1903,12 +1903,33 @@ "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.

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

" + } + }, + "ChannelType": { + "target": "com.amazonaws.sagemaker#AutoMLChannelType", + "traits": { + "smithy.api#documentation": "

The channel type (optional) is an enum string. The default value is\n training. Channels for training and validation must share the same\n ContentType and TargetAttributeName.

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

A channel is a named input source that training algorithms can consume. For more\n information, see .

" + "smithy.api#documentation": "

A channel is a named input source that training algorithms can consume. The\n validation dataset size is limited to less than 2 GB. The training dataset size must be\n less than 100 GB. For more information, see .

\n \n

A validation dataset must contain the same headers as the training dataset.

\n \n

" + } + }, + "com.amazonaws.sagemaker#AutoMLChannelType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "training", + "name": "TRAINING" + }, + { + "value": "validation", + "name": "VALIDATION" + } + ] } }, "com.amazonaws.sagemaker#AutoMLContainerDefinition": { @@ -1966,6 +1987,20 @@ "smithy.api#documentation": "

The data source for the Autopilot job.

" } }, + "com.amazonaws.sagemaker#AutoMLDataSplitConfig": { + "type": "structure", + "members": { + "ValidationFraction": { + "target": "com.amazonaws.sagemaker#ValidationFraction", + "traits": { + "smithy.api#documentation": "

The validation fraction (optional) is a float that specifies the portion of the training\n dataset to be used for validation. The default value is 0.2, and values can range from 0 to\n 1. We recommend setting this value to be less than 0.5.

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

This structure specifies how to split the data into train and test datasets. The\n validation and training datasets must contain the same headers. The validation dataset must\n be less than 2 GB in size.

" + } + }, "com.amazonaws.sagemaker#AutoMLFailureReason": { "type": "string", "traits": { @@ -2057,6 +2092,12 @@ "traits": { "smithy.api#documentation": "

The security configuration for traffic encryption or Amazon VPC settings.

" } + }, + "DataSplitConfig": { + "target": "com.amazonaws.sagemaker#AutoMLDataSplitConfig", + "traits": { + "smithy.api#documentation": "

The configuration for splitting the input training dataset.

\n

Type: AutoMLDataSplitConfig

" + } } }, "traits": { @@ -2702,7 +2743,7 @@ "MaximumExecutionTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", "traits": { - "smithy.api#documentation": "

Maximum execution timeout for the deployment. Note that the timeout value should be larger\n than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

" + "smithy.api#documentation": "

Maximum execution timeout for the deployment. Note that the timeout value should be larger\n than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

" } } }, @@ -2811,7 +2852,7 @@ "ModelInsights": { "target": "com.amazonaws.sagemaker#ModelInsightsLocation", "traits": { - "smithy.api#documentation": "

The Amazon S3 prefix to the model insight artifacts generated for the AutoML\n candidate.

" + "smithy.api#documentation": "

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

" } } }, @@ -2952,7 +2993,7 @@ "Type": { "target": "com.amazonaws.sagemaker#CapacitySizeType", "traits": { - "smithy.api#documentation": "

Specifies the endpoint capacity type.

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

Specifies the endpoint capacity type.

\n ", "smithy.api#required": {} } }, @@ -3218,13 +3259,13 @@ "RecordWrapperType": { "target": "com.amazonaws.sagemaker#RecordWrapper", "traits": { - "smithy.api#documentation": "

\n

Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.

\n

In File mode, leave this field unset or set it to None.

" + "smithy.api#documentation": "

\n

Specify RecordIO as the value when input data is in raw format but the training\n algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3\n object in a RecordIO record. If the input data is already in RecordIO format, you don't\n need to set this attribute. For more information, see Create\n a Dataset Using RecordIO.

\n

In File mode, leave this field unset or set it to None.

" } }, "InputMode": { "target": "com.amazonaws.sagemaker#TrainingInputMode", "traits": { - "smithy.api#documentation": "

(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, Amazon SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification\n request when you have a channel that needs a different input mode from the training\n job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML\n storage volume, and mount the directory to a Docker volume, use File input\n mode. To stream data directly from Amazon S3 to the container, choose Pipe input\n mode.

\n

To use a model for incremental training, choose File input model.

" + "smithy.api#documentation": "

(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification\n request when you have a channel that needs a different input mode from the training\n job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML\n storage volume, and mount the directory to a Docker volume, use File input\n mode. To stream data directly from Amazon S3 to the container, choose Pipe input\n mode.

\n

To use a model for incremental training, choose File input model.

" } }, "ShuffleConfig": { @@ -3313,7 +3354,7 @@ "S3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.

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

Identifies the S3 path where you want SageMaker to store checkpoints. For example,\n s3://bucket-name/key-name-prefix.

", "smithy.api#required": {} } }, @@ -3386,18 +3427,18 @@ "SkipCheck": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.

" + "smithy.api#documentation": "

This flag indicates if the drift check against the previous baseline will be skipped or not. \n If it is set to False, the previous baseline of the configured check type must be available.

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

This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints property.

" + "smithy.api#documentation": "

This flag indicates if a newly calculated baseline can be accessed through step properties \n BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. \n If it is set to False, the previous baseline of the configured check type must also be available. \n These can be accessed through the BaselineUsedForDriftCheckConstraints property.

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

The container for the metadata for the ClarifyCheck step. For more information, \n see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.\n

" + "smithy.api#documentation": "

The container for the metadata for the ClarifyCheck step. For more information, \n see the topic on ClarifyCheck step in the Amazon SageMaker Developer Guide.\n

" } }, "com.amazonaws.sagemaker#ClientId": { @@ -3932,7 +3973,7 @@ "Image": { "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { - "smithy.api#documentation": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker\n

" + "smithy.api#documentation": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker\n

" } }, "ImageConfig": { @@ -3950,7 +3991,7 @@ "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, Amazon SageMaker uses Amazon Web Services Security Token Service to\n download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your\n IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you\n need to reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

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

The S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3\n path is required for SageMaker built-in algorithms, but not if you use your own algorithms.\n For more information on built-in algorithms, see Common\n Parameters.

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model or endpoint you are creating.

\n \n

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to\n download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your\n IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you\n need to reactivate Amazon Web Services STS for that region. For more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User\n Guide.

\n \n

If you use a built-in algorithm to create a model, SageMaker requires that you provide\n a S3 path to the model artifacts in ModelDataUrl.

\n " } }, "Environment": { @@ -4218,7 +4259,7 @@ "ScalingType": { "target": "com.amazonaws.sagemaker#HyperParameterScalingType", "traits": { - "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

Amazon SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
ReverseLogarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.

\n

Reverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.

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

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
ReverseLogarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a reverse logarithmic scale.

\n

Reverse logarithmic scaling works only for ranges that are entirely within\n the range 0<=x<1.0.

\n
\n
" } } }, @@ -4350,7 +4391,7 @@ "target": "com.amazonaws.sagemaker#CreateAlgorithmOutput" }, "traits": { - "smithy.api#documentation": "

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the Amazon Web Services\n Marketplace.

" + "smithy.api#documentation": "

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#CreateAlgorithmInput": { @@ -4385,7 +4426,7 @@ "ValidationSpecification": { "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", "traits": { - "smithy.api#documentation": "

Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the\n algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker\n runs to test the algorithm's inference code.

" + "smithy.api#documentation": "

Specifies configurations for one or more training jobs and that SageMaker runs to test the\n algorithm's training code and, optionally, one or more batch transform jobs that SageMaker\n runs to test the algorithm's inference code.

" } }, "CertifyForMarketplace": { @@ -4720,7 +4761,7 @@ "target": "com.amazonaws.sagemaker#CreateCodeRepositoryOutput" }, "traits": { - "smithy.api#documentation": "

Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the\n repository with notebook instances so that you can use Git source control for the\n notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can\n be associated with more than one notebook instance, and it persists independently from\n the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in Amazon Web Services CodeCommit or in any\n other Git repository.

" + "smithy.api#documentation": "

Creates a Git repository as a resource in your SageMaker account. You can associate the\n repository with notebook instances so that you can use Git source control for the\n notebooks you create. The Git repository is a resource in your SageMaker account, so it can\n be associated with more than one notebook instance, and it persists independently from\n the lifecycle of any notebook instances it is associated with.

\n

The repository can be hosted either in Amazon Web Services CodeCommit or in any\n other Git repository.

" } }, "com.amazonaws.sagemaker#CreateCodeRepositoryInput": { @@ -5024,6 +5065,9 @@ "input": { "target": "com.amazonaws.sagemaker#CreateDeviceFleetRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceInUse" @@ -5200,6 +5244,9 @@ "input": { "target": "com.amazonaws.sagemaker#CreateEdgePackagingJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" @@ -5282,7 +5329,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using Amazon SageMaker hosting services.

\n

For an example that calls this method when deploying a model to Amazon SageMaker hosting services,\n see the Create Endpoint example notebook.\n

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

\n

When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n \n

When Amazon SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. Amazon SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n Amazon SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you\n provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously\n deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For\n more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.

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

Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.

\n

Use this API to deploy models using SageMaker hosting services.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see the Create Endpoint example notebook.\n

\n \n

You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n \n

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

\n

When it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.

\n \n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n \n

When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.

\n

If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you\n provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously\n deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For\n more information, see Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User\n Guide.

\n \n

To add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.

\n \n\n " } }, "com.amazonaws.sagemaker#CreateEndpointConfig": { @@ -5299,7 +5346,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want Amazon SageMaker to\n provision. Then you call the CreateEndpoint API.

\n \n

Use this API if you want to use Amazon SageMaker hosting services to deploy models into\n production.

\n \n

In the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want Amazon SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.

\n

If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

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

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint API.

\n \n

Use this API if you want to use SageMaker hosting services to deploy models into\n production.

\n \n

In the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.

\n

If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.

\n \n

When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

\n " } }, "com.amazonaws.sagemaker#CreateEndpointConfigInput": { @@ -5331,7 +5378,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n \n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

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

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n \n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " } }, "AsyncInferenceConfig": { @@ -5726,7 +5773,7 @@ "TrainingJobDefinition": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", "traits": { - "smithy.api#documentation": "

The HyperParameterTrainingJobDefinition object that describes the\n training jobs that this tuning job launches,\n including\n static hyperparameters, input data configuration, output data configuration, resource\n configuration, and stopping condition.

" + "smithy.api#documentation": "

The HyperParameterTrainingJobDefinition object that describes the\n training jobs that this tuning job launches, including static hyperparameters, input\n data configuration, output data configuration, resource configuration, and stopping\n condition.

" } }, "TrainingJobDefinitions": { @@ -5755,7 +5802,7 @@ "HyperParameterTuningJobArn": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a\n hyperparameter tuning job when you create it.

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

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a\n hyperparameter tuning job when you create it.

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

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image\n version represents a container image stored in Amazon Container Registry (ECR). For more information, see\n Bring your own SageMaker image.

" + "smithy.api#documentation": "

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image\n version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see\n Bring your own SageMaker image.

" } }, "com.amazonaws.sagemaker#CreateImageRequest": { @@ -5849,7 +5896,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a version of the SageMaker image specified by ImageName. The version\n represents the Amazon Container Registry (ECR) container image specified by BaseImage.

" + "smithy.api#documentation": "

Creates a version of the SageMaker image specified by ImageName. The version\n represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.

" } }, "com.amazonaws.sagemaker#CreateImageVersionRequest": { @@ -5858,7 +5905,7 @@ "BaseImage": { "target": "com.amazonaws.sagemaker#ImageBaseImage", "traits": { - "smithy.api#documentation": "

The registry path of the container image to use as the starting point for this\n version. The path is an Amazon Container Registry (ECR) URI in the following format:

\n

\n .dkr.ecr..amazonaws.com/\n

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

The registry path of the container image to use as the starting point for this\n version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

\n

\n .dkr.ecr..amazonaws.com/\n

", "smithy.api#required": {} } }, @@ -5953,6 +6000,12 @@ "smithy.api#documentation": "

A set of conditions for stopping a recommendation job. If any of \n the conditions are met, the job is automatically stopped.

" } }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobOutputConfig", + "traits": { + "smithy.api#documentation": "

Provides information about the output artifacts and the KMS key \n to use for Amazon S3 server-side encryption.

" + } + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -6090,7 +6143,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

For an example that calls this method when deploying a model to Amazon SageMaker hosting services,\n see Deploy the\n Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto\n 3)).\n

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the CreateModel request, you must define a container with the\n PrimaryContainer parameter.

\n

In the request, you also provide an IAM role that Amazon SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources,\n you grant necessary permissions via this role.

" + "smithy.api#documentation": "

Creates a model in SageMaker. In the request, you name the model and describe a primary\n container. For the primary container, you specify the Docker image that\n contains inference code, artifacts (from prior training), and a custom environment map\n that the inference code uses when you deploy the model for predictions.

\n

Use this API to create a model if you want to use SageMaker hosting services or run a batch\n transform job.

\n

To host your model, you create an endpoint configuration with the\n CreateEndpointConfig API, and then create an endpoint with the\n CreateEndpoint API. SageMaker then deploys all of the containers that you\n defined for the model in the hosting environment.

\n

For an example that calls this method when deploying a model to SageMaker hosting services,\n see Deploy the\n Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto\n 3)).\n

\n

To run a batch transform using your model, you start a job with the\n CreateTransformJob API. SageMaker uses your model and your dataset to get\n inferences which are then saved to a specified S3 location.

\n

In the request, you also provide an IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute hosting instances or for batch\n transform jobs. In addition, you also use the IAM role to manage permissions the\n inference code needs. For example, if the inference code access any other Amazon Web Services resources,\n you grant necessary permissions via this role.

" } }, "com.amazonaws.sagemaker#CreateModelBiasJobDefinition": { @@ -6320,7 +6373,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see Amazon SageMaker\n Roles.

\n \n

To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

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

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model\n artifacts and docker image for deployment on ML compute instances or for batch transform\n jobs. Deploying on ML compute instances is part of model hosting. For more information,\n see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", "smithy.api#required": {} } }, @@ -6350,7 +6403,7 @@ "ModelArn": { "target": "com.amazonaws.sagemaker#ModelArn", "traits": { - "smithy.api#documentation": "

The ARN of the model created in Amazon SageMaker.

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

The ARN of the model created in SageMaker.

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

Creates a model package that you can use to create Amazon SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in Amazon SageMaker.

\n

To create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.

\n \n

There are two types of model packages:

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

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services\n Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to\n model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

\n

To create a model package by specifying a Docker container that contains your\n inference code and the Amazon S3 location of your model artifacts, provide values for\n InferenceSpecification. To create a model from an algorithm resource\n that you created or subscribed to in Amazon Web Services Marketplace, provide a value for\n SourceAlgorithmSpecification.

\n \n

There are two types of model packages:

\n \n " } }, "com.amazonaws.sagemaker#CreateModelPackageGroup": { @@ -6459,7 +6512,7 @@ "ValidationSpecification": { "target": "com.amazonaws.sagemaker#ModelPackageValidationSpecification", "traits": { - "smithy.api#documentation": "

Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the\n model package.

" + "smithy.api#documentation": "

Specifies configurations for one or more transform jobs that SageMaker runs to test the\n model package.

" } }, "SourceAlgorithmSpecification": { @@ -6511,7 +6564,7 @@ "DriftCheckBaselines": { "target": "com.amazonaws.sagemaker#DriftCheckBaselines", "traits": { - "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model package.\n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n

" + "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model package.\n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n

" } }, "Domain": { @@ -6721,7 +6774,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML)\n compute instance running on a Jupyter notebook.

\n

In a CreateNotebookInstance request, specify the type of ML compute\n instance that you want to run. Amazon SageMaker launches the instance, installs common libraries\n that you can use to explore datasets for model training, and attaches an ML storage\n volume to the notebook instance.

\n

Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to\n use Amazon SageMaker with a specific algorithm or with a machine learning framework.

\n

After receiving the request, Amazon SageMaker does the following:

\n
    \n
  1. \n

    Creates a network interface in the Amazon SageMaker VPC.

    \n
    2. \n
  2. \n

    (Option) If you specified SubnetId, Amazon SageMaker creates a network\n interface in your own VPC, which is inferred from the subnet ID that you provide\n in the input. When creating this network interface, Amazon SageMaker attaches the security\n group that you specified in the request to the network interface that it creates\n in your VPC.

    \n \n
    3. \n
  3. \n

    Launches an EC2 instance of the type specified in the request in the Amazon SageMaker\n VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies both\n network interfaces when launching this instance. This enables inbound traffic\n from your own VPC to the notebook instance, assuming that the security groups\n allow it.

    \n
    4. \n
\n \n

After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN).\n You can't change the name of a notebook instance after you create it.

\n

After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and\n work in Jupyter notebooks. For example, you can write code to explore a dataset that you\n can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and\n validate hosted models.

\n

For more information, see How It Works.

" + "smithy.api#documentation": "

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML)\n compute instance running on a Jupyter notebook.

\n

In a CreateNotebookInstance request, specify the type of ML compute\n instance that you want to run. SageMaker launches the instance, installs common libraries\n that you can use to explore datasets for model training, and attaches an ML storage\n volume to the notebook instance.

\n

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to\n use SageMaker with a specific algorithm or with a machine learning framework.

\n

After receiving the request, SageMaker does the following:

\n
    \n
  1. \n

    Creates a network interface in the SageMaker VPC.

    \n
    2. \n
  2. \n

    (Option) If you specified SubnetId, SageMaker creates a network\n interface in your own VPC, which is inferred from the subnet ID that you provide\n in the input. When creating this network interface, SageMaker attaches the security\n group that you specified in the request to the network interface that it creates\n in your VPC.

    \n \n
    3. \n
  3. \n

    Launches an EC2 instance of the type specified in the request in the SageMaker\n VPC. If you specified SubnetId of your VPC, SageMaker specifies both\n network interfaces when launching this instance. This enables inbound traffic\n from your own VPC to the notebook instance, assuming that the security groups\n allow it.

    \n
    4. \n
\n \n

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN).\n You can't change the name of a notebook instance after you create it.

\n

After SageMaker creates the notebook instance, you can connect to the Jupyter server and\n work in Jupyter notebooks. For example, you can write code to explore a dataset that you\n can use for model training, train a model, host models by creating SageMaker endpoints, and\n validate hosted models.

\n

For more information, see How It Works.

" } }, "com.amazonaws.sagemaker#CreateNotebookInstanceInput": { @@ -6756,14 +6809,14 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

When you send any requests to Amazon Web Services resources from the notebook instance, Amazon SageMaker\n assumes this role to perform tasks on your behalf. You must grant this role necessary\n permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service\n principal (sagemaker.amazonaws.com) permissions to assume this role. For more\n information, see Amazon SageMaker Roles.

\n \n

To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

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

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker\n assumes this role to perform tasks on your behalf. You must grant this role necessary\n permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service\n principal (sagemaker.amazonaws.com) permissions to assume this role. For more\n information, see SageMaker Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to your notebook instance. The KMS key you provide must be\n enabled. For information, see Enabling and Disabling\n Keys in the Amazon Web Services Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on\n the storage volume attached to your notebook instance. The KMS key you provide must be\n enabled. For information, see Enabling and Disabling\n Keys in the Amazon Web Services Key Management Service Developer Guide.

" } }, "Tags": { @@ -6781,7 +6834,7 @@ "DirectInternetAccess": { "target": "com.amazonaws.sagemaker#DirectInternetAccess", "traits": { - "smithy.api#documentation": "

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this\n to Disabled this notebook instance is able to access resources only in your\n VPC, and is not be able to connect to Amazon SageMaker training and endpoint services unless you\n configure a NAT Gateway in your VPC.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.

" + "smithy.api#documentation": "

Sets whether SageMaker provides internet access to the notebook instance. If you set this\n to Disabled this notebook instance is able to access resources only in your\n VPC, and is not be able to connect to SageMaker training and endpoint services unless you\n configure a NAT Gateway in your VPC.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value\n of this parameter to Disabled only if you set a value for the\n SubnetId parameter.

" } }, "VolumeSizeInGB": { @@ -6799,13 +6852,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

A Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with SageMaker\n Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "RootAccess": { @@ -7047,7 +7100,7 @@ "target": "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlOutput" }, "traits": { - "smithy.api#documentation": "

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the Amazon SageMaker console, when you choose Open next to a notebook\n instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.

\n

The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n Amazon Web Services console sign-in page.

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

Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker console, when you choose Open next to a notebook\n instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.

\n

The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.

\n

You can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

\n \n

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n Amazon Web Services console sign-in page.

\n " } }, "com.amazonaws.sagemaker#CreatePresignedNotebookInstanceUrlInput": { @@ -7333,7 +7386,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a model training job. After training completes, Amazon SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.

\n

If you choose to host your model using Amazon SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than Amazon SageMaker, provided that you know how to use them for\n inference. \n

\n

In the request body, you provide the following:

\n \n

For more information about Amazon SageMaker, see How It Works.

" + "smithy.api#documentation": "

Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.

\n

If you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n

\n

In the request body, you provide the following:

\n \n

For more information about SageMaker, see How It Works.

" } }, "com.amazonaws.sagemaker#CreateTrainingJobRequest": { @@ -7349,40 +7402,40 @@ "HyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "

Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by Amazon SageMaker, see Algorithms.

\n

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.

" + "smithy.api#documentation": "

Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.

\n

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.

" } }, "AlgorithmSpecification": { "target": "com.amazonaws.sagemaker#AlgorithmSpecification", "traits": { - "smithy.api#documentation": "

The registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by Amazon SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with Amazon\n SageMaker.

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

The registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with Amazon\n SageMaker.

", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform\n tasks on your behalf.

\n

During model training, Amazon SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker\n Roles.

\n \n

To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

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

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform\n tasks on your behalf.

\n

During model training, SageMaker needs your permission to read input data from an S3\n bucket, download a Docker image that contains training code, write model artifacts to an\n S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant\n permissions for all of these tasks to an IAM role. For more information, see SageMaker\n Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n ", "smithy.api#required": {} } }, "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig\n describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files will be made available as input streams. They do not need to be\n downloaded.

" + "smithy.api#documentation": "

An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.

\n

Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.

\n

Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be\n downloaded.

" } }, "OutputDataConfig": { "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { - "smithy.api#documentation": "

Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker\n creates subfolders for the artifacts.

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

Specifies the path to the S3 location where you want to store model artifacts. SageMaker\n creates subfolders for the artifacts.

", "smithy.api#required": {} } }, "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "

The resources, including the ML compute instances and ML storage volumes, to use\n for model training.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.

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

The resources, including the ML compute instances and ML storage volumes, to use\n for model training.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use\n the ML storage volume to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.

", "smithy.api#required": {} } }, @@ -7395,7 +7448,7 @@ "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

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

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

", "smithy.api#required": {} } }, @@ -7408,7 +7461,7 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" + "smithy.api#documentation": "

Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n you enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" } }, "EnableInterContainerTrafficEncryption": { @@ -7534,7 +7587,7 @@ "MaxPayloadInMB": { "target": "com.amazonaws.sagemaker#MaxPayloadInMB", "traits": { - "smithy.api#documentation": "

The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n

\n

For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.

" + "smithy.api#documentation": "

The maximum allowed size of the payload, in MB. A payload is the\n data portion of a record (without metadata). The value in MaxPayloadInMB\n must be greater than, or equal to, the size of a single record. To estimate the size of\n a record in MB, divide the size of your dataset by the number of records. To ensure that\n the records fit within the maximum payload size, we recommend using a slightly larger\n value. The default value is 6 MB.\n

\n

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\n the MaxConcurrentTransforms parameter, the value of\n (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100\n MB.

\n

For cases where the payload might be arbitrarily large and is transmitted using HTTP\n chunked encoding, set the value to 0.\n This\n feature works only in supported algorithms. Currently, Amazon SageMaker built-in\n algorithms do not support HTTP chunked encoding.

" } }, "BatchStrategy": { @@ -8226,13 +8279,13 @@ "InputFilter": { "target": "com.amazonaws.sagemaker#JsonPath", "traits": { - "smithy.api#documentation": "

A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.

\n

Examples: \"$\", \"$[1:]\", \"$.features\"\n

" + "smithy.api#documentation": "

A JSONPath expression used to select a portion of the input data to pass to\n the algorithm. Use the InputFilter parameter to exclude fields, such as an\n ID column, from the input. If you want SageMaker to pass the entire input dataset to the\n algorithm, accept the default value $.

\n

Examples: \"$\", \"$[1:]\", \"$.features\"\n

" } }, "OutputFilter": { "target": "com.amazonaws.sagemaker#JsonPath", "traits": { - "smithy.api#documentation": "

A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.

\n

Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n

" + "smithy.api#documentation": "

A JSONPath expression used to select a portion of the joined dataset to save\n in the output file for a batch transform job. If you want SageMaker to store the entire input\n dataset in the output file, leave the default value, $. If you specify\n indexes that aren't within the dimension size of the joined dataset, you get an\n error.

\n

Examples: \"$\", \"$[0,5:]\",\n \"$['id','SageMakerOutput']\"\n

" } }, "JoinSource": { @@ -8597,6 +8650,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteAlgorithmInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Removes the specified algorithm from your account.

" } @@ -8618,6 +8674,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteAppRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceInUse" @@ -8635,6 +8694,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteAppImageConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -8792,6 +8854,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteCodeRepositoryInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes the specified Git repository from your account.

" } @@ -8853,6 +8918,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteDataQualityJobDefinitionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -8879,6 +8947,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteDeviceFleetRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceInUse" @@ -8905,6 +8976,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteDomainRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceInUse" @@ -8940,8 +9014,11 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteEndpointInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { - "smithy.api#documentation": "

Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the\n endpoint was created.

\n

Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.

" + "smithy.api#documentation": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the\n endpoint was created.

\n

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't\n need to use the RevokeGrant API call.

\n

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants.\n You might still see these resources in your account for a few minutes after deleting your endpoint.\n Do not delete or revoke the permissions for your\n \n ExecutionRoleArn\n ,\n otherwise SageMaker cannot delete these resources.

" } }, "com.amazonaws.sagemaker#DeleteEndpointConfig": { @@ -8949,6 +9026,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteEndpointConfigInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes an endpoint configuration. The DeleteEndpointConfig API\n deletes only the specified configuration. It does not delete endpoints created using the\n configuration.

\n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint operations\n are being performed on the endpoint. If you delete the EndpointConfig of an\n endpoint that is active or being created or updated you may lose visibility into the\n instance type the endpoint is using. The endpoint must be deleted in order to stop\n incurring charges.

" } @@ -9022,6 +9102,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteFeatureGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -9196,8 +9279,11 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteModelInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { - "smithy.api#documentation": "

Deletes a model. The DeleteModel API deletes only the model entry that\n was created in Amazon SageMaker when you called the CreateModel API. It does not\n delete model artifacts, inference code, or the IAM role that you specified when\n creating the model.

" + "smithy.api#documentation": "

Deletes a model. The DeleteModel API deletes only the model entry that\n was created in SageMaker when you called the CreateModel API. It does not\n delete model artifacts, inference code, or the IAM role that you specified when\n creating the model.

" } }, "com.amazonaws.sagemaker#DeleteModelBiasJobDefinition": { @@ -9205,6 +9291,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteModelBiasJobDefinitionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -9231,6 +9320,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteModelExplainabilityJobDefinitionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -9269,13 +9361,16 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteModelPackageInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ConflictException" } ], "traits": { - "smithy.api#documentation": "

Deletes a model package.

\n

A model package is used to create Amazon SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in Amazon SageMaker.

" + "smithy.api#documentation": "

Deletes a model package.

\n

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can\n subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

" } }, "com.amazonaws.sagemaker#DeleteModelPackageGroup": { @@ -9283,6 +9378,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ConflictException" @@ -9309,6 +9407,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteModelPackageGroupPolicyInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes a model group resource policy.

" } @@ -9331,7 +9432,7 @@ "ModelPackageName": { "target": "com.amazonaws.sagemaker#VersionedArnOrName", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the model package to delete.

\n

When you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

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

The name or Amazon Resource Name (ARN) of the model package to delete.

\n

When you specify a name, the name must have 1 to 63 characters. Valid\n characters are a-z, A-Z, 0-9, and - (hyphen).

", "smithy.api#required": {} } } @@ -9342,6 +9443,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteModelQualityJobDefinitionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -9368,6 +9472,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteMonitoringScheduleRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -9394,8 +9501,11 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { - "smithy.api#documentation": "

Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you\n must call the StopNotebookInstance API.

\n \n

When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes\n the ML compute instance, and deletes the ML storage volume and the network interface\n associated with the notebook instance.

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

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you\n must call the StopNotebookInstance API.

\n \n

When you delete a notebook instance, you lose all of your data. SageMaker removes\n the ML compute instance, and deletes the ML storage volume and the network interface\n associated with the notebook instance.

\n " } }, "com.amazonaws.sagemaker#DeleteNotebookInstanceInput": { @@ -9404,7 +9514,7 @@ "NotebookInstanceName": { "target": "com.amazonaws.sagemaker#NotebookInstanceName", "traits": { - "smithy.api#documentation": "

The name of the Amazon SageMaker notebook instance to delete.

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

The name of the SageMaker notebook instance to delete.

", "smithy.api#required": {} } } @@ -9415,6 +9525,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfigInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deletes a notebook instance lifecycle configuration.

" } @@ -9484,6 +9597,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteProjectInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ConflictException" @@ -9510,6 +9626,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceInUse" @@ -9543,7 +9662,7 @@ "target": "com.amazonaws.sagemaker#DeleteTagsOutput" }, "traits": { - "smithy.api#documentation": "

Deletes the specified tags from an Amazon SageMaker resource.

\n

To list a resource's tags, use the ListTags API.

\n \n

When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

\n \n \n

When you call this API to delete tags from a SageMaker Studio Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain\n or User Profile launched before you called this API.

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

Deletes the specified tags from an SageMaker resource.

\n

To list a resource's tags, use the ListTags API.

\n \n

When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.

\n \n \n

When you call this API to delete tags from a SageMaker Studio Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain\n or User Profile launched before you called this API.

\n " } }, "com.amazonaws.sagemaker#DeleteTagsInput": { @@ -9654,6 +9773,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeleteUserProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceInUse" @@ -9812,6 +9934,9 @@ "input": { "target": "com.amazonaws.sagemaker#DeregisterDevicesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

" } @@ -10008,7 +10133,7 @@ "ValidationSpecification": { "target": "com.amazonaws.sagemaker#AlgorithmValidationSpecification", "traits": { - "smithy.api#documentation": "

Details about configurations for one or more training jobs that Amazon SageMaker runs to test the\n algorithm.

" + "smithy.api#documentation": "

Details about configurations for one or more training jobs that SageMaker runs to test the\n algorithm.

" } }, "AlgorithmStatus": { @@ -11477,7 +11602,7 @@ "EndpointConfigName": { "target": "com.amazonaws.sagemaker#EndpointConfigName", "traits": { - "smithy.api#documentation": "

Name of the Amazon SageMaker endpoint configuration.

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

Name of the SageMaker endpoint configuration.

", "smithy.api#required": {} } }, @@ -12698,7 +12823,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf\n during data labeling.

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

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf\n during data labeling.

", "smithy.api#required": {} } }, @@ -13053,7 +13178,7 @@ "ModelName": { "target": "com.amazonaws.sagemaker#ModelName", "traits": { - "smithy.api#documentation": "

Name of the Amazon SageMaker model.

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

Name of the SageMaker model.

", "smithy.api#required": {} } }, @@ -13140,7 +13265,7 @@ "ModelPackageGroupName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "

The name of the model group to describe.

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

The name of gthe model group to describe.

", "smithy.api#required": {} } } @@ -13304,7 +13429,7 @@ "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

The last time the model package was modified.

" + "smithy.api#documentation": "

The last time that the model package was modified.

" } }, "LastModifiedBy": { @@ -13325,7 +13450,7 @@ "DriftCheckBaselines": { "target": "com.amazonaws.sagemaker#DriftCheckBaselines", "traits": { - "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model package. \n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n

" + "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model package. \n For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.\n

" } }, "Domain": { @@ -13734,7 +13859,7 @@ "NotebookInstanceName": { "target": "com.amazonaws.sagemaker#NotebookInstanceName", "traits": { - "smithy.api#documentation": "

The name of the Amazon SageMaker notebook instance.

" + "smithy.api#documentation": "

The name of the SageMaker notebook instance.

" } }, "NotebookInstanceStatus": { @@ -13782,13 +13907,13 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

" + "smithy.api#documentation": "

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage\n volume attached to the instance.

" } }, "NetworkInterfaceId": { "target": "com.amazonaws.sagemaker#NetworkInterfaceId", "traits": { - "smithy.api#documentation": "

The network interface IDs that Amazon SageMaker created at the time of creating the instance.\n

" + "smithy.api#documentation": "

The network interface IDs that SageMaker created at the time of creating the instance.\n

" } }, "LastModifiedTime": { @@ -13812,7 +13937,7 @@ "DirectInternetAccess": { "target": "com.amazonaws.sagemaker#DirectInternetAccess", "traits": { - "smithy.api#documentation": "

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this\n value is set to Disabled, the notebook instance does not have\n internet access, and cannot connect to Amazon SageMaker training and endpoint services.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default.

" + "smithy.api#documentation": "

Describes whether SageMaker provides internet access to the notebook instance. If this\n value is set to Disabled, the notebook instance does not have\n internet access, and cannot connect to SageMaker training and endpoint services.

\n

For more information, see Notebook Instances Are Internet-Enabled by Default.

" } }, "VolumeSizeInGB": { @@ -13830,13 +13955,13 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with SageMaker\n Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "RootAccess": { @@ -14616,7 +14741,7 @@ "LabelingJobArn": { "target": "com.amazonaws.sagemaker#LabelingJobArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the\n transform or training job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the\n transform or training job.

" } }, "AutoMLJobArn": { @@ -14635,14 +14760,14 @@ "TrainingJobStatus": { "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "

The status of the\n training\n job.

\n

Amazon SageMaker provides the following training job statuses:

\n \n

For\n more detailed information, see SecondaryStatus.

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

The status of the training job.

\n

SageMaker provides the following training job statuses:

\n \n

For more detailed information, see SecondaryStatus.

", "smithy.api#required": {} } }, "SecondaryStatus": { "target": "com.amazonaws.sagemaker#SecondaryStatus", "traits": { - "smithy.api#documentation": "

Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.

\n

Amazon SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Interrupted - The job stopped because the managed\n spot training instances were interrupted.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

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

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

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

Provides detailed information about the state of the training job. For detailed\n information on the secondary status of the training job, see StatusMessage\n under SecondaryStatusTransition.

\n

SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Interrupted - The job stopped because the managed\n spot training instances were interrupted.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n MaxWaitTimeExceeded - The job stopped because it\n exceeded the maximum allowed wait time.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

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

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

\n ", "smithy.api#required": {} } }, @@ -14680,7 +14805,7 @@ "OutputDataConfig": { "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The S3 path where model artifacts that you configured when creating the job are\n stored. Amazon SageMaker creates subfolders for model artifacts.

" + "smithy.api#documentation": "

The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.

" } }, "ResourceConfig": { @@ -14699,7 +14824,7 @@ "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

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

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

", "smithy.api#required": {} } }, @@ -14719,7 +14844,7 @@ "TrainingEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

" + "smithy.api#documentation": "

Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" } }, "LastModifiedTime": { @@ -14743,7 +14868,7 @@ "EnableNetworkIsolation": { "target": "com.amazonaws.sagemaker#Boolean", "traits": { - "smithy.api#documentation": "

If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" + "smithy.api#documentation": "

If you want to allow inbound or outbound network calls, except for calls between peers\n within a training cluster for distributed training, choose True. If you\n enable network isolation for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" } }, "EnableInterContainerTrafficEncryption": { @@ -14770,7 +14895,7 @@ "BillableTimeInSeconds": { "target": "com.amazonaws.sagemaker#BillableTimeInSeconds", "traits": { - "smithy.api#documentation": "

The billable time in seconds. Billable time refers to the absolute wall-clock\n time.

\n

Multiply BillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker will bill you if you run distributed training. The formula is as follows:\n BillableTimeInSeconds * InstanceCount .

\n

You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.

" + "smithy.api#documentation": "

The billable time in seconds. Billable time refers to the absolute wall-clock\n time.

\n

Multiply BillableTimeInSeconds by the number of instances\n (InstanceCount) in your training cluster to get the total compute time\n SageMaker bills you if you run distributed training. The formula is as follows:\n BillableTimeInSeconds * InstanceCount .

\n

You can calculate the savings from using managed spot training using the formula\n (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example,\n if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is\n 500, the savings is 80%.

" } }, "DebugHookConfig": { @@ -15448,7 +15573,7 @@ "VariantName": { "target": "com.amazonaws.sagemaker#VariantName", "traits": { - "smithy.api#documentation": "

The name of the\n variant\n to update.

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

The name of the variant to update.

", "smithy.api#required": {} } }, @@ -16072,30 +16197,30 @@ "Bias": { "target": "com.amazonaws.sagemaker#DriftCheckBias", "traits": { - "smithy.api#documentation": "

Represents the drift check bias baselines that can be used when the model monitor is set using the model \n package.

" + "smithy.api#documentation": "

Represents the drift check bias baselines that can be used when the model monitor is set using the model \n package.

" } }, "Explainability": { "target": "com.amazonaws.sagemaker#DriftCheckExplainability", "traits": { - "smithy.api#documentation": "

Represents the drift check explainability baselines that can be used when the model monitor is set using \n the model package.

" + "smithy.api#documentation": "

Represents the drift check explainability baselines that can be used when the model monitor is set using \n the model package.

" } }, "ModelQuality": { "target": "com.amazonaws.sagemaker#DriftCheckModelQuality", "traits": { - "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.

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

" } }, "ModelDataQuality": { "target": "com.amazonaws.sagemaker#DriftCheckModelDataQuality", "traits": { - "smithy.api#documentation": "

Represents the drift check model data quality baselines that can be used when the model monitor is set \n using the model package.

" + "smithy.api#documentation": "

Represents the drift check model data quality baselines that can be used when the model monitor is set \n using the model package.

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

Represents the drift check baselines that can be used when the model monitor is set using the model \n package.

" + "smithy.api#documentation": "

Represents the drift check baselines that can be used when the model monitor is set using the model \n package.

" } }, "com.amazonaws.sagemaker#DriftCheckBias": { @@ -16115,7 +16240,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the drift check bias baselines that can be used when the model monitor is set using the \n model package.

" + "smithy.api#documentation": "

Represents the drift check bias baselines that can be used when the model monitor is set using the \n model package.

" } }, "com.amazonaws.sagemaker#DriftCheckExplainability": { @@ -16132,7 +16257,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the drift check explainability baselines that can be used when the model monitor is set \n using the model package.

" + "smithy.api#documentation": "

Represents the drift check explainability baselines that can be used when the model monitor is set \n using the model package.

" } }, "com.amazonaws.sagemaker#DriftCheckModelDataQuality": { @@ -16146,7 +16271,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the drift check data quality baselines that can be used when the model monitor is set using \n the model package.

" + "smithy.api#documentation": "

Represents the drift check data quality baselines that can be used when the model monitor is set using \n the model package.

" } }, "com.amazonaws.sagemaker#DriftCheckModelQuality": { @@ -16160,7 +16285,7 @@ } }, "traits": { - "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.

" + "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": { @@ -18833,7 +18958,7 @@ "TrainingImage": { "target": "com.amazonaws.sagemaker#AlgorithmImage", "traits": { - "smithy.api#documentation": "

The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

" + "smithy.api#documentation": "

The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

" } }, "TrainingInputMode": { @@ -19013,21 +19138,21 @@ "ResourceConfig": { "target": "com.amazonaws.sagemaker#ResourceConfig", "traits": { - "smithy.api#documentation": "

The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.

\n

Storage\n volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want Amazon SageMaker to use the storage volume\n to store the training data, choose File as the\n TrainingInputMode in the algorithm specification. For distributed\n training algorithms, specify an instance count greater than 1.

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

The resources,\n including\n the compute instances and storage volumes, to use for the training\n jobs that the tuning job launches.

\n

Storage volumes store model artifacts and\n incremental\n states. Training algorithms might also use storage volumes for\n scratch\n space. If you want SageMaker to use the storage volume to store the\n training data, choose File as the TrainingInputMode in the\n algorithm specification. For distributed training algorithms, specify an instance count\n greater than 1.

", "smithy.api#required": {} } }, "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model hyperparameter training job can run. It also\n specifies how long a managed spot training job has to complete. When the job reaches the\n time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

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

Specifies a limit to how long a model hyperparameter training job can run. It also\n specifies how long a managed spot training job has to complete. When the job reaches the\n time limit, SageMaker ends the training job. Use this API to cap model training costs.

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

Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" + "smithy.api#documentation": "

Isolates the training container. No inbound or outbound network calls can be made,\n except for calls between peers within a training cluster for distributed training. If\n network isolation is used for training jobs that are configured to use a VPC, SageMaker\n downloads and uploads customer data and model artifacts through the specified VPC, but\n the training container does not have network access.

" } }, "EnableInterContainerTrafficEncryption": { @@ -19103,7 +19228,7 @@ "TrainingJobArn": { "target": "com.amazonaws.sagemaker#TrainingJobArn", "traits": { - "smithy.api#documentation": "

The\n Amazon\n Resource Name (ARN) of the training job.

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

The Amazon Resource Name (ARN) of the training job.

", "smithy.api#required": {} } }, @@ -19129,7 +19254,7 @@ "TrainingEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

Specifies the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

" + "smithy.api#documentation": "

Specifies the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" } }, "TrainingJobStatus": { @@ -19166,7 +19291,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies\n summary information about a training job.

" + "smithy.api#documentation": "

The container for the summary information about a training job.

" } }, "com.amazonaws.sagemaker#HyperParameterTuningJobArn": { @@ -19211,7 +19336,7 @@ "TrainingJobEarlyStoppingType": { "target": "com.amazonaws.sagemaker#TrainingJobEarlyStoppingType", "traits": { - "smithy.api#documentation": "

Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. This can be one of the following values (the default value is\n OFF):

\n
\n
OFF
\n
\n

Training jobs launched by the hyperparameter tuning job do not use early\n stopping.

\n
\n
AUTO
\n
\n

Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.

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

Specifies whether to use early stopping for training jobs launched by the\n hyperparameter tuning job. This can be one of the following values (the default value is\n OFF):

\n
\n
OFF
\n
\n

Training jobs launched by the hyperparameter tuning job do not use early\n stopping.

\n
\n
AUTO
\n
\n

SageMaker stops training jobs launched by the hyperparameter tuning job when\n they are unlikely to perform better than previously completed training jobs.\n For more information, see Stop Training Jobs Early.

\n
\n
" } }, "TuningJobCompletionCriteria": { @@ -20519,7 +20644,7 @@ "ScalingType": { "target": "com.amazonaws.sagemaker#HyperParameterScalingType", "traits": { - "smithy.api#documentation": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

Amazon SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

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

The scale that hyperparameter tuning uses to search the hyperparameter range. For\n information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

\n
\n
Auto
\n
\n

SageMaker hyperparameter tuning chooses the best scale for the\n hyperparameter.

\n
\n
Linear
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a linear scale.

\n
\n
Logarithmic
\n
\n

Hyperparameter tuning searches the values in the hyperparameter range by\n using a logarithmic scale.

\n

Logarithmic scaling works only for ranges that have only values greater\n than 0.

\n
\n
" } } }, @@ -20670,13 +20795,13 @@ "DefaultResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.

" + "smithy.api#documentation": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

" } }, "LifecycleConfigArns": { "target": "com.amazonaws.sagemaker#LifecycleConfigArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

\n \n

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

\n " } } }, @@ -20699,7 +20824,7 @@ "DefaultResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

" + "smithy.api#documentation": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

\n \n

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default\n instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation\n and the instance type parameter value is not passed.

\n " } }, "CustomImages": { @@ -20711,7 +20836,7 @@ "LifecycleConfigArns": { "target": "com.amazonaws.sagemaker#LifecycleConfigArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

\n \n

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

\n " } } }, @@ -20937,7 +21062,7 @@ "ContentClassifiers": { "target": "com.amazonaws.sagemaker#ContentClassifiers", "traits": { - "smithy.api#documentation": "

Declares that your content is free of personally identifiable information or adult\n content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task\n based on this information.

" + "smithy.api#documentation": "

Declares that your content is free of personally identifiable information or adult\n content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task\n based on this information.

" } } }, @@ -21062,7 +21187,7 @@ "FinalActiveLearningModelArn": { "target": "com.amazonaws.sagemaker#ModelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of\n automated data labeling.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of\n automated data labeling.

" } } }, @@ -21445,6 +21570,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ActionSummaries", "pageSize": "MaxResults" } } @@ -21532,6 +21658,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "AlgorithmSummaryList", "pageSize": "MaxResults" } } @@ -21596,7 +21723,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n algorithms, use it in the subsequent request.

" } } } @@ -21614,6 +21741,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "AppImageConfigs", "pageSize": "MaxResults" } } @@ -21707,6 +21835,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Apps", "pageSize": "MaxResults" } } @@ -21787,6 +21916,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ArtifactSummaries", "pageSize": "MaxResults" } } @@ -21879,6 +22009,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "AssociationSummaries", "pageSize": "MaxResults" } } @@ -21984,6 +22115,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "AutoMLJobSummaries", "pageSize": "MaxResults" } } @@ -22090,6 +22222,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Candidates", "pageSize": "MaxResults" } } @@ -22174,6 +22307,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "CodeRepositorySummaryList", "pageSize": "MaxResults" } } @@ -22268,6 +22402,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "CompilationJobSummaries", "pageSize": "MaxResults" } } @@ -22393,6 +22528,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ContextSummaries", "pageSize": "MaxResults" } } @@ -22480,6 +22616,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "JobDefinitionSummaries", "pageSize": "MaxResults" } } @@ -22568,6 +22705,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DeviceFleetSummaries", "pageSize": "MaxResults" } } @@ -22682,6 +22820,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "DeviceSummaries", "pageSize": "MaxResults" } } @@ -22753,6 +22892,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Domains", "pageSize": "MaxResults" } } @@ -22804,6 +22944,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "EdgePackagingJobSummaries", "pageSize": "MaxResults" } } @@ -22938,6 +23079,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "EndpointConfigs", "pageSize": "MaxResults" } } @@ -23002,7 +23144,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n endpoint configurations, use it in the subsequent request

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n endpoint configurations, use it in the subsequent request

" } } } @@ -23020,6 +23162,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Endpoints", "pageSize": "MaxResults" } } @@ -23102,7 +23245,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

" } } } @@ -23120,6 +23263,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ExperimentSummaries", "pageSize": "MaxResults" } } @@ -23285,6 +23429,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "FlowDefinitionSummaries", "pageSize": "MaxResults" } } @@ -23356,6 +23501,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "HumanTaskUiSummaries", "pageSize": "MaxResults" } } @@ -23427,6 +23573,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "HyperParameterTuningJobSummaries", "pageSize": "MaxResults" } } @@ -23450,13 +23597,13 @@ "SortBy": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobSortByOptions", "traits": { - "smithy.api#documentation": "

The\n field\n to sort results by. The default is Name.

" + "smithy.api#documentation": "

The field to sort results by. The default is Name.

" } }, "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

The sort\n order\n for results. The default is Ascending.

" + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" } }, "NameContains": { @@ -23468,13 +23615,13 @@ "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

A filter that returns only tuning jobs that were created after the\n specified\n time.

" + "smithy.api#documentation": "

A filter that returns only tuning jobs that were created after the specified\n time.

" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

A filter that returns only tuning jobs that were created before the\n specified\n time.

" + "smithy.api#documentation": "

A filter that returns only tuning jobs that were created before the specified\n time.

" } }, "LastModifiedTimeAfter": { @@ -23492,7 +23639,7 @@ "StatusEquals": { "target": "com.amazonaws.sagemaker#HyperParameterTuningJobStatus", "traits": { - "smithy.api#documentation": "

A filter that returns only tuning jobs with the\n specified\n status.

" + "smithy.api#documentation": "

A filter that returns only tuning jobs with the specified status.

" } } } @@ -23533,6 +23680,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ImageVersions", "pageSize": "MaxResults" } } @@ -23627,6 +23775,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Images", "pageSize": "MaxResults" } } @@ -23720,6 +23869,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "InferenceRecommendationsJobs", "pageSize": "MaxResults" } } @@ -23839,6 +23989,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "LabelingJobSummaryList", "pageSize": "MaxResults" } } @@ -23861,6 +24012,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "LabelingJobSummaryList", "pageSize": "MaxResults" } } @@ -23932,7 +24084,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.

" } } } @@ -24025,7 +24177,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n labeling jobs, use it in the subsequent request.

" } } } @@ -24049,6 +24201,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "LineageGroupSummaries", "pageSize": "MaxResults" } } @@ -24132,6 +24285,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "JobDefinitionSummaries", "pageSize": "MaxResults" } } @@ -24220,6 +24374,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "JobDefinitionSummaries", "pageSize": "MaxResults" } } @@ -24308,6 +24463,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ModelMetadataSummaries", "pageSize": "MaxResults" } } @@ -24366,6 +24522,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ModelPackageGroupSummaryList", "pageSize": "MaxResults" } } @@ -24448,6 +24605,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ModelPackageSummaryList", "pageSize": "MaxResults" } } @@ -24530,7 +24688,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n model packages, use it in the subsequent request.

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n model packages, use it in the subsequent request.

" } } } @@ -24548,6 +24706,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "JobDefinitionSummaries", "pageSize": "MaxResults" } } @@ -24636,6 +24795,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Models", "pageSize": "MaxResults" } } @@ -24700,7 +24860,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#PaginationToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n models, use it in the subsequent request.

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n models, use it in the subsequent request.

" } } } @@ -24718,6 +24878,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "MonitoringExecutionSummaries", "pageSize": "MaxResults" } } @@ -24848,6 +25009,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "MonitoringScheduleSummaries", "pageSize": "MaxResults" } } @@ -24966,6 +25128,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "NotebookInstanceLifecycleConfigs", "pageSize": "MaxResults" } } @@ -25035,7 +25198,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To get the next set of\n lifecycle configurations, use it in the next request.

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To get the next set of\n lifecycle configurations, use it in the next request.

" } }, "NotebookInstanceLifecycleConfigs": { @@ -25055,10 +25218,11 @@ "target": "com.amazonaws.sagemaker#ListNotebookInstancesOutput" }, "traits": { - "smithy.api#documentation": "

Returns a list of the Amazon SageMaker notebook instances in the requester's account in an Amazon Web Services\n Region.

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

Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services\n Region.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "NotebookInstances", "pageSize": "MaxResults" } } @@ -25152,7 +25316,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the response to the previous ListNotebookInstances request was\n truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use\n the token in the next request.

" + "smithy.api#documentation": "

If the response to the previous ListNotebookInstances request was\n truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use\n the token in the next request.

" } }, "NotebookInstances": { @@ -25181,6 +25345,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "PipelineExecutionSteps", "pageSize": "MaxResults" } } @@ -25249,6 +25414,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "PipelineExecutionSummaries", "pageSize": "MaxResults" } } @@ -25336,6 +25502,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "PipelineParameters", "pageSize": "MaxResults" } } @@ -25394,6 +25561,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "PipelineSummaries", "pageSize": "MaxResults" } } @@ -25475,6 +25643,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ProcessingJobSummaries", "pageSize": "MaxResults" } } @@ -25663,6 +25832,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "StudioLifecycleConfigs", "pageSize": "MaxResults" } } @@ -25762,6 +25932,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "SubscribedWorkteams", "pageSize": "MaxResults" } } @@ -25817,10 +25988,11 @@ "target": "com.amazonaws.sagemaker#ListTagsOutput" }, "traits": { - "smithy.api#documentation": "

Returns the tags for the specified Amazon SageMaker resource.

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

Returns the tags for the specified SageMaker resource.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Tags", "pageSize": "MaxResults" } } @@ -25838,7 +26010,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the response to the previous ListTags request is truncated, Amazon SageMaker\n returns this token. To retrieve the next set of tags, use it in the subsequent request.\n

" + "smithy.api#documentation": "

If the response to the previous ListTags request is truncated, SageMaker\n returns this token. To retrieve the next set of tags, use it in the subsequent request.\n

" } }, "MaxResults": { @@ -25870,7 +26042,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If response is truncated, Amazon SageMaker includes a token in the response. You can use this\n token in your subsequent request to fetch next set of tokens.

" + "smithy.api#documentation": "

If response is truncated, SageMaker includes a token in the response. You can use this\n token in your subsequent request to fetch next set of tokens.

" } } } @@ -25888,6 +26060,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TrainingJobSummaries", "pageSize": "MaxResults" } } @@ -25910,6 +26083,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TrainingJobSummaries", "pageSize": "MaxResults" } } @@ -25939,19 +26113,19 @@ "StatusEquals": { "target": "com.amazonaws.sagemaker#TrainingJobStatus", "traits": { - "smithy.api#documentation": "

A filter that returns only training jobs with the\n specified\n status.

" + "smithy.api#documentation": "

A filter that returns only training jobs with the specified status.

" } }, "SortBy": { "target": "com.amazonaws.sagemaker#TrainingJobSortByOptions", "traits": { - "smithy.api#documentation": "

The field to sort\n results\n by. The default is Name.

\n

If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.

" + "smithy.api#documentation": "

The field to sort results by. The default is Name.

\n

If the value of this field is FinalObjectiveMetricValue, any training\n jobs that did not return an objective metric are not listed.

" } }, "SortOrder": { "target": "com.amazonaws.sagemaker#SortOrder", "traits": { - "smithy.api#documentation": "

The sort order\n for\n results. The default is Ascending.

" + "smithy.api#documentation": "

The sort order for results. The default is Ascending.

" } } } @@ -26053,7 +26227,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

" + "smithy.api#documentation": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of\n training jobs, use it in the subsequent request.

" } } } @@ -26071,6 +26245,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TransformJobSummaries", "pageSize": "MaxResults" } } @@ -26183,6 +26358,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TrialComponentSummaries", "pageSize": "MaxResults" } } @@ -26281,6 +26457,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TrialSummaries", "pageSize": "MaxResults" } } @@ -26368,6 +26545,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "UserProfiles", "pageSize": "MaxResults" } } @@ -26443,6 +26621,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Workforces", "pageSize": "MaxResults" } } @@ -26529,6 +26708,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Workteams", "pageSize": "MaxResults" } } @@ -26944,7 +27124,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a metric that the training algorithm\n writes\n to stderr or stdout. Amazon SageMakerhyperparameter\n tuning captures\n all\n defined metrics.\n You\n specify one metric that a hyperparameter tuning job uses as its\n objective metric to choose the best training job.

" + "smithy.api#documentation": "

Specifies a metric that the training algorithm\n writes\n to stderr or stdout. SageMakerhyperparameter\n tuning captures\n all\n defined metrics.\n You\n specify one metric that a hyperparameter tuning job uses as its\n objective metric to choose the best training job.

" } }, "com.amazonaws.sagemaker#MetricDefinitionList": { @@ -27160,13 +27340,13 @@ "InvocationsTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#InvocationsTimeoutInSeconds", "traits": { - "smithy.api#documentation": "

The timeout value in seconds for an invocation request.

" + "smithy.api#documentation": "

The timeout value in seconds for an invocation request. The default value is 600.

" } }, "InvocationsMaxRetries": { "target": "com.amazonaws.sagemaker#InvocationsMaxRetries", "traits": { - "smithy.api#documentation": "

The maximum number of retries when invocation requests are failing.

" + "smithy.api#documentation": "

The maximum number of retries when invocation requests are failing. The default value is 3.

" } } }, @@ -27725,7 +27905,7 @@ "Image": { "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { - "smithy.api#documentation": "

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

\n

If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker,\n the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

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

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

\n

If you are using your own custom algorithm instead of an algorithm provided by SageMaker,\n the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with Amazon\n SageMaker.

", "smithy.api#required": {} } }, @@ -27738,7 +27918,7 @@ "ModelDataUrl": { "target": "com.amazonaws.sagemaker#Url", "traits": { - "smithy.api#documentation": "

The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model package.

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

The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).

\n \n

The model artifacts must be in an S3 bucket that is in the same region as the\n model package.

\n " } }, "ProductId": { @@ -28103,7 +28283,7 @@ "ModelApprovalStatus": { "target": "com.amazonaws.sagemaker#ModelApprovalStatus", "traits": { - "smithy.api#documentation": "

The approval status of the model. This can be one of the following values.

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

The approval status of the model. This can be one of the following values.

\n " } } }, @@ -28183,13 +28363,13 @@ "ValidationProfiles": { "target": "com.amazonaws.sagemaker#ModelPackageValidationProfiles", "traits": { - "smithy.api#documentation": "

An array of ModelPackageValidationProfile objects, each of which\n specifies a batch transform job that Amazon SageMaker runs to validate your model package.

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

An array of ModelPackageValidationProfile objects, each of which\n specifies a batch transform job that SageMaker runs to validate your model package.

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

Specifies batch transform jobs that Amazon SageMaker runs to validate your model package.

" + "smithy.api#documentation": "

Specifies batch transform jobs that SageMaker runs to validate your model package.

" } }, "com.amazonaws.sagemaker#ModelPackageVersion": { @@ -29694,7 +29874,7 @@ "Url": { "target": "com.amazonaws.sagemaker#NotebookInstanceUrl", "traits": { - "smithy.api#documentation": "

The\n URL that you use to connect to the Jupyter instance running in your notebook instance.\n

" + "smithy.api#documentation": "

The URL that you use to connect to the Jupyter notebook running in your notebook\n instance.

" } }, "InstanceType": { @@ -29724,18 +29904,18 @@ "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository associated with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with SageMaker\n Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories associated with the notebook instance. These\n can be either the names of Git repositories stored as resources in your account, or the\n URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

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

Provides summary information for an Amazon SageMaker notebook instance.

" + "smithy.api#documentation": "

Provides summary information for an SageMaker notebook instance.

" } }, "com.amazonaws.sagemaker#NotebookInstanceSummaryList": { @@ -30222,13 +30402,13 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer\n Guide.

" } }, "S3OutputPath": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.

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

Identifies the S3 path where you want SageMaker to store the model artifacts. For\n example, s3://bucket-name/key-name-prefix.

", "smithy.api#required": {} } } @@ -30587,13 +30767,13 @@ "CurrentServerlessConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", "traits": { - "smithy.api#documentation": "

The serverless configuration for the endpoint.

\n \n

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

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

The serverless configuration for the endpoint.

" } }, "DesiredServerlessConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", "traits": { - "smithy.api#documentation": "

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

\n \n

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

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

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

" } } }, @@ -31077,7 +31257,7 @@ "ClarifyCheck": { "target": "com.amazonaws.sagemaker#ClarifyCheckStepMetadata", "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 " + "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 " } }, "EMR": { @@ -32233,12 +32413,12 @@ "ServerlessConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", "traits": { - "smithy.api#documentation": "

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

\n \n

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

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

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

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

Identifies a model that you want to host and the resources chosen to deploy for\n hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic\n among the models by specifying variant weights.

" + "smithy.api#documentation": "

Identifies a model that you want to host and the resources chosen to deploy for\n hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic\n among the models by specifying variant weights.

" } }, "com.amazonaws.sagemaker#ProductionVariantAcceleratorType": { @@ -32285,7 +32465,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the core dump data at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services\n KMS in the Amazon Web Services Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using\n Amazon S3 server-side encryption. The KmsKeyId can be any of the following\n formats:

\n \n \n

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side\n encryption with KMS-managed keys for OutputDataConfig. If you use a bucket\n policy with an s3:PutObject permission that only allows objects with\n server-side encryption, set the condition key of\n s3:x-amz-server-side-encryption to \"aws:kms\". For more\n information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide.\n

\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint and UpdateEndpoint requests. For more\n information, see Using Key Policies in Amazon Web Services\n KMS in the Amazon Web Services Key Management Service Developer Guide.

" } } }, @@ -32595,7 +32775,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

\n \n

Specifies the serverless configuration for an endpoint variant.

" + "smithy.api#documentation": "

Specifies the serverless configuration for an endpoint variant.

" } }, "com.amazonaws.sagemaker#ProductionVariantStatus": { @@ -32686,13 +32866,13 @@ "CurrentServerlessConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", "traits": { - "smithy.api#documentation": "

The serverless configuration for the endpoint.

\n \n

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

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

The serverless configuration for the endpoint.

" } }, "DesiredServerlessConfig": { "target": "com.amazonaws.sagemaker#ProductionVariantServerlessConfig", "traits": { - "smithy.api#documentation": "

The serverless configuration requested for the endpoint update.

\n \n

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

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

The serverless configuration requested for the endpoint update.

" } } }, @@ -33417,12 +33597,12 @@ "Properties": { "target": "com.amazonaws.sagemaker#QueryProperties", "traits": { - "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. \n If multiple pairs are provided, an entity will be included in the results if it matches any of the provided pairs.

" + "smithy.api#documentation": "

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. \n If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

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

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the \n QueryLineage API action.

" + "smithy.api#documentation": "

A set of filters to narrow the set of lineage entities connected to the StartArn(s) returned by the \n QueryLineage API action.

" } }, "com.amazonaws.sagemaker#QueryLineage": { @@ -33478,13 +33658,13 @@ "Direction": { "target": "com.amazonaws.sagemaker#Direction", "traits": { - "smithy.api#documentation": "

Associations between lineage entities are directed. This parameter determines the direction from the \n StartArn(s) the query will look.

" + "smithy.api#documentation": "

Associations between lineage entities have a direction. This parameter determines the direction from the \n StartArn(s) that the query traverses.

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

Setting this value to True will retrieve not only the entities of interest but also the \n Associations and \n lineage entities on the path. Set to False to only return lineage entities that match your query.

" + "smithy.api#documentation": "

Setting this value to True retrieves not only the entities of interest but also the \n Associations and \n lineage entities on the path. Set to False to only return lineage entities that match your query.

" } }, "Filters": { @@ -33496,7 +33676,7 @@ "MaxDepth": { "target": "com.amazonaws.sagemaker#QueryLineageMaxDepth", "traits": { - "smithy.api#documentation": "

The maximum depth in lineage relationships from the StartArns that will be traversed. Depth is a measure of the number \n of Associations from the StartArn entity to the matched results.

" + "smithy.api#documentation": "

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number \n of Associations from the StartArn entity to the matched results.

" } }, "MaxResults": { @@ -33708,6 +33888,20 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:inference-recommendations-job/" } }, + "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig": { + "type": "structure", + "members": { + "S3OutputUri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "

Identifies the Amazon S3 bucket where you want SageMaker to store the \n compiled model artifacts.

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

Provides information about the output configuration for the compiled \n model.

" + } + }, "com.amazonaws.sagemaker#RecommendationJobDescription": { "type": "string", "traits": { @@ -33750,6 +33944,12 @@ "traits": { "smithy.api#documentation": "

Specifies the endpoint configuration to use for a job.

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

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. \n This key will be passed to SageMaker Hosting for endpoint creation.

\n \n

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage \n volume of the endpoints created for inference recommendation. The inference recommendation job will fail \n asynchronously during endpoint configuration creation if the role passed does not have \n kms:CreateGrant permission.

\n \n

The KmsKeyId can be any of the following formats:

\n \n

For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" + } } }, "traits": { @@ -33766,6 +33966,26 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63}$" } }, + "com.amazonaws.sagemaker#RecommendationJobOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key \n that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. \n The SageMaker execution role must have kms:GenerateDataKey permission.

\n \n

The KmsKeyId can be any of the following formats:

\n \n

For more information about key identifiers, see \n Key identifiers (KeyID) in the \n Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

" + } + }, + "CompiledOutputConfig": { + "target": "com.amazonaws.sagemaker#RecommendationJobCompiledOutputConfig", + "traits": { + "smithy.api#documentation": "

Provides information about the output configuration for the compiled \n model.

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

Provides information about the output configuration for the compiled model.

" + } + }, "com.amazonaws.sagemaker#RecommendationJobResourceLimit": { "type": "structure", "members": { @@ -34057,6 +34277,9 @@ "input": { "target": "com.amazonaws.sagemaker#RegisterDevicesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" @@ -34305,14 +34528,14 @@ "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#VolumeSizeInGB", "traits": { - "smithy.api#documentation": "

The size of the ML storage volume that you want to provision.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.

\n

You must specify sufficient ML storage for your scenario.

\n \n

Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.\n

\n \n \n

Certain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for training, Amazon SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.

\n

For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.

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

The size of the ML storage volume that you want to provision.

\n

ML storage volumes store model artifacts and incremental states. Training\n algorithms might also use the ML storage volume for scratch space. If you want to store\n the training data in the ML storage volume, choose File as the\n TrainingInputMode in the algorithm specification.

\n

You must specify sufficient ML storage for your scenario.

\n \n

SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.\n

\n \n \n

Certain Nitro-based instances include local storage with a fixed total size,\n dependent on the instance type. When using these instances for training, SageMaker mounts\n the local instance storage instead of Amazon EBS gp2 storage. You can't request a\n VolumeSizeInGB greater than the total size of the local instance\n storage.

\n

For a list of instance types that support local instance storage, including the\n total size per instance type, see Instance Store Volumes.

\n ", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML\n compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

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

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML\n compute instance(s) that run the training job.

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n \n

The VolumeKmsKeyId can be in any of the following formats:

\n " } } }, @@ -34349,7 +34572,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have exceeded an Amazon SageMaker resource limit. For example, you might have too many\n training jobs created.

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

You have exceeded an SageMaker resource limit. For example, you might have too many\n training jobs created.

", "smithy.api#error": "client" } }, @@ -34425,7 +34648,7 @@ "InstanceType": { "target": "com.amazonaws.sagemaker#AppInstanceType", "traits": { - "smithy.api#documentation": "

The instance type that the image version runs on.

" + "smithy.api#documentation": "

The instance type that the image version runs on.

\n \n

JupyterServer Apps only support the system value. KernelGateway Apps do not support the system value, but support all other values for available instance types.

\n " } }, "LifecycleConfigArn": { @@ -34712,21 +34935,21 @@ "S3DataType": { "target": "com.amazonaws.sagemaker#S3DataType", "traits": { - "smithy.api#documentation": "

If you choose S3Prefix, S3Uri identifies a key name prefix.\n Amazon SageMaker uses all objects that match the specified key name prefix for model training.

\n

If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model\n training.

\n

If you choose AugmentedManifestFile, S3Uri identifies an object that is\n an augmented manifest file in JSON lines format. This file contains the data you want to\n use for model training. AugmentedManifestFile can only be used if the\n Channel's input mode is Pipe.

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

If you choose S3Prefix, S3Uri identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix for model training.

\n

If you choose ManifestFile, S3Uri identifies an object that\n is a manifest file containing a list of object keys that you want SageMaker to use for model\n training.

\n

If you choose AugmentedManifestFile, S3Uri identifies an object that is\n an augmented manifest file in JSON lines format. This file contains the data you want to\n use for model training. AugmentedManifestFile can only be used if the\n Channel's input mode is Pipe.

", "smithy.api#required": {} } }, "S3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:

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

Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:

\n ", "smithy.api#required": {} } }, "S3DataDistributionType": { "target": "com.amazonaws.sagemaker#S3DataDistribution", "traits": { - "smithy.api#documentation": "

If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.

\n

If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.

\n

Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.

\n

In distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.

" + "smithy.api#documentation": "

If you want SageMaker to replicate the entire dataset on each ML compute instance that\n is launched for model training, specify FullyReplicated.

\n

If you want SageMaker to replicate a subset of data on each ML compute instance that is\n launched for model training, specify ShardedByS3Key. If there are\n n ML compute instances launched for a training job, each\n instance gets approximately 1/n of the number of S3 objects. In\n this case, model training on each machine uses only the subset of training data.

\n

Don't choose more ML compute instances for training than available S3 objects. If\n you do, some nodes won't get any data and you will pay for nodes that aren't getting any\n training data. This applies in both File and Pipe modes. Keep this in mind when\n developing algorithms.

\n

In distributed training, where you use multiple ML compute EC2 instances, you might\n choose ShardedByS3Key. If the algorithm requires copying training data to\n the ML storage volume (when TrainingInputMode is set to File),\n this copies 1/n of the number of objects.

" } }, "AttributeNames": { @@ -34810,7 +35033,7 @@ "name": "sagemaker" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Provides APIs for creating and managing Amazon SageMaker resources.

\n

Other Resources:

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

Provides APIs for creating and managing SageMaker resources.

\n

Other Resources:

\n ", "smithy.api#title": "Amazon SageMaker Service", "smithy.api#xmlNamespace": { "uri": "http://sagemaker.amazonaws.com/doc/2017-05-13/" @@ -35658,6 +35881,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Results", "pageSize": "MaxResults" } } @@ -35940,12 +36164,12 @@ "StatusMessage": { "target": "com.amazonaws.sagemaker#StatusMessage", "traits": { - "smithy.api#documentation": "

A detailed description of the progress within a secondary status.\n

\n

Amazon SageMaker provides secondary statuses and status messages that apply to each of\n them:

\n
\n
Starting
\n
\n
    \n
  • \n

    Starting the training job.

    \n
    • \n
  • \n

    Launching requested ML\n instances.

    \n
    • \n
  • \n

    Insufficient\n capacity error from EC2 while launching instances,\n retrying!

    \n
    • \n
  • \n

    Launched\n instance was unhealthy, replacing it!

    \n
    • \n
  • \n

    Preparing the instances for training.

    \n
    • \n
\n
\n
Training
\n
\n
    \n
  • \n

    Downloading the training image.

    \n
    • \n
  • \n

    Training\n image download completed. Training in\n progress.

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

Status messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.

\n \n

To have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For\n example, at the start of a training job, you might see the following:

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

A detailed description of the progress within a secondary status.\n

\n

SageMaker provides secondary statuses and status messages that apply to each of\n them:

\n
\n
Starting
\n
\n
    \n
  • \n

    Starting the training job.

    \n
    • \n
  • \n

    Launching requested ML\n instances.

    \n
    • \n
  • \n

    Insufficient\n capacity error from EC2 while launching instances,\n retrying!

    \n
    • \n
  • \n

    Launched\n instance was unhealthy, replacing it!

    \n
    • \n
  • \n

    Preparing the instances for training.

    \n
    • \n
\n
\n
Training
\n
\n
    \n
  • \n

    Downloading the training image.

    \n
    • \n
  • \n

    Training\n image download completed. Training in\n progress.

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

Status messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.

\n \n

To have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For\n example, at the start of a training job, you might see the following:

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

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides\n additional details about a status that the training job has transitioned through. A\n training job can be in one of several states, for example, starting, downloading,\n training, or uploading. Within each state, there are a number of intermediate states.\n For example, within the starting state, Amazon SageMaker could be starting the training job or\n launching the ML instances. These transitional states are referred to as the job's\n secondary\n status.\n

\n

" + "smithy.api#documentation": "

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides\n additional details about a status that the training job has transitioned through. A\n training job can be in one of several states, for example, starting, downloading,\n training, or uploading. Within each state, there are a number of intermediate states.\n For example, within the starting state, SageMaker could be starting the training job or\n launching the ML instances. These transitional states are referred to as the job's\n secondary\n status.\n

\n

" } }, "com.amazonaws.sagemaker#SecondaryStatusTransitions": { @@ -36107,7 +36331,7 @@ "smithy.api#box": {}, "smithy.api#range": { "min": 1, - "max": 50 + "max": 200 } } }, @@ -36475,13 +36699,13 @@ "AlgorithmName": { "target": "com.amazonaws.sagemaker#ArnOrName", "traits": { - "smithy.api#documentation": "

The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your Amazon SageMaker account or an algorithm in Amazon Web Services Marketplace that you\n are subscribed to.

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

The name of an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you\n are subscribed to.

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

Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your Amazon SageMaker account or an algorithm in Amazon Web Services Marketplace that you\n are subscribed to.

" + "smithy.api#documentation": "

Specifies an algorithm that was used to create the model package. The algorithm must\n be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you\n are subscribed to.

" } }, "com.amazonaws.sagemaker#SourceAlgorithmList": { @@ -36582,6 +36806,9 @@ "input": { "target": "com.amazonaws.sagemaker#StartMonitoringScheduleRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -36608,13 +36835,16 @@ "input": { "target": "com.amazonaws.sagemaker#StartNotebookInstanceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceLimitExceeded" } ], "traits": { - "smithy.api#documentation": "

Launches an ML compute instance with the latest version of the libraries and\n attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the\n notebook instance status to InService. A notebook instance's status must be\n InService before you can connect to your Jupyter notebook.

" + "smithy.api#documentation": "

Launches an ML compute instance with the latest version of the libraries and\n attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the\n notebook instance status to InService. A notebook instance's status must be\n InService before you can connect to your Jupyter notebook.

" } }, "com.amazonaws.sagemaker#StartNotebookInstanceInput": { @@ -36783,6 +37013,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopAutoMLJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -36809,6 +37042,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopCompilationJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -36835,6 +37071,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopEdgePackagingJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Request to stop an edge packaging job.

" } @@ -36856,6 +37095,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopHyperParameterTuningJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -36882,6 +37124,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopInferenceRecommendationsJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -36908,6 +37153,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopLabelingJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -36934,6 +37182,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopMonitoringScheduleRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -36960,8 +37211,11 @@ "input": { "target": "com.amazonaws.sagemaker#StopNotebookInstanceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { - "smithy.api#documentation": "

Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker\n disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. Amazon SageMaker\n stops charging you for the ML compute instance when you call\n StopNotebookInstance.

\n

To access data on the ML storage volume for a notebook instance that has been\n terminated, call the StartNotebookInstance API.\n StartNotebookInstance launches another ML compute instance, configures\n it, and attaches the preserved ML storage volume so you can continue your work.\n

" + "smithy.api#documentation": "

Terminates the ML compute instance. Before terminating the instance, SageMaker\n disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker\n stops charging you for the ML compute instance when you call\n StopNotebookInstance.

\n

To access data on the ML storage volume for a notebook instance that has been\n terminated, call the StartNotebookInstance API.\n StartNotebookInstance launches another ML compute instance, configures\n it, and attaches the preserved ML storage volume so you can continue your work.\n

" } }, "com.amazonaws.sagemaker#StopNotebookInstanceInput": { @@ -37029,6 +37283,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopProcessingJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -37055,13 +37312,16 @@ "input": { "target": "com.amazonaws.sagemaker#StopTrainingJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" } ], "traits": { - "smithy.api#documentation": "

Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the\n SIGTERM signal, which delays job termination for 120 seconds.\n Algorithms might use this 120-second window to save the model artifacts, so the results\n of the training is not lost.

\n

When it receives a StopTrainingJob request, Amazon SageMaker changes the status of\n the job to Stopping. After Amazon SageMaker stops the job, it sets the status to\n Stopped.

" + "smithy.api#documentation": "

Stops a training job. To stop a job, SageMaker sends the algorithm the\n SIGTERM signal, which delays job termination for 120 seconds.\n Algorithms might use this 120-second window to save the model artifacts, so the results\n of the training is not lost.

\n

When it receives a StopTrainingJob request, SageMaker changes the status of\n the job to Stopping. After SageMaker stops the job, it sets the status to\n Stopped.

" } }, "com.amazonaws.sagemaker#StopTrainingJobRequest": { @@ -37081,6 +37341,9 @@ "input": { "target": "com.amazonaws.sagemaker#StopTransformJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceNotFound" @@ -37108,18 +37371,18 @@ "MaxRuntimeInSeconds": { "target": "com.amazonaws.sagemaker#MaxRuntimeInSeconds", "traits": { - "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can run.

\n

For compilation jobs, if the job does not complete during this time, you will \n receive a TimeOut error. We recommend starting with 900 seconds and increase as \n necessary based on your model.

\n

For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When \n RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

" + "smithy.api#documentation": "

The maximum length of time, in seconds, that a training or compilation job can run.

\n

For compilation jobs, if the job does not complete during this time, a TimeOut error\n is generated. We recommend starting with 900 seconds and increasing as \n necessary based on your model.

\n

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When \n RetryStrategy is specified in the job request,\n MaxRuntimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

" } }, "MaxWaitTimeInSeconds": { "target": "com.amazonaws.sagemaker#MaxWaitTimeInSeconds", "traits": { - "smithy.api#documentation": "

The maximum length of time, in seconds, that a managed Spot training job has to\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n Amazon SageMaker ends the job.

\n

When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.

" + "smithy.api#documentation": "

The maximum length of time, in seconds, that a managed Spot training job has to\n complete. It is the amount of time spent waiting for Spot capacity plus the amount of\n time the job can run. It must be equal to or greater than\n MaxRuntimeInSeconds. If the job does not complete during this time,\n SageMaker ends the job.

\n

When RetryStrategy is specified in the job request,\n MaxWaitTimeInSeconds specifies the maximum time for all of the attempts\n in total, not each individual attempt.

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

Specifies a limit to how long a model training job or model compilation job \n can run. It also specifies how long a managed spot training\n job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or\n compilation job. Use this API to cap model training costs.

\n

To stop a training job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

\n

The training algorithms provided by Amazon SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.

\n \n

The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.

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

Specifies a limit to how long a model training job or model compilation job \n can run. It also specifies how long a managed spot training\n job has to complete. When the job reaches the time limit, SageMaker ends the training or\n compilation job. Use this API to cap model training costs.

\n

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

\n

The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.

\n \n

The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.

\n " } }, "com.amazonaws.sagemaker#String": { @@ -37960,7 +38223,7 @@ "CanarySize": { "target": "com.amazonaws.sagemaker#CapacitySize", "traits": { - "smithy.api#documentation": "

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than\n or equal to 50% of the variant's total instance count.

" + "smithy.api#documentation": "

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than\n or equal to 50% of the variant's total instance count.

" } }, "LinearStepSize": { @@ -38316,7 +38579,7 @@ "SecondaryStatus": { "target": "com.amazonaws.sagemaker#SecondaryStatus", "traits": { - "smithy.api#documentation": "

Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.

\n

Amazon SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

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

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

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

Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.

\n

SageMaker provides primary statuses and secondary statuses that apply to each of\n them:

\n
\n
InProgress
\n
\n
    \n
  • \n

    \n Starting\n - Starting the training job.

    \n
    • \n
  • \n

    \n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.

    \n
    • \n
  • \n

    \n Training - Training is in progress.

    \n
    • \n
  • \n

    \n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.

    \n
    • \n
\n
\n
Completed
\n
\n
    \n
  • \n

    \n Completed - The training job has completed.

    \n
    • \n
\n
\n
Failed
\n
\n
    \n
  • \n

    \n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.

    \n
    • \n
\n
\n
Stopped
\n
\n
    \n
  • \n

    \n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.

    \n
    • \n
  • \n

    \n Stopped - The training job has stopped.

    \n
    • \n
\n
\n
Stopping
\n
\n
    \n
  • \n

    \n Stopping - Stopping the training job.

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

Valid values for SecondaryStatus are subject to change.

\n \n

We no longer support the following secondary statuses:

\n " } }, "FailureReason": { @@ -38352,7 +38615,7 @@ "OutputDataConfig": { "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The S3 path where model artifacts that you configured when creating the job are\n stored. Amazon SageMaker creates subfolders for model artifacts.

" + "smithy.api#documentation": "

The S3 path where model artifacts that you configured when creating the job are\n stored. SageMaker creates subfolders for model artifacts.

" } }, "ResourceConfig": { @@ -38370,7 +38633,7 @@ "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

" + "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\n job termination for 120 seconds. Algorithms can use this 120-second window to save the\n model artifacts, so the results of training are not lost.

" } }, "CreationTime": { @@ -38388,7 +38651,7 @@ "TrainingEndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "

Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

" + "smithy.api#documentation": "

Indicates the time when the training job ends on training instances. You are billed\n for the time interval between the value of TrainingStartTime and this time.\n For successful jobs and stopped jobs, this is the time after model artifacts are\n uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

" } }, "LastModifiedTime": { @@ -38521,7 +38784,7 @@ "OutputDataConfig": { "target": "com.amazonaws.sagemaker#OutputDataConfig", "traits": { - "smithy.api#documentation": "

the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates\n subfolders for the artifacts.

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

the path to the S3 bucket where you want to store model artifacts. SageMaker creates\n subfolders for the artifacts.

", "smithy.api#required": {} } }, @@ -38535,7 +38798,7 @@ "StoppingCondition": { "target": "com.amazonaws.sagemaker#StoppingCondition", "traits": { - "smithy.api#documentation": "

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.

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

Specifies a limit to how long a model training job can run. It also specifies how long\n a managed Spot training job has to complete. When the job reaches the time limit, SageMaker\n ends the training job. Use this API to cap model training costs.

\n

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job\n termination for 120 seconds. Algorithms can use this 120-second window to save the model\n artifacts.

", "smithy.api#required": {} } } @@ -40496,6 +40759,9 @@ "input": { "target": "com.amazonaws.sagemaker#UpdateDeviceFleetRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.sagemaker#ResourceInUse" @@ -40547,6 +40813,9 @@ "input": { "target": "com.amazonaws.sagemaker#UpdateDevicesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "traits": { "smithy.api#documentation": "

Updates one or more devices in a fleet.

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

Deploys the new EndpointConfig specified in the request, switches to\n using newly created endpoint, and then deletes resources provisioned for the endpoint\n using the previous EndpointConfig (there is no availability loss).

\n

When Amazon SageMaker receives the request, it sets the endpoint status to\n Updating. After updating the endpoint, it sets the status to\n InService. To check the status of an endpoint, use the DescribeEndpoint API.\n \n

\n \n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n

If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.

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

Deploys the new EndpointConfig specified in the request, switches to\n using newly created endpoint, and then deletes resources provisioned for the endpoint\n using the previous EndpointConfig (there is no availability loss).

\n

When SageMaker receives the request, it sets the endpoint status to\n Updating. After updating the endpoint, it sets the status to\n InService. To check the status of an endpoint, use the DescribeEndpoint API.\n \n

\n \n

You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.

\n

If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.

\n " } }, "com.amazonaws.sagemaker#UpdateEndpointInput": { @@ -40714,7 +40983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates variant weight of one or more variants associated with an existing\n endpoint, or capacity of one variant associated with an existing endpoint. When it\n receives the request, Amazon SageMaker sets the endpoint status to Updating. After\n updating the endpoint, it sets the status to InService. To check the status\n of an endpoint, use the DescribeEndpoint API.

" + "smithy.api#documentation": "

Updates variant weight of one or more variants associated with an existing\n endpoint, or capacity of one variant associated with an existing endpoint. When it\n receives the request, SageMaker sets the endpoint status to Updating. After\n updating the endpoint, it sets the status to InService. To check the status\n of an endpoint, use the DescribeEndpoint API.

" } }, "com.amazonaws.sagemaker#UpdateEndpointWeightsAndCapacitiesInput": { @@ -40723,7 +40992,7 @@ "EndpointName": { "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

The name of an existing Amazon SageMaker endpoint.

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

The name of an existing SageMaker endpoint.

", "smithy.api#required": {} } }, @@ -41023,7 +41292,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the\n notebook instance. For more information, see Amazon SageMaker Roles.

\n \n

To be able to pass this role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission.

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

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the\n notebook instance. For more information, see SageMaker Roles.

\n \n

To be able to pass this role to SageMaker, the caller of this API must have the\n iam:PassRole permission.

\n " } }, "LifecycleConfigName": { @@ -41041,19 +41310,19 @@ "VolumeSizeInGB": { "target": "com.amazonaws.sagemaker#NotebookInstanceVolumeSizeInGB", "traits": { - "smithy.api#documentation": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the\n amount of available free space on the volume. Because of this, you can increase the\n volume size when you update a notebook instance, but you can't decrease the volume size.\n If you want to decrease the size of the ML storage volume in use, create a new notebook\n instance with the desired size.

" + "smithy.api#documentation": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The\n default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the\n amount of available free space on the volume. Because of this, you can increase the\n volume size when you update a notebook instance, but you can't decrease the volume size.\n If you want to decrease the size of the ML storage volume in use, create a new notebook\n instance with the desired size.

" } }, "DefaultCodeRepository": { "target": "com.amazonaws.sagemaker#CodeRepositoryNameOrUrl", "traits": { - "smithy.api#documentation": "

The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker\n Notebook Instances.

" + "smithy.api#documentation": "

The Git repository to associate with the notebook instance as its default code\n repository. This can be either the name of a Git repository stored as a resource in your\n account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any\n other Git repository. When you open a notebook instance, it opens in the directory that\n contains this repository. For more information, see Associating Git Repositories with SageMaker\n Notebook Instances.

" } }, "AdditionalCodeRepositories": { "target": "com.amazonaws.sagemaker#AdditionalCodeRepositoryNamesOrUrls", "traits": { - "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with Amazon SageMaker Notebook Instances.

" + "smithy.api#documentation": "

An array of up to three Git repositories to associate with the notebook instance.\n These can be either the names of Git repositories stored as resources in your account,\n or the URL of Git repositories in Amazon Web Services CodeCommit or in any\n other Git repository. These repositories are cloned at the same level as the default\n repository of your notebook instance. For more information, see Associating Git\n Repositories with SageMaker Notebook Instances.

" } }, "AcceleratorTypes": { @@ -41902,6 +42171,16 @@ "smithy.api#documentation": "

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are\n specified when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.

\n

\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.

" } }, + "com.amazonaws.sagemaker#ValidationFraction": { + "type": "float", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.sagemaker#VariantName": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/secretsmanager.json b/aws/sdk/aws-models/secretsmanager.json index 3f0024bce5..3fc31db8b2 100644 --- a/aws/sdk/aws-models/secretsmanager.json +++ b/aws/sdk/aws-models/secretsmanager.json @@ -75,7 +75,7 @@ } ], "traits": { - "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 \n

\n Required permissions: \n secretsmanager:CancelRotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n Required permissions: \n secretsmanager:CancelRotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#CancelRotateSecretRequest": { @@ -84,7 +84,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -163,7 +163,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:CreateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Creates a new secret. A secret can be a password, a set of \n credentials such as a user name and password, an OAuth token, or other secret information \n 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

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret,\n you must make sure the JSON you store in the SecretString matches the JSON structure of\n a database secret.

\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.

\n

\n Required permissions: \n secretsmanager:CreateSecret. If you \n include tags in the secret, you also need secretsmanager:TagResource.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

\n

To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.

" } }, "com.amazonaws.secretsmanager#CreateSecretRequest": { @@ -294,7 +294,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use PutResourcePolicy.

\n

\n Required permissions: \n secretsmanager:DeleteResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use PutResourcePolicy.

\n

\n Required permissions: \n secretsmanager:DeleteResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#DeleteResourcePolicyRequest": { @@ -303,7 +303,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -349,7 +349,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:DeleteSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:DeleteSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#DeleteSecretRequest": { @@ -358,7 +358,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -427,7 +427,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:DescribeSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:DescribeSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#DescribeSecretRequest": { @@ -436,7 +436,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -710,7 +710,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:GetRandomPassword. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:GetRandomPassword. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#GetRandomPasswordRequest": { @@ -807,7 +807,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:GetResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:GetResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#GetResourcePolicyRequest": { @@ -816,7 +816,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -871,7 +871,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

We recommend that you cache your secret values by using client-side caching. \n Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for \n your applications.

\n \n

\n Required permissions: \n secretsmanager:GetSecretValue. \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.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

We recommend that you cache your secret values by using client-side caching. \n Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for \n your applications.

\n \n

\n Required permissions: \n secretsmanager:GetSecretValue. \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.\n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#GetSecretValueRequest": { @@ -880,7 +880,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -1055,7 +1055,7 @@ } ], "traits": { - "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 Required permissions: \n secretsmanager:ListSecretVersionIds. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

Lists the 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 Required permissions: \n secretsmanager:ListSecretVersionIds. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1069,7 +1069,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

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

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1318,7 +1318,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:PutResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:PutResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#PutResourcePolicyRequest": { @@ -1327,7 +1327,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -1399,7 +1399,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:PutSecretValue. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:PutSecretValue. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#PutSecretValueRequest": { @@ -1408,7 +1408,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

\n

If the secret doesn't already exist, use CreateSecret instead.

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

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

\n

\n Required permissions: \n secretsmanager:RemoveRegionsFromReplication. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

\n

\n Required permissions: \n secretsmanager:RemoveRegionsFromReplication. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest": { @@ -1607,7 +1607,7 @@ } ], "traits": { - "smithy.api#documentation": "

Replicates the secret to a new Regions. See Multi-Region secrets.

\n

\n Required permissions: \n secretsmanager:ReplicateSecretToRegions. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Replicates the secret to a new Regions. See Multi-Region secrets.

\n

\n Required permissions: \n secretsmanager:ReplicateSecretToRegions. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest": { @@ -1746,7 +1746,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:RestoreSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:RestoreSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#RestoreSecretRequest": { @@ -1755,7 +1755,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } } @@ -1801,7 +1801,7 @@ } ], "traits": { - "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

\n Required permissions: \n secretsmanager:RotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. \n For more information, see \n Permissions for rotation.

" + "smithy.api#documentation": "

Configures and starts the asynchronous process of rotating the secret. For more information about rotation, \n see Rotate secrets.

\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.

\n

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must \n make sure the secret value is in the\n JSON structure\n of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser\n secret.

\n \n

To configure rotation, you also need 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

You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose \n a template that matches your Rotation strategy.

\n

When rotation is successful, the AWSPENDING staging label might be attached\n to the same version as the AWSCURRENT version, or it might not be attached to any\n version. If the AWSPENDING staging label is present but not attached to the same\n version as AWSCURRENT, then any later invocation of RotateSecret\n assumes that a previous rotation request is still in progress and returns an error.

\n

\n Required permissions: \n secretsmanager:RotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. \n For more information, see \n Permissions for rotation.

" } }, "com.amazonaws.secretsmanager#RotateSecretRequest": { @@ -1810,7 +1810,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2221,7 +2221,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:StopReplicationToReplica. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:StopReplicationToReplica. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#StopReplicationToReplicaRequest": { @@ -2293,6 +2293,9 @@ "input": { "target": "com.amazonaws.secretsmanager#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" @@ -2308,7 +2311,7 @@ } ], "traits": { - "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 \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 Required permissions: \n secretsmanager:TagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "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 \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 Required permissions: \n secretsmanager:TagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#TagResourceRequest": { @@ -2317,7 +2320,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2347,6 +2350,9 @@ "input": { "target": "com.amazonaws.secretsmanager#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.secretsmanager#InternalServiceError" @@ -2362,7 +2368,7 @@ } ], "traits": { - "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 \n

\n Required permissions: \n secretsmanager:UntagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n Required permissions: \n secretsmanager:UntagResource. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#UntagResourceRequest": { @@ -2371,7 +2377,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2425,7 +2431,7 @@ } ], "traits": { - "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 Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.

" + "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 Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.

" } }, "com.amazonaws.secretsmanager#UpdateSecretRequest": { @@ -2434,7 +2440,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2520,7 +2526,7 @@ } ], "traits": { - "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.

\n

\n Required permissions: \n secretsmanager:UpdateSecretVersionStage. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

\n

\n Required permissions: \n secretsmanager:UpdateSecretVersionStage. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest": { @@ -2529,7 +2535,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "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#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. See Finding a secret from a partial ARN.

", "smithy.api#required": {} } }, @@ -2597,7 +2603,7 @@ } ], "traits": { - "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 Required permissions: \n secretsmanager:ValidateResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "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 Required permissions: \n secretsmanager:ValidateResourcePolicy. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#ValidateResourcePolicyRequest": { diff --git a/aws/sdk/aws-models/securityhub.json b/aws/sdk/aws-models/securityhub.json index 959aec1093..ca9f773201 100644 --- a/aws/sdk/aws-models/securityhub.json +++ b/aws/sdk/aws-models/securityhub.json @@ -445,6 +445,21 @@ "target": "com.amazonaws.securityhub#NonEmptyString" } }, + "com.amazonaws.securityhub#AutoEnableStandards": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "DEFAULT", + "name": "DEFAULT" + } + ] + } + }, "com.amazonaws.securityhub#AvailabilityZone": { "type": "structure", "members": { @@ -12359,13 +12374,13 @@ "ProductName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the product that generated the finding.

\n

Security Hub populates this attribute automatically for each finding. You cannot update it using BatchImportFindings or BatchUpdateFindings. The exception to this is when you use a custom integration.

\n

When you use the Security Hub console to filter findings by product name, you use this attribute.

\n

When you use the Security Hub API to filter findings by product name, you use the aws/securityhub/ProductName attribute under ProductFields.

\n

Security Hub does not synchronize those two attributes.

" + "smithy.api#documentation": "

The name of the product that generated the finding.

\n

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

\n

When you use the Security Hub console or API to filter findings by product name, you use this attribute.

" } }, "CompanyName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the company for the product that generated the finding.

\n

Security Hub populates this attribute automatically for each finding. You cannot be updated using BatchImportFindings or BatchUpdateFindings. The exception to this is when you use a custom integration.

\n

When you use the Security Hub console to filter findings by company name, you use this attribute.

\n

When you use the Security Hub API to filter findings by company name, you use the aws/securityhub/CompanyName attribute under ProductFields.

\n

Security Hub does not synchronize those two attributes.

" + "smithy.api#documentation": "

The name of the company for the product that generated the finding.

\n

Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration.

\n

When you use the Security Hub console or API to filter findings by company name, you use this attribute.

" } }, "Region": { @@ -12722,13 +12737,13 @@ "ProductName": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

The name of the solution (product) that generates findings.

\n

Note that this is a filter against the aws/securityhub/ProductName field in ProductFields. It is not a filter for the top-level ProductName field.

" + "smithy.api#documentation": "

The name of the solution (product) that generates findings.

" } }, "CompanyName": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

The name of the findings provider (company) that owns the solution (product) that\n generates findings.

\n

Note that this is a filter against the aws/securityhub/CompanyName field in ProductFields. It is not a filter for the top-level CompanyName field.

" + "smithy.api#documentation": "

The name of the findings provider (company) that owns the solution (product) that\n generates findings.

" } }, "UserDefinedFields": { @@ -14435,7 +14450,7 @@ } ], "traits": { - "smithy.api#documentation": "

Used to enable finding aggregation. Must be called from the aggregation Region.

\n

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.\n

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

Used to enable finding aggregation. Must be called from the aggregation Region.

\n

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.\n

", "smithy.api#http": { "method": "POST", "uri": "/findingAggregator/create", @@ -15182,6 +15197,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ActionTargets", "pageSize": "MaxResults" } } @@ -15345,6 +15361,12 @@ "traits": { "smithy.api#documentation": "

Whether the maximum number of allowed member accounts are already associated with the\n Security Hub administrator account.

" } + }, + "AutoEnableStandards": { + "target": "com.amazonaws.securityhub#AutoEnableStandards", + "traits": { + "smithy.api#documentation": "

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

The default value of this parameter is equal to DEFAULT.

\n

If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to NONE, then default standards are not automatically enabled for new member \n accounts.

" + } } } }, @@ -15380,6 +15402,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Products", "pageSize": "MaxResults" } } @@ -15457,6 +15480,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Standards", "pageSize": "MaxResults" } } @@ -15493,6 +15517,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Controls", "pageSize": "MaxResults" } } @@ -16334,6 +16359,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "StandardsSubscriptions", "pageSize": "MaxResults" } } @@ -16489,6 +16515,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Findings", "pageSize": "MaxResults" } } @@ -16634,6 +16661,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Insights", "pageSize": "MaxResults" } } @@ -17320,6 +17348,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ProductSubscriptions", "pageSize": "MaxResults" } } @@ -17395,6 +17424,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "FindingAggregators", "pageSize": "MaxResults" } } @@ -17467,6 +17497,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Invitations", "pageSize": "MaxResults" } } @@ -17539,6 +17570,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Members", "pageSize": "MaxResults" } } @@ -17618,6 +17650,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "AdminAccounts", "pageSize": "MaxResults" } } @@ -19853,7 +19886,7 @@ "name": "securityhub" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the 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 ", + "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .

\n

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

\n

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

\n ", "smithy.api#title": "AWS SecurityHub" }, "version": "2018-10-26", @@ -21318,6 +21351,12 @@ "smithy.api#documentation": "

Whether to automatically enable Security Hub for new accounts in the organization.

\n

By default, this is false, and new accounts are not added\n automatically.

\n

To automatically enable Security Hub for new accounts, set this to true.

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

Whether to automatically enable Security Hub default standards \n for new member accounts in the organization.

\n

By default, this parameter is equal to DEFAULT, and new member accounts are automatically enabled with default Security Hub standards.

\n

To opt out of enabling default standards for new member accounts, set this parameter equal to NONE.

" + } } } }, diff --git a/aws/sdk/aws-models/ssm.json b/aws/sdk/aws-models/ssm.json index 37b04f7060..68d0fd8d23 100644 --- a/aws/sdk/aws-models/ssm.json +++ b/aws/sdk/aws-models/ssm.json @@ -221,7 +221,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your documents, managed nodes, maintenance windows, Parameter Store parameters, and\n patch baselines. Tags enable you to categorize your resources in different ways, for example, by\n purpose, owner, or environment. Each tag consists of a key and an optional value, both of which\n you define. For example, you could define a set of tags for your account's managed nodes that\n helps you track each node's owner and stack level. For example:

\n \n

Each resource can have a maximum of 50 tags.

\n

We recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.

\n

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and\n patch baselines. Tags enable you to categorize your resources in different ways, for example, by\n purpose, owner, or environment. Each tag consists of a key and an optional value, both of which\n you define. For example, you could define a set of tags for your account's managed nodes that\n helps you track each node's owner and stack level. For example:

\n \n

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

\n

We recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.

\n

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ssm#AddTagsToResourceRequest": { @@ -237,7 +237,7 @@ "ResourceId": { "target": "com.amazonaws.ssm#ResourceId", "traits": { - "smithy.api#documentation": "

The resource ID you want to tag.

\n

Use the ID of the resource. Here are some examples:

\n

\n MaintenanceWindow: mw-012345abcde\n

\n

\n PatchBaseline: pb-012345abcde\n

\n

\n OpsMetadata object: ResourceID for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from\n the strings that come after the word opsmetadata in the ARN. For example, an\n OpsMetadata object with an ARN of\n arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a\n ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the\n resource.

\n

\n ManagedInstance: mi-012345abcde\n

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. You must specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.

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

The resource ID you want to tag.

\n

Use the ID of the resource. Here are some examples:

\n

\n MaintenanceWindow: mw-012345abcde\n

\n

\n PatchBaseline: pb-012345abcde\n

\n

\n Automation: example-c160-4567-8519-012345abcde\n

\n

\n OpsMetadata object: ResourceID for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from\n the strings that come after the word opsmetadata in the ARN. For example, an\n OpsMetadata object with an ARN of\n arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a\n ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the\n resource.

\n

\n ManagedInstance: mi-012345abcde\n

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. You must specify the name of the managed node in the following format:\n mi-ID_number\n . For example,\n mi-1a2b3c4d5e6f.

\n ", "smithy.api#required": {} } }, @@ -879,6 +879,13 @@ "traits": { "smithy.api#documentation": "

The association name.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" + } } }, "traits": { @@ -1070,6 +1077,13 @@ "traits": { "smithy.api#documentation": "

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" + } } }, "traits": { @@ -1771,6 +1785,13 @@ "traits": { "smithy.api#documentation": "

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association\n when this association version was created.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" + } } }, "traits": { @@ -4445,6 +4466,13 @@ "traits": { "smithy.api#documentation": "

Use this action to create an association in multiple Regions and multiple accounts.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" + } } }, "traits": { @@ -4567,6 +4595,13 @@ "traits": { "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to create an association in multiple Regions and multiple\n accounts.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

\n " + } } } }, @@ -21506,7 +21541,7 @@ "ResourceId": { "target": "com.amazonaws.ssm#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the resource from which you want to remove tags. For example:

\n

ManagedInstance: mi-012345abcde

\n

MaintenanceWindow: mw-012345abcde

\n

PatchBaseline: pb-012345abcde

\n

OpsMetadata object: ResourceID for tagging is created from the Amazon Resource\n Name (ARN) for the object. Specifically, ResourceID is created from the strings that\n come after the word opsmetadata in the ARN. For example, an OpsMetadata object with\n an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager\n has a ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the resource.

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For\n example, mi-1a2b3c4d5e6f.

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

The ID of the resource from which you want to remove tags. For example:

\n

ManagedInstance: mi-012345abcde

\n

MaintenanceWindow: mw-012345abcde

\n

\n Automation: example-c160-4567-8519-012345abcde\n

\n

PatchBaseline: pb-012345abcde

\n

OpsMetadata object: ResourceID for tagging is created from the Amazon Resource\n Name (ARN) for the object. Specifically, ResourceID is created from the strings that\n come after the word opsmetadata in the ARN. For example, an OpsMetadata object with\n an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager\n has a ResourceID of either aws/ssm/MyGroup/appmanager or\n /aws/ssm/MyGroup/appmanager.

\n

For the Document and Parameter values, use the name of the resource.

\n \n

The ManagedInstance type for this API operation is only for on-premises\n managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For\n example, mi-1a2b3c4d5e6f.

\n ", "smithy.api#required": {} } }, @@ -22556,6 +22591,15 @@ } } }, + "com.amazonaws.ssm#ScheduleOffset": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 6 + } + } + }, "com.amazonaws.ssm#ScheduledWindowExecution": { "type": "structure", "members": { @@ -23503,7 +23547,7 @@ "Tags": { "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an automation. Tags enable you to categorize a resource in different ways, such as by purpose,\n owner, or environment. For example, you might want to tag an automation to identify an\n environment or operating system. In this case, you could specify the following key-value\n pairs:

\n \n \n

To add tags to an existing patch baseline, use the AddTagsToResource\n operation.

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

Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an automation. Tags enable you to categorize a resource in different ways, such as by purpose,\n owner, or environment. For example, you might want to tag an automation to identify an\n environment or operating system. In this case, you could specify the following key-value\n pairs:

\n \n \n

To add tags to an existing automation, use the AddTagsToResource\n operation.

\n " } } } @@ -24806,6 +24850,13 @@ "traits": { "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to update an association in multiple Regions and multiple\n accounts.

" } + }, + "ScheduleOffset": { + "target": "com.amazonaws.ssm#ScheduleOffset", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

\n " + } } } }, diff --git a/aws/sdk/aws-models/storagegateway.json b/aws/sdk/aws-models/storagegateway.json index 2d6e6163f7..2aa4cbe2d1 100644 --- a/aws/sdk/aws-models/storagegateway.json +++ b/aws/sdk/aws-models/storagegateway.json @@ -381,7 +381,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in\n the S3 storage class that is associated with the pool. When you use your backup application\n to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or\n S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in\n the S3 storage class that is associated with the pool. When you use your backup application\n to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or\n S3 Glacier Deep Archive) that corresponds to the pool.

" } }, "com.amazonaws.storagegateway#AssignTapePoolInput": { @@ -397,7 +397,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

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

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

", "smithy.api#required": {} } }, @@ -647,7 +647,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool.\n When you use your backup application to eject the tape, the tape is archived directly into\n the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the\n pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

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

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool.\n When you use your backup application to eject the tape, the tape is archived directly into\n the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the\n pool.

", "smithy.api#required": {} } }, @@ -896,7 +896,7 @@ "VolumeUsedInBytes": { "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", "traits": { - "smithy.api#documentation": "

The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.

\n\n \n

This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

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

The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.

\n\n \n

This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.

\n\n

If you use a delete tool that overwrites the data on your volume with random data,\n your usage will not be reduced. This is because the random data is not compressible. If\n you want to reduce the amount of billed storage on your volume, we recommend overwriting\n your files with zeros to compress the data to a negligible amount of actual\n storage.

\n " } }, "KMSKey": { @@ -1288,7 +1288,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -1454,7 +1454,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -1971,7 +1971,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.

" } }, "Worm": { @@ -2078,7 +2078,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

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

Deletes a snapshot of a volume.

\n\n

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API\n action enables you to delete a snapshot schedule for a volume. For more information, see\n Backing up your\n volumes. In the DeleteSnapshotSchedule request, you identify the\n volume by providing its Amazon Resource Name (ARN). This operation is only supported in\n stored and cached volume gateway types.

\n\n \n\n

To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to DescribeSnapshots\n in the Amazon Elastic Compute Cloud API Reference.

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

Deletes a snapshot of a volume.

\n\n

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API\n action enables you to delete a snapshot schedule for a volume. For more information, see\n Backing up your\n volumes. In the DeleteSnapshotSchedule request, you identify the\n volume by providing its Amazon Resource Name (ARN). This operation is only supported for\n cached volume gateway types.

\n\n \n\n

To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to DescribeSnapshots\n in the Amazon Elastic Compute Cloud API Reference.

\n " } }, "com.amazonaws.storagegateway#DeleteSnapshotScheduleInput": { @@ -3122,7 +3122,7 @@ "LastSoftwareUpdate": { "target": "com.amazonaws.storagegateway#LastSoftwareUpdate", "traits": { - "smithy.api#documentation": "

The date on which the last software update was applied to the gateway. If the gateway\n has never been updated, this field does not return a value in the response.

" + "smithy.api#documentation": "

The date on which the last software update was applied to the gateway. If the gateway\n has never been updated, this field does not return a value in the response. This only only\n exist and returns once it have been chosen and set by the SGW service, based on the OS\n version of the gateway VM

" } }, "Ec2InstanceId": { @@ -3152,7 +3152,7 @@ "CloudWatchLogGroupARN": { "target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway. This field only only exist and returns once it have been\n chosen and set by the SGW service, based on the OS version of the gateway VM

" } }, "HostEnvironment": { @@ -6162,7 +6162,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

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

Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to Amazon S3.

\n\n

Storage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

\n\n \n\n

For more information, see Getting file upload notification in the Storage Gateway User\n Guide.

" + "smithy.api#documentation": "

Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to S3. Amazon S3.

\n\n

Storage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.

\n\n \n\n

For more information, see Getting file upload notification in the Storage Gateway User\n Guide.

" } }, "com.amazonaws.storagegateway#NotifyWhenUploadedInput": { @@ -6564,7 +6564,7 @@ } ], "traits": { - "smithy.api#documentation": "

Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.

\n

You can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.

\n\n

When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.

\n\n

Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

\n\n

If you invoke the RefreshCache API when two requests are already being processed, any\n new request will cause an InvalidGatewayRequestException error because too\n many requests were sent to the server.

\n\n \n\n

For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

" + "smithy.api#documentation": "

Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.

\n\n

You can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.

\n\n

When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.

\n\n

Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

\n\n \n \n \n\n \n

The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.

\n \n\n \n\n

For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.

" } }, "com.amazonaws.storagegateway#RefreshCacheInput": { @@ -6911,7 +6911,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -7902,7 +7902,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

" } }, "Worm": { @@ -7935,7 +7935,7 @@ "min": 50, "max": 500 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{7,16}$" + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{5,16}$" } }, "com.amazonaws.storagegateway#TapeARNs": { @@ -8004,7 +8004,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that was used to archive the tape. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that was used to archive the tape. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool.

" } }, "Worm": { @@ -8043,7 +8043,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 7, + "min": 5, "max": 16 }, "smithy.api#pattern": "^[A-Z0-9]*$" @@ -8104,7 +8104,7 @@ "PoolId": { "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

\n\n

Valid Values: GLACIER | DEEP_ARCHIVE\n

" + "smithy.api#documentation": "

The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

" } }, "RetentionStartDate": { @@ -8766,7 +8766,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { @@ -8893,7 +8893,7 @@ "DefaultStorageClass": { "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" + "smithy.api#documentation": "

The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_STANDARD. Optional.

\n\n

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n

" } }, "ObjectACL": { diff --git a/aws/sdk/aws-models/textract.json b/aws/sdk/aws-models/textract.json index 53b0fc49b7..f1ee55b200 100644 --- a/aws/sdk/aws-models/textract.json +++ b/aws/sdk/aws-models/textract.json @@ -85,7 +85,7 @@ } ], "traits": { - "smithy.api#documentation": "

Analyzes an input document for relationships between detected items.

\n

The types of information returned are as follows:

\n \n \n

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.

\n

You can choose which type of analysis to perform by specifying the FeatureTypes list. \n

\n

The output is returned in a list of Block objects.

\n

\n AnalyzeDocument is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentAnalysis.

\n

For more information, see Document Text Analysis.

" + "smithy.api#documentation": "

Analyzes an input document for relationships between detected items.

\n

The types of information returned are as follows:

\n \n \n

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.

\n \n

You can choose which type of analysis to perform by specifying the FeatureTypes list. \n

\n

The output is returned in a list of Block objects.

\n

\n AnalyzeDocument is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentAnalysis.

\n

For more information, see Document Text Analysis.

" } }, "com.amazonaws.textract#AnalyzeDocumentRequest": { @@ -94,7 +94,7 @@ "Document": { "target": "com.amazonaws.textract#Document", "traits": { - "smithy.api#documentation": "

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Textract operations, you can't pass image bytes. The document must be an image \n in JPEG or PNG format.

\n

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes that are passed using the Bytes field.

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

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Textract operations, you can't pass image bytes. The document must be an image \n in JPEG, PNG, PDF, or TIFF format.

\n

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes that are passed using the Bytes field.

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

Sets the configuration for the human in the loop workflow for analyzing documents.

" } + }, + "QueriesConfig": { + "target": "com.amazonaws.textract#QueriesConfig", + "traits": { + "smithy.api#documentation": "

Contains Queries and the alias for those Queries, as determined by the input.

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

Analyzes identity documents for relevant information. This information is extracted\n and returned as IdentityDocumentFields, which records both the normalized\n field and value of the extracted text.

" + "smithy.api#documentation": "

Analyzes identity documents for relevant information. This information is extracted\n and returned as IdentityDocumentFields, which records both the normalized\n field and value of the extracted text.Unlike other Amazon Textract operations, AnalyzeID \n doesn't return any Geometry data.

" } }, "com.amazonaws.textract#AnalyzeIDDetections": { @@ -329,7 +335,7 @@ "BlockType": { "target": "com.amazonaws.textract#BlockType", "traits": { - "smithy.api#documentation": "

The type of text item that's recognized. In operations for text detection, the following\n types are returned:

\n \n

In text analysis operations, the following types are returned:

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

The type of text item that's recognized. In operations for text detection, the following\n types are returned:

\n \n

In text analysis operations, the following types are returned:

\n " } }, "Confidence": { @@ -409,6 +415,12 @@ "traits": { "smithy.api#documentation": "

The page on which a block was detected. Page is returned by asynchronous\n operations. Page values greater than 1 are only returned for multipage documents that are\n in PDF or TIFF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is\n considered to be a single-page document. The value of Page is always 1.\n Synchronous operations don't return Page because every input document is\n considered to be a single-page document.

" } + }, + "Query": { + "target": "com.amazonaws.textract#Query", + "traits": { + "smithy.api#documentation": "

" + } } }, "traits": { @@ -460,6 +472,14 @@ { "value": "TITLE", "name": "TITLE" + }, + { + "value": "QUERY", + "name": "QUERY" + }, + { + "value": "QUERY_RESULT", + "name": "QUERY_RESULT" } ] } @@ -571,7 +591,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects text in the input document. Amazon Textract can detect lines of text and the\n words that make up a line of text. The input document must be an image in JPEG or PNG\n format. DetectDocumentText returns the detected text in an array of Block objects.

\n

Each document page has as an associated Block of type PAGE. Each PAGE Block object\n is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is\n a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

\n \n

\n DetectDocumentText is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentTextDetection.

\n

For more information, see Document Text Detection.

" + "smithy.api#documentation": "

Detects text in the input document. Amazon Textract can detect lines of text and the\n words that make up a line of text. The input document must be an image in JPEG, PNG, PDF, or TIFF\n format. DetectDocumentText returns the detected text in an array of Block objects.

\n

Each document page has as an associated Block of type PAGE. Each PAGE Block object\n is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is\n a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

\n \n

\n DetectDocumentText is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentTextDetection.

\n

For more information, see Document Text Detection.

" } }, "com.amazonaws.textract#DetectDocumentTextRequest": { @@ -836,6 +856,10 @@ { "value": "FORMS", "name": "FORMS" + }, + { + "value": "QUERIES", + "name": "QUERIES" } ] } @@ -913,7 +937,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

\n

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier\n (JobId). When the text analysis operation finishes, Amazon Textract publishes a\n completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to\n StartDocumentAnalysis. To get the results of the text-detection operation,\n first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetDocumentAnalysis, and pass the job identifier\n (JobId) from the initial call to StartDocumentAnalysis.

\n

\n GetDocumentAnalysis returns an array of Block objects. The following\n types of information are returned:

\n \n \n

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.

\n \n \n \n

Use the MaxResults parameter to limit the number of blocks that are\n returned. If there are more results than specified in MaxResults, the value of\n NextToken in the operation response contains a pagination token for getting\n the next set of results. To get the next page of results, call\n GetDocumentAnalysis, and populate the NextToken request\n parameter with the token value that's returned from the previous call to\n GetDocumentAnalysis.

\n

For more information, see Document Text Analysis.

" + "smithy.api#documentation": "

Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

\n

You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier\n (JobId). When the text analysis operation finishes, Amazon Textract publishes a\n completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to\n StartDocumentAnalysis. To get the results of the text-detection operation,\n first check that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetDocumentAnalysis, and pass the job identifier\n (JobId) from the initial call to StartDocumentAnalysis.

\n

\n GetDocumentAnalysis returns an array of Block objects. The following\n types of information are returned:

\n \n \n

Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT Block object contains information about a selection element,\n including the selection status.

\n \n \n

Use the MaxResults parameter to limit the number of blocks that are\n returned. If there are more results than specified in MaxResults, the value of\n NextToken in the operation response contains a pagination token for getting\n the next set of results. To get the next page of results, call\n GetDocumentAnalysis, and populate the NextToken request\n parameter with the token value that's returned from the previous call to\n GetDocumentAnalysis.

\n

For more information, see Document Text Analysis.

" } }, "com.amazonaws.textract#GetDocumentAnalysisRequest": { @@ -1750,6 +1774,90 @@ "smithy.api#error": "client" } }, + "com.amazonaws.textract#Queries": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#Query" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.textract#QueriesConfig": { + "type": "structure", + "members": { + "Queries": { + "target": "com.amazonaws.textract#Queries", + "traits": { + "smithy.api#documentation": "

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

" + } + }, + "com.amazonaws.textract#Query": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.textract#QueryInput", + "traits": { + "smithy.api#documentation": "

Question that Amazon Textract will apply to the document. An example would be \"What is the customer's SSN?\"

", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.textract#QueryInput", + "traits": { + "smithy.api#documentation": "

Alias attached to the query, for ease of location.

" + } + }, + "Pages": { + "target": "com.amazonaws.textract#QueryPages", + "traits": { + "smithy.api#documentation": "

List of pages associated with the query. The following is a list of rules for using this parameter.

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

Each query contains the question you want to ask in the Text and the alias you want to associate.

" + } + }, + "com.amazonaws.textract#QueryInput": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s!\"\\#\\$%'&\\(\\)\\*\\+\\,\\-\\./:;=\\?@\\[\\\\\\]\\^_`\\{\\|\\}~><]+$" + } + }, + "com.amazonaws.textract#QueryPage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 9 + }, + "smithy.api#pattern": "^[0-9\\*\\-]+$" + } + }, + "com.amazonaws.textract#QueryPages": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#QueryPage" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.textract#Relationship": { "type": "structure", "members": { @@ -1799,6 +1907,10 @@ { "value": "TITLE", "name": "TITLE" + }, + { + "value": "ANSWER", + "name": "ANSWER" } ] } @@ -1990,6 +2102,9 @@ "traits": { "smithy.api#documentation": "

The KMS key used to encrypt the inference results. This can be \n in either Key ID or Key Alias format. When a KMS key is provided, the \n KMS key will be used for server-side encryption of the objects in the \n customer bucket. When this parameter is not enabled, the result will \n be encrypted server side,using SSE-S3.

" } + }, + "QueriesConfig": { + "target": "com.amazonaws.textract#QueriesConfig" } } }, @@ -2327,7 +2442,7 @@ } }, "traits": { - "smithy.api#documentation": "

The format of the input document isn't supported. Documents for synchronous operations can be in\n PNG or JPEG format only. Documents for asynchronous operations can be in PDF format.

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

The format of the input document isn't supported. Documents for operations can be in\n PNG, JPEG, PDF, or TIFF format.

", "smithy.api#error": "client" } }, diff --git a/aws/sdk/aws-models/transfer.json b/aws/sdk/aws-models/transfer.json index f132f531e4..227dddd613 100644 --- a/aws/sdk/aws-models/transfer.json +++ b/aws/sdk/aws-models/transfer.json @@ -179,7 +179,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "Policy": { @@ -422,7 +422,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n\n

\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n

\n\n

In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n\n

\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n

\n\n

In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the HomeDirectory\n parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "Policy": { @@ -535,7 +535,7 @@ "Steps": { "target": "com.amazonaws.transfer#WorkflowSteps", "traits": { - "smithy.api#documentation": "

Specifies the details for the steps that are in the specified workflow.

\n

\n The TYPE specifies which of the following actions is being taken for this step.\n

\n \n \n

\n Currently, copying and tagging are supported only on S3.\n

\n \n

\n For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.\n

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

Specifies the details for the steps that are in the specified workflow.

\n

\n The TYPE specifies which of the following actions is being taken for this step.\n

\n \n \n

\n Currently, copying and tagging are supported only on S3.\n

\n \n

\n For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.\n

", "smithy.api#required": {} } }, @@ -640,6 +640,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteAccessRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -682,6 +685,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteServerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#AccessDeniedException" @@ -720,6 +726,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteSshPublicKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -792,6 +801,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -834,6 +846,9 @@ "input": { "target": "com.amazonaws.transfer#DeleteWorkflowRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#AccessDeniedException" @@ -1888,7 +1903,7 @@ "StepType": { "target": "com.amazonaws.transfer#WorkflowStepType", "traits": { - "smithy.api#documentation": "

One of the available step types.

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

One of the available step types.

\n " } }, "Outputs": { @@ -1995,7 +2010,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an object that contains entries and targets for\n HomeDirectoryMappings.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Represents an object that contains entries and targets for\n HomeDirectoryMappings.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "com.amazonaws.transfer#HomeDirectoryMappings": { @@ -3738,6 +3753,9 @@ "input": { "target": "com.amazonaws.transfer#StartServerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -3820,6 +3838,9 @@ "input": { "target": "com.amazonaws.transfer#StopServerRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -3910,6 +3931,9 @@ "input": { "target": "com.amazonaws.transfer#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -4245,6 +4269,9 @@ "input": { "target": "com.amazonaws.transfer#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transfer#InternalServiceError" @@ -4329,7 +4356,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to / and set Target to the\n HomeDirectory parameter value.

\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "Policy": { @@ -4563,7 +4590,7 @@ "HomeDirectoryMappings": { "target": "com.amazonaws.transfer#HomeDirectoryMappings", "traits": { - "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]\n

\n\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

\n\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" + "smithy.api#documentation": "

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should\n be visible to your user and how you want to make them visible. You must specify the\n Entry and Target pair, where Entry shows how the path\n is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you\n only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity\n and Access Management (IAM) role provides access to paths in Target. This value\n can only be set when HomeDirectoryType is set to\n LOGICAL.

\n\n

The following is an Entry and Target pair example.

\n

\n [ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

\n\n

In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"chroot\"). To do this, you can set\n Entry to '/' and set Target to the HomeDirectory\n parameter value.

\n\n

The following is an Entry and Target pair example for chroot.

\n

\n [ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]\n

" } }, "Policy": { @@ -4761,7 +4788,7 @@ "Type": { "target": "com.amazonaws.transfer#WorkflowStepType", "traits": { - "smithy.api#documentation": "

\n Currently, the following step types are supported.\n

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

\n Currently, the following step types are supported.\n

\n " } }, "CopyStepDetails": { diff --git a/aws/sdk/aws-models/wisdom.json b/aws/sdk/aws-models/wisdom.json index 40d9e90e73..8dc83c2a97 100644 --- a/aws/sdk/aws-models/wisdom.json +++ b/aws/sdk/aws-models/wisdom.json @@ -27,7 +27,7 @@ "objectFields": { "target": "com.amazonaws.wisdom#ObjectFieldsList", "traits": { - "smithy.api#documentation": "

The fields from the source that are made available to your agents in Wisdom.

\n \n

Make sure to include additional field(s); these are indexed and used to source\n recommendations.

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

The fields from the source that are made available to your agents in Wisdom.

\n \n

Make sure to include additional fields. These fields are indexed and used to source\n recommendations.

", "smithy.api#required": {} } } @@ -85,10 +85,7 @@ ], "traits": { "aws.api#arn": { - "template": "assistant/{assistantId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "assistant/{assistantId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} @@ -118,10 +115,7 @@ }, "traits": { "aws.api#arn": { - "template": "association/{assistantId}/{assistantAssociationId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "association/{assistantId}/{assistantAssociationId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} @@ -154,7 +148,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

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

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } }, @@ -194,7 +188,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the knowledge base.

" } } }, @@ -243,7 +237,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

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

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } }, @@ -296,7 +290,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

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

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } }, @@ -394,7 +388,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

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

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } }, @@ -518,10 +512,7 @@ ], "traits": { "aws.api#arn": { - "template": "content/{knowledgeBaseId}/{contentId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "content/{knowledgeBaseId}/{contentId}" }, "aws.iam#disableConditionKeyInference": {} } @@ -553,7 +544,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

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

The identifier of the knowledge base.

", "smithy.api#required": {} } }, @@ -615,8 +606,7 @@ "target": "com.amazonaws.wisdom#Url", "traits": { "smithy.api#documentation": "

The URL of the content.

", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "urlExpiry": { @@ -647,6 +637,12 @@ }, "value": { "target": "com.amazonaws.wisdom#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } } }, "com.amazonaws.wisdom#ContentReference": { @@ -661,7 +657,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the knowledge base.

" } }, "contentArn": { @@ -743,7 +739,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

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

The identifier of the knowledge base.

", "smithy.api#required": {} } }, @@ -826,7 +822,7 @@ "com.amazonaws.wisdom#ContentType": { "type": "string", "traits": { - "smithy.api#pattern": "^(text/(plain|html))|(application/x\\.wisdom-json;source=(salesforce|servicenow))$" + "smithy.api#pattern": "^(text/(plain|html))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" } }, "com.amazonaws.wisdom#CreateAssistant": { @@ -854,9 +850,8 @@ "traits": { "smithy.api#documentation": "

Creates an Amazon Connect Wisdom assistant.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -889,9 +884,8 @@ "traits": { "smithy.api#documentation": "

Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the\n only supported association is with a knowledge base. An assistant can have only a single\n association.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/associations", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1030,9 +1024,8 @@ "traits": { "smithy.api#documentation": "

Creates Wisdom content. Before to calling this API, use StartContentUpload to\n upload an asset.

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/contents", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1043,7 +1036,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

Creates a knowledge base.

\n \n

When using this API, you cannot reuse Amazon AppIntegrations\n DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do,\n you'll get an InvalidRequestException error.

\n\n

For example, you're programmatically managing your external knowledge base, and you want\n to add or remove one of the fields that is being ingested from Salesforce. Do the\n following:

\n
    \n
  1. \n

    Call DeleteKnowledgeBase.

    \n
    2. \n
  2. \n

    Call DeleteDataIntegration.

    \n
    3. \n
  3. \n

    Call CreateDataIntegration to recreate the DataIntegration or a create different\n one.

    \n
    4. \n
  4. \n

    Call CreateKnowledgeBase.

    \n
    5. \n
\n ", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1227,9 +1219,8 @@ "traits": { "smithy.api#documentation": "

Creates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is\n enabled.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/sessions", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -1306,8 +1297,8 @@ "traits": { "smithy.api#documentation": "

Deletes an assistant.

", "smithy.api#http": { - "method": "DELETE", "uri": "/assistants/{assistantId}", + "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} @@ -1335,8 +1326,8 @@ "traits": { "smithy.api#documentation": "

Deletes an assistant association.

", "smithy.api#http": { - "method": "DELETE", "uri": "/assistants/{assistantId}/associations/{assistantAssociationId}", + "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} @@ -1406,8 +1397,8 @@ "traits": { "smithy.api#documentation": "

Deletes the content.

", "smithy.api#http": { - "method": "DELETE", "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} @@ -1419,7 +1410,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1455,13 +1446,16 @@ }, { "target": "com.amazonaws.wisdom#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wisdom#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the knowledge base.

\n \n

When you use this API to delete an external knowledge base such as Salesforce or\n ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration.\n This is because you can't reuse the DataIntegration after it's been associated with an\n external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API\n Reference.

\n ", "smithy.api#http": { - "method": "DELETE", "uri": "/knowledgeBases/{knowledgeBaseId}", + "method": "DELETE", "code": 204 }, "smithy.api#idempotent": {} @@ -1525,10 +1519,9 @@ "type": "structure", "members": { "text": { - "target": "smithy.api#String", + "target": "com.amazonaws.wisdom#SensitiveString", "traits": { - "smithy.api#documentation": "

Text in the document.

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

Text in the document.

" } }, "highlights": { @@ -1631,9 +1624,8 @@ "traits": { "smithy.api#documentation": "

Retrieves information about an assistant.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1660,9 +1652,8 @@ "traits": { "smithy.api#documentation": "

Retrieves information about an assistant association.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}/associations/{assistantAssociationId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1745,9 +1736,8 @@ "traits": { "smithy.api#documentation": "

Retrieves content, including a pre-signed URL to download the content.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1766,7 +1756,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

Retrieves summary information about the content.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1827,7 +1816,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

Retrieves information about the knowledge base.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases/{knowledgeBaseId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1880,7 +1868,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

Retrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the\n waitTimeSeconds parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -1971,6 +1958,12 @@ "smithy.api#documentation": "

The recommendations.

", "smithy.api#required": {} } + }, + "triggers": { + "target": "com.amazonaws.wisdom#RecommendationTriggerList", + "traits": { + "smithy.api#documentation": "

The triggers corresponding to recommendations.

" + } } } }, @@ -1996,9 +1989,8 @@ "traits": { "smithy.api#documentation": "

Retrieves information for a specified session.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}/sessions/{sessionId}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2113,10 +2105,7 @@ ], "traits": { "aws.api#arn": { - "template": "knowledge-base/{knowledgeBaseId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "knowledge-base/{knowledgeBaseId}" }, "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} @@ -2128,7 +2117,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the knowledge base.

" } }, "knowledgeBaseArn": { @@ -2148,7 +2137,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

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

The identifier of the knowledge base.

", "smithy.api#required": {} } }, @@ -2270,7 +2259,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#Uuid", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base.

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

The identifier of the knowledge base.

", "smithy.api#required": {} } }, @@ -2305,7 +2294,7 @@ "sourceConfiguration": { "target": "com.amazonaws.wisdom#SourceConfiguration", "traits": { - "smithy.api#documentation": "

[KEVIN]

" + "smithy.api#documentation": "

Configuration information about the external data source.

" } }, "renderingConfiguration": { @@ -2379,15 +2368,14 @@ "traits": { "smithy.api#documentation": "

Lists information about assistant associations.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants/{assistantId}/associations", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "assistantAssociationSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "assistantAssociationSummaries" }, "smithy.api#readonly": {} } @@ -2456,15 +2444,14 @@ "traits": { "smithy.api#documentation": "

Lists information about assistants.

", "smithy.api#http": { - "method": "GET", "uri": "/assistants", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "assistantSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "assistantSummaries" }, "smithy.api#readonly": {} } @@ -2528,15 +2515,14 @@ "traits": { "smithy.api#documentation": "

Lists the content.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases/{knowledgeBaseId}/contents", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "contentSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "contentSummaries" }, "smithy.api#readonly": {} } @@ -2561,7 +2547,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2605,15 +2591,14 @@ "traits": { "smithy.api#documentation": "

Lists the knowledge bases.

", "smithy.api#http": { - "method": "GET", "uri": "/knowledgeBases", - "code": 200 + "method": "GET" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "knowledgeBaseSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "knowledgeBaseSummaries" }, "smithy.api#readonly": {} } @@ -2671,9 +2656,8 @@ "traits": { "smithy.api#documentation": "

Lists the tags for the specified resource.

", "smithy.api#http": { - "method": "GET", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -2762,9 +2746,8 @@ "traits": { "smithy.api#documentation": "

Removes the specified recommendations from the specified assistant's queue of newly\n available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling\n behavior and avoiding duplicate recommendations.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -2890,17 +2873,19 @@ "traits": { "smithy.api#documentation": "

Performs a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use GetRecommendations.\n

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/query", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "results", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "results" }, - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] } }, "com.amazonaws.wisdom#QueryAssistantRequest": { @@ -2953,6 +2938,20 @@ } } }, + "com.amazonaws.wisdom#QueryRecommendationTriggerData": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.wisdom#QueryText", + "traits": { + "smithy.api#documentation": "

The text associated with the recommendation trigger.

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

Data associated with the QUERY RecommendationTriggerType.

" + } + }, "com.amazonaws.wisdom#QueryResultsList": { "type": "list", "member": { @@ -2993,6 +2992,12 @@ "traits": { "smithy.api#documentation": "

The relevance level of the recommendation.

" } + }, + "type": { + "target": "com.amazonaws.wisdom#RecommendationType", + "traits": { + "smithy.api#documentation": "

The type of recommendation.

" + } } }, "traits": { @@ -3011,6 +3016,110 @@ "target": "com.amazonaws.wisdom#RecommendationData" } }, + "com.amazonaws.wisdom#RecommendationSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ISSUE_DETECTION", + "name": "ISSUE_DETECTION" + }, + { + "value": "RULE_EVALUATION", + "name": "RULE_EVALUATION" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.wisdom#RecommendationTrigger": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.wisdom#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the recommendation trigger.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.wisdom#RecommendationTriggerType", + "traits": { + "smithy.api#documentation": "

The type of recommendation trigger.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.wisdom#RecommendationSourceType", + "traits": { + "smithy.api#documentation": "

The source of the recommendation trigger.

\n ", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.wisdom#RecommendationTriggerData", + "traits": { + "smithy.api#documentation": "

A union type containing information related to the trigger.

", + "smithy.api#required": {} + } + }, + "recommendationIds": { + "target": "com.amazonaws.wisdom#RecommendationIdList", + "traits": { + "smithy.api#documentation": "

The identifiers of the recommendations.

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

A recommendation trigger provides context on the event that produced the referenced recommendations.\n Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

" + } + }, + "com.amazonaws.wisdom#RecommendationTriggerData": { + "type": "union", + "members": { + "query": { + "target": "com.amazonaws.wisdom#QueryRecommendationTriggerData", + "traits": { + "smithy.api#documentation": "

Data associated with the QUERY RecommendationTriggerType.

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

A union type containing information related to the trigger.

" + } + }, + "com.amazonaws.wisdom#RecommendationTriggerList": { + "type": "list", + "member": { + "target": "com.amazonaws.wisdom#RecommendationTrigger" + } + }, + "com.amazonaws.wisdom#RecommendationTriggerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUERY", + "name": "QUERY" + } + ] + } + }, + "com.amazonaws.wisdom#RecommendationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_CONTENT", + "name": "KNOWLEDGE_CONTENT" + } + ] + } + }, "com.amazonaws.wisdom#RelevanceLevel": { "type": "string", "traits": { @@ -3060,8 +3169,8 @@ "traits": { "smithy.api#documentation": "

Removes a URI template from a knowledge base.

", "smithy.api#http": { - "method": "DELETE", "uri": "/knowledgeBases/{knowledgeBaseId}/templateUri", + "method": "DELETE", "code": 204 } } @@ -3072,7 +3181,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3166,15 +3275,14 @@ "traits": { "smithy.api#documentation": "

Searches for content in a specified knowledge base. Can be used to get a specific content\n resource by its name.

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/search", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "contentSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "contentSummaries" }, "smithy.api#readonly": {} } @@ -3199,7 +3307,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3268,15 +3376,14 @@ "traits": { "smithy.api#documentation": "

Searches for sessions.

", "smithy.api#http": { - "method": "POST", "uri": "/assistants/{assistantId}/searchSessions", - "code": 200 + "method": "POST" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "sessionSummaries", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "sessionSummaries" }, "smithy.api#readonly": {} } @@ -3333,13 +3440,19 @@ } } }, + "com.amazonaws.wisdom#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.wisdom#ServerSideEncryptionConfiguration": { "type": "structure", "members": { "kmsKeyId": { "target": "com.amazonaws.wisdom#NonEmptyString", "traits": { - "smithy.api#documentation": "

The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The KMS key. For information about valid ID values, see Key identifiers (KeyId).

" } } }, @@ -3378,10 +3491,7 @@ }, "traits": { "aws.api#arn": { - "template": "session/{assistantId}/{sessionId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "session/{assistantId}/{sessionId}" }, "aws.iam#disableConditionKeyInference": {} } @@ -3460,7 +3570,7 @@ "assistantArn": { "target": "com.amazonaws.wisdom#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Wisdom assistant

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

The Amazon Resource Name (ARN) of the Wisdom assistant.

", "smithy.api#required": {} } } @@ -3505,9 +3615,8 @@ "traits": { "smithy.api#documentation": "

Get a URL to upload content to a knowledge base. To upload content, first make a PUT\n request to the returned URL with your file, making sure to include the required headers. Then\n use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a\n knowledge base of type CUSTOM.

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/upload", - "code": 200 + "method": "POST" } } }, @@ -3517,7 +3626,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3545,8 +3654,7 @@ "target": "com.amazonaws.wisdom#Url", "traits": { "smithy.api#documentation": "

The URL of the upload.

", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "urlExpiry": { @@ -3607,9 +3715,8 @@ "traits": { "smithy.api#documentation": "

Adds the specified tags to the specified resource.

", "smithy.api#http": { - "method": "POST", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -3691,9 +3798,8 @@ "traits": { "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", "smithy.api#http": { - "method": "DELETE", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "DELETE" }, "smithy.api#idempotent": {} } @@ -3748,9 +3854,8 @@ "traits": { "smithy.api#documentation": "

Updates information about the content.

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", - "code": 200 + "method": "POST" } } }, @@ -3760,7 +3865,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN

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

The identifier of the knowledge base. Can be either the ID or the ARN

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

Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in ${variable} format; this\n interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce\n article, it has an Id value, and you can set the template URI to\n https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.\n

", "smithy.api#http": { - "method": "POST", "uri": "/knowledgeBases/{knowledgeBaseId}/templateUri", - "code": 200 + "method": "POST" } } }, @@ -3856,7 +3960,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.wisdom#UuidOrArn", "traits": { - "smithy.api#documentation": "

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3896,7 +4000,8 @@ "smithy.api#length": { "min": 1, "max": 4096 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.wisdom#Uuid": { @@ -3919,7 +4024,7 @@ } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

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

The input fails to satisfy the constraints specified by a service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3935,6 +4040,20 @@ }, "com.amazonaws.wisdom#WisdomService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Wisdom", + "arnNamespace": "wisdom", + "cloudFormationName": "Wisdom" + }, + "aws.auth#sigv4": { + "name": "wisdom" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively\n speaking with customers. Agents can search across connected repositories from within their agent desktop\n to find answers quickly. Use the Amazon Connect Wisdom APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

", + "smithy.api#title": "Amazon Connect Wisdom Service" + }, "version": "2020-10-19", "operations": [ { @@ -3954,23 +4073,7 @@ { "target": "com.amazonaws.wisdom#KnowledgeBase" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Wisdom", - "arnNamespace": "wisdom", - "cloudFormationName": "Wisdom", - "cloudTrailEventSource": "wisdom.amazonaws.com", - "endpointPrefix": "wisdom" - }, - "aws.auth#sigv4": { - "name": "wisdom" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": {}, - "smithy.api#documentation": "

All Amazon Connect Wisdom functionality is accessible using the API. For example, you can create an\n assistant and a knowledge base.

\n\n

Some more advanced features are only accessible using the Wisdom API. For example, you\n can manually manage content by uploading custom files and control their lifecycle.

", - "smithy.api#title": "Amazon Connect Wisdom Service" - } + ] } } } diff --git a/aws/sdk/aws-models/worklink.json b/aws/sdk/aws-models/worklink.json index 1ee3df9773..7b8ca00780 100644 --- a/aws/sdk/aws-models/worklink.json +++ b/aws/sdk/aws-models/worklink.json @@ -32,7 +32,7 @@ "com.amazonaws.worklink#AcmCertificateArn": { "type": "string", "traits": { - "smithy.api#pattern": "arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*" + "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*$" } }, "com.amazonaws.worklink#AssociateDomain": { @@ -64,6 +64,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Specifies a domain to be associated to Amazon WorkLink.

", "smithy.api#http": { "method": "POST", @@ -137,6 +140,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

", "smithy.api#http": { "method": "POST", @@ -210,6 +216,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Imports the root certificate of a certificate authority (CA) used to obtain TLS\n certificates used by associated websites within the company network.

", "smithy.api#http": { "method": "POST", @@ -284,7 +293,7 @@ "min": 1, "max": 8192 }, - "smithy.api#pattern": "-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" + "smithy.api#pattern": "^-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?$" } }, "com.amazonaws.worklink#CertificateChain": { @@ -294,7 +303,7 @@ "min": 1, "max": 32768 }, - "smithy.api#pattern": "(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" + "smithy.api#pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?$" } }, "com.amazonaws.worklink#CompanyCode": { @@ -335,6 +344,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Creates a fleet. A fleet consists of resources and the configuration that delivers\n associated websites to authorized users who download and set up the Amazon WorkLink app.

", "smithy.api#http": { "method": "POST", @@ -413,6 +425,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Deletes a fleet. Prevents users from accessing previously associated websites.

", "smithy.api#http": { "method": "POST", @@ -463,6 +478,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Describes the configuration for delivering audit streams to the customer account.

", "smithy.api#http": { "method": "POST", @@ -520,6 +538,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Describes the networking configuration to access the internal websites associated with\n the specified fleet.

", "smithy.api#http": { "method": "POST", @@ -589,6 +610,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Provides information about a user's device.

", "smithy.api#http": { "method": "POST", @@ -623,6 +647,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Describes the device policy configuration for the specified fleet.

", "smithy.api#http": { "method": "POST", @@ -758,6 +785,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Provides information about the domain.

", "smithy.api#http": { "method": "POST", @@ -846,6 +876,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Provides basic information for the specified fleet, excluding identity provider,\n networking, and device configuration details.

", "smithy.api#http": { "method": "POST", @@ -945,6 +978,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Describes the identity provider configuration of the specified fleet.

", "smithy.api#http": { "method": "POST", @@ -1014,6 +1050,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Provides information about the certificate authority.

", "smithy.api#http": { "method": "POST", @@ -1176,6 +1215,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

", "smithy.api#http": { "method": "POST", @@ -1236,6 +1278,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Disassociates a website authorization provider from a specified fleet. After the\n disassociation, users can't load any associated websites that require this authorization\n provider.

", "smithy.api#http": { "method": "POST", @@ -1293,6 +1338,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Removes a certificate authority (CA).

", "smithy.api#http": { "method": "POST", @@ -1610,6 +1658,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of devices registered with the specified fleet.

", "smithy.api#http": { "method": "POST", @@ -1690,6 +1741,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of domains associated to a specified fleet.

", "smithy.api#http": { "method": "POST", @@ -1767,6 +1821,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of fleets for the current account and Region.

", "smithy.api#http": { "method": "POST", @@ -1828,6 +1885,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of tags for the specified resource.

", "smithy.api#http": { "method": "GET", @@ -1886,6 +1946,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of website authorization providers associated with a specified fleet.

", "smithy.api#http": { "method": "POST", @@ -1963,6 +2026,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Retrieves a list of certificate authorities added for the current account and\n Region.

", "smithy.api#http": { "method": "POST", @@ -2033,7 +2099,7 @@ "min": 1, "max": 4096 }, - "smithy.api#pattern": "[\\w\\-]+" + "smithy.api#pattern": "^[\\w\\-]+$" } }, "com.amazonaws.worklink#ResourceAlreadyExistsException": { @@ -2088,6 +2154,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Moves a domain to ACTIVE status if it was in the INACTIVE status.

", "smithy.api#http": { "method": "POST", @@ -2145,6 +2214,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Moves a domain to INACTIVE status if it was in the ACTIVE status.

", "smithy.api#http": { "method": "POST", @@ -2229,6 +2301,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Signs the user out from all of their devices. The user can sign in again if they have\n valid credentials.

", "smithy.api#http": { "method": "POST", @@ -2323,6 +2398,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

", "smithy.api#http": { "method": "POST", @@ -2404,6 +2482,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Removes one or more tags from the specified resource.

", "smithy.api#http": { "method": "DELETE", @@ -2463,6 +2544,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates the audit stream configuration for the fleet.

", "smithy.api#http": { "method": "POST", @@ -2519,6 +2603,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates the company network configuration for the fleet.

", "smithy.api#http": { "method": "POST", @@ -2590,6 +2677,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates the device policy configuration for the fleet.

", "smithy.api#http": { "method": "POST", @@ -2646,6 +2736,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates domain metadata, such as DisplayName.

", "smithy.api#http": { "method": "POST", @@ -2709,6 +2802,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates fleet metadata, such as DisplayName.

", "smithy.api#http": { "method": "POST", @@ -2771,6 +2867,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." + }, "smithy.api#documentation": "

Updates the identity provider configuration for the fleet.

", "smithy.api#http": { "method": "POST", @@ -2896,6 +2995,21 @@ }, "com.amazonaws.worklink#WorkLink": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "WorkLink", + "arnNamespace": "worklink", + "cloudFormationName": "WorkLink", + "cloudTrailEventSource": "worklink.amazonaws.com", + "endpointPrefix": "worklink" + }, + "aws.auth#sigv4": { + "name": "worklink" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon WorkLink is a cloud-based service that provides secure access\n to internal websites and web apps from iOS and Android phones. In a single step, your users, such as\n employees, can access internal websites as efficiently as they access any other public website.\n They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink\n authenticates the user's access and securely renders authorized internal web content in a secure\n rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on\n mobile devices.

", + "smithy.api#title": "Amazon WorkLink" + }, "version": "2018-09-25", "operations": [ { @@ -2997,22 +3111,7 @@ { "target": "com.amazonaws.worklink#UpdateIdentityProviderConfiguration" } - ], - "traits": { - "aws.api#service": { - "sdkId": "WorkLink", - "arnNamespace": "worklink", - "cloudFormationName": "WorkLink", - "cloudTrailEventSource": "worklink.amazonaws.com", - "endpointPrefix": "worklink" - }, - "aws.auth#sigv4": { - "name": "worklink" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon WorkLink is a cloud-based service that provides secure access\n to internal websites and web apps from iOS and Android phones. In a single step, your users, such as\n employees, can access internal websites as efficiently as they access any other public website.\n They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink\n authenticates the user's access and securely renders authorized internal web content in a secure\n rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on\n mobile devices.

", - "smithy.api#title": "Amazon WorkLink" - } + ] } } } diff --git a/gradle.properties b/gradle.properties index ecd78ea30f..bc5815c2dd 100644 --- a/gradle.properties +++ b/gradle.properties @@ -8,10 +8,10 @@ rust.msrv=1.58.1 # Version number to use for the generated SDK # Note: these must always be full 3-segment semver versions -aws.sdk.version=0.10.1 +aws.sdk.version=0.11.0 # Version number to use for the generated runtime crates -smithy.rs.runtime.crate.version=0.40.2 +smithy.rs.runtime.crate.version=0.41.0 kotlin.code.style=official diff --git a/tools/sdk-lints/Cargo.lock b/tools/sdk-lints/Cargo.lock index 7b69a845b6..c07c0af3c1 100644 --- a/tools/sdk-lints/Cargo.lock +++ b/tools/sdk-lints/Cargo.lock @@ -121,6 +121,43 @@ version = "2.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "308cc39be01b73d0d18f82a0e7b2a3df85245f84af96fdddc5d202d27e47b86a" +[[package]] +name = "num-integer" +version = "0.1.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2cc698a63b549a70bc047073d2949cce27cd1c7b0a4a862d08a8031bc2801db" +dependencies = [ + "autocfg", + "num-traits", +] + +[[package]] +name = "num-traits" +version = "0.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a64b1ec5cda2586e284722486d802acf1f7dbdc623e2bfc57e65ca1cd099290" +dependencies = [ + "autocfg", +] + +[[package]] +name = "num_threads" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aba1801fb138d8e85e11d0fc70baf4fe1cdfffda7c6cd34a854905df588e5ed0" +dependencies = [ + "libc", +] + +[[package]] +name = "ordinal" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c80c1530f46e9d8985706d7deb80b83172b250538902f607dea6cd6028851083" +dependencies = [ + "num-integer", +] + [[package]] name = "os_str_bytes" version = "6.0.0" @@ -180,7 +217,9 @@ dependencies = [ "cargo_toml", "clap", "lazy_static", + "ordinal", "serde", + "time", "toml", ] @@ -236,6 +275,16 @@ version = "0.15.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b1141d4d61095b28419e22cb0bbf02755f5e54e0526f97f1e3d1d160e60885fb" +[[package]] +name = "time" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2702e08a7a860f005826c6815dcac101b19b5eb330c27fe4a5928fec1d20ddd" +dependencies = [ + "libc", + "num_threads", +] + [[package]] name = "toml" version = "0.5.8" diff --git a/tools/sdk-lints/Cargo.toml b/tools/sdk-lints/Cargo.toml index d178154b79..6185ee41b0 100644 --- a/tools/sdk-lints/Cargo.toml +++ b/tools/sdk-lints/Cargo.toml @@ -17,3 +17,5 @@ clap = { version = "3.1.7", features = ["derive"]} toml = "0.5.8" serde = { version = "1", features = ["derive"]} lazy_static = "1.4.0" +time = { version = "0.3.9", features = ["local-offset"]} +ordinal = "0.3.2" diff --git a/tools/sdk-lints/src/changelog.rs b/tools/sdk-lints/src/changelog.rs index 7a2eaf8f81..8f2f0e4abf 100644 --- a/tools/sdk-lints/src/changelog.rs +++ b/tools/sdk-lints/src/changelog.rs @@ -220,7 +220,7 @@ pub(crate) fn update_changelogs( std::fs::write(path, update)?; } std::fs::write(changelog_next.as_ref(), EXAMPLE_ENTRY.trim())?; - eprintln!("Changelogs updated!"); + eprintln!("Changelogs updated:\n SDK: {aws_sdk_rust_version}\n Smithy: {smithy_rs_version}\n Date: {date}"); Ok(()) } diff --git a/tools/sdk-lints/src/main.rs b/tools/sdk-lints/src/main.rs index 2bf635e5f4..d468de0161 100644 --- a/tools/sdk-lints/src/main.rs +++ b/tools/sdk-lints/src/main.rs @@ -12,10 +12,12 @@ use crate::todos::TodosHaveContext; use anyhow::{bail, Context, Result}; use clap::Parser; use lazy_static::lazy_static; +use ordinal::Ordinal; use std::env::set_current_dir; use std::path::{Path, PathBuf}; use std::process::Command; use std::{fs, io}; +use time::OffsetDateTime; mod anchor; mod changelog; @@ -64,11 +66,11 @@ enum Args { }, UpdateChangelog { #[clap(long)] - smithy_version: String, + smithy_version: Option, #[clap(long)] - sdk_version: String, + sdk_version: Option, #[clap(long)] - date: String, + date: Option, }, } @@ -169,18 +171,55 @@ fn main() -> Result<()> { smithy_version, sdk_version, date, - } => changelog::update_changelogs( - repo_root().join("CHANGELOG.next.toml"), - repo_root().join("CHANGELOG.md"), - repo_root().join("aws/SDK_CHANGELOG.md"), - &smithy_version, - &sdk_version, - &date, - )?, + } => { + let auto = auto_changelog_meta()?; + changelog::update_changelogs( + repo_root().join("CHANGELOG.next.toml"), + repo_root().join("CHANGELOG.md"), + repo_root().join("aws/SDK_CHANGELOG.md"), + &smithy_version.unwrap_or(auto.smithy_version), + &sdk_version.unwrap_or(auto.sdk_version), + &date.unwrap_or(auto.date), + )? + } } Ok(()) } +struct ChangelogMeta { + smithy_version: String, + sdk_version: String, + date: String, +} + +/// Discover the new version for the changelog from gradle.properties and the date. +fn auto_changelog_meta() -> Result { + let gradle_props = fs::read_to_string(repo_root().join("gradle.properties"))?; + let load_gradle_prop = |key: &str| { + let prop = gradle_props + .lines() + .flat_map(|line| line.strip_prefix(key)) + .flat_map(|prop| prop.strip_prefix('=')) + .next(); + prop.map(|prop| prop.to_string()) + .ok_or_else(|| anyhow::Error::msg(format!("missing expected gradle property: {key}"))) + }; + let smithy_version = load_gradle_prop("smithy.rs.runtime.crate.version")?; + let sdk_version = load_gradle_prop("aws.sdk.version")?; + let now = OffsetDateTime::now_local()?; + let date = format!( + "{month} {day}, {year}", + month = now.date().month(), + day = Ordinal(now.date().day()), + year = now.date().year() + ); + Ok(ChangelogMeta { + smithy_version, + sdk_version, + date, + }) +} + fn ls(path: impl AsRef) -> Result> { Ok(fs::read_dir(path.as_ref()) .with_context(|| format!("failed to ls: {:?}", path.as_ref()))?