mirror of https://github.com/smithy-lang/smithy-rs
Release (#1351)
* Bump version numbers in gradle.properties * Add auto-changelog script * Update models, holding back S3 * Update CI to 1.58.1
This commit is contained in:
parent
c66ef58ce1
commit
9b6210c105
|
@ -9,7 +9,7 @@ on:
|
|||
workflow_call:
|
||||
|
||||
env:
|
||||
rust_version: 1.56.1
|
||||
rust_version: 1.58.1
|
||||
rust_toolchain_components: clippy,rustfmt
|
||||
|
||||
jobs:
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
10
CHANGELOG.md
10
CHANGELOG.md
|
@ -1,4 +1,14 @@
|
|||
<!-- Do not manually edit this file, use `update-changelogs` -->
|
||||
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)
|
||||
=========================
|
||||
|
||||
|
|
|
@ -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"
|
||||
|
|
|
@ -1,4 +1,16 @@
|
|||
<!-- Do not manually edit this file, use `update-changelogs` -->
|
||||
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)
|
||||
=========================
|
||||
|
||||
|
|
|
@ -340,7 +340,7 @@
|
|||
"repositoryCloneMethod": {
|
||||
"target": "com.amazonaws.amplify#RepositoryCloneMethod",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The authentication protocol to use to access the Git repository for an Amplify app.\n For a GitHub repository, specify <code>TOKEN</code>. For an Amazon Web Services CodeCommit repository,\n specify <code>SIGV4</code>. For GitLab and Bitbucket repositories, specify\n <code>SSH</code>.</p>"
|
||||
"smithy.api#documentation": "<note>\n <p>This is for internal use.</p>\n </note>\n <p>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 <code>TOKEN</code> for a GitHub\n repository, <code>SIGV4</code> for an Amazon Web Services CodeCommit repository, and\n <code>SSH</code> for GitLab and Bitbucket repositories.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -1001,13 +1001,13 @@
|
|||
"oauthToken": {
|
||||
"target": "com.amazonaws.amplify#OauthToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> 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. </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>Use <code>oauthToken</code> for repository providers other than GitHub, such as\n Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use\n <code>accessToken</code>.</p>\n <p>You must specify either <code>oauthToken</code> or <code>accessToken</code> when you\n create a new app.</p>\n <p>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 <a href=\"https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth\">Migrating an existing OAuth app to the Amplify GitHub App</a> in the\n <i>Amplify User Guide</i> .</p>"
|
||||
}
|
||||
},
|
||||
"accessToken": {
|
||||
"target": "com.amazonaws.amplify#AccessToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> 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. </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>Use <code>accessToken</code> for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use <code>oauthToken</code>.</p>\n <p>You must specify either <code>accessToken</code> or <code>oauthToken</code> when you\n create a new app.</p>\n <p>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 <a href=\"https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth\">Migrating an existing OAuth app to the Amplify GitHub App</a> in the\n <i>Amplify User Guide</i> .</p>"
|
||||
}
|
||||
},
|
||||
"environmentVariables": {
|
||||
|
@ -5008,13 +5008,13 @@
|
|||
"oauthToken": {
|
||||
"target": "com.amazonaws.amplify#OauthToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> 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 </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>Use <code>oauthToken</code> for repository providers other than GitHub, such as\n Bitbucket or CodeCommit.</p>\n <p>To authorize access to GitHub as your repository provider, use\n <code>accessToken</code>.</p>\n <p>You must specify either <code>oauthToken</code> or <code>accessToken</code> when you\n update an app.</p>\n <p>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 <a href=\"https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth\">Migrating an existing OAuth app to the Amplify GitHub App</a> in the\n <i>Amplify User Guide</i> .</p>"
|
||||
}
|
||||
},
|
||||
"accessToken": {
|
||||
"target": "com.amazonaws.amplify#AccessToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> 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 </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>Use <code>accessToken</code> for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use <code>oauthToken</code>.</p>\n <p>You must specify either <code>accessToken</code> or <code>oauthToken</code> when you\n update an app.</p>\n <p>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 <a href=\"https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth\">Migrating an existing OAuth app to the Amplify GitHub App</a> in the\n <i>Amplify User Guide</i> .</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
@ -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": "<p>The OAuth 2.0 credentials required for OAuth 2.0 authentication.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.appflow#OAuth2CustomParameter": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"key": {
|
||||
"target": "com.amazonaws.appflow#Key",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The key of the custom parameter required for OAuth 2.0 authentication.</p>"
|
||||
}
|
||||
},
|
||||
"isRequired": {
|
||||
"target": "com.amazonaws.appflow#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the custom parameter for OAuth 2.0 authentication is required.</p>"
|
||||
}
|
||||
},
|
||||
"label": {
|
||||
"target": "com.amazonaws.appflow#Label",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The label of the custom parameter used for OAuth 2.0 authentication.</p>"
|
||||
}
|
||||
},
|
||||
"description": {
|
||||
"target": "com.amazonaws.appflow#Description",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A description about the custom parameter used for OAuth 2.0 authentication.</p>"
|
||||
}
|
||||
},
|
||||
"isSensitiveField": {
|
||||
"target": "com.amazonaws.appflow#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether this authentication custom parameter is a sensitive field.</p>"
|
||||
}
|
||||
},
|
||||
"connectorSuppliedValues": {
|
||||
"target": "com.amazonaws.appflow#ConnectorSuppliedValueList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Contains default values for this authentication parameter that are supplied by the\n connector.</p>"
|
||||
}
|
||||
},
|
||||
"type": {
|
||||
"target": "com.amazonaws.appflow#OAuth2CustomPropType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether custom parameter is used with TokenUrl or AuthUrl.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Custom parameter required for OAuth 2.0 authentication.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>OAuth 2.0 grant types supported by the connector.</p>"
|
||||
}
|
||||
},
|
||||
"oauth2CustomProperties": {
|
||||
"target": "com.amazonaws.appflow#OAuth2CustomPropertiesList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>List of custom parameters required for OAuth 2.0 authentication.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -4940,6 +5017,12 @@
|
|||
"smithy.api#documentation": "<p>The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"tokenUrlCustomProperties": {
|
||||
"target": "com.amazonaws.appflow#TokenUrlCustomProperties",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
|
|
|
@ -1382,6 +1382,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"SessionScriptS3Location": {
|
||||
"target": "com.amazonaws.appstream#S3Location",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -4121,6 +4127,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The USB device filter strings associated with the fleet.</p>"
|
||||
}
|
||||
},
|
||||
"SessionScriptS3Location": {
|
||||
"target": "com.amazonaws.appstream#S3Location",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"SessionScriptS3Location": {
|
||||
"target": "com.amazonaws.appstream#S3Location",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets. </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
@ -35,7 +35,7 @@
|
|||
"S3AclOption": {
|
||||
"target": "com.amazonaws.athena#S3AclOption",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n <code>BUCKET_OWNER_FULL_CONTROL</code>. 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 <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl\">Canned ACL</a> in the <i>Amazon S3 User\n Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n <code>BUCKET_OWNER_FULL_CONTROL</code>. 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 <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl\">Canned ACL</a> in the <i>Amazon S3 User Guide</i>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -193,6 +193,18 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>An integer value that provides specific information about an Athena query\n error. For the meaning of specific values, see the <a href=\"https://docs.aws.amazon.com/athena/latest/ug/error-reference.html#error-reference-error-type-reference\">Error Type Reference</a> in the <i>Amazon Athena User\n Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"Retryable": {
|
||||
"target": "com.amazonaws.athena#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>True if the query might succeed if resubmitted.</p>"
|
||||
}
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"target": "com.amazonaws.athena#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Contains a short description of the error that occurred.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -1027,19 +1039,19 @@
|
|||
"EncryptionOption": {
|
||||
"target": "com.amazonaws.athena#EncryptionOption",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys\n (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys (CSE-KMS) is\n used.</p>\n <p>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. </p>",
|
||||
"smithy.api#documentation": "<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE_S3</code>), server-side encryption with KMS-managed keys\n (<code>SSE_KMS</code>), or client-side encryption with KMS-managed keys\n (<code>CSE_KMS</code>) is used.</p>\n <p>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. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"KmsKey": {
|
||||
"target": "com.amazonaws.athena#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or\n ID.</p>"
|
||||
"smithy.api#documentation": "<p>For <code>SSE_KMS</code> and <code>CSE_KMS</code>, this is the KMS key ARN or\n ID.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key\n information.</p>"
|
||||
"smithy.api#documentation": "<p>If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) and key\n information.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#EncryptionOption": {
|
||||
|
@ -2356,7 +2368,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A query, where <code>QueryString</code> contains the SQL statements that\n make up the query.</p>"
|
||||
"smithy.api#documentation": "<p>A query, where <code>QueryString</code> contains the SQL statements that make up the\n query.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#NamedQueryDescriptionString": {
|
||||
|
@ -2731,13 +2743,13 @@
|
|||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.athena#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) 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 <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
|
||||
"smithy.api#documentation": "<p>If query results are encrypted in Amazon S3, indicates the encryption option\n used (for example, <code>SSE_KMS</code> or <code>CSE_KMS</code>) 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 <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
|
||||
}
|
||||
},
|
||||
"ExpectedBucketOwner": {
|
||||
"target": "com.amazonaws.athena#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>.\n If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it\n makes Amazon S3 calls to your specified output location. If the\n <code>ExpectedBucketOwner</code>\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.</p>\n <p>This is a client-side setting. If workgroup settings override client-side settings,\n then the query uses the <code>ExpectedBucketOwner</code> setting that is specified for\n the workgroup, and also uses the location for storing query results specified in the\n workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>\n and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>.\n If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it\n makes Amazon S3 calls to your specified output location. If the\n <code>ExpectedBucketOwner</code>\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.</p>\n <p>This is a client-side setting. If workgroup settings override client-side settings,\n then the query uses the <code>ExpectedBucketOwner</code> setting that is specified for\n the workgroup, and also uses the location for storing query results specified in the\n workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>\n and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
|
||||
}
|
||||
},
|
||||
"AclConfiguration": {
|
||||
|
@ -2763,7 +2775,7 @@
|
|||
"RemoveOutputLocation": {
|
||||
"target": "com.amazonaws.athena#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>OutputLocation</code> in <code>ResultConfigurationUpdates</code> (the\n client-side setting), the <code>OutputLocation</code> in the workgroup's\n <code>ResultConfiguration</code> will be updated with the new value. For more\n information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override\n Client-Side Settings</a>.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>OutputLocation</code> in <code>ResultConfigurationUpdates</code> (the\n client-side setting), the <code>OutputLocation</code> in the workgroup's\n <code>ResultConfiguration</code> will be updated with the new value. For more\n information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override\n Client-Side Settings</a>.</p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
|
@ -2781,13 +2793,13 @@
|
|||
"ExpectedBucketOwner": {
|
||||
"target": "com.amazonaws.athena#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>.\n If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it\n makes Amazon S3 calls to your specified output location. If the\n <code>ExpectedBucketOwner</code>\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.</p>\n \n <p>If workgroup settings override client-side settings, then the query uses the\n <code>ExpectedBucketOwner</code> setting that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by <a>ResultConfiguration$OutputLocation</a>.\n If set, Athena uses the value for <code>ExpectedBucketOwner</code> when it\n makes Amazon S3 calls to your specified output location. If the\n <code>ExpectedBucketOwner</code>\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.</p>\n\n <p>If workgroup settings override client-side settings, then the query uses the\n <code>ExpectedBucketOwner</code> setting that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
|
||||
}
|
||||
},
|
||||
"RemoveExpectedBucketOwner": {
|
||||
"target": "com.amazonaws.athena#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If set to \"true\", removes the Amazon Web Services account ID previously specified for\n <a>ResultConfiguration$ExpectedBucketOwner</a>. If set to \"false\" or not\n set, and a value is present in the <code>ExpectedBucketOwner</code> in\n <code>ResultConfigurationUpdates</code> (the client-side setting), the\n <code>ExpectedBucketOwner</code> in the workgroup's <code>ResultConfiguration</code>\n is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override\n Client-Side Settings</a>.</p>"
|
||||
"smithy.api#documentation": "<p>If set to \"true\", removes the Amazon Web Services account ID previously specified for\n <a>ResultConfiguration$ExpectedBucketOwner</a>. If set to \"false\" or not\n set, and a value is present in the <code>ExpectedBucketOwner</code> in\n <code>ResultConfigurationUpdates</code> (the client-side setting), the\n <code>ExpectedBucketOwner</code> in the workgroup's <code>ResultConfiguration</code>\n is updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override\n Client-Side Settings</a>.</p>"
|
||||
}
|
||||
},
|
||||
"AclConfiguration": {
|
||||
|
@ -3407,7 +3419,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates a <a>NamedQuery</a> object. The database or workgroup cannot be updated.</p>",
|
||||
"smithy.api#documentation": "<p>Updates a <a>NamedQuery</a> object. The database or workgroup cannot be\n updated.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
|
|
@ -3295,7 +3295,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> Deletes an assessment report from an assessment in Audit Manager. </p>",
|
||||
"smithy.api#documentation": "<p>Deletes an assessment report in Audit Manager. </p>\n <p>When you run the <code>DeleteAssessmentReport</code> operation, Audit Manager attempts to delete the following data:</p>\n <ol>\n <li>\n <p>The specified assessment report that’s stored in your S3 bucket</p>\n </li>\n <li>\n <p>The associated metadata that’s stored in Audit Manager</p>\n </li>\n </ol>\n <p>If Audit Manager can’t access the assessment report in your S3 bucket, the report\n isn’t deleted. In this event, the <code>DeleteAssessmentReport</code> 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. </p>\n <p>This scenario happens when Audit Manager receives a <code>403 (Forbidden)</code> or\n <code>404 (Not Found)</code> 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 <a href=\"https://docs.aws.amazon.com/audit-manager/latest/userguide/security_iam_id-based-policy-examples.html#full-administrator-access-assessment-report-destination\">Assessment report destination permissions</a> in the <i>Audit Manager User Guide</i>. For information about the issues that could cause a <code>403\n (Forbidden)</code> or <code>404 (Not Found</code>) error from Amazon S3, see\n <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList\">List of Error Codes</a> in the <i>Amazon Simple Storage Service API\n Reference</i>. </p>",
|
||||
"smithy.api#http": {
|
||||
"method": "DELETE",
|
||||
"uri": "/assessments/{assessmentId}/reports/{assessmentReportId}",
|
||||
|
@ -6743,13 +6743,13 @@
|
|||
"keywordInputType": {
|
||||
"target": "com.amazonaws.auditmanager#KeywordInputType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> The method of input for the keyword. </p>"
|
||||
"smithy.api#documentation": "<p> The input method for the keyword. </p>"
|
||||
}
|
||||
},
|
||||
"keywordValue": {
|
||||
"target": "com.amazonaws.auditmanager#KeywordValue",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> 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. </p>"
|
||||
"smithy.api#documentation": "<p> 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. </p>\n <p>If you’re mapping a data source to a rule in Config, the\n <code>keywordValue</code> that you specify depends on the type of rule:</p>\n <ul>\n <li>\n <p>For <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">managed rules</a>, you can use the rule identifier as the\n <code>keywordValue</code>. You can find the rule identifier from the <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html\">list of Config managed rules</a>.</p>\n <ul>\n <li>\n <p>Managed rule name: <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-acl-prohibited.html\">s3-bucket-acl-prohibited</a>\n </p>\n <p>\n <code>keywordValue</code>: <code>S3_BUCKET_ACL_PROHIBITED</code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>For <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html\">custom rules</a>, you form the <code>keywordValue</code>\n by adding the <code>Custom_</code> prefix to the rule name. This prefix distinguishes\n the rule from a managed rule.</p>\n <ul>\n <li>\n <p>Custom rule name: my-custom-config-rule</p>\n <p>\n <code>keywordValue</code>: <code>Custom_my-custom-config-rule</code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>For <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/service-linked-awsconfig-rules.html\">service-linked rules</a>, you form the\n <code>keywordValue</code> by adding the <code>Custom_</code> prefix to the rule\n name. In addition, you remove the suffix ID that appears at the end of the rule\n name.</p>\n <ul>\n <li>\n <p>Service-linked rule name:\n CustomRuleForAccount-conformance-pack-szsm1uv0w</p>\n <p>\n <code>keywordValue</code>:\n <code>Custom_CustomRuleForAccount-conformance-pack</code>\n </p>\n </li>\n <li>\n <p>Service-linked rule name: securityhub-api-gw-cache-encrypted-101104e1</p>\n <p>\n <code>keywordValue</code>:\n <code>Custom_securityhub-api-gw-cache-encrypted</code>\n </p>\n </li>\n <li>\n <p>Service-linked rule name:\n OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba</p>\n <p>\n <code>keywordValue</code>:\n <code>Custom_OrgConfigRule-s3-bucket-versioning-enabled</code>\n </p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
@ -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": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>The duration of the health check grace period, in seconds.</p>"
|
||||
}
|
||||
},
|
||||
"Instances": {
|
||||
|
@ -710,7 +713,13 @@
|
|||
"DesiredCapacityType": {
|
||||
"target": "com.amazonaws.autoscaling#XmlStringMaxLen255",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports <code>DesiredCapacityType</code> for attribute-based instance type selection\n only. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html\">Creating\n an Auto Scaling group using attribute-based instance type selection</a> in the\n <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>By default, Amazon EC2 Auto Scaling specifies <code>units</code>, which translates into number of\n instances.</p>\n <p>Valid values: <code>units</code> | <code>vcpu</code> | <code>memory-mib</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports <code>DesiredCapacityType</code> for attribute-based instance type selection\n only.</p>"
|
||||
}
|
||||
},
|
||||
"DefaultInstanceWarmup": {
|
||||
"target": "com.amazonaws.autoscaling#DefaultInstanceWarmup",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The duration of the default instance warmup, in seconds.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -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": "<p>The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is <code>300</code>. This setting applies\n when using simple scaling policies, but not when using other scaling policies or\n scheduled scaling. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling cooldowns for Amazon EC2 Auto Scaling</a>\n in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i>Only needed if you use simple scaling policies.</i>\n </p>\n <p>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 <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling cooldowns\n for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>Default: <code>300</code> seconds</p>"
|
||||
}
|
||||
},
|
||||
"AvailabilityZones": {
|
||||
|
@ -1673,13 +1685,13 @@
|
|||
"HealthCheckGracePeriod": {
|
||||
"target": "com.amazonaws.autoscaling#HealthCheckGracePeriod",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>0</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health\n check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>Required if you are adding an <code>ELB</code> health check.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i></i>\n </p>\n <p>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 <code>InService</code> state. For more\n information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health\n check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>Default: <code>0</code> seconds</p>"
|
||||
}
|
||||
},
|
||||
"PlacementGroup": {
|
||||
"target": "com.amazonaws.autoscaling#XmlStringMaxLen255",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The name of an existing placement group into which to launch your instances. For more\n information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement groups</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i>.</p>\n <note>\n <p>A <i>cluster</i> 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. </p>\n </note>"
|
||||
}
|
||||
},
|
||||
"VPCZoneIdentifier": {
|
||||
|
@ -1741,6 +1753,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports <code>DesiredCapacityType</code> for attribute-based instance type selection\n only. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html\">Creating\n an Auto Scaling group using attribute-based instance type selection</a> in the\n <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>By default, Amazon EC2 Auto Scaling specifies <code>units</code>, which translates into number of\n instances.</p>\n \n <p>Valid values: <code>units</code> | <code>vcpu</code> | <code>memory-mib</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"DefaultInstanceWarmup": {
|
||||
"target": "com.amazonaws.autoscaling#DefaultInstanceWarmup",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>InService</code> state. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html\">Set\n the default instance warmup for an Auto Scaling group</a> in the\n <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <important>\n <p>To manage your warm-up settings at the group level, we recommend that you set the\n default instance warmup, <i>even if its value is set to 0 seconds</i>.\n This also optimizes the performance of scaling policies that scale continuously,\n such as target tracking and step scaling policies. </p>\n <p>If you need to remove a value that you previously set, include the property but\n specify <code>-1</code> for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a minimum value of\n <code>0</code>.</p>\n </important>\n <p>Default: None </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -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": "<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic\n instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>This parameter can only be used if you are launching EC2-Classic instances.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i>EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.</i>\n </p>\n <p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
}
|
||||
},
|
||||
"ClassicLinkVPCSecurityGroups": {
|
||||
"target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic\n instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>If you specify the <code>ClassicLinkVPCId</code> parameter, you must specify this\n parameter.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i>EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.</i>\n </p>\n <p>The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i>.</p>\n <p>If you specify the <code>ClassicLinkVPCId</code> parameter, you must specify this\n parameter.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Amazon EC2 Auto Scaling.</p>\n <p>To create your customized metric specification:</p>\n <ul>\n <li>\n <p>Add values for each required parameter from CloudWatch. You can use an existing\n metric, or a new metric that you create. To use your own metric, you must first\n publish the metric to CloudWatch. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publish\n custom metrics</a> in the <i>Amazon CloudWatch User\n Guide</i>.</p>\n </li>\n <li>\n <p>Choose a metric that changes proportionally with capacity. The value of the\n metric should increase or decrease in inverse proportion to the number of\n capacity units. That is, the value of the metric should decrease when capacity\n increases.</p>\n </li>\n </ul>\n <p>For more information about the CloudWatch terminology below, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html\">Amazon CloudWatch\n concepts</a>.</p>\n <note>\n <p>Each individual service provides information about the metrics, namespace, and\n dimensions they use. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html\">Amazon Web Services services that publish CloudWatch metrics</a> in the <i>Amazon CloudWatch User\n Guide</i>.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The name of the filter.</p>\n <p>The valid values for <code>Name</code> depend on which API operation you're using with\n the filter (<a>DescribeAutoScalingGroups</a> or <a>DescribeTags</a>).</p>\n <p>\n <b>DescribeAutoScalingGroups</b>\n </p>\n <p>Valid values for <code>Name</code> include the following: </p>\n <ul>\n <li>\n <p>\n <code>tag-key</code> - Accepts tag keys. The results only include information\n about the Auto Scaling groups associated with these tag keys. </p>\n </li>\n <li>\n <p>\n <code>tag-value</code> - Accepts tag values. The results only include\n information about the Auto Scaling groups associated with these tag values. </p>\n </li>\n <li>\n <p>\n <code>tag:<key></code> - Accepts the key/value combination of the tag.\n Use the tag key in the filter name and the tag value as the filter value. The\n results only include information about the Auto Scaling groups associated with the\n specified key/value combination. </p>\n </li>\n </ul>\n <p>\n <b>DescribeTags</b>\n </p>\n <p>Valid values for <code>Name</code> include the following: </p>\n <ul>\n <li>\n <p>\n <code>auto-scaling-group</code> - Accepts the names of Auto Scaling groups. The\n results only include information about the tags associated with these Auto Scaling\n groups. </p>\n </li>\n <li>\n <p>\n <code>key</code> - Accepts tag keys. The results only include information\n about the tags associated with these tag keys. </p>\n </li>\n <li>\n <p>\n <code>value</code> - Accepts tag values. The results only include information\n about the tags associated with these tag values. </p>\n </li>\n <li>\n <p>\n <code>propagate-at-launch</code> - Accepts a Boolean value, which specifies\n whether tags propagate to instances at launch. The results only include\n information about the tags associated with the specified Boolean value. </p>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>The name of the filter.</p>\n <p>The valid values for <code>Name</code> depend on which API operation you're using with\n the filter (<a>DescribeAutoScalingGroups</a> or <a>DescribeTags</a>).</p>\n <p>\n <b>DescribeAutoScalingGroups</b>\n </p>\n <p>Valid values for <code>Name</code> include the following: </p>\n <ul>\n <li>\n <p>\n <code>tag-key</code> - Accepts tag keys. The results only include information\n about the Auto Scaling groups associated with these tag keys. </p>\n </li>\n <li>\n <p>\n <code>tag-value</code> - Accepts tag values. The results only include\n information about the Auto Scaling groups associated with these tag values. </p>\n </li>\n <li>\n <p>\n <code>tag:<key></code> - Accepts the key/value combination of the tag.\n Use the tag key in the filter name and the tag value as the filter value. The\n results only include information about the Auto Scaling groups associated with the\n specified key/value combination. </p>\n </li>\n </ul>\n <p>\n <b>DescribeTags</b>\n </p>\n <p>Valid values for <code>Name</code> include the following: </p>\n <ul>\n <li>\n <p>\n <code>auto-scaling-group</code> - Accepts the names of Auto Scaling groups. The\n results only include information about the tags associated with these Auto Scaling\n groups. </p>\n </li>\n <li>\n <p>\n <code>key</code> - Accepts tag keys. The results only include information\n about the tags associated with these tag keys. </p>\n </li>\n <li>\n <p>\n <code>value</code> - Accepts tag values. The results only include information\n about the tags associated with these tag values. </p>\n </li>\n <li>\n <p>\n <code>propagate-at-launch</code> - Accepts a Boolean value, which specifies\n whether tags propagate to instances at launch. The results only include\n information about the tags associated with the specified Boolean value. </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"Values": {
|
||||
|
@ -4517,13 +4595,13 @@
|
|||
"ClassicLinkVPCId": {
|
||||
"target": "com.amazonaws.autoscaling#XmlStringMaxLen255",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic\n instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i>EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.</i>\n </p>\n <p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.</p>"
|
||||
}
|
||||
},
|
||||
"ClassicLinkVPCSecurityGroups": {
|
||||
"target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The IDs of one or more security groups for the VPC specified in\n <code>ClassicLinkVPCId</code>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html#as-ClassicLink\">Linking EC2-Classic\n instances to a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i>EC2-Classic retires on August 15, 2022. This parameter is not supported after\n that date.</i>\n </p>\n <p>The IDs of one or more security groups for the VPC specified in\n <code>ClassicLinkVPCId</code>.</p>"
|
||||
}
|
||||
},
|
||||
"UserData": {
|
||||
|
@ -4824,7 +4902,7 @@
|
|||
"GlobalTimeout": {
|
||||
"target": "com.amazonaws.autoscaling#GlobalTimeout",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum time, in seconds, that an instance can remain in a\n <code>Pending:Wait</code> or <code>Terminating:Wait</code> state. The maximum is\n 172800 seconds (48 hours) or 100 times <code>HeartbeatTimeout</code>, whichever is\n smaller.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>HeartbeatTimeout</code>, whichever is\n smaller.</p>"
|
||||
}
|
||||
},
|
||||
"DefaultResult": {
|
||||
|
@ -5776,7 +5854,7 @@
|
|||
"PredefinedMetricType": {
|
||||
"target": "com.amazonaws.autoscaling#MetricType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The metric type. The following predefined metrics are available:</p>\n <ul>\n <li>\n <p>\n <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling\n group.</p>\n </li>\n <li>\n <p>\n <code>ASGAverageNetworkIn</code> - Average number of bytes received (per\n instance per minute) for the Auto Scaling group.</p>\n </li>\n <li>\n <p>\n <code>ASGAverageNetworkOut</code> - Average number of bytes sent out (per\n instance per minute) for the Auto Scaling group.</p>\n </li>\n <li>\n <p>\n <code>ALBRequestCountPerTarget</code> - Average Application Load Balancer request count (per\n target per minute) for your Auto Scaling group.</p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>The metric type. The following predefined metrics are available:</p>\n <ul>\n <li>\n <p>\n <code>ASGAverageCPUUtilization</code> - Average CPU utilization of the Auto Scaling\n group.</p>\n </li>\n <li>\n <p>\n <code>ASGAverageNetworkIn</code> - Average number of bytes received on all\n network interfaces by the Auto Scaling group.</p>\n </li>\n <li>\n <p>\n <code>ASGAverageNetworkOut</code> - Average number of bytes sent out on all\n network interfaces by the Auto Scaling group.</p>\n </li>\n <li>\n <p>\n <code>ALBRequestCountPerTarget</code> - Average Application Load Balancer request count per target\n for your Auto Scaling group.</p>\n </li>\n </ul>",
|
||||
"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": "<p>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.</p>\n <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see\n <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling\n cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see\n <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling\n cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"MetricAggregationType": {
|
||||
|
@ -6348,7 +6429,7 @@
|
|||
"EstimatedInstanceWarmup": {
|
||||
"target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>Valid only if the policy type is <code>TargetTrackingScaling</code> or\n <code>StepScaling</code>.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i>Not needed if the default instance warmup is defined for the\n group.</i>\n </p>\n <p>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.</p>\n <p>Valid only if the policy type is <code>TargetTrackingScaling</code> or\n <code>StepScaling</code>.</p>\n <note>\n <p>The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then <code>EstimatedInstanceWarmup</code>\n falls back to the value of default cooldown.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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 <code>90</code>.</p>\n <p>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. </p>"
|
||||
"smithy.api#documentation": "<p>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 <code>90</code>.</p>\n <p>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. </p>"
|
||||
}
|
||||
},
|
||||
"InstanceWarmup": {
|
||||
"target": "com.amazonaws.autoscaling#RefreshInstanceWarmup",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i>Not needed if the default instance warmup is defined for the\n group.</i>\n </p>\n <p>The duration of the instance warmup, in seconds.</p>\n <note>\n <p>The default is to use the value for the default instance warmup defined for the\n group. If default instance warmup is null, then <code>InstanceWarmup</code> falls\n back to the value of the health check grace period.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is <code>300</code>. This setting applies\n when using simple scaling policies, but not when using other scaling policies or\n scheduled scaling. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling cooldowns for Amazon EC2 Auto Scaling</a>\n in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>\n <i>Only needed if you use simple scaling policies.</i>\n </p>\n <p>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 <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling cooldowns\n for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"AvailabilityZones": {
|
||||
|
@ -7729,13 +7828,13 @@
|
|||
"HealthCheckGracePeriod": {
|
||||
"target": "com.amazonaws.autoscaling#HealthCheckGracePeriod",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>0</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health\n check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>Required if you are adding an <code>ELB</code> health check.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>InService</code> state. For more\n information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health\n check grace period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"PlacementGroup": {
|
||||
"target": "com.amazonaws.autoscaling#XmlStringMaxLen255",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The name of an existing placement group into which to launch your instances. For more\n information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement groups</a> in the\n <i>Amazon EC2 User Guide for Linux Instances</i>.</p>\n <note>\n <p>A <i>cluster</i> 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. </p>\n </note>"
|
||||
}
|
||||
},
|
||||
"VPCZoneIdentifier": {
|
||||
|
@ -7785,6 +7884,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports <code>DesiredCapacityType</code> for attribute-based instance type selection\n only. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html\">Creating\n an Auto Scaling group using attribute-based instance type selection</a> in the\n <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <p>By default, Amazon EC2 Auto Scaling specifies <code>units</code>, which translates into number of\n instances.</p>\n <p>Valid values: <code>units</code> | <code>vcpu</code> | <code>memory-mib</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"DefaultInstanceWarmup": {
|
||||
"target": "com.amazonaws.autoscaling#DefaultInstanceWarmup",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>InService</code> state. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html\">Set\n the default instance warmup for an Auto Scaling group</a> in the\n <i>Amazon EC2 Auto Scaling User Guide</i>.</p>\n <important>\n <p>To manage your warm-up settings at the group level, we recommend that you set the\n default instance warmup, <i>even if its value is set to 0 seconds</i>.\n This also optimizes the performance of scaling policies that scale continuously,\n such as target tracking and step scaling policies. </p>\n <p>If you need to remove a value that you previously set, include the property but\n specify <code>-1</code> for the value. However, we strongly recommend keeping the\n default instance warmup enabled by specifying a minimum value of\n <code>0</code>.</p>\n </important>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -31,7 +31,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Braket API Reference provides information about the operations and structures\n supported in Amazon Braket.</p>\n <p>Additional Resources:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/braket/latest/developerguide/what-is-braket.html\">Amazon Braket Developer Guide</a>\n </p>\n </li>\n </ul>",
|
||||
"smithy.api#title": "Braket"
|
||||
},
|
||||
"version": "2019-09-01",
|
||||
|
@ -124,9 +122,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Cancels an Amazon Braket job.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "PUT",
|
||||
"uri": "/job/{jobArn}/cancel",
|
||||
"code": 200
|
||||
"method": "PUT"
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
|
@ -194,9 +191,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Cancels the specified task.</p>",
|
||||
"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": "<p>Creates an Amazon Braket job.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -370,7 +366,7 @@
|
|||
"outputDataConfig": {
|
||||
"target": "com.amazonaws.braket#JobOutputDataConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The path to the S3 location where you want to store job artifacts and the\n encryption key used to store them.</p>",
|
||||
"smithy.api#documentation": "<p>The path to the S3 location where you want to store job artifacts and the encryption key\n used to store them.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -415,20 +411,20 @@
|
|||
"hyperParameters": {
|
||||
"target": "com.amazonaws.braket#HyperParameters",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"deviceConfig": {
|
||||
"target": "com.amazonaws.braket#DeviceConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.</p>",
|
||||
"smithy.api#documentation": "<p>The quantum processing unit (QPU) or simulator used to create an Amazon Braket\n job.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"tags": {
|
||||
"target": "com.amazonaws.braket#TagsMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.</p>"
|
||||
"smithy.api#documentation": "<p>A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -479,8 +475,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a quantum task.</p>",
|
||||
"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": "<p>The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.</p>",
|
||||
"smithy.api#documentation": "<p>The primary quantum processing unit (QPU) or simulator used to create and run an Amazon\n Braket job.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Configures the quantum processing units (QPUs) or simulator used to create and run an Amazon Braket job.</p>"
|
||||
"smithy.api#documentation": "<p>Configures the quantum processing units (QPUs) or simulator used to create and run an\n Amazon Braket job.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Retrieves the devices available in Amazon Braket.</p>",
|
||||
"smithy.api#documentation": "<p>Retrieves the devices available in Amazon Braket.</p>\n <note>\n <p>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.</p>\n </note>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/device/{deviceArn}",
|
||||
"code": 200
|
||||
"method": "GET"
|
||||
},
|
||||
"smithy.api#readonly": {}
|
||||
}
|
||||
|
@ -875,9 +868,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves the specified Amazon Braket job.</p>",
|
||||
"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": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"inputDataConfig": {
|
||||
|
@ -952,7 +944,7 @@
|
|||
"outputDataConfig": {
|
||||
"target": "com.amazonaws.braket#JobOutputDataConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The path to the S3 location where job artifacts are stored and the encryption\n key used to store them there.</p>",
|
||||
"smithy.api#documentation": "<p>The path to the S3 location where job artifacts are stored and the encryption key used\n to store them there.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -971,14 +963,14 @@
|
|||
"algorithmSpecification": {
|
||||
"target": "com.amazonaws.braket#AlgorithmSpecification",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"instanceConfig": {
|
||||
"target": "com.amazonaws.braket#InstanceConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The resource instances to use while running the hybrid job on Amazon\n Braket.</p>",
|
||||
"smithy.api#documentation": "<p>The resource instances to use while running the hybrid job on Amazon Braket.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1025,7 +1017,7 @@
|
|||
"tags": {
|
||||
"target": "com.amazonaws.braket#TagsMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.</p>"
|
||||
"smithy.api#documentation": "<p>A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1058,9 +1050,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves the specified quantum task.</p>",
|
||||
"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": "<p>Configures the type resource instances to use while running an Amazon Braket hybrid job.</p>",
|
||||
"smithy.api#documentation": "<p>Configures the type resource instances to use while running an Amazon Braket hybrid\n job.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1240,10 +1231,19 @@
|
|||
},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"instanceCount": {
|
||||
"target": "smithy.api#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Configures the number of resource instances to use while running an Amazon Braket job on\n Amazon Braket. The default value is 1.</p>",
|
||||
"smithy.api#range": {
|
||||
"min": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon\n Braket.</p>"
|
||||
"smithy.api#documentation": "<p>Configures the resource instances to use while running the Amazon Braket hybrid job on\n Amazon Braket.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.braket#InstanceType": {
|
||||
|
@ -1417,7 +1417,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The request processing has failed because of an unknown error, exception, or failure.</p>",
|
||||
"smithy.api#documentation": "<p>The request processing has failed because of an unknown error, exception, or\n failure.</p>",
|
||||
"smithy.api#error": "server",
|
||||
"smithy.api#httpError": 500
|
||||
}
|
||||
|
@ -1438,13 +1438,13 @@
|
|||
"localPath": {
|
||||
"target": "com.amazonaws.braket#String4096",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>(Optional) The local directory where checkpoints are written. The default directory is <code>/opt/braket/checkpoints/</code>.</p>"
|
||||
"smithy.api#documentation": "<p>(Optional) The local directory where checkpoints are written. The default directory is\n <code>/opt/braket/checkpoints/</code>.</p>"
|
||||
}
|
||||
},
|
||||
"s3Uri": {
|
||||
"target": "com.amazonaws.braket#S3Path",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, <code>s3://bucket-name/key-name-prefix</code>.</p>",
|
||||
"smithy.api#documentation": "<p>Identifies the S3 path where you want Amazon Braket to store checkpoints. For example,\n <code>s3://bucket-name/key-name-prefix</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -1553,13 +1553,13 @@
|
|||
"kmsKeyId": {
|
||||
"target": "com.amazonaws.braket#String2048",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"s3Path": {
|
||||
"target": "com.amazonaws.braket#S3Path",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For\n example, <code>s3://bucket-name/key-name-prefix</code>.</p>",
|
||||
"smithy.api#documentation": "<p>Identifies the S3 path where you want Amazon Braket to store the job training artifacts.\n For example, <code>s3://bucket-name/key-name-prefix</code>.</p>",
|
||||
"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": "<p>Provides summary information about the primary device used by an Amazon Braket job.</p>",
|
||||
"smithy.api#documentation": "<p>Provides summary information about the primary device used by an Amazon Braket\n job.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1703,7 +1701,7 @@
|
|||
"tags": {
|
||||
"target": "com.amazonaws.braket#TagsMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.</p>"
|
||||
"smithy.api#documentation": "<p>A tag object that consists of a key and an optional value, used to manage metadata for\n Amazon Braket resources.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -1755,8 +1753,7 @@
|
|||
"smithy.api#documentation": "<p>Shows the tags associated with this resource.</p>",
|
||||
"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": "<p>Contains information about the Python scripts used for entry and by an Amazon Braket job.</p>"
|
||||
"smithy.api#documentation": "<p>Contains information about the Python scripts used for entry and by an Amazon Braket\n job.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.braket#SearchDevices": {
|
||||
|
@ -2034,15 +2029,14 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Searches for devices using the specified filters.</p>",
|
||||
"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": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
@ -2121,14 +2115,14 @@
|
|||
"devices": {
|
||||
"target": "com.amazonaws.braket#DeviceSummaryList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of <code>DeviceSummary</code> objects for devices that match the specified filter values.</p>",
|
||||
"smithy.api#documentation": "<p>An array of <code>DeviceSummary</code> objects for devices that match the specified\n filter values.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"nextToken": {
|
||||
"target": "smithy.api#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -2158,15 +2152,14 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Searches for Amazon Braket jobs that match the specified filter values.</p>",
|
||||
"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": "<p>A token used for pagination of results, or <code>null</code> if there are no additional results. Use\n the token value in a subsequent request to continue results where the previous request\n ended.</p>"
|
||||
"smithy.api#documentation": "<p>A token used for pagination of results, or <code>null</code> if there are no additional\n results. Use the token value in a subsequent request to continue results where the previous\n request ended.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -2319,15 +2312,14 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Searches for tasks that match the specified filter values.</p>",
|
||||
"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": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
@ -2440,14 +2432,14 @@
|
|||
"quantumTasks": {
|
||||
"target": "com.amazonaws.braket#QuantumTaskSummaryList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of <code>QuantumTaskSummary</code> objects for tasks that match the specified filters.</p>",
|
||||
"smithy.api#documentation": "<p>An array of <code>QuantumTaskSummary</code> objects for tasks that match the specified\n filters.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"nextToken": {
|
||||
"target": "smithy.api#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -2545,8 +2537,7 @@
|
|||
"smithy.api#documentation": "<p>Add a tag to the specified resource.</p>",
|
||||
"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": "<p>Specify the <code>resourceArn</code> of the resource to which a tag will be added.</p>",
|
||||
"smithy.api#documentation": "<p>Specify the <code>resourceArn</code> of the resource to which a tag will be\n added.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -2619,8 +2610,7 @@
|
|||
"smithy.api#documentation": "<p>Remove tags from a resource.</p>",
|
||||
"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": "<p>Specify the <code>resourceArn</code> for the resource from which to remove the tags.</p>",
|
||||
"smithy.api#documentation": "<p>Specify the <code>resourceArn</code> for the resource from which to remove the\n tags.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
|
@ -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": "<p>The service encountered an unexpected error.</p>",
|
||||
"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": "<p>The number of customer requests exceeds the request rate limit.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 429
|
||||
}
|
||||
},
|
||||
"com.amazonaws.chimesdkmeetings#TranscribeContentIdentificationType": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
|
@ -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": "<p>A configuration for a set of custom HTTP response headers.</p>"
|
||||
}
|
||||
},
|
||||
"ServerTimingHeadersConfig": {
|
||||
"target": "com.amazonaws.cloudfront#ResponseHeadersPolicyServerTimingHeadersConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A configuration for enabling the <code>Server-Timing</code> header in HTTP responses\n\t\t\tsent from CloudFront.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -11339,6 +11384,27 @@
|
|||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudfront#ResponseHeadersPolicyServerTimingHeadersConfig": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Enabled": {
|
||||
"target": "com.amazonaws.cloudfront#boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A Boolean that determines whether CloudFront adds the <code>Server-Timing</code> 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.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SamplingRate": {
|
||||
"target": "com.amazonaws.cloudfront#SamplingRate",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to\n\t\t\tadd the <code>Server-Timing</code> header to. When you set the sampling rate to 100,\n\t\t\tCloudFront adds the <code>Server-Timing</code> 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.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A configuration for enabling the <code>Server-Timing</code> 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.</p>\n\t\t <p>You can use the <code>Server-Timing</code> 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 <code>Server-Timing</code> header to\n\t\t\ttroubleshoot issues or test the efficiency of your CloudFront configuration. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#server-timing-header\">Server-Timing header</a> in the\n\t\t\t<i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
|
|
|
@ -76,7 +76,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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).</p>",
|
||||
"smithy.api#documentation": "<p>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).</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
@ -86,7 +86,7 @@
|
|||
"ResourceId": {
|
||||
"target": "com.amazonaws.cloudtrail#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:</p>\n <p>\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>\n </p>",
|
||||
"smithy.api#documentation": "<p>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:</p>\n <p>\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>\n </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -99,7 +99,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the tags to add to a trail.</p>"
|
||||
"smithy.api#documentation": "<p>Specifies the tags to add to a trail or event data store.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudtrail#AddTagsResponse": {
|
||||
|
@ -493,7 +493,7 @@
|
|||
"code": "ConflictException",
|
||||
"httpResponseCode": 409
|
||||
},
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 409
|
||||
}
|
||||
|
@ -1328,49 +1328,73 @@
|
|||
"TerminationProtectionEnabled": {
|
||||
"target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the event data store is protected from termination.</p>"
|
||||
"smithy.api#deprecated": {
|
||||
"message": "TerminationProtectionEnabled is no longer returned by ListEventDataStores"
|
||||
},
|
||||
"smithy.api#documentation": "<p>This field is being deprecated. Indicates whether the event data store is protected from termination.</p>"
|
||||
}
|
||||
},
|
||||
"Status": {
|
||||
"target": "com.amazonaws.cloudtrail#EventDataStoreStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The status of an event data store. Values are <code>ENABLED</code> and <code>PENDING_DELETION</code>.</p>"
|
||||
"smithy.api#deprecated": {
|
||||
"message": "Status is no longer returned by ListEventDataStores"
|
||||
},
|
||||
"smithy.api#documentation": "<p>This field is being deprecated. The status of an event data store. Values are <code>ENABLED</code> and <code>PENDING_DELETION</code>.</p>"
|
||||
}
|
||||
},
|
||||
"AdvancedEventSelectors": {
|
||||
"target": "com.amazonaws.cloudtrail#AdvancedEventSelectors",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The advanced event selectors that were used to select events for the data store.</p>"
|
||||
"smithy.api#deprecated": {
|
||||
"message": "AdvancedEventSelectors is no longer returned by ListEventDataStores"
|
||||
},
|
||||
"smithy.api#documentation": "<p>This field is being deprecated. The advanced event selectors that were used to select events for the data store.</p>"
|
||||
}
|
||||
},
|
||||
"MultiRegionEnabled": {
|
||||
"target": "com.amazonaws.cloudtrail#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the event data store includes events from all regions, or only from the region in which it was created.</p>"
|
||||
"smithy.api#deprecated": {
|
||||
"message": "MultiRegionEnabled is no longer returned by ListEventDataStores"
|
||||
},
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"OrganizationEnabled": {
|
||||
"target": "com.amazonaws.cloudtrail#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates that an event data store is collecting logged events for an organization.</p>"
|
||||
"smithy.api#deprecated": {
|
||||
"message": "OrganizationEnabled is no longer returned by ListEventDataStores"
|
||||
},
|
||||
"smithy.api#documentation": "<p>This field is being deprecated. Indicates that an event data store is collecting logged events for an organization.</p>"
|
||||
}
|
||||
},
|
||||
"RetentionPeriod": {
|
||||
"target": "com.amazonaws.cloudtrail#RetentionPeriod",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The retention period, in days.</p>"
|
||||
"smithy.api#deprecated": {
|
||||
"message": "RetentionPeriod is no longer returned by ListEventDataStores"
|
||||
},
|
||||
"smithy.api#documentation": "<p>This field is being deprecated. The retention period, in days.</p>"
|
||||
}
|
||||
},
|
||||
"CreatedTimestamp": {
|
||||
"target": "com.amazonaws.cloudtrail#Date",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp of the event data store's creation.</p>"
|
||||
"smithy.api#deprecated": {
|
||||
"message": "CreatedTimestamp is no longer returned by ListEventDataStores"
|
||||
},
|
||||
"smithy.api#documentation": "<p>This field is being deprecated. The timestamp of the event data store's creation.</p>"
|
||||
}
|
||||
},
|
||||
"UpdatedTimestamp": {
|
||||
"target": "com.amazonaws.cloudtrail#Date",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp showing when an event data store was updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>"
|
||||
"smithy.api#deprecated": {
|
||||
"message": "UpdatedTimestamp is no longer returned by ListEventDataStores"
|
||||
},
|
||||
"smithy.api#documentation": "<p>This field is being deprecated. The timestamp showing when an event data store was updated, if applicable. <code>UpdatedTimestamp</code> is always either the same or newer than the time shown in <code>CreatedTimestamp</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -2126,7 +2150,7 @@
|
|||
"code": "InactiveEventDataStore",
|
||||
"httpResponseCode": 400
|
||||
},
|
||||
"smithy.api#documentation": "<p>The event data store against which you ran your query is inactive.</p>",
|
||||
"smithy.api#documentation": "<p>The event data store is inactive.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 400
|
||||
}
|
||||
|
@ -2221,7 +2245,7 @@
|
|||
"code": "InsufficientDependencyServiceAccessPermission",
|
||||
"httpResponseCode": 400
|
||||
},
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a>.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 400
|
||||
}
|
||||
|
@ -2347,7 +2371,7 @@
|
|||
"code": "InvalidDateRange",
|
||||
"httpResponseCode": 400
|
||||
},
|
||||
"smithy.api#documentation": "<p>A date range for the query was specified that is not valid. For more information \n about writing a query, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html\">Create \n or edit a query</a> in the <i>CloudTrail User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html\">Create \n or edit a query</a> in the <i>CloudTrail User Guide</i>.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 400
|
||||
}
|
||||
|
@ -3124,7 +3148,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the tags for the trail in the current region.</p>",
|
||||
"smithy.api#documentation": "<p>Lists the tags for the trail or event data store in the current region.</p>",
|
||||
"smithy.api#idempotent": {},
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
|
@ -3139,7 +3163,7 @@
|
|||
"ResourceIdList": {
|
||||
"target": "com.amazonaws.cloudtrail#ResourceIdList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>\n </p>",
|
||||
"smithy.api#documentation": "<p>Specifies a list of trail and event data store ARNs whose tags will be listed. The list \n has a limit of 20 ARNs.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -3151,7 +3175,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies a list of trail tags to return.</p>"
|
||||
"smithy.api#documentation": "<p>Specifies a list of tags to return.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudtrail#ListTagsResponse": {
|
||||
|
@ -3485,7 +3509,7 @@
|
|||
"code": "NotOrganizationMasterAccount",
|
||||
"httpResponseCode": 400
|
||||
},
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a>.</p>",
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a> or <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html\">Create an event data store</a>.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 400
|
||||
}
|
||||
|
@ -3546,7 +3570,7 @@
|
|||
"code": "OrganizationNotInAllFeaturesMode",
|
||||
"httpResponseCode": 400
|
||||
},
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html\">Prepare For Creating a Trail For Your Organization</a>.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 400
|
||||
}
|
||||
|
@ -4033,7 +4057,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Removes the specified tags from a trail.</p>",
|
||||
"smithy.api#documentation": "<p>Removes the specified tags from a trail or event data store.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
@ -4043,7 +4067,7 @@
|
|||
"ResourceId": {
|
||||
"target": "com.amazonaws.cloudtrail#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:</p>\n <p>\n <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>\n </p>",
|
||||
"smithy.api#documentation": "<p>Specifies the ARN of the trail or event data store from which tags should be removed.</p>\n <p>\n Example trail ARN format: <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code>\n </p>\n <p>Example event data store ARN format: <code>arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</code>\n </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -4056,7 +4080,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the tags to remove from a trail.</p>"
|
||||
"smithy.api#documentation": "<p>Specifies the tags to remove from a trail or event data store.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudtrail#RemoveTagsResponse": {
|
||||
|
@ -4300,7 +4324,7 @@
|
|||
"smithy.api#box": {},
|
||||
"smithy.api#range": {
|
||||
"min": 7,
|
||||
"max": 2555
|
||||
"max": 2557
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
@ -1607,14 +1607,14 @@
|
|||
"DeploymentType": {
|
||||
"target": "com.amazonaws.fsx#OntapDeploymentType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the FSx for ONTAP file system deployment type to use in creating the file system. \n <code>MULTI_AZ_1</code> is the supported ONTAP deployment type.</p>",
|
||||
"smithy.api#documentation": "<p>Specifies the FSx for ONTAP file system deployment type to use in creating\n the file system. </p>\n <ul>\n <li>\n <p>\n <code>MULTI_AZ_1</code> - (Default) A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability. </p>\n </li>\n <li>\n <p>\n <code>SINGLE_AZ_1</code> - A file system configured for Single-AZ\n redundancy.</p>\n </li>\n </ul>\n <p>For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n <a href=\"https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html\">Choosing Multi-AZ or\n Single-AZ file system deployment</a>. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"EndpointIpAddressRange": {
|
||||
"target": "com.amazonaws.fsx#IpAddressRange",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <important>\n <p>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.</p>\n </important>"
|
||||
"smithy.api#documentation": "<p>(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.</p>\n <important>\n <p>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.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"FsxAdminPassword": {
|
||||
|
@ -1632,19 +1632,19 @@
|
|||
"PreferredSubnetId": {
|
||||
"target": "com.amazonaws.fsx#SubnetId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Required when <code>DeploymentType</code> is set to <code>MULTI_AZ_1</code>. This specifies the subnet \n in which you want the preferred file server to be located.</p>"
|
||||
"smithy.api#documentation": "<p>Required when <code>DeploymentType</code> is set to <code>MULTI_AZ_1</code>. This\n specifies the subnet in which you want the preferred file server to be located.</p>"
|
||||
}
|
||||
},
|
||||
"RouteTableIds": {
|
||||
"target": "com.amazonaws.fsx#RouteTableIds",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>(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.</p>"
|
||||
}
|
||||
},
|
||||
"ThroughputCapacity": {
|
||||
"target": "com.amazonaws.fsx#MegabytesPerSecond",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Sets the throughput capacity for the file system that you're creating. \n Valid values are 128, 256, 512, 1024, and 2048 MBps.</p>",
|
||||
"smithy.api#documentation": "<p>Sets the throughput capacity for the file system that you're creating. Valid values\n are 128, 256, 512, 1024, and 2048 MBps.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1653,7 +1653,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.</p>"
|
||||
"smithy.api#documentation": "<p>The ONTAP configuration properties of the FSx for ONTAP file system that you\n are creating.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The ONTAP file system deployment type.</p>"
|
||||
"smithy.api#documentation": "<p>Specifies the FSx for ONTAP file system deployment type in use in the file\n system. </p>\n <ul>\n <li>\n <p>\n <code>MULTI_AZ_1</code> - (Default) A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability. </p>\n </li>\n <li>\n <p>\n <code>SINGLE_AZ_1</code> - A file system configured for Single-AZ\n redundancy.</p>\n </li>\n </ul>\n <p>For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n <a href=\"https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html\">Choosing Multi-AZ or\n Single-AZ file system deployment</a>. </p>"
|
||||
}
|
||||
},
|
||||
"EndpointIpAddressRange": {
|
||||
"target": "com.amazonaws.fsx#IpAddressRange",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The IP address range in which the endpoints to access your file system\n are created.</p>\n <important>\n <p>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.</p>\n </important>"
|
||||
"smithy.api#documentation": "<p>(Multi-AZ only) The IP address range in which the endpoints to access your file system\n are created.</p>\n <important>\n <p>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.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"Endpoints": {
|
||||
|
@ -5515,7 +5519,7 @@
|
|||
"RouteTableIds": {
|
||||
"target": "com.amazonaws.fsx#RouteTableIds",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The VPC route tables in which your file system's endpoints are\n created.</p>"
|
||||
"smithy.api#documentation": "<p>(Multi-AZ only) The VPC route tables in which your file system's endpoints are\n created.</p>"
|
||||
}
|
||||
},
|
||||
"ThroughputCapacity": {
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -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": "<p>Retrieves the details for the custom patterns specified by a list of names.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#BatchGetCustomEntityTypesRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Names": {
|
||||
"target": "com.amazonaws.glue#CustomEntityTypeNames",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of names of the custom patterns that you want to retrieve.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#BatchGetCustomEntityTypesResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CustomEntityTypes": {
|
||||
"target": "com.amazonaws.glue#CustomEntityTypes",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of <code>CustomEntityType</code> objects representing the custom patterns that have been created.</p>"
|
||||
}
|
||||
},
|
||||
"CustomEntityTypesNotFound": {
|
||||
"target": "com.amazonaws.glue#CustomEntityTypeNames",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of the names of custom patterns that were not found.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#BatchGetDevEndpoints": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
@ -3575,6 +3642,18 @@
|
|||
"smithy.api#documentation": "<p>Specifies the connections used by a job.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -4366,6 +4448,77 @@
|
|||
"smithy.api#documentation": "<p>Specifies a custom CSV classifier for <code>CreateClassifier</code> to create.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.</p>\n\t\n\t <p>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.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#CreateCustomEntityTypeRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"RegexString": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A regular expression string that is used for detecting sensitive data in a custom pattern.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"ContextWords": {
|
||||
"target": "com.amazonaws.glue#ContextWords",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\t\n\t <p>If no context words are passed only a regular expression is checked.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#CreateCustomEntityTypeResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the custom pattern you created.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"RegexString": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A regular expression string that is used for detecting sensitive data in a custom pattern.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"ContextWords": {
|
||||
"target": "com.amazonaws.glue#ContextWords",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\t\n\t <p>If no context words are passed only a regular expression is checked.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object representing a custom pattern for detecting sensitive data across the columns and rows of your structured data.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Deletes a custom pattern by specifying its name.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#DeleteCustomEntityTypeRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the custom pattern that you want to delete.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#DeleteCustomEntityTypeResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the custom pattern you deleted.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>Retrieves the details of a custom pattern by specifying its name.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#GetCustomEntityTypeRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the custom pattern that you want to retrieve.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#GetCustomEntityTypeResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Name": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the custom pattern that you retrieved.</p>"
|
||||
}
|
||||
},
|
||||
"RegexString": {
|
||||
"target": "com.amazonaws.glue#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A regular expression string that is used for detecting sensitive data in a custom pattern.</p>"
|
||||
}
|
||||
},
|
||||
"ContextWords": {
|
||||
"target": "com.amazonaws.glue#ContextWords",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#GetDataCatalogEncryptionSettings": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
@ -13646,6 +13961,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>\n \n <p>For more information about the available Glue versions and corresponding Spark and Python versions, see <a href=\"https://docs.aws.amazon.com/glue/latest/dg/add-job.html\">Glue version</a> in the developer guide.</p>\n\t \n\t <p>Jobs that are created without specifying a Glue version default to Glue 0.9.</p>"
|
||||
}
|
||||
},
|
||||
"DPUSeconds": {
|
||||
"target": "com.amazonaws.glue#NullableDouble",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>G.1X</code> and 2 for <code>G.2X</code> workers). This value may be different than the <code>executionEngineRuntime</code> * <code>MaxCapacity</code> as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the <code>MaxCapacity</code>. Therefore, it is possible that the value of <code>DPUSeconds</code> is less than <code>executionEngineRuntime</code> * <code>MaxCapacity</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -13933,11 +14254,20 @@
|
|||
"type": "structure",
|
||||
"members": {
|
||||
"UseLakeFormationCredentials": {
|
||||
"target": "com.amazonaws.glue#NullableBoolean"
|
||||
"target": "com.amazonaws.glue#NullableBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials.</p>"
|
||||
}
|
||||
},
|
||||
"AccountId": {
|
||||
"target": "com.amazonaws.glue#AccountId"
|
||||
"target": "com.amazonaws.glue#AccountId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Required for cross account crawls. For same account crawls as the target data, this can be left as null.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies AWS Lake Formation configuration settings for the crawler.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Lists all the custom patterns that have been created.</p>",
|
||||
"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": "<p>A paginated token to offset the results.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"target": "com.amazonaws.glue#PageSize",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum number of results to return.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#ListCustomEntityTypesResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CustomEntityTypes": {
|
||||
"target": "com.amazonaws.glue#CustomEntityTypes",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of <code>CustomEntityType</code> objects representing custom patterns.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.glue#PaginationToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A pagination token, if more results are available.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.glue#ListDevEndpoints": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
|
@ -2132,10 +2132,16 @@
|
|||
}
|
||||
},
|
||||
"startTime": {
|
||||
"target": "com.amazonaws.iottwinmaker#Time"
|
||||
"target": "com.amazonaws.iottwinmaker#Time",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ISO8601 DateTime of the earliest property value to return.</p>\n <p>For more information about the ISO8601 DateTime format, see the data type <a href=\"https://docs.aws.amazon.com/roci/latest/roci-api/API_PropertyValue.html\">PropertyValue</a>.</p>"
|
||||
}
|
||||
},
|
||||
"endTime": {
|
||||
"target": "com.amazonaws.iottwinmaker#Time"
|
||||
"target": "com.amazonaws.iottwinmaker#Time",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ISO8601 DateTime of the latest property value to return.</p>\n <p>For more information about the ISO8601 DateTime format, see the data type <a href=\"https://docs.aws.amazon.com/roci/latest/roci-api/API_PropertyValue.html\">PropertyValue</a>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -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": "<p>An object that filters items in a list of component types.</p>"
|
||||
"smithy.api#documentation": "<p>An object that filters items in a list of component types.</p>\n <note>\n <p>Only one object is accepted as a valid input.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.iottwinmaker#ListComponentTypesFilters": {
|
||||
|
@ -2746,7 +2752,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.iottwinmaker#ListEntitiesFilters",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of objects that filter the request.</p>"
|
||||
"smithy.api#documentation": "<p>A list of objects that filter the request.</p>\n <note>\n <p>Only one object is accepted as a valid input.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
@ -3415,7 +3421,10 @@
|
|||
}
|
||||
},
|
||||
"time": {
|
||||
"target": "com.amazonaws.iottwinmaker#Time"
|
||||
"target": "com.amazonaws.iottwinmaker#Time",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>ISO8601 DateTime of a value for a time series property.</p>\n <p>The time for when the property value was recorded in ISO 8601 format: <i>YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]</i>.</p> \n <ul>\n <li>\n <p>\n <i>[YYYY]</i>: year</p>\n </li>\n <li>\n <p>\n <i>[MM]</i>: month</p>\n </li>\n <li>\n <p>\n <i>[DD]</i>: day</p>\n </li>\n <li>\n <p>\n <i>[hh]</i>: hour</p>\n </li>\n <li>\n <p>\n <i>[mm]</i>: minute</p>\n </li>\n <li>\n <p>\n <i>[ss]</i>: seconds</p>\n </li>\n <li>\n <p>\n <i>[.SSSSSSSSS]</i>: additional precision, where precedence is maintained. For\n example: [.573123] is equal to 573123000 nanoseconds.</p>\n </li>\n <li>\n <p>\n <i>Z</i>: default timezone UTC</p>\n </li>\n <li>\n <p>\n <i>± HH:mm</i>: time zone offset in Hours and Minutes.</p>\n </li>\n </ul>\n <p>\n <i>Required sub-fields</i>: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -3440,7 +3449,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object that specifies information about time series property values.</p>"
|
||||
"smithy.api#documentation": "<p>An object that specifies information about time series property values. This object is used and consumed by the <a href=\"https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html\">BatchPutPropertyValues</a> action.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.iottwinmaker#PropertyValueHistory": {
|
||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -1009,7 +1009,7 @@
|
|||
"VpcConfiguration": {
|
||||
"target": "com.amazonaws.kendra#DataSourceVpcConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Configuration information for an Amazon VPC to connect to your Box. For \n more information, see <a href=\"https://docs.aws.amazon.com/endra/latest/dg/vpc-configuration.html\">Configuring a VPC</a>.</p>"
|
||||
"smithy.api#documentation": "<p>Configuration information for an Amazon VPC to connect to your Box. For \n more information, see <a href=\"https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html\">Configuring a VPC</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -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": "<p>Provides the configuration information to connect to Box as your data source.</p>"
|
||||
}
|
||||
},
|
||||
"QuipConfiguration": {
|
||||
"target": "com.amazonaws.kendra#QuipConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides the configuration information to connect to Quip as your \n data source.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.kendra#Domain": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 1,
|
||||
"max": 63
|
||||
},
|
||||
"smithy.api#pattern": "^(?!-)[A-Za-z0-9-].*(?<!-)$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.kendra#Duration": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
@ -5833,6 +5874,21 @@
|
|||
"smithy.api#pattern": "^(fs-[0-9a-f]{8,})$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.kendra#FolderId": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 1,
|
||||
"max": 500
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.kendra#FolderIdList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"target": "com.amazonaws.kendra#FolderId"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.kendra#FsxConfiguration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
@ -8255,6 +8311,9 @@
|
|||
"input": {
|
||||
"target": "com.amazonaws.kendra#PutPrincipalMappingRequest"
|
||||
},
|
||||
"output": {
|
||||
"target": "smithy.api#Unit"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.kendra#AccessDeniedException"
|
||||
|
@ -8747,6 +8806,88 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.kendra#QuipConfiguration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Domain": {
|
||||
"target": "com.amazonaws.kendra#Domain",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The configuration information to connect to your Quip data source domain.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SecretArn": {
|
||||
"target": "com.amazonaws.kendra#SecretArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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:</p>\n <ul>\n <li>\n <p>username—The Active Directory user name, along with the Domain Name\n System (DNS) domain\n name. For example,\n <i>user@corp.example.com</i>.\n The Active Directory user account must have read and mounting access to the Quip\n file system for Windows.</p>\n </li>\n <li>\n <p>password—The password of the Active Directory user account with \n read and mounting access to the Quip Windows file system.</p>\n </li>\n </ul>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"CrawlFileComments": {
|
||||
"target": "com.amazonaws.kendra#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specify whether to crawl file comments in your Quip data source. \n You can specify one or more of these options.</p>"
|
||||
}
|
||||
},
|
||||
"CrawlChatRooms": {
|
||||
"target": "com.amazonaws.kendra#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specify whether to crawl chat rooms in your Quip data source. \n You can specify one or more of these options.</p>"
|
||||
}
|
||||
},
|
||||
"CrawlAttachments": {
|
||||
"target": "com.amazonaws.kendra#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specify whether to crawl attachments in your Quip data source. \n You can specify one or more of these options.</p>"
|
||||
}
|
||||
},
|
||||
"FolderIds": {
|
||||
"target": "com.amazonaws.kendra#FolderIdList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the Quip folder IDs to index.</p>"
|
||||
}
|
||||
},
|
||||
"ThreadFieldMappings": {
|
||||
"target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of field mappings to apply when indexing Quip threads.</p>"
|
||||
}
|
||||
},
|
||||
"MessageFieldMappings": {
|
||||
"target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of field mappings to apply when indexing Quip messages.</p>"
|
||||
}
|
||||
},
|
||||
"AttachmentFieldMappings": {
|
||||
"target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of field mappings to apply when indexing Quip attachments.</p>"
|
||||
}
|
||||
},
|
||||
"InclusionPatterns": {
|
||||
"target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"ExclusionPatterns": {
|
||||
"target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"VpcConfiguration": {
|
||||
"target": "com.amazonaws.kendra#DataSourceVpcConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Configuration information for connecting to an Amazon Virtual Private Cloud\n (VPC)\n for your Quip. Your Quip instance must reside inside your VPC.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides the configuration information to connect to Quip as your data source.</p>"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -177,6 +177,61 @@
|
|||
]
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lightsail#AccountLevelBpaSync": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"status": {
|
||||
"target": "com.amazonaws.lightsail#AccountLevelBpaSyncStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The status of the account-level BPA synchronization.</p>\n\n <p>The following statuses are possible:</p>\n <ul>\n <li>\n <p>\n <code>InSync</code> - Account-level BPA is synchronized. The Amazon S3\n account-level BPA configuration applies to your Lightsail buckets.</p>\n </li>\n <li>\n <p>\n <code>NeverSynced</code> - Synchronization has not yet happened. The Amazon S3\n account-level BPA configuration does not apply to your Lightsail buckets.</p>\n </li>\n <li>\n <p>\n <code>Failed</code> - Synchronization failed. The Amazon S3 account-level BPA\n configuration does not apply to your Lightsail buckets.</p>\n </li>\n <li>\n <p>\n <code>Defaulted</code> - Synchronization failed and account-level BPA for your\n Lightsail buckets is defaulted to <i>active</i>.</p>\n </li>\n </ul>\n <note>\n <p>You might need to complete further actions if the status is <code>Failed</code> or\n <code>Defaulted</code>. The <code>message</code> parameter provides more information for\n those statuses.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"lastSyncedAt": {
|
||||
"target": "com.amazonaws.lightsail#IsoDate",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"message": {
|
||||
"target": "com.amazonaws.lightsail#BPAStatusMessage",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A message that provides a reason for a <code>Failed</code> or <code>Defaulted</code>\n synchronization status.</p>\n\n <p>The following messages are possible:</p>\n <ul>\n <li>\n <p>\n <code>SYNC_ON_HOLD</code> - The synchronization has not yet happened. This status\n message occurs immediately after you create your first Lightsail bucket. This status\n message should change after the first synchronization happens, approximately 1 hour after\n the first bucket is created.</p>\n </li>\n <li>\n <p>\n <code>DEFAULTED_FOR_SLR_MISSING</code> - The synchronization failed because the\n required service-linked role is missing from your Amazon Web Services account. The\n account-level BPA configuration for your Lightsail buckets is defaulted to\n <i>active</i> until the synchronization can occur. This means that all\n your buckets are private and not publicly accessible. For more information about how to\n create the required service-linked role to allow synchronization, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles\">Using Service-Linked Roles for Amazon Lightsail</a> in the\n <i>Amazon Lightsail Developer Guide</i>.</p>\n </li>\n <li>\n <p>\n <code>DEFAULTED_FOR_SLR_MISSING_ON_HOLD</code> - The synchronization failed because\n the required service-linked role is missing from your Amazon Web Services account.\n Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the\n bucket access permissions and individual object access permissions apply to your\n Lightsail buckets. For more information about how to create the required service-linked\n role to allow synchronization, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles\">Using Service-Linked Roles for Amazon Lightsail</a> in the\n <i>Amazon Lightsail Developer Guide</i>.</p>\n </li>\n <li>\n <p>\n <code>Unknown</code> - The reason that synchronization failed is unknown. Contact\n Amazon Web Services Support for more information.</p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"bpaImpactsLightsail": {
|
||||
"target": "com.amazonaws.lightsail#boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A Boolean value that indicates whether account-level block public access is affecting your\n Lightsail buckets.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3)\n account-level block public access (BPA) feature for your Lightsail buckets.</p>\n\n <p>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 <code>InSync</code>, 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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets\">Block public access for buckets in Amazon Lightsail</a> in the\n <i>Amazon Lightsail Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.</p>\n <p>After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.</p>\n <p>Use the <code>CreateCertificate</code> action to create a certificate that you can attach\n to your distribution.</p>\n <important>\n <p>Only certificates created in the <code>us-east-1</code> 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 <code>us-east-1</code> Region.</p>\n </important>",
|
||||
"smithy.api#documentation": "<p>Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN)\n distribution.</p>\n <p>After the certificate is attached, your distribution accepts HTTPS traffic for all of the\n domains that are associated with the certificate.</p>\n <p>Use the <code>CreateCertificate</code> action to create a certificate that you can attach\n to your distribution.</p>\n <important>\n <p>Only certificates created in the <code>us-east-1</code>\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 <code>us-east-1</code> Region.</p>\n </important>",
|
||||
"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": "<p>An object that describes the location of the bucket, such as the Amazon Web Services Region\n and Availability Zone.</p>"
|
||||
}
|
||||
},
|
||||
"name": {
|
||||
"target": "com.amazonaws.lightsail#BucketName",
|
||||
|
@ -1175,13 +1256,13 @@
|
|||
"ableToUpdateBundle": {
|
||||
"target": "com.amazonaws.lightsail#boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.</p>\n\n <p>You can update a bucket's bundle only one time within a monthly AWS billing\n cycle.</p>\n\n <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html\">UpdateBucketBundle</a> action to change a\n bucket's bundle.</p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the bundle that is currently applied to a bucket can be changed to\n another bundle.</p>\n\n <p>You can update a bucket's bundle only one time within a monthly Amazon Web Services billing\n cycle.</p>\n\n <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html\">UpdateBucketBundle</a> action to change a\n bucket's bundle.</p>"
|
||||
}
|
||||
},
|
||||
"readonlyAccessAccounts": {
|
||||
"target": "com.amazonaws.lightsail#PartnerIdList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of strings that specify the AWS account IDs that have read-only access to the\n bucket.</p>"
|
||||
"smithy.api#documentation": "<p>An array of strings that specify the Amazon Web Services account IDs that have read-only\n access to the bucket.</p>"
|
||||
}
|
||||
},
|
||||
"resourcesReceivingAccess": {
|
||||
|
@ -1220,7 +1301,7 @@
|
|||
"destination": {
|
||||
"target": "com.amazonaws.lightsail#BucketName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <note>\n <p>This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <note>\n <p>This parameter is required when enabling the access log for a bucket, and should be\n omitted when disabling the access log.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"prefix": {
|
||||
|
@ -1837,7 +1918,7 @@
|
|||
"location": {
|
||||
"target": "com.amazonaws.lightsail#ResourceLocation",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of objects describing the Availability Zone and AWS Region of the CloudFormation\n stack record.</p>"
|
||||
"smithy.api#documentation": "<p>A list of objects describing the Availability Zone and Amazon Web Services Region of the\n CloudFormation stack record.</p>"
|
||||
}
|
||||
},
|
||||
"resourceType": {
|
||||
|
@ -1981,7 +2062,10 @@
|
|||
}
|
||||
},
|
||||
"location": {
|
||||
"target": "com.amazonaws.lightsail#ResourceLocation"
|
||||
"target": "com.amazonaws.lightsail#ResourceLocation",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.</p>"
|
||||
}
|
||||
},
|
||||
"resourceType": {
|
||||
"target": "com.amazonaws.lightsail#ResourceType",
|
||||
|
@ -2174,7 +2258,7 @@
|
|||
"location": {
|
||||
"target": "com.amazonaws.lightsail#ResourceLocation",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object that describes the location of the container service, such as the AWS Region\n and Availability Zone.</p>"
|
||||
"smithy.api#documentation": "<p>An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.</p>"
|
||||
}
|
||||
},
|
||||
"resourceType": {
|
||||
|
@ -2240,7 +2324,7 @@
|
|||
"principalArn": {
|
||||
"target": "com.amazonaws.lightsail#string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The principal ARN of the container service.</p>\n\n <p>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.</p>"
|
||||
"smithy.api#documentation": "<p>The principal ARN of the container service.</p>\n\n <p>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.</p>"
|
||||
}
|
||||
},
|
||||
"privateDomainName": {
|
||||
|
@ -2817,7 +2901,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>When copying a <i>manual snapshot</i>, be sure to define the <code>source\n region</code>, <code>source snapshot name</code>, and <code>target snapshot name</code>\n parameters.</p>\n <p>When copying an <i>automatic snapshot</i>, be sure to define the\n <code>source region</code>, <code>source resource name</code>, <code>target snapshot\n name</code>, and either the <code>restore date</code> or the <code>use latest restorable\n auto snapshot</code> parameters.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>When copying a <i>manual snapshot</i>, be sure to define the <code>source\n region</code>, <code>source snapshot name</code>, and <code>target snapshot name</code>\n parameters.</p>\n <p>When copying an <i>automatic snapshot</i>, be sure to define the\n <code>source region</code>, <code>source resource name</code>, <code>target snapshot\n name</code>, and either the <code>restore date</code> or the <code>use latest restorable\n auto snapshot</code> parameters.</p>",
|
||||
"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": "<p>The AWS Region where the source manual or automatic snapshot is located.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services Region where the source manual or automatic snapshot is\n located.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -3047,7 +3131,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.</p>\n <p>After the certificate is valid, use the <code>AttachCertificateToDistribution</code>\n action to use the certificate and its domains with your distribution. Or use the\n <code>UpdateContainerService</code> action to use the certificate and its domains with your\n container service.</p>\n <important>\n <p>Only certificates created in the <code>us-east-1</code> 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 <code>us-east-1</code> Region.</p>\n </important>",
|
||||
"smithy.api#documentation": "<p>Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN)\n distribution and a container service.</p>\n <p>After the certificate is valid, use the <code>AttachCertificateToDistribution</code>\n action to use the certificate and its domains with your distribution. Or use the\n <code>UpdateContainerService</code> action to use the certificate and its domains with your\n container service.</p>\n <important>\n <p>Only certificates created in the <code>us-east-1</code>\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 <code>us-east-1</code> Region.</p>\n </important>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/ls/api/2016-11-28/CreateCertificate",
|
||||
|
@ -3195,7 +3279,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates an email or SMS text message contact method.</p>\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>",
|
||||
"smithy.api#documentation": "<p>Creates an email or SMS text message contact method.</p>\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>",
|
||||
"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": "<p>The protocol of the contact method, such as <code>Email</code> or <code>SMS</code> (text\n messaging).</p>\n <p>The <code>SMS</code> protocol is supported only in the following AWS Regions.</p>\n <ul>\n <li>\n <p>US East (N. Virginia) (<code>us-east-1</code>)</p>\n </li>\n <li>\n <p>US West (Oregon) (<code>us-west-2</code>)</p>\n </li>\n <li>\n <p>Europe (Ireland) (<code>eu-west-1</code>)</p>\n </li>\n <li>\n <p>Asia Pacific (Tokyo) (<code>ap-northeast-1</code>)</p>\n </li>\n <li>\n <p>Asia Pacific (Singapore) (<code>ap-southeast-1</code>)</p>\n </li>\n <li>\n <p>Asia Pacific (Sydney) (<code>ap-southeast-2</code>)</p>\n </li>\n </ul>\n <p>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 <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html\">Supported Regions and Countries</a> in the <i>Amazon SNS Developer\n Guide</i>.</p>\n <p>For more information about notifications in Amazon Lightsail, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>",
|
||||
"smithy.api#documentation": "<p>The protocol of the contact method, such as <code>Email</code> or <code>SMS</code> (text\n messaging).</p>\n <p>The <code>SMS</code> protocol is supported only in the following Amazon Web Services\n Regions.</p>\n <ul>\n <li>\n <p>US East (N. Virginia) (<code>us-east-1</code>)</p>\n </li>\n <li>\n <p>US West (Oregon) (<code>us-west-2</code>)</p>\n </li>\n <li>\n <p>Europe (Ireland) (<code>eu-west-1</code>)</p>\n </li>\n <li>\n <p>Asia Pacific (Tokyo) (<code>ap-northeast-1</code>)</p>\n </li>\n <li>\n <p>Asia Pacific (Singapore) (<code>ap-southeast-1</code>)</p>\n </li>\n <li>\n <p>Asia Pacific (Sydney) (<code>ap-southeast-2</code>)</p>\n </li>\n </ul>\n <p>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 <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html\">Supported Regions and Countries</a> in the <i>Amazon SNS Developer\n Guide</i>.</p>\n <p>For more information about notifications in Amazon Lightsail, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -3293,7 +3377,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a deployment for your Amazon Lightsail container service.</p>\n\n <p>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.</p>\n\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images\">Creating container images for your Amazon Lightsail container services</a> in the\n <i>Amazon Lightsail Developer Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Creates a deployment for your Amazon Lightsail container service.</p>\n\n <p>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.</p>\n\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images\">Creating container images for your Amazon Lightsail container services</a> in the\n <i>Amazon Lightsail Developer Guide</i>.</p>",
|
||||
"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": "<p>The name for the container service.</p>\n\n <p>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 <code>https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com</code>.\n If the name of your container service is <code>container-service-1</code>, and it's located in\n the US East (Ohio) AWS region (<code>us-east-2</code>), then the domain for your container\n service will be like the following example:\n <code>https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com</code>\n </p>\n\n <p>The following are the requirements for container service names:</p>\n\n <ul>\n <li>\n <p>Must be unique within each AWS Region in your Lightsail account.</p>\n </li>\n <li>\n <p>Must contain 1 to 63 characters.</p>\n </li>\n <li>\n <p>Must contain only alphanumeric characters and hyphens.</p>\n </li>\n <li>\n <p>A hyphen (-) can separate words but cannot be at the start or end of the name.</p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>The name for the container service.</p>\n\n <p>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 <code>https://<ServiceName>.<RandomGUID>.<AWSRegion>.cs.amazonlightsail.com</code>.\n If the name of your container service is <code>container-service-1</code>, and it's located in\n the US East (Ohio) AWS region (<code>us-east-2</code>), then the domain for your container\n service will be like the following example:\n <code>https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com</code>\n </p>\n\n <p>The following are the requirements for container service names:</p>\n\n <ul>\n <li>\n <p>Must be unique within each Amazon Web Services Region in your Lightsail\n account.</p>\n </li>\n <li>\n <p>Must contain 1 to 63 characters.</p>\n </li>\n <li>\n <p>Must contain only alphanumeric characters and hyphens.</p>\n </li>\n <li>\n <p>A hyphen (-) can separate words but cannot be at the start or end of the name.</p>\n </li>\n </ul>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -4487,6 +4571,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The IP address type for the load balancer.</p>\n\n <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for\n IPv4 and IPv6.</p>\n\n <p>The default value is <code>dualstack</code>.</p>"
|
||||
}
|
||||
},
|
||||
"tlsPolicyName": {
|
||||
"target": "com.amazonaws.lightsail#string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the TLS policy to apply to the load balancer.</p>\n\n <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html\">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can\n specify.</p>\n\n <p>For more information about load balancer TLS policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Load balancer TLS security policies</a> in the <i>Amazon Lightsail Developer\n Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -5057,7 +5147,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes a Amazon Lightsail bucket.</p>\n\n <note>\n <p>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.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Deletes a Amazon Lightsail bucket.</p>\n\n <note>\n <p>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.</p>\n </note>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/ls/api/2016-11-28/DeleteBucket",
|
||||
|
@ -5244,7 +5334,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes a contact method.</p>\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>",
|
||||
"smithy.api#documentation": "<p>Deletes a contact method.</p>\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/ls/api/2016-11-28/DeleteContactMethod",
|
||||
|
@ -7393,7 +7483,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>create\n cloud formation stack</code> operation to create new Amazon EC2 instances.</p>\n <p>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.</p>\n <p></p>\n <p>The <code>export snapshot</code> operation supports tag-based access control via resource\n tags applied to the resource identified by <code>source snapshot name</code>. For more\n information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>\n <note>\n <p>Use the <code>get instance snapshots</code> or <code>get disk snapshots</code>\n operations to get a list of snapshots that you can export to Amazon EC2.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>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 <code>create\n cloud formation stack</code> operation to create new Amazon EC2 instances.</p>\n <p>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.</p>\n <p></p>\n <p>The <code>export snapshot</code> operation supports tag-based access control via resource\n tags applied to the resource identified by <code>source snapshot name</code>. For more\n information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>\n <note>\n <p>Use the <code>get instance snapshots</code> or <code>get disk snapshots</code>\n operations to get a list of snapshots that you can export to Amazon EC2.</p>\n </note>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/ls/api/2016-11-28/ExportSnapshot",
|
||||
|
@ -8108,7 +8198,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns information about one or more Amazon Lightsail buckets.</p>\n\n <p>For more information about buckets, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail\">Buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer\n Guide</i>..</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>For more information about buckets, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail\">Buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer\n Guide</i>.</p>",
|
||||
"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": "<p>The name of the bucket for which to return information.</p>\n\n <p>When omitted, the response includes all of your buckets in the AWS Region where the\n request is made.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the bucket for which to return information.</p>\n\n <p>When omitted, the response includes all of your buckets in the Amazon Web Services Region\n where the request is made.</p>"
|
||||
}
|
||||
},
|
||||
"pageToken": {
|
||||
|
@ -8153,6 +8243,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token to advance to the next page of results from your request.</p>\n\n <p>A next page token is not returned if there are no more results to display.</p>\n\n <p>To get the next page of results, perform another <code>GetBuckets</code> request and\n specify the next page token using the <code>pageToken</code> parameter.</p>"
|
||||
}
|
||||
},
|
||||
"accountLevelBpaSync": {
|
||||
"target": "com.amazonaws.lightsail#AccountLevelBpaSync",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.</p>\n\n <p>For more information about this feature and how it affects Lightsail buckets, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets\">Block public access for buckets in Amazon Lightsail</a>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -8270,7 +8366,7 @@
|
|||
"certificateStatuses": {
|
||||
"target": "com.amazonaws.lightsail#CertificateStatusList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The status of the certificates for which to return information.</p>\n <p>For example, specify <code>ISSUED</code> to return only certificates with an\n <code>ISSUED</code> status.</p>\n <p>When omitted, the response includes all of your certificates in the AWS Region where the\n request is made, regardless of their current status.</p>"
|
||||
"smithy.api#documentation": "<p>The status of the certificates for which to return information.</p>\n <p>For example, specify <code>ISSUED</code> to return only certificates with an\n <code>ISSUED</code> status.</p>\n <p>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.</p>"
|
||||
}
|
||||
},
|
||||
"includeCertificateDetails": {
|
||||
|
@ -8282,7 +8378,7 @@
|
|||
"certificateName": {
|
||||
"target": "com.amazonaws.lightsail#CertificateName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name for the certificate for which to return information.</p>\n <p>When omitted, the response includes all of your certificates in the AWS Region where the\n request is made.</p>"
|
||||
"smithy.api#documentation": "<p>The name for the certificate for which to return information.</p>\n <p>When omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -8395,7 +8491,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.</p>\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>",
|
||||
"smithy.api#documentation": "<p>Returns information about the configured contact methods. Specify a protocol in your\n request to return information about a specific contact method.</p>\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>",
|
||||
"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": "<p>The name of the container service for which to return information.</p>\n\n <p>When omitted, the response includes all of your container services in the AWS Region\n where the request is made.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the container service for which to return information.</p>\n\n <p>When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.</p>",
|
||||
"smithy.api#httpQuery": "serviceName"
|
||||
}
|
||||
}
|
||||
|
@ -9174,7 +9270,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.</p>\n <p>A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your dsitribution.</p>",
|
||||
"smithy.api#documentation": "<p>Returns the bundles that can be applied to your Amazon Lightsail content delivery network\n (CDN) distributions.</p>\n <p>A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.</p>",
|
||||
"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": "<p>The name of the distribution for which to return information.</p>\n \n <p>When omitted, the response includes all of your distributions in the AWS Region where\n the request is made.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the distribution for which to return information.</p>\n \n <p>When omitted, the response includes all of your distributions in the Amazon Web Services\n Region where the request is made.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.</p>\n\n <p>For more information about load balancer TLS security policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Load balancer TLS security policies</a> in the <i>Amazon Lightsail Developer\n Guide</i>.</p>",
|
||||
"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": "<p>The token to advance to the next page of results from your request.</p>\n\n <p>To get a page token, perform an initial <code>GetLoadBalancerTlsPolicies</code> 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.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lightsail#GetLoadBalancerTlsPoliciesResult": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"tlsPolicies": {
|
||||
"target": "com.amazonaws.lightsail#LoadBalancerTlsPolicyList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of objects that describe the TLS security policies that are available.</p>"
|
||||
}
|
||||
},
|
||||
"nextPageToken": {
|
||||
"target": "com.amazonaws.lightsail#string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token to advance to the next page of results from your request.</p>\n\n <p>A next page token is not returned if there are no more results to display.</p>\n\n <p>To get the next page of results, perform another <code>GetLoadBalancerTlsPolicies</code>\n request and specify the next page token using the <code>pageToken</code> parameter.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lightsail#GetLoadBalancers": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
@ -13046,7 +13204,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lightsail throws this exception when user input does not conform to the validation rules\n of an input field.</p>\n <note>\n <p>Domain and distribution APIs are only available in the N. Virginia\n (<code>us-east-1</code>) AWS Region. Please set your AWS Region configuration to\n <code>us-east-1</code> to create, view, or edit these resources.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Lightsail throws this exception when user input does not conform to the validation rules\n of an input field.</p>\n <note>\n <p>Domain and distribution APIs are only available in the N. Virginia\n (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services\n Region configuration to <code>us-east-1</code> to create, view, or edit these\n resources.</p>\n </note>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 400
|
||||
}
|
||||
|
@ -13240,7 +13398,7 @@
|
|||
"location": {
|
||||
"target": "com.amazonaws.lightsail#ResourceLocation",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object that describes the location of the distribution, such as the AWS Region and\n Availability Zone.</p>\n <note>\n <p>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 <code>us-east-1</code> Region.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>An object that describes the location of the distribution, such as the Amazon Web Services\n Region and Availability Zone.</p>\n <note>\n <p>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 <code>us-east-1</code> Region.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"resourceType": {
|
||||
|
@ -13352,7 +13510,7 @@
|
|||
"name": "lightsail"
|
||||
},
|
||||
"aws.protocols#awsJson1_1": {},
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli\">Amazon Lightsail Developer Guide</a>.</p>\n\n <p>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 <a href=\"https://docs.aws.amazon.com/general/latest/gr/lightsail.html\">Amazon Lightsail Endpoints and\n Quotas</a> in the <i>AWS General Reference</i>.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli\">Amazon Lightsail Developer Guide</a>.</p>\n\n <p>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 <a href=\"https://docs.aws.amazon.com/general/latest/gr/lightsail.html\">Amazon Lightsail Endpoints\n and Quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"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": "<p>The IP address type of the load balancer.</p>\n\n <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for\n IPv4 and IPv6.</p>"
|
||||
}
|
||||
},
|
||||
"httpsRedirectionEnabled": {
|
||||
"target": "com.amazonaws.lightsail#boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A Boolean value that indicates whether HTTPS redirection is enabled for the load\n balancer.</p>"
|
||||
}
|
||||
},
|
||||
"tlsPolicyName": {
|
||||
"target": "com.amazonaws.lightsail#ResourceName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the TLS security policy for the load balancer.</p>\n\n <p>The following TLS security policy names are possible:</p>\n <ul>\n <li>\n <p>\n <code>TLS-2016-08</code>\n </p>\n </li>\n <li>\n <p>\n <code>TLS-FS-Res-1-2-2019-08</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>The name of the TLS security policy.</p>\n\n <p>The following TLS security policy names are possible:</p>\n\n <ul>\n <li>\n <p>\n <code>TLS-2016-08</code>\n </p>\n </li>\n <li>\n <p>\n <code>TLS-FS-Res-1-2-2019-08</code>\n </p>\n </li>\n </ul>\n\n <p>You can specify either of these values for the <code>tlsSecurityPolicyName</code> request\n parameter in the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateLoadBalancer.html\">CreateLoadBalancer</a> action, and the <code>attributeValue</code> request parameter in\n the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateLoadBalancerAttribute.html\">UpdateLoadBalancerAttribute</a> action.</p>"
|
||||
}
|
||||
},
|
||||
"isDefault": {
|
||||
"target": "com.amazonaws.lightsail#boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A Boolean value that indicates whether the TLS security policy is the default.</p>"
|
||||
}
|
||||
},
|
||||
"description": {
|
||||
"target": "com.amazonaws.lightsail#string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The description of the TLS security policy.</p>"
|
||||
}
|
||||
},
|
||||
"protocols": {
|
||||
"target": "com.amazonaws.lightsail#StringList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The protocols used in a given TLS security policy.</p>\n\n <p>The following protocols are possible:</p>\n <ul>\n <li>\n <p>\n <code>Protocol-TLSv1</code>\n </p>\n </li>\n <li>\n <p>\n <code>Protocol-TLSv1.1</code>\n </p>\n </li>\n <li>\n <p>\n <code>Protocol-TLSv1.2</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"ciphers": {
|
||||
"target": "com.amazonaws.lightsail#StringList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ciphers used by the TLS security policy.</p>\n <p>The ciphers are listed in order of preference.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the TLS security policies that are available for Lightsail load\n balancers.</p>\n\n <p>For more information about load balancer TLS security policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Load balancer TLS security policies</a> in the <i>Amazon Lightsail\n Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The AWS Region and Availability Zone.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services Region and Availability Zone.</p>"
|
||||
}
|
||||
},
|
||||
"isTerminal": {
|
||||
|
@ -15881,7 +16106,7 @@
|
|||
"contactProtocols": {
|
||||
"target": "com.amazonaws.lightsail#ContactProtocolsList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The contact protocols to use for the alarm, such as <code>Email</code>, <code>SMS</code>\n (text messaging), or both.</p>\n <p>A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.</p>\n <p>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 <code>notificationEnabled</code> paramater.</p>\n <p>Use the <code>CreateContactMethod</code> action to configure a contact protocol in an\n AWS Region.</p>"
|
||||
"smithy.api#documentation": "<p>The contact protocols to use for the alarm, such as <code>Email</code>, <code>SMS</code>\n (text messaging), or both.</p>\n <p>A notification is sent via the specified contact protocol if notifications are enabled for\n the alarm, and when the alarm is triggered.</p>\n <p>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 <code>notificationEnabled</code> paramater.</p>\n <p>Use the <code>CreateContactMethod</code> action to configure a contact protocol in an\n Amazon Web Services Region.</p>"
|
||||
}
|
||||
},
|
||||
"notificationTriggers": {
|
||||
|
@ -16326,7 +16551,10 @@
|
|||
"type": "structure",
|
||||
"members": {
|
||||
"containerImage": {
|
||||
"target": "com.amazonaws.lightsail#ContainerImage"
|
||||
"target": "com.amazonaws.lightsail#ContainerImage",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object that describes a container image that is registered to a Lightsail container\n service</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -17342,7 +17570,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>\n <p>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.</p>\n <important>\n <p>Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.</p>\n </important>",
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>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 <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>\n <p>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.</p>\n <important>\n <p>Notifications are not sent to an email contact method until after it is verified, and\n confirmed as valid.</p>\n </important>",
|
||||
"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": "<p>The resource type.</p>\n <p>The possible values are <code>Distribution</code>, <code>Instance</code>, and\n <code>LoadBalancer</code>.</p>\n <note>\n <p>Distribution-related APIs are available only in the N. Virginia (<code>us-east-1</code>)\n AWS Region. Set your AWS Region configuration to <code>us-east-1</code> to create, view,\n or edit distributions.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>The resource type.</p>\n <p>The possible values are <code>Distribution</code>, <code>Instance</code>, and\n <code>LoadBalancer</code>.</p>\n <note>\n <p>Distribution-related APIs are available only in the N. Virginia (<code>us-east-1</code>)\n Amazon Web Services Region. Set your Amazon Web Services Region configuration to\n <code>us-east-1</code> to create, view, or edit distributions.</p>\n </note>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -17507,7 +17735,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.</p>\n\n <p>Lightsail buckets currently support setting access for Lightsail instances in the same\n AWS Region.</p>",
|
||||
"smithy.api#documentation": "<p>Sets the Amazon Lightsail resources that can access the specified Lightsail\n bucket.</p>\n\n <p>Lightsail buckets currently support setting access for Lightsail instances in the same\n Amazon Web Services Region.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/ls/api/2016-11-28/SetResourceAccessForBucket",
|
||||
|
@ -18309,7 +18537,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates an existing Amazon Lightsail bucket.</p>\n\n <p>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.</p>",
|
||||
"smithy.api#documentation": "<p>Updates an existing Amazon Lightsail bucket.</p>\n\n <p>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.</p>",
|
||||
"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": "<p>An array of strings to specify the AWS account IDs that can access the bucket.</p>\n\n <p>You can give a maximum of 10 AWS accounts access to a bucket.</p>"
|
||||
"smithy.api#documentation": "<p>An array of strings to specify the Amazon Web Services account IDs that can access the\n bucket.</p>\n\n <p>You can give a maximum of 10 Amazon Web Services accounts access to a bucket.</p>"
|
||||
}
|
||||
},
|
||||
"accessLogConfig": {
|
||||
|
@ -18582,7 +18810,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.</p>\n <p>A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your dsitribution.</p>\n <p>Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.</p>\n <p>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 <code>GetDistributions</code> action. The <code>ableToUpdateBundle</code> parameter in the\n result will indicate whether you can currently update your distribution's bundle.</p>",
|
||||
"smithy.api#documentation": "<p>Updates the bundle of your Amazon Lightsail content delivery network (CDN)\n distribution.</p>\n <p>A distribution bundle specifies the monthly network transfer quota and monthly cost of\n your distribution.</p>\n <p>Update your distribution's bundle if your distribution is going over its monthly network\n transfer quota and is incurring an overage fee.</p>\n <p>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 <code>GetDistributions</code> action. The <code>ableToUpdateBundle</code> parameter in the\n result will indicate whether you can currently update your distribution's bundle.</p>",
|
||||
"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": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -18791,14 +19022,14 @@
|
|||
"attributeName": {
|
||||
"target": "com.amazonaws.lightsail#LoadBalancerAttributeName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the attribute you want to update. Valid values are below.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the attribute you want to update.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"attributeValue": {
|
||||
"target": "com.amazonaws.lightsail#StringMax256",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The value that you want to specify for the attribute name.</p>",
|
||||
"smithy.api#documentation": "<p>The value that you want to specify for the attribute name.</p>\n <p>The following values are supported depending on what you specify for the\n <code>attributeName</code> request parameter:</p>\n <ul>\n <li>\n <p>If you specify <code>HealthCheckPath</code> for the <code>attributeName</code> request\n parameter, then the <code>attributeValue</code> request parameter must be the path to ping\n on the target (for example, <code>/weather/us/wa/seattle</code>).</p>\n </li>\n <li>\n <p>If you specify <code>SessionStickinessEnabled</code> for the\n <code>attributeName</code> request parameter, then the <code>attributeValue</code>\n request parameter must be <code>true</code> or <code>false</code>.</p>\n </li>\n <li>\n <p>If you specify <code>SessionStickiness_LB_CookieDurationSeconds</code> for the\n <code>attributeName</code> request parameter, then the <code>attributeValue</code>\n request parameter must be an interger that represents the cookie duration in\n seconds.</p>\n </li>\n <li>\n <p>If you specify <code>HttpsRedirectionEnabled</code> for the <code>attributeName</code>\n request parameter, then the <code>attributeValue</code> request parameter must be\n <code>true</code> or <code>false</code>.</p>\n </li>\n <li>\n <p>If you specify <code>TlsPolicyName</code> for the <code>attributeName</code> request\n parameter, then the <code>attributeValue</code> request parameter must be <code>TLS\n version 1.0, 1.1, and 1.2</code> or <code>TLS version 1.2</code>.</p>\n </li>\n </ul>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -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": "<p>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. </p>",
|
||||
"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": "<p>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. </p>",
|
||||
"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": "<p>\nIndicates whether there is a potential data issue related to categorical values.\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"NumberOfCategory": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates the number of categories in the data.\n</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nEntity that comprises information on categorical values in data.\n</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>\n\nIndicates the count of occurences of the given statistic.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Percentage": {
|
||||
"target": "com.amazonaws.lookoutequipment#Float",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nIndicates the percentage of occurances of the given statistic.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nEntity that comprises information of count and percentage.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#CreateDataset": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
@ -222,8 +281,7 @@
|
|||
"DatasetSchema": {
|
||||
"target": "com.amazonaws.lookoutequipment#DatasetSchema",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A JSON description of the data that is in each time series dataset, including names,\n column names, and data types. </p>",
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#documentation": "<p>A JSON description of the data that is in each time series dataset, including names,\n column names, and data types. </p>"
|
||||
}
|
||||
},
|
||||
"ServerSideKmsKeyId": {
|
||||
|
@ -587,7 +645,7 @@
|
|||
"IngestionInputConfiguration": {
|
||||
"target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> Specifies information for the input data for the data inference job, including data S3\n location parameters. </p>"
|
||||
"smithy.api#documentation": "<p> Specifies information for the input data for the data inference job, including data Amazon S3\n location parameters. </p>"
|
||||
}
|
||||
},
|
||||
"Status": {
|
||||
|
@ -615,6 +673,58 @@
|
|||
"smithy.api#documentation": "<p>The configuration is the <code>TargetSamplingRate</code>, 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 <code>TargetSamplingRate</code> is 1 minute.</p>\n <p>When providing a value for the <code>TargetSamplingRate</code>, you must \n attach the prefix \"PT\" to the rate you want. The value for a 1 second rate \n is therefore <i>PT1S</i>, the value for a 15 minute rate \n is <i>PT15M</i>, and the value for a 1 hour rate \n is <i>PT1H</i>\n </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#DataQualitySummary": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InsufficientSensorData": {
|
||||
"target": "com.amazonaws.lookoutequipment#InsufficientSensorData",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"MissingSensorData": {
|
||||
"target": "com.amazonaws.lookoutequipment#MissingSensorData",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nParameter that gives information about data that is missing over all the sensors in the input data.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"InvalidSensorData": {
|
||||
"target": "com.amazonaws.lookoutequipment#InvalidSensorData",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nParameter that gives information about data that is invalid over all the sensors in the input data.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"UnsupportedTimestamps": {
|
||||
"target": "com.amazonaws.lookoutequipment#UnsupportedTimestamps",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nParameter that gives information about unsupported timestamps in the input data.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"DuplicateTimestamps": {
|
||||
"target": "com.amazonaws.lookoutequipment#DuplicateTimestamps",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nParameter that gives information about duplicate timestamps in the input data.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Provides information on a specific data ingestion job such as creation time, dataset\n ARN, status, and so on. </p>"
|
||||
"smithy.api#documentation": "<p>Provides information on a specific data ingestion job such as creation time, dataset\n ARN, and status.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest": {
|
||||
|
@ -945,6 +1055,39 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the reason for failure when a data ingestion job has failed. </p>"
|
||||
}
|
||||
},
|
||||
"DataQualitySummary": {
|
||||
"target": "com.amazonaws.lookoutequipment#DataQualitySummary",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nGives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.\n</p>"
|
||||
}
|
||||
},
|
||||
"IngestedFilesSummary": {
|
||||
"target": "com.amazonaws.lookoutequipment#IngestedFilesSummary"
|
||||
},
|
||||
"StatusDetail": {
|
||||
"target": "com.amazonaws.lookoutequipment#BoundedLengthString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n Provides details about status of the ingestion job that is currently in progress.\n </p>"
|
||||
}
|
||||
},
|
||||
"IngestedDataSize": {
|
||||
"target": "com.amazonaws.lookoutequipment#DataSizeInBytes",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n Indicates the size of the ingested dataset.\n </p>"
|
||||
}
|
||||
},
|
||||
"DataStartTime": {
|
||||
"target": "com.amazonaws.lookoutequipment#Timestamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.\n </p>"
|
||||
}
|
||||
},
|
||||
"DataEndTime": {
|
||||
"target": "com.amazonaws.lookoutequipment#Timestamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.\n </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -974,7 +1117,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides a JSON description of the data that is in each time series dataset, including names, column names, and data types.</p>"
|
||||
"smithy.api#documentation": "<p>Provides a JSON description of the data in each time series dataset, including names, column names, and data types.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#DescribeDatasetRequest": {
|
||||
|
@ -1039,6 +1182,36 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the S3 location configuration for the data input for the data ingestion job. </p>"
|
||||
}
|
||||
},
|
||||
"DataQualitySummary": {
|
||||
"target": "com.amazonaws.lookoutequipment#DataQualitySummary",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>"
|
||||
}
|
||||
},
|
||||
"IngestedFilesSummary": {
|
||||
"target": "com.amazonaws.lookoutequipment#IngestedFilesSummary",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.\n</p>"
|
||||
}
|
||||
},
|
||||
"RoleArn": {
|
||||
"target": "com.amazonaws.lookoutequipment#IamRoleArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job. \n </p>"
|
||||
}
|
||||
},
|
||||
"DataStartTime": {
|
||||
"target": "com.amazonaws.lookoutequipment#Timestamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.\n </p>"
|
||||
}
|
||||
},
|
||||
"DataEndTime": {
|
||||
"target": "com.amazonaws.lookoutequipment#Timestamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.\n </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -1338,12 +1511,30 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#DuplicateTimestamps": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"TotalNumberOfDuplicateTimestamps": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates the total number of duplicate timestamps.\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nEntity that comprises information abount duplicate timestamps in the dataset.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p> Specifies configuration information for the output results from for the inference\n execution, including the output S3 location. </p>"
|
||||
"smithy.api#documentation": "<p> Specifies configuration information for the output results from for the inference\n execution, including the output Amazon S3 location. </p>"
|
||||
}
|
||||
},
|
||||
"CustomerResultObject": {
|
||||
|
@ -1475,13 +1666,13 @@
|
|||
"S3InputConfiguration": {
|
||||
"target": "com.amazonaws.lookoutequipment#InferenceS3InputConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> Specifies configuration information for the input data for the inference, including S3\n location of input data.. </p>"
|
||||
"smithy.api#documentation": "<p> Specifies configuration information for the input data for the inference, including Amazon S3\n location of input data.</p>"
|
||||
}
|
||||
},
|
||||
"InputTimeZoneOffset": {
|
||||
"target": "com.amazonaws.lookoutequipment#TimeZoneOffset",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates the difference between your time zone and Greenwich Mean Time (GMT). </p>"
|
||||
"smithy.api#documentation": "<p>Indicates the difference between your time zone and Coordinated Universal Time (UTC).</p>"
|
||||
}
|
||||
},
|
||||
"InferenceInputNameConfiguration": {
|
||||
|
@ -1492,7 +1683,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies configuration information for the input data for the inference, including S3\n location of input data.. </p>"
|
||||
"smithy.api#documentation": "<p>Specifies configuration information for the input data for the inference, including Amazon S3\n location of input data.. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#InferenceInputNameConfiguration": {
|
||||
|
@ -1687,6 +1878,34 @@
|
|||
"smithy.api#documentation": "<p>Contains information about the specific inference scheduler, including data delay\n offset, model name and ARN, status, and so on. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#IngestedFilesSummary": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"TotalNumberOfFiles": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates the total number of files that were submitted for ingestion.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"IngestedNumberOfFiles": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates the number of files that were successfully ingested.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"DiscardedFiles": {
|
||||
"target": "com.amazonaws.lookoutequipment#ListOfDiscardedFiles",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#IngestionInputConfiguration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
@ -1746,12 +1965,46 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The prefix for the S3 location being used for the input data for the data ingestion.\n </p>"
|
||||
}
|
||||
},
|
||||
"KeyPattern": {
|
||||
"target": "com.amazonaws.lookoutequipment#KeyPattern",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> Specifies S3 configuration information for the input data for the data ingestion job.\n </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#InsufficientSensorData": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"MissingCompleteSensorData": {
|
||||
"target": "com.amazonaws.lookoutequipment#MissingCompleteSensorData",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nParameter that describes the total number of sensors that have data completely missing for it.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SensorsWithShortDateRange": {
|
||||
"target": "com.amazonaws.lookoutequipment#SensorsWithShortDateRange",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nEntity that comprises aggregated information on sensors having insufficient data.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>\n\nIndicates the number of sensors that have at least some invalid values.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"TotalNumberOfInvalidValues": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nIndicates the total number of invalid values across all the sensors.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nEntity that comprises aggregated information on sensors having insufficient data.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The location information (prefix and bucket name) for the s3 location being used for\n label data. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#LargeTimestampGaps": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Status": {
|
||||
"target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates whether there is a potential data issue related to large gaps in timestamps.\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"NumberOfLargeTimestampGaps": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates the number of large timestamp gaps, if there are any.\n</p>"
|
||||
}
|
||||
},
|
||||
"MaxTimestampGapInDays": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates the size of the largest timestamp gap, in days.\n</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nEntity that comprises information on large gaps between consecutive timestamps in data.\n</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>\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</p>",
|
||||
"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": "<p>\nThe name of the dataset associated with the list of Sensor Statistics.\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"IngestionJobId": {
|
||||
"target": "com.amazonaws.lookoutequipment#IngestionJobId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"target": "com.amazonaws.lookoutequipment#MaxResults",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nSpecifies the maximum number of sensors for which to retrieve statistics.\n</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.lookoutequipment#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nAn opaque pagination token indicating where to continue the listing of sensor statistics.\n</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#ListSensorStatisticsResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"SensorStatisticsSummaries": {
|
||||
"target": "com.amazonaws.lookoutequipment#SensorStatisticsSummaries",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.lookoutequipment#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nAn opaque pagination token indicating where to continue the listing of sensor statistics.\n</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>\n\nIndicates the number of sensors that have data missing completely.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nEntity that comprises information on sensors that have sensor data completely missing.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#MissingSensorData": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AffectedSensorCount": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nIndicates the number of sensors that have atleast some data missing.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"TotalNumberOfMissingValues": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nIndicates the total number of missing values across all the sensors.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nEntity that comprises aggregated information on sensors having missing data.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#ModelArn": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
@ -2366,6 +2806,61 @@
|
|||
"smithy.api#documentation": "<p>Provides information about the specified ML model, including dataset and model names and\n ARNs, as well as status. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#MonotonicValues": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Status": {
|
||||
"target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates whether there is a potential data issue related to having monotonic values.\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Monotonicity": {
|
||||
"target": "com.amazonaws.lookoutequipment#Monotonicity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.\n</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nEntity that comprises information on monotonic values in the data.\n</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>\n Indicates whether there is a potential data issue related to having multiple operating modes.\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nEntity that comprises information on operating modes in data.\n</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>\n\nName of the component to which the particular sensor belongs for which the statistics belong to.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"SensorName": {
|
||||
"target": "com.amazonaws.lookoutequipment#SensorName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nName of the sensor that the statistics belong to.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"DataExists": {
|
||||
"target": "com.amazonaws.lookoutequipment#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nParameter that indicates whether data exists for the sensor that the statistics belong to.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"MissingValues": {
|
||||
"target": "com.amazonaws.lookoutequipment#CountPercent",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>"
|
||||
}
|
||||
},
|
||||
"InvalidValues": {
|
||||
"target": "com.amazonaws.lookoutequipment#CountPercent",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>"
|
||||
}
|
||||
},
|
||||
"InvalidDateEntries": {
|
||||
"target": "com.amazonaws.lookoutequipment#CountPercent",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nParameter that describes the total number of invalid date entries associated with the sensor that the statistics belong to.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"DuplicateTimestamps": {
|
||||
"target": "com.amazonaws.lookoutequipment#CountPercent",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nParameter that describes the total number of duplicate timestamp records associated with the sensor that the statistics belong to.\n</p>"
|
||||
}
|
||||
},
|
||||
"CategoricalValues": {
|
||||
"target": "com.amazonaws.lookoutequipment#CategoricalValues",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nParameter that describes potential risk about whether data associated with the sensor is categorical.\n</p>"
|
||||
}
|
||||
},
|
||||
"MultipleOperatingModes": {
|
||||
"target": "com.amazonaws.lookoutequipment#MultipleOperatingModes",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nParameter that describes potential risk about whether data associated with the sensor has more than one operating mode.\n</p>"
|
||||
}
|
||||
},
|
||||
"LargeTimestampGaps": {
|
||||
"target": "com.amazonaws.lookoutequipment#LargeTimestampGaps",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nParameter that describes potential risk about whether data associated with the sensor contains one or more large gaps between consecutive timestamps.\n</p>"
|
||||
}
|
||||
},
|
||||
"MonotonicValues": {
|
||||
"target": "com.amazonaws.lookoutequipment#MonotonicValues",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nParameter that describes potential risk about whether data associated with the sensor is mostly monotonic.\n</p>"
|
||||
}
|
||||
},
|
||||
"DataStartTime": {
|
||||
"target": "com.amazonaws.lookoutequipment#Timestamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates the time reference to indicate the beginning of valid data associated with the sensor that the statistics belong to.\n</p>"
|
||||
}
|
||||
},
|
||||
"DataEndTime": {
|
||||
"target": "com.amazonaws.lookoutequipment#Timestamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nIndicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.\n</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\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</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#SensorsWithShortDateRange": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AffectedSensorCount": {
|
||||
"target": "com.amazonaws.lookoutequipment#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nIndicates the number of sensors that have less than 90 days of data.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nEntity that comprises information on sensors that have shorter date range.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>\n\nIndicates the total number of unsupported timestamps across the ingested data.\n\n</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n\nEntity that comprises information abount unsupported timestamps in the dataset.\n\n</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutequipment#UntagResource": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
|
@ -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": "<p>A string.</p>"
|
||||
}
|
||||
},
|
||||
"N": {
|
||||
"target": "com.amazonaws.lookoutmetrics#NumberAttributeValue",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A number.</p>"
|
||||
}
|
||||
},
|
||||
"B": {
|
||||
"target": "com.amazonaws.lookoutmetrics#BinaryAttributeValue",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A binary value.</p>"
|
||||
}
|
||||
},
|
||||
"SS": {
|
||||
"target": "com.amazonaws.lookoutmetrics#StringListAttributeValue",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of strings.</p>"
|
||||
}
|
||||
},
|
||||
"NS": {
|
||||
"target": "com.amazonaws.lookoutmetrics#NumberListAttributeValue",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of numbers.</p>"
|
||||
}
|
||||
},
|
||||
"BS": {
|
||||
"target": "com.amazonaws.lookoutmetrics#BinaryListAttributeValue",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of binary values.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An attribute value.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#AutoDetectionMetricSource": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"S3SourceConfig": {
|
||||
"target": "com.amazonaws.lookoutmetrics#AutoDetectionS3SourceConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The source's source config.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An auto detection metric source.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#AutoDetectionS3SourceConfig": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"TemplatedPathList": {
|
||||
"target": "com.amazonaws.lookoutmetrics#TemplatedPathList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The config's templated path list.</p>"
|
||||
}
|
||||
},
|
||||
"HistoricalDataPathList": {
|
||||
"target": "com.amazonaws.lookoutmetrics#HistoricalDataPathList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The config's historical data path list.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An auto detection source config.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Detects an Amazon S3 dataset's file format, interval, and offset.</p>",
|
||||
"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": "<p>An anomaly detector ARN.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"AutoDetectionMetricSource": {
|
||||
"target": "com.amazonaws.lookoutmetrics#AutoDetectionMetricSource",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A data source.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#DetectMetricSetConfigResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"DetectedMetricSetConfig": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedMetricSetConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The inferred dataset configuration for the datasource.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#DetectedCsvFormatDescriptor": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FileCompression": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The format's file compression.</p>"
|
||||
}
|
||||
},
|
||||
"Charset": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The format's charset.</p>"
|
||||
}
|
||||
},
|
||||
"ContainsHeader": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Whether the format includes a header.</p>"
|
||||
}
|
||||
},
|
||||
"Delimiter": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The format's delimiter.</p>"
|
||||
}
|
||||
},
|
||||
"HeaderList": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The format's header list.</p>"
|
||||
}
|
||||
},
|
||||
"QuoteSymbol": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The format's quote symbol.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Properties of an inferred CSV format.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#DetectedField": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Value": {
|
||||
"target": "com.amazonaws.lookoutmetrics#AttributeValue",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The field's value.</p>"
|
||||
}
|
||||
},
|
||||
"Confidence": {
|
||||
"target": "com.amazonaws.lookoutmetrics#Confidence",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The field's confidence.</p>"
|
||||
}
|
||||
},
|
||||
"Message": {
|
||||
"target": "com.amazonaws.lookoutmetrics#Message",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The field's message.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An inferred field.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#DetectedFileFormatDescriptor": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CsvFormatDescriptor": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedCsvFormatDescriptor",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Details about a CSV format.</p>"
|
||||
}
|
||||
},
|
||||
"JsonFormatDescriptor": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedJsonFormatDescriptor",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Details about a JSON format.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Properties of an inferred data format.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#DetectedJsonFormatDescriptor": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FileCompression": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The format's file compression.</p>"
|
||||
}
|
||||
},
|
||||
"Charset": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The format's character set.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A detected JSON format descriptor.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#DetectedMetricSetConfig": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Offset": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The dataset's offset.</p>"
|
||||
}
|
||||
},
|
||||
"MetricSetFrequency": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedField",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The dataset's interval.</p>"
|
||||
}
|
||||
},
|
||||
"MetricSource": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedMetricSource",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The dataset's data source.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An inferred dataset configuration.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#DetectedMetricSource": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"S3SourceConfig": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedS3SourceConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The data source's source configuration.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An inferred data source.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lookoutmetrics#DetectedS3SourceConfig": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FileFormatDescriptor": {
|
||||
"target": "com.amazonaws.lookoutmetrics#DetectedFileFormatDescriptor",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The source's file format descriptor.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An inferred source configuration.</p>"
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
|
|
|
@ -1110,6 +1110,13 @@
|
|||
"smithy.api#jsonName": "jobId"
|
||||
}
|
||||
},
|
||||
"originType": {
|
||||
"target": "com.amazonaws.macie2#OriginType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies how Amazon Macie found the sensitive data that produced the finding: SENSITIVE_DATA_DISCOVERY_JOB, for a classification job.</p>",
|
||||
"smithy.api#jsonName": "originType"
|
||||
}
|
||||
},
|
||||
"result": {
|
||||
"target": "com.amazonaws.macie2#ClassificationResult",
|
||||
"traits": {
|
||||
|
@ -1119,7 +1126,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides information about a sensitive data finding, including the classification job that produced the finding.</p>"
|
||||
"smithy.api#documentation": "<p>Provides information about a sensitive data finding and the details of the finding.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.macie2#ClassificationExportConfiguration": {
|
||||
|
@ -4423,7 +4430,7 @@
|
|||
"findingIds": {
|
||||
"target": "com.amazonaws.macie2#__listOf__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of strings that lists the unique identifiers for the findings to retrieve.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#jsonName": "findingIds",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -5262,7 +5269,7 @@
|
|||
"com.amazonaws.macie2#JobComparator": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The operator to use in a condition. Valid values are:</p>",
|
||||
"smithy.api#documentation": "<p>The operator to use in a condition. Depending on the type of condition, possible values are:</p>",
|
||||
"smithy.api#enum": [
|
||||
{
|
||||
"value": "EQ",
|
||||
|
@ -7009,6 +7016,18 @@
|
|||
]
|
||||
}
|
||||
},
|
||||
"com.amazonaws.macie2#OriginType": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies how Amazon Macie found the sensitive data that produced a finding. The only possible value is:</p>",
|
||||
"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": "<p>Specifies the locations of occurrences of sensitive data in a non-binary text file.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.macie2#Record": {
|
||||
|
@ -7259,6 +7281,9 @@
|
|||
"type": "list",
|
||||
"member": {
|
||||
"target": "com.amazonaws.macie2#Record"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the locations of occurrences of sensitive data in an Apache Avro object container or a structured data file.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.macie2#RelationshipStatus": {
|
||||
|
@ -8909,7 +8934,7 @@
|
|||
"tagKeys": {
|
||||
"target": "com.amazonaws.macie2#__listOf__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 (&).</p>",
|
||||
"smithy.api#documentation": "<p>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 (&).</p>",
|
||||
"smithy.api#httpQuery": "tagKeys",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
|
@ -234,7 +234,7 @@
|
|||
"AdSegmentUrlPrefix": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.&lt;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.</p>"
|
||||
"smithy.api#documentation": "<p>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.&lt;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.</p>"
|
||||
}
|
||||
},
|
||||
"ContentSegmentUrlPrefix": {
|
||||
|
@ -310,6 +310,13 @@
|
|||
"smithy.api#documentation": "<p>The tags to assign to the channel.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
},
|
||||
"Tier": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The tier for this channel. STANDARD tier channels can contain live programs.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -477,6 +484,12 @@
|
|||
"smithy.api#documentation": "<p>The tags to assign to the channel.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
},
|
||||
"Tier": {
|
||||
"target": "com.amazonaws.mediatailor#Tier",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The tier of the channel.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -537,6 +550,112 @@
|
|||
"smithy.api#documentation": "<p>The tags assigned to the channel.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
},
|
||||
"Tier": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The channel's tier.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#CreateLiveSource": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.mediatailor#CreateLiveSourceRequest"
|
||||
},
|
||||
"output": {
|
||||
"target": "com.amazonaws.mediatailor#CreateLiveSourceResponse"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates name for a specific live source in a source location.</p>",
|
||||
"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": "<p>A list of HTTP package configuration parameters for this live source.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the live source you are working on.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the source location you are working on.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.mediatailor#__mapOf__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The tags to assign to the live source.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#CreateLiveSourceResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Arn": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the live source.</p>"
|
||||
}
|
||||
},
|
||||
"CreationTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp that indicates when the live source was created.</p>"
|
||||
}
|
||||
},
|
||||
"HttpPackageConfigurations": {
|
||||
"target": "com.amazonaws.mediatailor#HttpPackageConfigurations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The HTTP package configurations.</p>"
|
||||
}
|
||||
},
|
||||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp that indicates when the live source was modified.</p>"
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the live source.</p>"
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the source location associated with the VOD source.</p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.mediatailor#__mapOf__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The tags assigned to the live source.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -673,6 +792,12 @@
|
|||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the LiveSource for this Program.</p>"
|
||||
}
|
||||
},
|
||||
"ProgramName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
|
@ -698,8 +823,7 @@
|
|||
"VodSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name that's used to refer to a VOD source.</p>",
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#documentation": "<p>The name that's used to refer to a VOD source.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -731,6 +855,12 @@
|
|||
"smithy.api#documentation": "<p>The timestamp of when the program was created.</p>"
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the LiveSource for this Program.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>A list of the segment delivery configurations associated with this resource.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>A list of the segment delivery configurations associated with this resource.</p>"
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
|
@ -896,7 +1032,7 @@
|
|||
"HttpPackageConfigurations": {
|
||||
"target": "com.amazonaws.mediatailor#HttpPackageConfigurations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of HTTP package configuration parameters for this VOD source.</p>",
|
||||
"smithy.api#documentation": "<p>A list of HTTP package configuration parameters for this VOD source.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -949,7 +1085,7 @@
|
|||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN for the VOD source.</p>"
|
||||
"smithy.api#documentation": "<p>The last modified time of the VOD source.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Deletes a specific live source in a specific source location.</p>",
|
||||
"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": "<p>The identifier for the live source you are working on.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the source location you are working on.</p>",
|
||||
"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": "<p>The tags assigned to the channel.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
},
|
||||
"Tier": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The channel's tier.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#DescribeLiveSource": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.mediatailor#DescribeLiveSourceRequest"
|
||||
},
|
||||
"output": {
|
||||
"target": "com.amazonaws.mediatailor#DescribeLiveSourceResponse"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides details about a specific live source in a specific source location.</p>",
|
||||
"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": "<p>The identifier for the live source you are working on.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the source location you are working on.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#DescribeLiveSourceResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Arn": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the live source.</p>"
|
||||
}
|
||||
},
|
||||
"CreationTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp that indicates when the live source was created.</p>"
|
||||
}
|
||||
},
|
||||
"HttpPackageConfigurations": {
|
||||
"target": "com.amazonaws.mediatailor#HttpPackageConfigurations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The HTTP package configurations.</p>"
|
||||
}
|
||||
},
|
||||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp that indicates when the live source was modified.</p>"
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the live source.</p>"
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the source location associated with the VOD source.</p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.mediatailor#__mapOf__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The tags assigned to the live source.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -1482,6 +1752,12 @@
|
|||
"smithy.api#documentation": "<p>The timestamp of when the program was created.</p>"
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the LiveSource for this Program.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>A list of the segment delivery configurations associated with this resource.</p>"
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
|
@ -1657,7 +1936,7 @@
|
|||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN for the VOD source.</p>"
|
||||
"smithy.api#documentation": "<p>The last modified time of the VOD source.</p>"
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
|
@ -1785,7 +2064,7 @@
|
|||
"Items": {
|
||||
"target": "com.amazonaws.mediatailor#__listOfScheduleEntry",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of schedule entries for the channel.</p>"
|
||||
"smithy.api#documentation": "<p>A list of schedule entries for the channel.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
@ -2162,7 +2441,7 @@
|
|||
"Items": {
|
||||
"target": "com.amazonaws.mediatailor#__listOfAlert",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of alerts that are associated with this resource.</p>"
|
||||
"smithy.api#documentation": "<p>A list of alerts that are associated with this resource.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
@ -2221,7 +2500,7 @@
|
|||
"Items": {
|
||||
"target": "com.amazonaws.mediatailor#__listOfChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of channels that are associated with this account.</p>"
|
||||
"smithy.api#documentation": "<p>A list of channels that are associated with this account.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>lists all the live sources in a source location.</p>",
|
||||
"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": "<p>Upper bound on number of records to return. The maximum number of results is 100.</p>",
|
||||
"smithy.api#httpQuery": "maxResults"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Pagination token from the GET list request. Use the token to fetch the next page of results.</p>",
|
||||
"smithy.api#httpQuery": "nextToken"
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the source location you are working on.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#ListLiveSourcesResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Items": {
|
||||
"target": "com.amazonaws.mediatailor#__listOfLiveSource",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the live sources.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Pagination token from the list request. Use the token to fetch the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#ListPlaybackConfigurations": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
@ -2410,7 +2756,7 @@
|
|||
"Items": {
|
||||
"target": "com.amazonaws.mediatailor#__listOfSourceLocation",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of source locations.</p>"
|
||||
"smithy.api#documentation": "<p>A list of source locations.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
@ -2555,6 +2901,61 @@
|
|||
"smithy.api#documentation": "<p>The configuration for pre-roll ad insertion.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#LiveSource": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Arn": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN for the live source.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"CreationTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp that indicates when the live source was created.</p>"
|
||||
}
|
||||
},
|
||||
"HttpPackageConfigurations": {
|
||||
"target": "com.amazonaws.mediatailor#HttpPackageConfigurations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The HTTP package configurations for the live source.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp that indicates when the live source was last modified.</p>"
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name that's used to refer to a live source.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the source location.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.mediatailor#__mapOf__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The tags assigned to the live source.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Live source configuration parameters.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The name of the live source used for the program.</p>"
|
||||
}
|
||||
},
|
||||
"ProgramName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
|
@ -3496,8 +3918,7 @@
|
|||
"VodSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the VOD source.</p>",
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#documentation": "<p>The name of the VOD source.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -3550,11 +3971,20 @@
|
|||
"type": "structure",
|
||||
"members": {
|
||||
"BaseUrl": {
|
||||
"target": "com.amazonaws.mediatailor#__string"
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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*.</p>"
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
"target": "com.amazonaws.mediatailor#__string"
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A unique identifier used to distinguish between multiple segment delivery configurations in a source location.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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*.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#SlateSource": {
|
||||
|
@ -3619,7 +4049,10 @@
|
|||
}
|
||||
},
|
||||
"SegmentDeliveryConfigurations": {
|
||||
"target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration"
|
||||
"target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The segment delivery configurations for the source location.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The duration of the live program in seconds.</p>"
|
||||
}
|
||||
},
|
||||
"RelativePosition": {
|
||||
"target": "com.amazonaws.mediatailor#RelativePosition",
|
||||
"traits": {
|
||||
|
@ -3969,6 +4423,105 @@
|
|||
"smithy.api#documentation": "<p>The tags assigned to the channel.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
},
|
||||
"Tier": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The channel's tier.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#UpdateLiveSource": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.mediatailor#UpdateLiveSourceRequest"
|
||||
},
|
||||
"output": {
|
||||
"target": "com.amazonaws.mediatailor#UpdateLiveSourceResponse"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates a specific live source in a specific source location.</p>",
|
||||
"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": "<p>A list of HTTP package configurations for the live source on this account.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the live source you are working on.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the source location you are working on.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.mediatailor#UpdateLiveSourceResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Arn": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the live source.</p>"
|
||||
}
|
||||
},
|
||||
"CreationTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp that indicates when the live source was created.</p>"
|
||||
}
|
||||
},
|
||||
"HttpPackageConfigurations": {
|
||||
"target": "com.amazonaws.mediatailor#HttpPackageConfigurations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The HTTP package configurations.</p>"
|
||||
}
|
||||
},
|
||||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp that indicates when the live source was modified.</p>"
|
||||
}
|
||||
},
|
||||
"LiveSourceName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the live source.</p>"
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the source location associated with the VOD source.</p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.mediatailor#__mapOf__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The tags assigned to the live source.</p>",
|
||||
"smithy.api#jsonName": "tags"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -4012,7 +4565,10 @@
|
|||
}
|
||||
},
|
||||
"SegmentDeliveryConfigurations": {
|
||||
"target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration"
|
||||
"target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of the segment delivery configurations associated with this resource.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>A list of the segment delivery configurations associated with this resource.</p>"
|
||||
}
|
||||
},
|
||||
"SourceLocationName": {
|
||||
"target": "com.amazonaws.mediatailor#__string",
|
||||
|
@ -4104,7 +4663,7 @@
|
|||
"HttpPackageConfigurations": {
|
||||
"target": "com.amazonaws.mediatailor#HttpPackageConfigurations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of HTTP package configurations for the VOD source on this account.</p>",
|
||||
"smithy.api#documentation": "<p>A list of HTTP package configurations for the VOD source on this account.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -4150,7 +4709,7 @@
|
|||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.mediatailor#__timestampUnix",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN for the VOD source.</p>"
|
||||
"smithy.api#documentation": "<p>The last modified time of the VOD source.</p>"
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
|
|
|
@ -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": "<p>The Application Migration Service service.</p>",
|
||||
|
@ -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": "<p>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.)</p>",
|
||||
"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": "<p>Creates a new ReplicationConfigurationTemplate.</p>",
|
||||
"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": "<p>Deletes a single Job by ID.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/DeleteJob",
|
||||
"method": "POST",
|
||||
"code": 204
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
|
@ -841,8 +840,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes a single Replication Configuration Template by ID</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/DeleteReplicationConfigurationTemplate",
|
||||
"method": "POST",
|
||||
"code": 204
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
|
@ -886,8 +885,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes a single source server by ID.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/DeleteSourceServer",
|
||||
"method": "POST",
|
||||
"code": 204
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
|
@ -931,8 +930,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes a given vCenter client by ID.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/DeleteVcenterClient",
|
||||
"method": "POST",
|
||||
"code": 204
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
|
@ -969,15 +968,15 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves detailed job log items with paging.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"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": "<p>Request to describe Job log filters.</p>",
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#documentation": "<p>Request to describe Job log filters.</p>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
@ -1156,15 +1154,15 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.</p>",
|
||||
"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": "<p>Request to describe Replication Configuration template by template IDs.</p>",
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#documentation": "<p>Request to describe Replication Configuration template by template IDs.</p>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
@ -1229,15 +1226,15 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves all SourceServers or multiple SourceServers by ID.</p>",
|
||||
"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": "<p>Request to filter Source Servers list.</p>",
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#documentation": "<p>Request to filter Source Servers list.</p>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
@ -1349,15 +1345,15 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns a list of the installed vCenter clients.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/DisconnectFromService",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
|
@ -1514,8 +1510,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/FinalizeCutover",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
|
@ -1574,8 +1570,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists all LaunchConfigurations available, filtered by Source Server IDs.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/GetLaunchConfiguration",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
},
|
||||
"smithy.api#readonly": {}
|
||||
|
@ -1612,8 +1608,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists all ReplicationConfigurations, filtered by Source Server ID.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/GetReplicationConfiguration",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
},
|
||||
"smithy.api#readonly": {}
|
||||
|
@ -1704,8 +1700,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Initialize Application Migration Service.</p>",
|
||||
"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": "<p>List all tags for your Application Migration Service resources.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/tags/{resourceArn}",
|
||||
"code": 200
|
||||
"uri": "/tags/{resourceArn}"
|
||||
},
|
||||
"smithy.api#readonly": {}
|
||||
}
|
||||
|
@ -2523,8 +2515,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/RetryDataReplication",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
|
@ -3170,6 +3159,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Exceeded the service quota code.</p>"
|
||||
}
|
||||
},
|
||||
"quotaValue": {
|
||||
"target": "com.amazonaws.mgn#StrictlyPositiveInteger",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Exceeded the service quota value.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/StartCutover",
|
||||
"method": "POST",
|
||||
"code": 202
|
||||
}
|
||||
}
|
||||
|
@ -3496,8 +3488,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Starts replication for SNAPSHOT_SHIPPING agents.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/StartReplication",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
|
@ -3536,8 +3528,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/StartTest",
|
||||
"method": "POST",
|
||||
"code": 202
|
||||
}
|
||||
}
|
||||
|
@ -3648,8 +3640,7 @@
|
|||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/TerminateTargetInstances",
|
||||
"method": "POST",
|
||||
"code": 202
|
||||
}
|
||||
}
|
||||
|
@ -3859,8 +3850,7 @@
|
|||
"smithy.api#documentation": "<p>Deletes the specified set of tags from the specified set of Application Migration Service resources.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "DELETE",
|
||||
"uri": "/tags/{resourceArn}",
|
||||
"code": 200
|
||||
"uri": "/tags/{resourceArn}"
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
|
@ -3911,8 +3901,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates multiple LaunchConfigurations by Source Server ID.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/UpdateLaunchConfiguration",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
|
@ -4000,8 +3990,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Allows you to update multiple ReplicationConfigurations by Source Server ID.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/UpdateReplicationConfiguration",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
|
@ -4128,8 +4118,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates multiple ReplicationConfigurationTemplates by ID.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/UpdateReplicationConfigurationTemplate",
|
||||
"method": "POST",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
|
@ -4249,8 +4239,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.</p>",
|
||||
"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}"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -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": "<p>The name of the dimension. Dimension names must contain only ASCII characters and must include \n\t\t\tat least one non-whitespace character.</p>",
|
||||
"smithy.api#documentation": "<p>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 (<code>:</code>).</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1425,7 +1428,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>"
|
||||
"smithy.api#documentation": "<p>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\t<code>InstanceId</code> as a dimension name, and the actual instance ID as the value for that dimension.</p>\n\t\t <p>You \n\t\tcan assign up to 10 dimensions to a metric.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatch#DimensionFilter": {
|
||||
|
@ -1496,6 +1499,9 @@
|
|||
"input": {
|
||||
"target": "com.amazonaws.cloudwatch#DisableAlarmActionsInput"
|
||||
},
|
||||
"output": {
|
||||
"target": "smithy.api#Unit"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
|
@ -1560,6 +1566,9 @@
|
|||
"input": {
|
||||
"target": "com.amazonaws.cloudwatch#EnableAlarmActionsInput"
|
||||
},
|
||||
"output": {
|
||||
"target": "smithy.api#Unit"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Enables the actions for the specified alarms.</p>"
|
||||
}
|
||||
|
@ -1869,7 +1878,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>You can use the <code>GetMetricData</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User\n\t\t\t\tGuide</i>.</p>\n\t\t\n\t\t <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than \n\t\t\tcalls to <code>GetMetricStatistics</code>. For more information about pricing, see \n\t\t\t<a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p>\n\n\t\t <p>Amazon CloudWatch retains metric data as follows:</p>\n\t\t <ul>\n <li>\n <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution\n\t\t\t\tmetrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>\n </li>\n <li>\n <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p>\n </li>\n <li>\n <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p>\n </li>\n <li>\n <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>\n </li>\n </ul>\n\t\t <p>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.</p>\n\t\t\n\t\t <p>If you omit <code>Unit</code> 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.</p>",
|
||||
"smithy.api#documentation": "<p>You can use the <code>GetMetricData</code> 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.</p>\n\t\t <p>A <code>GetMetricData</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User\n\t\t\t\t\tGuide</i>.</p>\n\t\t\n\t\t\t\t\n\t\t <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can include only one\n\t\t\tquery. But the same <code>GetMetricData</code> 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 <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html\">Query your metrics with CloudWatch Metrics Insights</a>.</p>\n\t\t\n\t\t <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than \n\t\t\tcalls to <code>GetMetricStatistics</code>. For more information about pricing, see \n\t\t\t<a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p>\n\n\t\t <p>Amazon CloudWatch retains metric data as follows:</p>\n\t\t <ul>\n <li>\n <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution\n\t\t\t\tmetrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>\n </li>\n <li>\n <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p>\n </li>\n <li>\n <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p>\n </li>\n <li>\n <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>\n </li>\n </ul>\n\t\t <p>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.</p>\n\t\t\n\t\t <p>If you omit <code>Unit</code> 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.</p>\n\t\n\t\t <p>\n <b>Using Metrics Insights queries with metric math</b>\n </p>\n\t\t <p>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 <b>GROUP BY</b> 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 <b>GROUP BY</b> 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. </p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
@ -1883,7 +1892,7 @@
|
|||
"MetricDataQueries": {
|
||||
"target": "com.amazonaws.cloudwatch#MetricDataQueries",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The metric queries to be returned. A single <code>GetMetricData</code> call can include as many as 500 <code>MetricDataQuery</code>\n\t\tstructures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data. </p>",
|
||||
"smithy.api#documentation": "<p>The metric queries to be returned. A single <code>GetMetricData</code> call can include as many as 500 <code>MetricDataQuery</code>\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. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -2167,7 +2176,13 @@
|
|||
"OutputFormat": {
|
||||
"target": "com.amazonaws.cloudwatch#MetricStreamOutputFormat",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p></p>"
|
||||
"smithy.api#documentation": "<p>The output format for the stream. Valid values are <code>json</code>\n\t\t\tand <code>opentelemetry0.7</code>. For more information about metric stream\n\t\t\toutput formats, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html\">\n\t\t\t\tMetric streams output formats</a>.</p>"
|
||||
}
|
||||
},
|
||||
"StatisticsConfigurations": {
|
||||
"target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html\">\n\t\t\t\tCloudWatch statistics definitions</a>. </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -3293,7 +3308,7 @@
|
|||
"TreatMissingData": {
|
||||
"target": "com.amazonaws.cloudwatch#TreatMissingData",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of <code>missing</code> is used.</p>"
|
||||
"smithy.api#documentation": "<p>Sets how this alarm is to handle missing data points. The valid values\n \tare <code>breaching</code>, <code>notBreaching</code>, <code>ignore</code>, and \n \t<code>missing</code>. For more information, see\n \t<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data\">Configuring how CloudWatch alarms treat missing data</a>.</p>\n\t\t <p>If this parameter is omitted, the default \n \tbehavior of <code>missing</code> is used.</p>"
|
||||
}
|
||||
},
|
||||
"EvaluateLowSampleCountPercentile": {
|
||||
|
@ -3356,7 +3371,7 @@
|
|||
"Expression": {
|
||||
"target": "com.amazonaws.cloudwatch#MetricExpression",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>Id</code> of the other metrics to refer to those metrics, and can also use the <code>Id</code> of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the\n\t\t\t<i>Amazon CloudWatch User Guide</i>.</p>\n\t\t <p>Within each MetricDataQuery object, you must specify either \n\t\t\t<code>Expression</code> or <code>MetricStat</code> but not both.</p>"
|
||||
"smithy.api#documentation": "<p>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\t<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage\">Metrics Insights query components and syntax</a> in the\n\t\t\t<i>Amazon CloudWatch User Guide</i>.</p>\n\t\t <p>A math expression\n\t\t\tcan use the <code>Id</code> of the other metrics or queries to refer to those metrics, and can also use \n\t\t\tthe <code>Id</code> of other \n\t\t\texpressions to use the result of those expressions. For more information about metric math expressions, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the\n\t\t\t<i>Amazon CloudWatch User Guide</i>.</p>\n\t\t <p>Within each MetricDataQuery object, you must specify either \n\t\t\t<code>Expression</code> or <code>MetricStat</code> but not both.</p>"
|
||||
}
|
||||
},
|
||||
"Label": {
|
||||
|
@ -3385,7 +3400,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported\n\t\t\tuse of this structure is different for those two operations.</p>\n\t\t <p>When used in <code>GetMetricData</code>, 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 <code>GetMetricData</code> call can include up to 500 <code>MetricDataQuery</code>\n\t\t\tstructures.</p>\n\t\t <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each <code>MetricDataQuery</code> 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 <code>PutMetricAlarm</code> call can include up to 20\n\t\t\t\t<code>MetricDataQuery</code> structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the <code>Expression</code> parameter\n\t\t\tto perform a math expression. Of those <code>Expression</code> structures, one must have <code>True</code>\n\t\tas the value for <code>ReturnData</code>. The result of this expression is the value the alarm watches.</p>\n\n\t\t <p>Any expression used in a <code>PutMetricAlarm</code>\n\t\t\toperation must return a single time series. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User\n\t\t\t\tGuide</i>.</p>\n\n\t\t <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code>\n\t\t\toperation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>"
|
||||
"smithy.api#documentation": "<p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported\n\t\t\tuse of this structure is different for those two operations.</p>\n\t\t <p>When used in <code>GetMetricData</code>, 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 <code>GetMetricData</code> call can include up to 500 <code>MetricDataQuery</code>\n\t\t\tstructures.</p>\n\t\t <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a\n\t\t\tmetric math expression. Each <code>MetricDataQuery</code> 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 <code>PutMetricAlarm</code> call can include up to 20\n\t\t\t\t<code>MetricDataQuery</code> structures in the array. The 20 structures can include\n\t\t\tas many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a\n\t\t\tmetric, and as many as 10 structures that contain the <code>Expression</code> parameter\n\t\t\tto perform a math expression. Of those <code>Expression</code> structures, one must have <code>True</code>\n\t\tas the value for <code>ReturnData</code>. The result of this expression is the value the alarm watches.</p>\n\n\t\t <p>Any expression used in a <code>PutMetricAlarm</code>\n\t\t\toperation must return a single time series. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User\n\t\t\t\tGuide</i>.</p>\n\n\t\t <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code>\n\t\t\toperation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>An array of metric name and namespace pairs that stream the additional statistics listed\n\t\tin the value of the <code>AdditionalStatistics</code> parameter. There can be as many as \n\t\t100 pairs in the array.</p>\n\t\t <p>All metrics that match the combination of metric name and namespace will be streamed\n\t\twith the additional statistics, no matter their dimensions.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"AdditionalStatistics": {
|
||||
"target": "com.amazonaws.cloudwatch#MetricStreamStatisticsAdditionalStatistics",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The list of additional statistics that are to be streamed for the metrics listed\n\t\tin the <code>IncludeMetrics</code> array in this structure. This list can include as many as 20 statistics.</p>\n\t\t <p>If the <code>OutputFormat</code> for the stream is <code>opentelemetry0.7</code>, the only \n\t\t\tvalid values are <code>p<i>??</i>\n </code> percentile statistics such as <code>p90</code>, <code>p99</code> and so on.</p>\n\t\t <p>If the <code>OutputFormat</code> for the stream is <code>json</code>, \n\t\t\tthe valid values include the abbreviations for all of the statistics listed in \n\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html\">\n\t\t\t\tCloudWatch statistics definitions</a>. For example, this includes\n\t\t<code>tm98, </code>\n <code>wm90</code>, <code>PR(:300)</code>, and so on.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>, \n\t\t\tand <code>SAMPLECOUNT</code> 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<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html\">\n\t\t\t\tCloudWatch statistics definitions</a>.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The namespace of the metric.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"MetricName": {
|
||||
"target": "com.amazonaws.cloudwatch#MetricName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the metric.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This object contains the information for one metric that is to be streamed with \n\t\tadditional statistics.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Creates or updates a <i>composite alarm</i>. 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.</p>\n\t\t <p>The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms.</p>\n\t\t <p>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.</p>\n\t\t <p>Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.</p>\n\t\t <note>\n <p>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.</p>\n\t\t\t <p>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 <code>AlarmRule</code> of one of the alarms to <code>False</code>. </p>\n\t\t\t <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t</p>\n </note>\n\t\t <p>When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\t<code>INSUFFICIENT_DATA</code>. 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 <code>INSUFFICIENT_DATA</code> state.</p>\n\t\t <p>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.</p>\n\t\t\n\t\t <p>To use this operation, you must be signed on with \n\t\t\tthe <code>cloudwatch:PutCompositeAlarm</code> permission that is scoped to <code>*</code>. You can't create a\n\t\t\tcomposite alarms if your <code>cloudwatch:PutCompositeAlarm</code> permission has a narrower scope.</p>\n\t\t\n\t\t <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.</p>"
|
||||
"smithy.api#documentation": "<p>Creates or updates a <i>composite alarm</i>. 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.</p>\n\t\t <p>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.</p>\n\t\t <p>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.</p>\n\t\t <p>Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.</p>\n\t\t <note>\n <p>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.</p>\n\t\t\t <p>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 <code>AlarmRule</code> of one of the alarms to <code>False</code>. </p>\n\t\t\t <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t</p>\n </note>\n\t\t <p>When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\t<code>INSUFFICIENT_DATA</code>. 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 <code>INSUFFICIENT_DATA</code> state.</p>\n\t\t <p>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.</p>\n\t\t\n\t\t <p>To use this operation, you must be signed on with \n\t\t\tthe <code>cloudwatch:PutCompositeAlarm</code> permission that is scoped to <code>*</code>. You can't create a\n\t\t\tcomposite alarms if your <code>cloudwatch:PutCompositeAlarm</code> permission has a narrower scope.</p>\n\t\t\n\t\t <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p> Sets how this alarm is to handle missing data points. If <code>TreatMissingData</code> is omitted, the default behavior of <code>missing</code> is used. \n\t\t\tFor more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data\">Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data</a>.</p>\n\t\t <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code>\n </p>"
|
||||
"smithy.api#documentation": "<p> Sets how this alarm is to handle missing data points. If <code>TreatMissingData</code> is omitted, the default behavior of <code>missing</code> is used. \n\t\t\tFor more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data\">Configuring How CloudWatch \n\t\t\t\tAlarms Treats Missing Data</a>.</p>\n\t\t <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code>\n </p>\n\t\t <note>\n <p>Alarms that evaluate metrics in the <code>AWS/DynamoDB</code> namespace always <code>ignore</code>\n\t\t\tmissing data even if you choose a different option for <code>TreatMissingData</code>. When an \n\t\t\t<code>AWS/DynamoDB</code> metric has missing data, alarms that evaluate that metric remain in their current state.</p>\n\t\t </note>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>\n\t\t <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html\">\n\t\tUsing Metric Streams</a>.</p>\n\t\t <p>To create a metric stream, \n\t\t\tyou must be logged on to an account that has the <code>iam:PassRole</code> permission\n\t\t\tand either the <code>CloudWatchFullAccess</code>\n\t\tpolicy or the <code>cloudwatch:PutMetricStream</code> \n\t\tpermission.</p>\n\t\t <p>When you create or update a metric stream, you choose one of the following:</p>\n\t\t <ul>\n <li>\n <p>Stream metrics from all metric namespaces in the account.</p>\n </li>\n <li>\n <p>Stream metrics from all metric namespaces in the account, except\n\t\t\t\tfor the namespaces that you list in <code>ExcludeFilters</code>.</p>\n </li>\n <li>\n <p>Stream metrics from only the metric namespaces that you list in \n\t\t\t\t<code>IncludeFilters</code>.</p>\n </li>\n </ul>\n\t\t\n\t\t <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream \n\t\tis created in the <code>running</code> state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html\">\n\t\tUsing Metric Streams</a>.</p>\n\t\t <p>To create a metric stream, \n\t\t\tyou must be logged on to an account that has the <code>iam:PassRole</code> permission\n\t\t\tand either the <code>CloudWatchFullAccess</code>\n\t\tpolicy or the <code>cloudwatch:PutMetricStream</code> \n\t\tpermission.</p>\n\t\t <p>When you create or update a metric stream, you choose one of the following:</p>\n\t\t <ul>\n <li>\n <p>Stream metrics from all metric namespaces in the account.</p>\n </li>\n <li>\n <p>Stream metrics from all metric namespaces in the account, except\n\t\t\t\tfor the namespaces that you list in <code>ExcludeFilters</code>.</p>\n </li>\n <li>\n <p>Stream metrics from only the metric namespaces that you list in \n\t\t\t\t<code>IncludeFilters</code>.</p>\n </li>\n </ul>\n\t\t\n\t\t <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>, \n\t\t\tand <code>SAMPLECOUNT</code> statistics for each metric that is streamed. You can use the\n\t\t\t<code>StatisticsConfigurations</code> 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 <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>. </p>\n\t\t\n\t\t <p>When you use <code>PutMetricStream</code> to create a new metric stream, the stream \n\t\tis created in the <code>running</code> state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatch#PutMetricStreamInput": {
|
||||
|
@ -4330,6 +4419,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\t\t <p>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.</p>\n\t\t <p>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\t<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html\">TagResource</a>\n\t\t\tor <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html\">UntagResource</a>.</p>"
|
||||
}
|
||||
},
|
||||
"StatisticsConfigurations": {
|
||||
"target": "com.amazonaws.cloudwatch#MetricStreamStatisticsConfigurations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>, <code>SUM</code>, \n\t\t\tand <code>SAMPLECOUNT</code> 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.</p>\n\t\t <p>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 <code>OutputFormat</code>.\n\t\t\tIf the <code>OutputFormat</code> is <code>json</code>, you can stream any additional statistic that is supported \n\t\t\tby CloudWatch, listed in \n\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html\">\n\t\t\t\tCloudWatch statistics definitions</a>. If the <code>OutputFormat</code> is \n\t\t\t<code>opentelemetry0.7</code>, you can stream percentile statistics such as p95, p99.9 and so on.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -4473,6 +4568,9 @@
|
|||
"input": {
|
||||
"target": "com.amazonaws.cloudwatch#SetAlarmStateInput"
|
||||
},
|
||||
"output": {
|
||||
"target": "smithy.api#Unit"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.cloudwatch#InvalidFormatFault"
|
||||
|
|
|
@ -29,6 +29,28 @@
|
|||
]
|
||||
},
|
||||
"shapes": {
|
||||
"com.amazonaws.mq#ActionRequired": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ActionRequiredCode": {
|
||||
"target": "com.amazonaws.mq#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com//latest/developer-guide/troubleshooting-action-required-codes.html\">Amazon MQ action required codes</a>. Each code references a topic with detailed information, instructions, and recommendations for how to resolve the issue and prevent future occurrences.</p>",
|
||||
"smithy.api#jsonName": "actionRequiredCode"
|
||||
}
|
||||
},
|
||||
"ActionRequiredInfo": {
|
||||
"target": "com.amazonaws.mq#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Information about the action required to resolve your broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.</p>",
|
||||
"smithy.api#jsonName": "actionRequiredInfo"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The action required to resolve a broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>A list of actions required for a broker.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"smithy.api#title": "AmazonMQ"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -207,7 +207,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>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. </p>"
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>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. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#AssociateSubnetsRequest": {
|
||||
|
@ -292,7 +292,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a>FirewallStatus</a>.</p>"
|
||||
"smithy.api#documentation": "<p>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 <a>FirewallStatus</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#AttachmentStatus": {
|
||||
|
@ -387,7 +387,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates an AWS Network Firewall <a>Firewall</a> and accompanying <a>FirewallStatus</a> for a VPC. </p>\n <p>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. </p> \n <p>After you create a firewall, you can provide additional settings, like the logging configuration. </p>\n <p>To update the settings for a firewall, you use the operations that apply to the settings\n themselves, for example <a>UpdateLoggingConfiguration</a>, <a>AssociateSubnets</a>, and <a>UpdateFirewallDeleteProtection</a>. </p>\n <p>To manage a firewall's tags, use the standard AWS resource tagging operations, <a>ListTagsForResource</a>, <a>TagResource</a>, and <a>UntagResource</a>.</p>\n <p>To retrieve information about firewalls, use <a>ListFirewalls</a> and <a>DescribeFirewall</a>.</p>"
|
||||
"smithy.api#documentation": "<p>Creates an Network Firewall <a>Firewall</a> and accompanying <a>FirewallStatus</a> for a VPC. </p>\n <p>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. </p> \n <p>After you create a firewall, you can provide additional settings, like the logging configuration. </p>\n <p>To update the settings for a firewall, you use the operations that apply to the settings\n themselves, for example <a>UpdateLoggingConfiguration</a>, <a>AssociateSubnets</a>, and <a>UpdateFirewallDeleteProtection</a>. </p>\n <p>To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, <a>ListTagsForResource</a>, <a>TagResource</a>, and <a>UntagResource</a>.</p>\n <p>To retrieve information about firewalls, use <a>ListFirewalls</a> and <a>DescribeFirewall</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#CreateFirewallPolicy": {
|
||||
|
@ -416,7 +416,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates the firewall policy for the firewall according to the specifications. </p>\n <p>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. </p>"
|
||||
"smithy.api#documentation": "<p>Creates the firewall policy for the firewall according to the specifications. </p>\n <p>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. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#CreateFirewallPolicyRequest": {
|
||||
|
@ -451,7 +451,13 @@
|
|||
"DryRun": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>\n <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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. </p>\n <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>\n <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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. </p>\n <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A complex type that contains settings for encryption of your firewall policy resources.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -515,13 +521,13 @@
|
|||
"SubnetChangeProtection": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
}
|
||||
},
|
||||
"FirewallPolicyChangeProtection": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
|
@ -535,6 +541,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The key:value pairs to associate with the resource.</p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A complex type that contains settings for encryption of your firewall resources.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -603,13 +615,13 @@
|
|||
"Rules": {
|
||||
"target": "com.amazonaws.networkfirewall#RulesString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>\n <note>\n <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p>\n </note> \n <p>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 <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>"
|
||||
"smithy.api#documentation": "<p>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. </p>\n <note>\n <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p>\n </note> \n <p>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 <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>"
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroupType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p>",
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -622,7 +634,7 @@
|
|||
"Capacity": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleCapacity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. \n When you update a rule group, you are limited to this capacity. When you reference a rule group \n from a firewall policy, Network Firewall reserves this capacity for the rule group. </p> \n <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling \n <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p> \n <note>\n <p>You can't change or exceed this capacity when you update the rule group, so leave\n room for your rule group to grow. </p>\n </note>\n <p>\n <b>Capacity for a stateless rule group</b>\n </p>\n <p>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. </p>\n <p>To calculate the capacity requirement of a single rule, multiply the capacity\n requirement values of each of the rule's match settings:</p>\n <ul>\n <li>\n <p>A match setting with no criteria specified has a value of 1. </p>\n </li>\n <li>\n <p>A match setting with <code>Any</code> specified has a value of 1. </p>\n </li>\n <li>\n <p>All other match settings have a value equal to the number of elements provided in\n the setting. For example, a protocol setting [\"UDP\"] and a source setting\n [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value\n of 2. A source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"] has a value of 3.\n </p>\n </li>\n </ul>\n <p>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. </p>\n <p>\n <b>Capacity for a stateful rule group</b>\n </p>\n <p>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. </p>",
|
||||
"smithy.api#documentation": "<p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.\n When you update a rule group, you are limited to this capacity. When you reference a rule group\n from a firewall policy, Network Firewall reserves this capacity for the rule group. </p>\n <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling\n <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p> \n <note>\n <p>You can't change or exceed this capacity when you update the rule group, so leave\n room for your rule group to grow. </p>\n </note>\n <p>\n <b>Capacity for a stateless rule group</b>\n </p>\n <p>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. </p>\n <p>To calculate the capacity requirement of a single rule, multiply the capacity\n requirement values of each of the rule's match settings:</p>\n <ul>\n <li>\n <p>A match setting with no criteria specified has a value of 1. </p>\n </li>\n <li>\n <p>A match setting with <code>Any</code> specified has a value of 1. </p>\n </li>\n <li>\n <p>All other match settings have a value equal to the number of elements provided in\n the setting. For example, a protocol setting [\"UDP\"] and a source setting\n [\"10.0.0.0/24\"] each have a value of 1. A protocol setting [\"UDP\",\"TCP\"] has a value\n of 2. A source setting [\"10.0.0.0/24\",\"10.0.0.1/24\",\"10.0.0.2/24\"] has a value of 3.\n </p>\n </li>\n </ul>\n <p>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. </p>\n <p>\n <b>Capacity for a stateful rule group</b>\n </p>\n <p>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. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -635,7 +647,19 @@
|
|||
"DryRun": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>\n <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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. </p>\n <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>\n <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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. </p>\n <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A complex type that contains settings for encryption of your rule group resources.</p>"
|
||||
}
|
||||
},
|
||||
"SourceMetadata": {
|
||||
"target": "com.amazonaws.networkfirewall#SourceMetadata",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -716,7 +740,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes the specified <a>Firewall</a> and its <a>FirewallStatus</a>. \n This operation requires the firewall's <code>DeleteProtection</code> flag to be\n <code>FALSE</code>. You can't revert this operation. </p>\n <p>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 <a>DescribeFirewall</a>.\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.</p>\n <p>To delete a firewall, remove the delete protection if you need to using <a>UpdateFirewallDeleteProtection</a>,\n then delete the firewall by calling <a>DeleteFirewall</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Deletes the specified <a>Firewall</a> and its <a>FirewallStatus</a>.\n This operation requires the firewall's <code>DeleteProtection</code> flag to be\n <code>FALSE</code>. You can't revert this operation. </p>\n <p>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 <a>DescribeFirewall</a>.\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.</p>\n <p>To delete a firewall, remove the delete protection if you need to using <a>UpdateFirewallDeleteProtection</a>,\n then delete the firewall by calling <a>DeleteFirewall</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#DeleteFirewallPolicy": {
|
||||
|
@ -903,7 +927,7 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroupType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1155,7 +1179,7 @@
|
|||
"Policy": {
|
||||
"target": "com.amazonaws.networkfirewall#PolicyString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS Identity and Access Management policy for the resource. </p>"
|
||||
"smithy.api#documentation": "<p>The IAM policy for the resource. </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1209,7 +1233,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>High-level information about a rule group, returned by operations like create and describe. \n You can use the information provided in the metadata to retrieve and manage a rule group. \n You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>.\n </p>"
|
||||
"smithy.api#documentation": "<p>High-level information about a rule group, returned by operations like create and describe.\n You can use the information provided in the metadata to retrieve and manage a rule group.\n You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>.\n </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#DescribeRuleGroupMetadataRequest": {
|
||||
|
@ -1230,7 +1254,7 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroupType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1261,17 +1285,23 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroupType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"Capacity": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleCapacity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. \n When you update a rule group, you are limited to this capacity. When you reference a rule group \n from a firewall policy, Network Firewall reserves this capacity for the rule group. </p> \n <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling \n <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p>"
|
||||
"smithy.api#documentation": "<p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.\n When you update a rule group, you are limited to this capacity. When you reference a rule group\n from a firewall policy, Network Firewall reserves this capacity for the rule group. </p>\n <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling\n <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p>"
|
||||
}
|
||||
},
|
||||
"StatefulRuleOptions": {
|
||||
"target": "com.amazonaws.networkfirewall#StatefulRuleOptions"
|
||||
},
|
||||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.networkfirewall#LastUpdateTime",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The last time that the rule group was changed.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -1293,7 +1323,7 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroupType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1311,7 +1341,7 @@
|
|||
"RuleGroup": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroup",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p> \n <p>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. </p>\n <p>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. </p>"
|
||||
"smithy.api#documentation": "<p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>\n <p>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. </p>\n <p>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. </p>"
|
||||
}
|
||||
},
|
||||
"RuleGroupResponse": {
|
||||
|
@ -1355,7 +1385,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The value to use in an Amazon CloudWatch custom metric dimension. This is used in the\n <code>PublishMetrics</code>\n <a>CustomAction</a>. A CloudWatch custom metric dimension is a name/value pair that's\n part of the identity of a metric. </p>\n <p>AWS Network Firewall sets the dimension name to <code>CustomAction</code> and you provide the\n dimension value. </p>\n <p>For more information about CloudWatch custom metric dimensions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions\">Publishing Custom Metrics</a> in the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html\">Amazon CloudWatch User\n Guide</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The value to use in an Amazon CloudWatch custom metric dimension. This is used in the\n <code>PublishMetrics</code>\n <a>CustomAction</a>. A CloudWatch custom metric dimension is a name/value pair that's\n part of the identity of a metric. </p>\n <p>Network Firewall sets the dimension name to <code>CustomAction</code> and you provide the\n dimension value. </p>\n <p>For more information about CloudWatch custom metric dimensions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions\">Publishing Custom Metrics</a> in the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html\">Amazon CloudWatch User\n Guide</a>.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id\">Key ID</a> in the <i>Amazon Web Services KMS Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html\">Encryption at rest with Amazon Web Services Key Managment Service</a> in the <i>Network Firewall Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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 <code>TRUE</code>.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
}
|
||||
},
|
||||
"FirewallPolicyChangeProtection": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
|
@ -1549,10 +1615,16 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p></p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p> \n <p>The status of the firewall, for example whether it's ready to filter network traffic,\n is provided in the corresponding <a>FirewallStatus</a>. You can retrieve both\n objects by calling <a>DescribeFirewall</a>.</p>"
|
||||
"smithy.api#documentation": "<p>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. </p> \n <p>The status of the firewall, for example whether it's ready to filter network traffic,\n is provided in the corresponding <a>FirewallStatus</a>. You can retrieve both\n objects by calling <a>DescribeFirewall</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#FirewallMetadata": {
|
||||
|
@ -1600,7 +1672,7 @@
|
|||
"StatelessFragmentDefaultActions": {
|
||||
"target": "com.amazonaws.networkfirewall#StatelessActions",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>aws:forward_to_sfe</code>. </p>\n <p>You must specify one of the standard actions: <code>aws:pass</code>,\n <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify\n custom actions that are compatible with your standard section choice.</p>\n <p>For example, you could specify <code>[\"aws:pass\"]</code> or you could specify\n <code>[\"aws:pass\", “customActionName”]</code>. For information about compatibility, see\n the custom action descriptions under <a>CustomAction</a>.</p>",
|
||||
"smithy.api#documentation": "<p>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 <code>aws:forward_to_sfe</code>. </p>\n <p>You must specify one of the standard actions: <code>aws:pass</code>,\n <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify\n custom actions that are compatible with your standard section choice.</p>\n <p>For example, you could specify <code>[\"aws:pass\"]</code> or you could specify\n <code>[\"aws:pass\", “customActionName”]</code>. For information about compatibility, see\n the custom action descriptions under <a>CustomAction</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1619,13 +1691,13 @@
|
|||
"StatefulDefaultActions": {
|
||||
"target": "com.amazonaws.networkfirewall#StatefulActions",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, \n and is only valid when using the strict rule order.</p>\n <p>Valid values of the stateful default action:</p>\n <ul>\n <li>\n <p>aws:drop_strict</p>\n </li>\n <li>\n <p>aws:drop_established</p>\n </li>\n <li>\n <p>aws:alert_strict</p>\n </li>\n <li>\n <p>aws:alert_established</p>\n </li>\n </ul>\n <p>For more information, see \n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-strict-rule-evaluation-order.html\">Strict evaluation order</a> in the <i>AWS Network Firewall Developer Guide</i>.\n </p>"
|
||||
"smithy.api#documentation": "<p>The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional,\n and is only valid when using the strict rule order.</p>\n <p>Valid values of the stateful default action:</p>\n <ul>\n <li>\n <p>aws:drop_strict</p>\n </li>\n <li>\n <p>aws:drop_established</p>\n </li>\n <li>\n <p>aws:alert_strict</p>\n </li>\n <li>\n <p>aws:alert_established</p>\n </li>\n </ul>\n <p>For more information, see\n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html\">Strict evaluation order</a> in the <i>Network Firewall Developer Guide</i>.\n </p>"
|
||||
}
|
||||
},
|
||||
"StatefulEngineOptions": {
|
||||
"target": "com.amazonaws.networkfirewall#StatefulEngineOptions",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -1712,6 +1784,18 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The number of firewalls that are associated with this firewall policy.</p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.</p>"
|
||||
}
|
||||
},
|
||||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.networkfirewall#LastUpdateTime",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The last time that the firewall policy was changed.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -1818,21 +1902,21 @@
|
|||
"Protocol": {
|
||||
"target": "com.amazonaws.networkfirewall#StatefulRuleProtocol",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The protocol to inspect for. To specify all, you can use <code>IP</code>, because all traffic on AWS and on the internet is IP.</p>",
|
||||
"smithy.api#documentation": "<p>The protocol to inspect for. To specify all, you can use <code>IP</code>, because all traffic on Amazon Web Services and on the internet is IP.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Source": {
|
||||
"target": "com.amazonaws.networkfirewall#Source",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The source IP address or address range to inspect for, in CIDR notation. \n To match with any address, specify <code>ANY</code>. </p>\n <p>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. </p>\n <p>Examples: </p>\n <ul>\n <li>\n <p>To configure Network Firewall to inspect for the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p>\n </li>\n <li>\n <p>To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p>\n </li>\n </ul>\n <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless\n Inter-Domain Routing</a>.</p>",
|
||||
"smithy.api#documentation": "<p>The source IP address or address range to inspect for, in CIDR notation.\n To match with any address, specify <code>ANY</code>. </p>\n <p>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. </p>\n <p>Examples: </p>\n <ul>\n <li>\n <p>To configure Network Firewall to inspect for the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p>\n </li>\n <li>\n <p>To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p>\n </li>\n </ul>\n <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless\n Inter-Domain Routing</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"SourcePort": {
|
||||
"target": "com.amazonaws.networkfirewall#Port",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The source port to inspect for. You can specify an individual port, for \n example <code>1994</code> and you can specify a port\n range, for example <code>1990:1994</code>.\n To match with any port, specify <code>ANY</code>. </p>",
|
||||
"smithy.api#documentation": "<p>The source port to inspect for. You can specify an individual port, for\n example <code>1994</code> and you can specify a port\n range, for example <code>1990:1994</code>.\n To match with any port, specify <code>ANY</code>. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1846,20 +1930,20 @@
|
|||
"Destination": {
|
||||
"target": "com.amazonaws.networkfirewall#Destination",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The destination IP address or address range to inspect for, in CIDR notation. \n To match with any address, specify <code>ANY</code>. </p>\n <p>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. </p>\n <p>Examples: </p>\n <ul>\n <li>\n <p>To configure Network Firewall to inspect for the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p>\n </li>\n <li>\n <p>To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p>\n </li>\n </ul>\n <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless\n Inter-Domain Routing</a>.</p>",
|
||||
"smithy.api#documentation": "<p>The destination IP address or address range to inspect for, in CIDR notation.\n To match with any address, specify <code>ANY</code>. </p>\n <p>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. </p>\n <p>Examples: </p>\n <ul>\n <li>\n <p>To configure Network Firewall to inspect for the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</p>\n </li>\n <li>\n <p>To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</p>\n </li>\n </ul>\n <p>For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless\n Inter-Domain Routing</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"DestinationPort": {
|
||||
"target": "com.amazonaws.networkfirewall#Port",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The destination port to inspect for. You can specify an individual port, for \n example <code>1994</code> and you can specify\n a port range, for example <code>1990:1994</code>.\n To match with any port, specify <code>ANY</code>. </p>",
|
||||
"smithy.api#documentation": "<p>The destination port to inspect for. You can specify an individual port, for\n example <code>1994</code> and you can specify\n a port range, for example <code>1990:1994</code>.\n To match with any port, specify <code>ANY</code>. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a>StatefulRule</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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 <a>StatefulRule</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#IPSet": {
|
||||
|
@ -1894,7 +1978,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>AWS doesn't currently have enough available capacity to fulfill your request. Try your\n request later. </p>",
|
||||
"smithy.api#documentation": "<p>Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your\n request later. </p>",
|
||||
"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": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"target": "com.amazonaws.networkfirewall#PaginationMaxResults",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more \n objects are available, in the response, Network Firewall provides a \n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
|
||||
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more\n objects are available, in the response, Network Firewall provides a\n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -2031,7 +2129,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.networkfirewall#PaginationToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
}
|
||||
},
|
||||
"VpcIds": {
|
||||
|
@ -2088,7 +2187,7 @@
|
|||
"MaxResults": {
|
||||
"target": "com.amazonaws.networkfirewall#PaginationMaxResults",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more \n objects are available, in the response, Network Firewall provides a \n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
|
||||
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more\n objects are available, in the response, Network Firewall provides a\n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -2099,7 +2198,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.networkfirewall#PaginationToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"target": "com.amazonaws.networkfirewall#PaginationMaxResults",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more \n objects are available, in the response, Network Firewall provides a \n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
|
||||
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more\n objects are available, in the response, Network Firewall provides a\n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
|
||||
}
|
||||
},
|
||||
"Scope": {
|
||||
"target": "com.amazonaws.networkfirewall#ResourceManagedStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The scope of the request. The default setting of <code>ACCOUNT</code> or a setting of \n <code>NULL</code> returns all of the rule groups in your account. A setting of \n <code>MANAGED</code> returns all available managed rule groups.</p>"
|
||||
"smithy.api#documentation": "<p>The scope of the request. The default setting of <code>ACCOUNT</code> or a setting of\n <code>NULL</code> returns all of the rule groups in your account. A setting of\n <code>MANAGED</code> returns all available managed rule groups.</p>"
|
||||
}
|
||||
},
|
||||
"ManagedType": {
|
||||
"target": "com.amazonaws.networkfirewall#ResourceManagedType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates the general category of the Amazon Web Services managed rule group.</p>"
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroupType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -2167,7 +2279,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.networkfirewall#PaginationToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
}
|
||||
},
|
||||
"RuleGroups": {
|
||||
|
@ -2201,10 +2313,11 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall\n policies, and rule groups. </p>",
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall\n policies, and rule groups. </p>",
|
||||
"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": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"target": "com.amazonaws.networkfirewall#TagsPaginationMaxResults",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more \n objects are available, in the response, Network Firewall provides a \n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
|
||||
"smithy.api#documentation": "<p>The maximum number of objects that you want Network Firewall to return for this request. If more\n objects are available, in the response, Network Firewall provides a\n <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceArn": {
|
||||
|
@ -2239,7 +2352,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.networkfirewall#PaginationToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> \n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
"smithy.api#documentation": "<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available\n for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code>\n value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
|
@ -2276,7 +2389,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Defines where AWS Network Firewall sends logs for the firewall for one log type. This is used\n in <a>LoggingConfiguration</a>. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.</p>\n <p>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 <code>DROP</code> or <code>ALERT</code>. </p>"
|
||||
"smithy.api#documentation": "<p>Defines where Network Firewall sends logs for the firewall for one log type. This is used\n in <a>LoggingConfiguration</a>. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.</p>\n <p>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 <code>DROP</code> or <code>ALERT</code>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#LogDestinationConfigs": {
|
||||
|
@ -2357,7 +2470,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Defines how AWS Network Firewall performs logging for a <a>Firewall</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Defines how Network Firewall performs logging for a <a>Firewall</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#MatchAttributes": {
|
||||
|
@ -2418,7 +2531,7 @@
|
|||
"name": "network-firewall"
|
||||
},
|
||||
"aws.protocols#awsJson1_0": {},
|
||||
"smithy.api#documentation": "<p>This is the API Reference for AWS Network Firewall. This guide is for developers who need\n detailed information about the Network Firewall API actions, data types, and errors. </p>\n <ul>\n <li>\n <p>The REST API requires you to handle connection details, such as calculating\n signatures, handling request retries, and error handling. For general information\n about using the AWS REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">AWS APIs</a>. </p>\n <p>To access Network Firewall using the REST API endpoint:\n <code>https://network-firewall.<region>.amazonaws.com </code>\n </p>\n </li>\n <li>\n <p>Alternatively, you can use one of the AWS SDKs to access an API that's tailored to\n the programming language or platform that you're using. For more information, see\n <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p>\n </li>\n <li>\n <p>For descriptions of Network Firewall features, including and step-by-step\n instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer\n Guide</a>.</p>\n </li>\n </ul>\n <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and\n prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the\n perimeter of your VPC. This includes filtering traffic going to and coming from an internet\n gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible\n with Suricata, a free, open source intrusion detection system (IDS) engine. \n AWS Network Firewall supports Suricata version 5.0.2. For information about Suricata, \n see the <a href=\"https://suricata-ids.org/\">Suricata website</a>.</p>\n <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways.\n The following are just a few examples: </p>\n <ul>\n <li>\n <p>Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and\n block all other forms of traffic.</p>\n </li>\n <li>\n <p>Use custom lists of known bad domains to limit the types of domain names that your\n applications can access.</p>\n </li>\n <li>\n <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p>\n </li>\n <li>\n <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.</p>\n </li>\n </ul>\n <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in\n Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p>\n <p>To start using Network Firewall, do the following: </p>\n <ol>\n <li>\n <p>(Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC. </p>\n </li>\n <li>\n <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a\n subnet for the sole use of Network Firewall. </p>\n </li>\n <li>\n <p>In Network Firewall, create stateless and stateful rule groups, \n to define the components of the network traffic filtering behavior that you want your firewall to have. </p>\n </li>\n <li>\n <p>In Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior. </p>\n </li>\n <li>\n <p>In Network Firewall, create a firewall and specify your new firewall policy and \n VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you\n specify, with the behavior that's defined in the firewall policy.</p>\n </li>\n <li>\n <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.</p>\n </li>\n </ol>",
|
||||
"smithy.api#documentation": "<p>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. </p>\n <ul>\n <li>\n <p>The REST API requires you to handle connection details, such as calculating\n signatures, handling request retries, and error handling. For general information\n about using the Amazon Web Services REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">Amazon Web Services APIs</a>. </p>\n <p>To access Network Firewall using the REST API endpoint:\n <code>https://network-firewall.<region>.amazonaws.com </code>\n </p>\n </li>\n <li>\n <p>Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to\n the programming language or platform that you're using. For more information, see\n <a href=\"http://aws.amazon.com/tools/#SDKs\">Amazon Web Services SDKs</a>.</p>\n </li>\n <li>\n <p>For descriptions of Network Firewall features, including and step-by-step\n instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer\n Guide</a>.</p>\n </li>\n </ul>\n <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and\n prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the\n perimeter of your VPC. This includes filtering traffic going to and coming from an internet\n gateway, NAT gateway, or over VPN or 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 <a href=\"https://suricata-ids.org/\">Suricata website</a>.</p>\n <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways.\n The following are just a few examples: </p>\n <ul>\n <li>\n <p>Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and\n block all other forms of traffic.</p>\n </li>\n <li>\n <p>Use custom lists of known bad domains to limit the types of domain names that your\n applications can access.</p>\n </li>\n <li>\n <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p>\n </li>\n <li>\n <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.</p>\n </li>\n </ul>\n <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in\n Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p>\n <p>To start using Network Firewall, do the following: </p>\n <ol>\n <li>\n <p>(Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC. </p>\n </li>\n <li>\n <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a\n subnet for the sole use of Network Firewall. </p>\n </li>\n <li>\n <p>In Network Firewall, create stateless and stateful rule groups,\n to define the components of the network traffic filtering behavior that you want your firewall to have. </p>\n </li>\n <li>\n <p>In Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior. </p>\n </li>\n <li>\n <p>In Network Firewall, create a firewall and specify your new firewall policy and\n VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you\n specify, with the behavior that's defined in the firewall policy.</p>\n </li>\n <li>\n <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.</p>\n </li>\n </ol>",
|
||||
"smithy.api#title": "AWS Network Firewall"
|
||||
},
|
||||
"version": "2020-11-12",
|
||||
|
@ -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": "<p>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. </p>\n <p>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. </p>\n <p>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. </p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_GetResourceShareInvitations.html\">GetResourceShareInvitations</a> - Returns the Amazon Resource Names (ARNs) of the resource share invitations. </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html\">AcceptResourceShareInvitation</a> - Accepts the share invitation for a specified resource share. </p>\n </li>\n </ul>\n <p>For additional information about resource sharing using RAM, see <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/what-is.html\">AWS Resource Access Manager User Guide</a>.</p>"
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>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. </p>\n <p>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. </p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_GetResourceShareInvitations.html\">GetResourceShareInvitations</a> - Returns the Amazon Resource Names (ARNs) of the resource share invitations. </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html\">AcceptResourceShareInvitation</a> - Accepts the share invitation for a specified resource share. </p>\n </li>\n </ul>\n <p>For additional information about resource sharing using RAM, see <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/what-is.html\">Resource Access Manager User Guide</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#PutResourcePolicyRequest": {
|
||||
|
@ -2748,7 +2864,7 @@
|
|||
"Policy": {
|
||||
"target": "com.amazonaws.networkfirewall#PolicyString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>For a rule group resource, you can specify the following operations in the Actions section of the statement:</p>\n <ul>\n <li>\n <p>network-firewall:CreateFirewallPolicy</p>\n </li>\n <li>\n <p>network-firewall:UpdateFirewallPolicy</p>\n </li>\n <li>\n <p>network-firewall:ListRuleGroups</p>\n </li>\n </ul>\n <p>For a firewall policy resource, you can specify the following operations in the Actions section of the statement:</p>\n <ul>\n <li>\n <p>network-firewall:CreateFirewall</p>\n </li>\n <li>\n <p>network-firewall:UpdateFirewall</p>\n </li>\n <li>\n <p>network-firewall:AssociateFirewallPolicy</p>\n </li>\n <li>\n <p>network-firewall:ListFirewallPolicies</p>\n </li>\n </ul>\n <p>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 <code>Arn</code>.</p>",
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>For a rule group resource, you can specify the following operations in the Actions section of the statement:</p>\n <ul>\n <li>\n <p>network-firewall:CreateFirewallPolicy</p>\n </li>\n <li>\n <p>network-firewall:UpdateFirewallPolicy</p>\n </li>\n <li>\n <p>network-firewall:ListRuleGroups</p>\n </li>\n </ul>\n <p>For a firewall policy resource, you can specify the following operations in the Actions section of the statement:</p>\n <ul>\n <li>\n <p>network-firewall:CreateFirewall</p>\n </li>\n <li>\n <p>network-firewall:UpdateFirewall</p>\n </li>\n <li>\n <p>network-firewall:AssociateFirewallPolicy</p>\n </li>\n <li>\n <p>network-firewall:ListFirewallPolicies</p>\n </li>\n </ul>\n <p>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 <code>Arn</code>.</p>",
|
||||
"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": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#RuleGroup": {
|
||||
|
@ -2889,12 +3020,12 @@
|
|||
"StatefulRuleOptions": {
|
||||
"target": "com.amazonaws.networkfirewall#StatefulRuleOptions",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p> \n <p>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. </p>\n <p>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. </p>"
|
||||
"smithy.api#documentation": "<p>The object that defines the rules in a rule group. This, along with <a>RuleGroupResponse</a>, define the rule group. You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>. </p>\n <p>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. </p>\n <p>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. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#RuleGroupMetadata": {
|
||||
|
@ -2950,13 +3081,13 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroupType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules. </p>"
|
||||
}
|
||||
},
|
||||
"Capacity": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleCapacity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. \n When you update a rule group, you are limited to this capacity. When you reference a rule group \n from a firewall policy, Network Firewall reserves this capacity for the rule group. </p> \n <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling \n <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p>"
|
||||
"smithy.api#documentation": "<p>The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.\n When you update a rule group, you are limited to this capacity. When you reference a rule group\n from a firewall policy, Network Firewall reserves this capacity for the rule group. </p>\n <p>You can retrieve the capacity that would be required for a rule group before you create the rule group by calling\n <a>CreateRuleGroup</a> with <code>DryRun</code> set to <code>TRUE</code>. </p>"
|
||||
}
|
||||
},
|
||||
"RuleGroupStatus": {
|
||||
|
@ -2982,6 +3113,30 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The number of firewall policies that use this rule group.</p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.</p>"
|
||||
}
|
||||
},
|
||||
"SourceMetadata": {
|
||||
"target": "com.amazonaws.networkfirewall#SourceMetadata",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"SnsTopic": {
|
||||
"target": "com.amazonaws.networkfirewall#ResourceArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/sns/latest/dg/welcome.html\">Amazon Simple Notification Service Developer Guide.</a>.</p>"
|
||||
}
|
||||
},
|
||||
"LastModifiedTime": {
|
||||
"target": "com.amazonaws.networkfirewall#LastUpdateTime",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The last time that the rule group was changed.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -3105,7 +3260,7 @@
|
|||
"StatefulRules": {
|
||||
"target": "com.amazonaws.networkfirewall#StatefulRules",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>Rules</code> format, see\n <a href=\"https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#\">Rules Format</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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 <code>Rules</code> format, see\n <a href=\"https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#\">Rules Format</a>. </p>"
|
||||
}
|
||||
},
|
||||
"StatelessRulesAndCustomActions": {
|
||||
|
@ -3145,7 +3300,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Stateful inspection criteria for a domain list rule group. </p>\n <p>For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.</p>\n <p>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 <code>HOME_NET</code> rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see <a>RuleVariables</a> in this guide and <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html\">Stateful domain list rule groups in AWS Network Firewall</a> in the <i>Network Firewall Developer Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Stateful inspection criteria for a domain list rule group. </p>\n <p>For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.</p>\n <p>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 <code>HOME_NET</code> rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see <a>RuleVariables</a> in this guide and <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html\">Stateful domain list rule groups in Network Firewall</a> in the <i>Network Firewall Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.</p>"
|
||||
}
|
||||
},
|
||||
"SourceUpdateToken": {
|
||||
"target": "com.amazonaws.networkfirewall#UpdateToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html#networkfirewall-DescribeRuleGroup-response-UpdateToken\">DescribeRuleGroup</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html\">DescribeRuleGroup</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#StatefulAction": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
@ -3214,7 +3389,7 @@
|
|||
"RuleOrder": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleOrder",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates how to manage the order of stateful rule evaluation for the policy. <code>DEFAULT_ACTION_ORDER</code> is\n the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\n based on certain settings. For more information, see \n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html\">Evaluation order for stateful rules</a> in the <i>AWS Network Firewall Developer Guide</i>.\n </p>"
|
||||
"smithy.api#documentation": "<p>Indicates how to manage the order of stateful rule evaluation for the policy. <code>DEFAULT_ACTION_ORDER</code> is\n the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\n based on certain settings. For more information, see\n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html\">Evaluation order for stateful rules</a> in the <i>Network Firewall Developer Guide</i>.\n </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -3248,7 +3423,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>Rules</code> format, see\n <a href=\"https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#\">Rules Format</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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 <code>Rules</code> format, see\n <a href=\"https://suricata.readthedocs.io/en/suricata-5.0.0/rules/intro.html#\">Rules Format</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#StatefulRuleDirection": {
|
||||
|
@ -3320,7 +3495,7 @@
|
|||
"RuleOrder": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleOrder",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates how to manage the order of the rule evaluation for the rule group. <code>DEFAULT_ACTION_ORDER</code> is\n the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\n based on certain settings. For more information, see \n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html\">Evaluation order for stateful rules</a> in the <i>AWS Network Firewall Developer Guide</i>.\n </p>"
|
||||
"smithy.api#documentation": "<p>Indicates how to manage the order of the rule evaluation for the rule group. <code>DEFAULT_ACTION_ORDER</code> is\n the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\n based on certain settings. For more information, see\n <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html\">Evaluation order for stateful rules</a> in the <i>Network Firewall Developer Guide</i>.\n </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -3512,7 +3687,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for a subnet that you want to associate with the firewall. This is used with\n <a>CreateFirewall</a> and <a>AssociateSubnets</a>. 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.</p>"
|
||||
"smithy.api#documentation": "<p>The ID for a subnet that you want to associate with the firewall. This is used with\n <a>CreateFirewall</a> and <a>AssociateSubnets</a>. 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.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#SubnetMappings": {
|
||||
|
@ -3538,7 +3713,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The status of the firewall endpoint and firewall policy configuration for a single VPC\n subnet. </p>\n <p>For each VPC subnet that you associate with a firewall, AWS Network Firewall does the\n following: </p>\n <ul>\n <li>\n <p>Instantiates a firewall endpoint in the subnet, ready to take traffic.</p>\n </li>\n <li>\n <p>Configures the endpoint with the current firewall policy settings, to provide the\n filtering behavior for the endpoint.</p>\n </li>\n </ul>\n <p>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. </p>"
|
||||
"smithy.api#documentation": "<p>The status of the firewall endpoint and firewall policy configuration for a single VPC\n subnet. </p>\n <p>For each VPC subnet that you associate with a firewall, Network Firewall does the\n following: </p>\n <ul>\n <li>\n <p>Instantiates a firewall endpoint in the subnet, ready to take traffic.</p>\n </li>\n <li>\n <p>Configures the endpoint with the current firewall policy settings, to provide the\n filtering behavior for the endpoint.</p>\n </li>\n </ul>\n <p>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. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#SyncStateConfig": {
|
||||
|
@ -3644,7 +3819,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>"
|
||||
"smithy.api#documentation": "<p>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. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#TagKey": {
|
||||
|
@ -3704,7 +3879,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall\n policies, and rule groups. </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall\n policies, and rule groups. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#TagResourceRequest": {
|
||||
|
@ -3818,7 +3993,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>You can manage tags for the AWS resources that you manage through AWS Network Firewall:\n firewalls, firewall policies, and rule groups. </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>You can manage tags for the Amazon Web Services resources that you manage through Network Firewall:\n firewalls, firewall policies, and rule groups. </p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>A complex type that contains settings for encryption of your firewall resources.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#UpdateFirewallEncryptionConfigurationRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"UpdateToken": {
|
||||
"target": "com.amazonaws.networkfirewall#UpdateToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>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.</p>\n <p>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 <code>InvalidTokenException</code>. 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. </p>"
|
||||
}
|
||||
},
|
||||
"FirewallArn": {
|
||||
"target": "com.amazonaws.networkfirewall#ResourceArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the firewall.</p>"
|
||||
}
|
||||
},
|
||||
"FirewallName": {
|
||||
"target": "com.amazonaws.networkfirewall#ResourceName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration"
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#UpdateFirewallEncryptionConfigurationResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FirewallArn": {
|
||||
"target": "com.amazonaws.networkfirewall#ResourceArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the firewall.</p>"
|
||||
}
|
||||
},
|
||||
"FirewallName": {
|
||||
"target": "com.amazonaws.networkfirewall#ResourceName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateToken": {
|
||||
"target": "com.amazonaws.networkfirewall#UpdateToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>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.</p>\n <p>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 <code>InvalidTokenException</code>. 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. </p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration"
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#UpdateFirewallPolicy": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
@ -4080,7 +4339,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Modifies the flag, <code>ChangeProtection</code>, which indicates whether it \n is possible to change the firewall. If the flag is set to <code>TRUE</code>, the firewall is protected \n from changes. This setting helps protect against accidentally changing a firewall that's in use.</p>"
|
||||
"smithy.api#documentation": "<p>Modifies the flag, <code>ChangeProtection</code>, which indicates whether it\n is possible to change the firewall. If the flag is set to <code>TRUE</code>, the firewall is protected\n from changes. This setting helps protect against accidentally changing a firewall that's in use.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.networkfirewall#UpdateFirewallPolicyChangeProtectionRequest": {
|
||||
|
@ -4107,7 +4366,7 @@
|
|||
"FirewallPolicyChangeProtection": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>",
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -4137,7 +4396,7 @@
|
|||
"FirewallPolicyChangeProtection": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -4180,7 +4439,13 @@
|
|||
"DryRun": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>\n <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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. </p>\n <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>\n <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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. </p>\n <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A complex type that contains settings for encryption of your firewall policy resources.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -4339,13 +4604,13 @@
|
|||
"Rules": {
|
||||
"target": "com.amazonaws.networkfirewall#RulesString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>\n <note>\n <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p>\n </note> \n <p>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 <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>"
|
||||
"smithy.api#documentation": "<p>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. </p>\n <note>\n <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p>\n </note> \n <p>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 <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>"
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.networkfirewall#RuleGroupType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains\nstateless rules. If it is stateful, it contains stateful rules. </p> \n <note>\n <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
|
@ -4357,7 +4622,19 @@
|
|||
"DryRun": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>\n <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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. </p>\n <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request. </p>\n <p>If set to <code>TRUE</code>, 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 <code>FALSE</code>, 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. </p>\n <p>If set to <code>FALSE</code>, Network Firewall makes the requested changes to your resources. </p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.networkfirewall#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A complex type that contains settings for encryption of your rule group resources.</p>"
|
||||
}
|
||||
},
|
||||
"SourceMetadata": {
|
||||
"target": "com.amazonaws.networkfirewall#SourceMetadata",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -4437,7 +4714,7 @@
|
|||
"SubnetChangeProtection": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>",
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -4467,7 +4744,7 @@
|
|||
"SubnetChangeProtection": {
|
||||
"target": "com.amazonaws.networkfirewall#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
"smithy.api#documentation": "<p>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 <code>TRUE</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -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": "<p>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.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.personalize#StartRecommenderRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"recommenderArn": {
|
||||
"target": "com.amazonaws.personalize#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the recommender to start.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.personalize#StartRecommenderResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"recommenderArn": {
|
||||
"target": "com.amazonaws.personalize#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the recommender you started.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.personalize#StopRecommenderRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"recommenderArn": {
|
||||
"target": "com.amazonaws.personalize#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the recommender to stop.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.personalize#StopRecommenderResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"recommenderArn": {
|
||||
"target": "com.amazonaws.personalize#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the recommender you stopped.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>Updates a campaign by either deploying a new solution or changing the value of the\n campaign's <code>minProvisionedTPS</code> parameter.</p>\n <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html\">DescribeCampaign</a> operation.</p>\n <note>\n <p>You must wait until the <code>status</code> of the\n updated campaign is <code>ACTIVE</code> before asking the campaign for recommendations.</p>\n </note>\n <p>For more information on campaigns, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html\">CreateCampaign</a>.</p>",
|
||||
"smithy.api#documentation": "<p>Updates a campaign by either deploying a new solution or changing the value of the\n campaign's <code>minProvisionedTPS</code> parameter.</p>\n <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html\">DescribeCampaign</a> operation.</p>\n\n <note>\n <p>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 <code>Active</code>.\n </p>\n </note>\n \n <p>For more information on campaigns, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html\">CreateCampaign</a>.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
|
|
@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
@ -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": "<p>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 <code>Location</code>, <code>Storage\n Class</code>, and <code>Operating System</code>, 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.</p>\n <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all AWS services, then \n <code>GetServices</code> 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 <code>GetAttributeValues</code>\n to see what values are available for an attribute. With the service code and an attribute name and value, \n you can use <code>GetProducts</code> to find specific products that you're interested in, such as \n an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> \n <code>volumeType</code>.</p>\n <p>Service Endpoint</p>\n <p>Amazon Web Services Price List Service API provides the following two endpoints:</p>\n <ul>\n <li>\n <p>https://api.pricing.us-east-1.amazonaws.com</p>\n </li>\n <li>\n <p>https://api.pricing.ap-south-1.amazonaws.com</p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>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 <code>Location</code>, <code>Storage\n Class</code>, and <code>Operating System</code>, 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.</p>\n <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all AWS services, then \n <code>GetServices</code> 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 <code>GetAttributeValues</code>\n to see what values are available for an attribute. With the service code and an attribute name and value, \n you can use <code>GetProducts</code> to find specific products that you're interested in, such as \n an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> \n <code>volumeType</code>.</p>\n <p>Service Endpoint</p>\n <p>Amazon Web Services Price List Service API provides the following two endpoints:</p>\n <ul>\n <li>\n <p>https://api.pricing.us-east-1.amazonaws.com</p>\n </li>\n <li>\n <p>https://api.pricing.ap-south-1.amazonaws.com</p>\n </li>\n </ul>",
|
||||
"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": "<p>The pagination token for the next set of retreivable results.</p>"
|
||||
"smithy.api#documentation": "<p>The pagination token for the next set of retrievable results.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -266,7 +266,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs\">Offer File Definitions</a>\n in the <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html\">Amazon Web Services Billing and Cost Management User Guide</a>.</p>",
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs\">Offer File Definitions</a>\n in the <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html\">Amazon Web Services Billing and Cost Management User Guide</a>.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
|
@ -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": "<p>You do not have sufficient access to perform this action.</p>",
|
||||
"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": "<p>An array of floating point numbers.</p>"
|
||||
"smithy.api#documentation": "<p>An array of integers.</p>"
|
||||
}
|
||||
},
|
||||
"doubleValues": {
|
||||
"target": "com.amazonaws.rdsdata#DoubleArray",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of integers.</p>"
|
||||
"smithy.api#documentation": "<p>An array of floating-point numbers.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Runs a batch SQL statement over an array of data.</p>\n <p>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.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p> \n </important>",
|
||||
"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": "<p>Starts a SQL transaction.</p>\n \n <important>\n <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and \n rolled back automatically after 24 hours.</p>\n <p>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.</p>\n <p>DDL statements inside a transaction cause an implicit commit. We recommend \n that you run each DDL statement in a separate <code>ExecuteStatement</code> call with \n <code>continueAfterTimeout</code> enabled.</p>\n </important>",
|
||||
"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": "<p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and\n commits the changes.</p>",
|
||||
"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": "<p>An array of floating point numbers.</p>\n <note>\n <p>Some array entries can be null.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>An array of floating-point numbers.</p>\n <note>\n <p>Some array entries can be null.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Runs one or more SQL statements.</p>\n <important>\n <p>This operation is deprecated. Use the <code>BatchExecuteStatement</code> or\n <code>ExecuteStatement</code> operation.</p>\n </important>",
|
||||
"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": "<p>Runs a SQL statement against a database.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p> \n </important>\n <p>The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.</p>",
|
||||
"smithy.api#documentation": "<p>Runs a SQL statement against a database.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p> \n </important>\n <p>If the binary response data from the database is more than 1 MB, the call is terminated.</p>",
|
||||
"smithy.api#http": {
|
||||
"code": 200,
|
||||
"method": "POST",
|
||||
"uri": "/Execute",
|
||||
"code": 200
|
||||
"uri": "/Execute"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -703,6 +731,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Options that control how the result set is returned.</p>"
|
||||
}
|
||||
},
|
||||
"formatRecordsAs": {
|
||||
"target": "com.amazonaws.rdsdata#RecordsFormatType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A value that indicates whether to format the result set as a single JSON string.\n This parameter only applies to <code>SELECT</code> statements and is ignored for\n other types of statements. Allowed values are <code>NONE</code> and <code>JSON</code>.\n The default value is <code>NONE</code>. The result is returned in the <code>formattedRecords</code> field.</p>\n <p>For usage information about the JSON format for result sets, see\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API</a>\n in the <i>Amazon Aurora User Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -715,13 +749,13 @@
|
|||
"records": {
|
||||
"target": "com.amazonaws.rdsdata#SqlRecords",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The records returned by the SQL statement.</p>"
|
||||
"smithy.api#documentation": "<p>The records returned by the SQL statement. This field is blank if the\n <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p>"
|
||||
}
|
||||
},
|
||||
"columnMetadata": {
|
||||
"target": "com.amazonaws.rdsdata#Metadata",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Metadata for the columns included in the results.</p>"
|
||||
"smithy.api#documentation": "<p>Metadata for the columns included in the results. This field is blank if the\n <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p>"
|
||||
}
|
||||
},
|
||||
"numberOfRecordsUpdated": {
|
||||
|
@ -733,7 +767,13 @@
|
|||
"generatedFields": {
|
||||
"target": "com.amazonaws.rdsdata#FieldList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Values for fields generated during the request.</p>\n \n <note>\n <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL.\n To get the values of generated fields, use the <code>RETURNING</code> clause. For\n more information, see <a href=\"https://www.postgresql.org/docs/10/dml-returning.html\">Returning Data From\n Modified Rows</a> in the PostgreSQL documentation.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Values for fields generated during a DML request.</p>\n \n <note>\n <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL.\n To get the values of generated fields, use the <code>RETURNING</code> clause. For\n more information, see <a href=\"https://www.postgresql.org/docs/10/dml-returning.html\">Returning Data From\n Modified Rows</a> in the PostgreSQL documentation.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"formattedRecords": {
|
||||
"target": "com.amazonaws.rdsdata#FormattedSqlRecords",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A string value that represents the result set of a <code>SELECT</code> statement\n in JSON format. This value is only present when the <code>formatRecordsAs</code>\n parameter is set to <code>JSON</code>.</p>\n <p>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.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -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": "<p>An array of integers.</p>\n <note>\n <p>Some array entries can be null.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"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": "<fullname>Amazon RDS Data Service</fullname>\n <p>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.</p>\n <p>For more information about the Data Service API, see\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API</a>\n in the <i>Amazon Aurora User Guide</i>.</p>",
|
||||
"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": "<fullname>Amazon RDS Data Service</fullname>\n <p>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.</p>\n <p>For more information about the Data Service API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora\n Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>",
|
||||
"smithy.api#title": "AWS RDS DataService"
|
||||
}
|
||||
]
|
||||
},
|
||||
"com.amazonaws.rdsdata#Record": {
|
||||
"type": "structure",
|
||||
|
@ -921,7 +976,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A record returned by a call.</p>"
|
||||
"smithy.api#documentation": "<p>A record returned by a call.</p>\n <important>\n <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.\n Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"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": "<p>The result set returned by a SQL statement.</p>"
|
||||
"smithy.api#documentation": "<p>The result set returned by a SQL statement.</p>\n <important>\n <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.\n Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rdsdata#ResultSetMetadata": {
|
||||
|
@ -981,6 +1051,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>A value that indicates how a field of <code>DECIMAL</code> type is represented\n in the response. The value of <code>STRING</code>, the default, specifies that\n it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code>\n specifies that it is converted to a Long value if its scale is 0, or to a Double\n value otherwise.</p>\n <important>\n <p>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.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"longReturnType": {
|
||||
"target": "com.amazonaws.rdsdata#LongReturnType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A value that indicates how a field of <code>LONG</code> type is represented.\n Allowed values are <code>LONG</code> and <code>STRING</code>. The default\n is <code>LONG</code>. Specify <code>STRING</code> if the length or\n precision of numeric values might cause truncation or rounding errors.\n </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>Performs a rollback of a transaction. Rolling back a transaction cancels its changes.</p>",
|
||||
"smithy.api#http": {
|
||||
"code": 200,
|
||||
"method": "POST",
|
||||
"uri": "/RollbackTransaction",
|
||||
"code": 200
|
||||
"uri": "/RollbackTransaction"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -1151,7 +1230,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The result of a SQL statement.</p>\n \n <important>\n <p>This data type is deprecated.</p>\n </important>"
|
||||
"smithy.api#documentation": "<p>The result of a SQL statement.</p>\n \n <important>\n <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.\n Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rdsdata#SqlStatementResults": {
|
||||
|
@ -1205,7 +1284,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A structure value returned by a call.</p>"
|
||||
"smithy.api#documentation": "<p>A structure value returned by a call.</p>\n <important>\n <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.\n Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rdsdata#TransactionStatus": {
|
||||
|
@ -1332,7 +1411,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Contains the value of a column.</p>\n \n <important>\n <p>This data type is deprecated.</p>\n </important>"
|
||||
"smithy.api#documentation": "<p>Contains the value of a column.</p>\n \n <important>\n <p>This data structure is only used with the deprecated <code>ExecuteSql</code> operation.\n Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation instead.</p>\n </important>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -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": "<p>The name of an existing S3 bucket where the log files are to be stored.</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>Must be in the same region as the cluster</p>\n </li>\n <li>\n <p>The cluster must have read bucket and put object permissions</p>\n </li>\n </ul>",
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#documentation": "<p>The name of an existing S3 bucket where the log files are to be stored.</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>Must be in the same region as the cluster</p>\n </li>\n <li>\n <p>The cluster must have read bucket and put object permissions</p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"S3KeyPrefix": {
|
||||
|
@ -7199,6 +7237,18 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The prefix applied to the log file names.</p>\n <p>Constraints:</p>\n <ul>\n <li>\n <p>Cannot exceed 512 characters</p>\n </li>\n <li>\n <p>Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash\n (\\), or control characters. The hexadecimal codes for invalid characters are: </p>\n <ul>\n <li>\n <p>x00 to x20</p>\n </li>\n <li>\n <p>x22</p>\n </li>\n <li>\n <p>x27</p>\n </li>\n <li>\n <p>x5c</p>\n </li>\n <li>\n <p>x7f or larger</p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"LogDestinationType": {
|
||||
"target": "com.amazonaws.redshift#LogDestinationType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The log destination type. An enum with possible values of <code>s3</code> and <code>cloudwatch</code>.</p>"
|
||||
}
|
||||
},
|
||||
"LogExports": {
|
||||
"target": "com.amazonaws.redshift#LogTypeList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The collection of exported log types. Log types include the connection log, user log and user activity log.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>The message indicating that logs failed to be delivered.</p>"
|
||||
}
|
||||
},
|
||||
"LogDestinationType": {
|
||||
"target": "com.amazonaws.redshift#LogDestinationType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The log destination type. An enum with possible values of <code>s3</code> and <code>cloudwatch</code>.</p>"
|
||||
}
|
||||
},
|
||||
"LogExports": {
|
||||
"target": "com.amazonaws.redshift#LogTypeList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The collection of exported log types. Log types include the connection log, user log and user activity log.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"NodeType": {
|
||||
|
@ -12632,7 +12718,7 @@
|
|||
"Encrypted": {
|
||||
"target": "com.amazonaws.redshift#BooleanOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Enables support for restoring an unencrypted snapshot to a cluster encrypted \n with Key Management Service (KMS) and a CMK.</p>"
|
||||
"smithy.api#documentation": "<p>Enables support for restoring an unencrypted snapshot to a cluster encrypted \n with Key Management Service (KMS) and a customer managed key.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
@ -75,7 +75,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.</p>\n <p>To turn on automatic rotation again, call <a>RotateSecret</a>.</p>\n <note>\n <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified\n by the <code>VersionId</code> 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.</p>\n </note>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:CancelRotateSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.</p>\n <p>To turn on automatic rotation again, call <a>RotateSecret</a>.</p>\n <note>\n <p>If you cancel a rotation in progress, it can leave the <code>VersionStage</code>\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified\n by the <code>VersionId</code> 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.</p>\n </note>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:CancelRotateSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#CancelRotateSecretRequest": {
|
||||
|
@ -84,7 +84,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret.</p> \n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret.</p> \n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -163,7 +163,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a new secret. A <i>secret</i> 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.</p>\n <p>For information about creating a secret in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html\">Create a secret</a>.</p>\n <p>To create a secret, you can provide the secret value to be encrypted in either the\n <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both. \n If you include <code>SecretString</code> or <code>SecretBinary</code>\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label <code>AWSCURRENT</code> to it.</p>\n <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n <code>aws/secretsmanager</code>. 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 <code>aws/secretsmanager</code>. \n Creating <code>aws/secretsmanager</code> can result in a one-time significant delay in returning the \n result.</p>\n <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must create \n and use a customer managed KMS key. </p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:CreateSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Creates a new secret. A <i>secret</i> 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.</p>\n <p>For information about creating a secret in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html\">Create a secret</a>.</p>\n <p>To create a secret, you can provide the secret value to be encrypted in either the\n <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both. \n If you include <code>SecretString</code> or <code>SecretBinary</code>\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label <code>AWSCURRENT</code> to it.</p>\n <p>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 <code>SecretString</code> matches the <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html\">JSON structure of\n a database secret</a>.</p>\n <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n <code>aws/secretsmanager</code>. 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 <code>aws/secretsmanager</code>. \n Creating <code>aws/secretsmanager</code> can result in a one-time significant delay in returning the \n result.</p>\n <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use <code>aws/secretsmanager</code> to encrypt the secret, and you must create \n and use a customer managed KMS key. </p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:CreateSecret</code>. If you \n include tags in the secret, you also need <code>secretsmanager:TagResource</code>.\n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>\n <p>To encrypt the secret with a KMS key other than <code>aws/secretsmanager</code>, you need <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permission to the key. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#CreateSecretRequest": {
|
||||
|
@ -294,7 +294,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use <a>PutResourcePolicy</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:DeleteResourcePolicy</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Deletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use <a>PutResourcePolicy</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:DeleteResourcePolicy</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#DeleteResourcePolicyRequest": {
|
||||
|
@ -303,7 +303,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to delete the attached resource-based policy for.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to delete the attached resource-based policy for.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -349,7 +349,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>DeletionDate</code> 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.</p>\n <p>For information about deleting a secret in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html\">https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html</a>. </p>\n <p>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.</p>\n <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to\n remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>\n <p>In a secret scheduled for deletion, you cannot access the encrypted secret value.\n To access that information, first cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:DeleteSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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 <code>DeletionDate</code> 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.</p>\n <p>For information about deleting a secret in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html\">https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html</a>. </p>\n <p>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.</p>\n <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to\n remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p>\n <p>In a secret scheduled for deletion, you cannot access the encrypted secret value.\n To access that information, first cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:DeleteSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#DeleteSecretRequest": {
|
||||
|
@ -358,7 +358,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to delete.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to delete.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -427,7 +427,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:DescribeSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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. </p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:DescribeSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#DescribeSecretRequest": {
|
||||
|
@ -436,7 +436,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret. </p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret. </p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -710,7 +710,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:GetRandomPassword</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:GetRandomPassword</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#GetRandomPasswordRequest": {
|
||||
|
@ -807,7 +807,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html\">Permissions \n policies attached to a secret</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:GetResourcePolicy</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html\">Permissions \n policies attached to a secret</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:GetResourcePolicy</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#GetResourcePolicyRequest": {
|
||||
|
@ -816,7 +816,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to retrieve the attached resource-based policy for.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to retrieve the attached resource-based policy for.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -871,7 +871,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves the contents of the encrypted fields <code>SecretString</code> or\n <code>SecretBinary</code> from the specified version of a secret, whichever contains\n content.</p>\n <p>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 <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html\">Cache secrets for \n your applications</a>.</p>\n \n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:GetSecretValue</code>. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code> permissions for that key.\n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Retrieves the contents of the encrypted fields <code>SecretString</code> or\n <code>SecretBinary</code> from the specified version of a secret, whichever contains\n content.</p>\n <p>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 <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html\">Cache secrets for \n your applications</a>.</p>\n \n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:GetSecretValue</code>. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n <code>aws/secretsmanager</code>, then you also need <code>kms:Decrypt</code> permissions for that key.\n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#GetSecretValueRequest": {
|
||||
|
@ -880,7 +880,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to retrieve.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to retrieve.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1055,7 +1055,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the versions for a secret. </p>\n <p>To list the secrets in the account, use <a>ListSecrets</a>.</p>\n <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>, \n call <a>GetSecretValue</a>.</p> \n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:ListSecretVersionIds</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>",
|
||||
"smithy.api#documentation": "<p>Lists the versions for a secret. </p>\n <p>To list the secrets in the account, use <a>ListSecrets</a>.</p>\n <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>, \n call <a>GetSecretValue</a>.</p> \n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:ListSecretVersionIds</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
@ -1069,7 +1069,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret whose versions you want to list.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret whose versions you want to list.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1144,7 +1144,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p>\n <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>, \n call <a>GetSecretValue</a>.</p> \n <p>For information about finding secrets in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html\">Enhanced search capabilities \n for secrets in Secrets Manager</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:ListSecrets</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>",
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>To list the versions of a secret, use <a>ListSecretVersionIds</a>.</p>\n <p>To get the secret value from <code>SecretString</code> or <code>SecretBinary</code>, \n call <a>GetSecretValue</a>.</p> \n <p>For information about finding secrets in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html\">Enhanced search capabilities \n for secrets in Secrets Manager</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:ListSecrets</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
@ -1318,7 +1318,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Attaches a resource-based permission policy to a secret. A resource-based policy is \n optional. For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication and access control for Secrets Manager</a>\n </p> \n <p>For information about attaching a policy in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html\">Attach a \n permissions policy to a secret</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:PutResourcePolicy</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Attaches a resource-based permission policy to a secret. A resource-based policy is \n optional. For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication and access control for Secrets Manager</a>\n </p> \n <p>For information about attaching a policy in the console, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html\">Attach a \n permissions policy to a secret</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:PutResourcePolicy</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#PutResourcePolicyRequest": {
|
||||
|
@ -1327,7 +1327,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to attach the resource-based policy.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to attach the resource-based policy.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1399,7 +1399,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. </p>\n <p>We recommend you avoid calling <code>PutSecretValue</code> 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 <code>PutSecretValue</code> 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.</p>\n <p>You can specify the staging labels to attach to the new version in <code>VersionStages</code>. \n If you don't include <code>VersionStages</code>, then Secrets Manager automatically\n moves the staging label <code>AWSCURRENT</code> to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label <code>AWSCURRENT</code> to it .</p>\n <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this\n version, then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to\n the version that <code>AWSCURRENT</code> was removed from.</p>\n <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same\n value as the <code>ClientRequestToken</code> 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.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:PutSecretValue</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. </p>\n <p>We recommend you avoid calling <code>PutSecretValue</code> 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 <code>PutSecretValue</code> 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.</p>\n <p>You can specify the staging labels to attach to the new version in <code>VersionStages</code>. \n If you don't include <code>VersionStages</code>, then Secrets Manager automatically\n moves the staging label <code>AWSCURRENT</code> to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label <code>AWSCURRENT</code> to it .</p>\n <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this\n version, then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to\n the version that <code>AWSCURRENT</code> was removed from.</p>\n <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same\n value as the <code>ClientRequestToken</code> 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.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:PutSecretValue</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#PutSecretValueRequest": {
|
||||
|
@ -1408,7 +1408,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to add a new version to.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p> \n <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to add a new version to.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p> \n <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -1514,7 +1514,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:RemoveRegionsFromReplication</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:RemoveRegionsFromReplication</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest": {
|
||||
|
@ -1607,7 +1607,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Replicates the secret to a new Regions. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html\">Multi-Region secrets</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:ReplicateSecretToRegions</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Replicates the secret to a new Regions. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html\">Multi-Region secrets</a>.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:ReplicateSecretToRegions</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest": {
|
||||
|
@ -1746,7 +1746,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time\n stamp. You can access a secret again after it has been restored.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:RestoreSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time\n stamp. You can access a secret again after it has been restored.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:RestoreSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#RestoreSecretRequest": {
|
||||
|
@ -1755,7 +1755,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to restore.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to restore.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -1801,7 +1801,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Configures and starts the asynchronous process of rotating the secret.</p>\n <p>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 <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html\">Rotate secrets</a>.</p>\n <p>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 <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more\n information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html\">How rotation works</a>.</p>\n <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached to the same \n version as the <code>AWSCURRENT</code> version, or it might not be attached to any version.</p>\n <p>If the <code>AWSPENDING</code> staging label is present but not attached to the same version as\n <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code> assumes that a previous\n rotation request is still in progress and returns an error.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:RotateSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. You also need <code>lambda:InvokeFunction</code> permissions on the rotation function. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html\">\n Permissions for rotation</a>.</p>"
|
||||
"smithy.api#documentation": "<p>Configures and starts the asynchronous process of rotating the secret. For more information about rotation, \n see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html\">Rotate secrets</a>.</p>\n <p>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. </p>\n <p>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 <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html\"> JSON structure\n of a database secret</a>. In particular, if you want to use the <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users\"> alternating users strategy</a>, your secret must contain the ARN of a superuser\n secret.</p>\n \n <p>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 <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more\n information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html\">How rotation works</a>.</p>\n <p>You can create the Lambda rotation function based on the <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html\">rotation function templates</a> that Secrets Manager provides. Choose \n a template that matches your <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html\">Rotation strategy</a>.</p>\n <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached\n to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any\n version. If the <code>AWSPENDING</code> staging label is present but not attached to the same\n version as <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code>\n assumes that a previous rotation request is still in progress and returns an error.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:RotateSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. You also need <code>lambda:InvokeFunction</code> permissions on the rotation function. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html\">\n Permissions for rotation</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#RotateSecretRequest": {
|
||||
|
@ -1810,7 +1810,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to rotate.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret to rotate.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -2221,7 +2221,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.</p>\n <p>You must call this operation from the Region in which you want to promote the replica to a primary secret.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:StopReplicationToReplica</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.</p>\n <p>You must call this operation from the Region in which you want to promote the replica to a primary secret.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:StopReplicationToReplica</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p> \n <p>The following restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per secret: 50</p>\n </li>\n <li>\n <p>Maximum key length: 127 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length: 255 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Tag keys and values are case sensitive.</p>\n </li>\n <li>\n <p>Do not use the <code>aws:</code> prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.</p>\n </li>\n <li>\n <p>If you use your tagging schema across multiple services and resources,\n other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.</p>\n </li>\n </ul>\n \n <important>\n <p>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.</p>\n </important>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:TagResource</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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.</p> \n <p>The following restrictions apply to tags:</p>\n <ul>\n <li>\n <p>Maximum number of tags per secret: 50</p>\n </li>\n <li>\n <p>Maximum key length: 127 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Maximum value length: 255 Unicode characters in UTF-8</p>\n </li>\n <li>\n <p>Tag keys and values are case sensitive.</p>\n </li>\n <li>\n <p>Do not use the <code>aws:</code> prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.</p>\n </li>\n <li>\n <p>If you use your tagging schema across multiple services and resources,\n other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.</p>\n </li>\n </ul>\n \n <important>\n <p>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.</p>\n </important>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:TagResource</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#TagResourceRequest": {
|
||||
|
@ -2317,7 +2320,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p> \n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>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.</p> \n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"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": "<p>Removes specific tags from a secret.</p>\n <p>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.</p>\n <important>\n <p>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.</p>\n </important>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:UntagResource</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>Removes specific tags from a secret.</p>\n <p>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.</p>\n <important>\n <p>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.</p>\n </important>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:UntagResource</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#UntagResourceRequest": {
|
||||
|
@ -2371,7 +2377,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret.</p>\n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -2425,7 +2431,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>\n <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>\n \n <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than \n once every 10 minutes. When you call <code>UpdateSecret</code> 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.</p>\n <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new\n secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new\n version. </p>\n <p>If you call this operation with a <code>VersionId</code> that matches an existing version's \n <code>ClientRequestToken</code>, 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 <a>UpdateSecretVersionStage</a>.</p>\n <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n <code>aws/secretsmanager</code>. 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 <code>aws/secretsmanager</code>. Creating <code>aws/secretsmanager</code> can result in a one-time \n significant delay in returning the result. </p>\n <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use <code>aws/secretsmanager</code> to encrypt the secret, and you must create and use a customer managed key. </p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:UpdateSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. \n If you use a customer managed key, you must also have <code>kms:GenerateDataKey</code> and \n <code>kms:Decrypt</code> permissions on the key. For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html\">\n Secret encryption and decryption</a>.</p>"
|
||||
"smithy.api#documentation": "<p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>\n <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>\n \n <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than \n once every 10 minutes. When you call <code>UpdateSecret</code> 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.</p>\n <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new\n secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new\n version. </p>\n <p>If you call this operation with a <code>VersionId</code> that matches an existing version's \n <code>ClientRequestToken</code>, 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 <a>UpdateSecretVersionStage</a>.</p>\n <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n <code>aws/secretsmanager</code>. 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 <code>aws/secretsmanager</code>. Creating <code>aws/secretsmanager</code> can result in a one-time \n significant delay in returning the result. </p>\n <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use <code>aws/secretsmanager</code> to encrypt the secret, and you must create and use a customer managed key. </p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:UpdateSecret</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. \n If you use a customer managed key, you must also have <code>kms:GenerateDataKey</code> and \n <code>kms:Decrypt</code> permissions on the key. For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html\">\n Secret encryption and decryption</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#UpdateSecretRequest": {
|
||||
|
@ -2434,7 +2440,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret.</p> \n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or name of the secret.</p> \n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -2520,7 +2526,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version\">Concepts: Version</a>. </p>\n <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added\n to the existing list of staging labels for the version. </p>\n <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this\n call.</p>\n <note>\n <p>Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label <code>AWSPREVIOUS</code>\n to the version that <code>AWSCURRENT</code> was removed from.</p>\n </note>\n <p>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.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:UpdateSecretVersionStage</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version\">Concepts: Version</a>. </p>\n <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added\n to the existing list of staging labels for the version. </p>\n <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this\n call.</p>\n <note>\n <p>Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label <code>AWSPREVIOUS</code>\n to the version that <code>AWSCURRENT</code> was removed from.</p>\n </note>\n <p>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.</p>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:UpdateSecretVersionStage</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest": {
|
||||
|
@ -2529,7 +2535,7 @@
|
|||
"SecretId": {
|
||||
"target": "com.amazonaws.secretsmanager#SecretIdType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN or the name of the secret with the version and staging labelsto modify.</p> \n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The ARN or the name of the secret with the version and staging labelsto modify.</p> \n <p>For an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN. See <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen\">Finding a secret from a partial ARN</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -2597,7 +2603,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>The API performs three checks when validating the policy:</p>\n <ul>\n <li>\n <p>Sends a call to <a href=\"https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/\">Zelkova</a>, an automated reasoning engine, to ensure your resource policy does not\n allow broad access to your secret, for example policies that use a wildcard for the principal.</p>\n </li>\n <li>\n <p>Checks for correct syntax in a policy.</p>\n </li>\n <li>\n <p>Verifies the policy does not lock out a caller.</p>\n </li>\n </ul>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:ValidateResourcePolicy</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>The API performs three checks when validating the policy:</p>\n <ul>\n <li>\n <p>Sends a call to <a href=\"https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/\">Zelkova</a>, an automated reasoning engine, to ensure your resource policy does not\n allow broad access to your secret, for example policies that use a wildcard for the principal.</p>\n </li>\n <li>\n <p>Checks for correct syntax in a policy.</p>\n </li>\n <li>\n <p>Verifies the policy does not lock out a caller.</p>\n </li>\n </ul>\n <p>\n <b>Required permissions: </b>\n <code>secretsmanager:ValidateResourcePolicy</code>. \n For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions\">\n IAM policy actions for Secrets Manager</a> and <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html\">Authentication \n and access control in Secrets Manager</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.secretsmanager#ValidateResourcePolicyRequest": {
|
||||
|
|
|
@ -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": "<p>The name of the product that generated the finding.</p>\n <p>Security Hub populates this attribute automatically for each finding. You cannot update it using <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is when you use a custom integration.</p>\n <p>When you use the Security Hub console to filter findings by product name, you use this attribute.</p>\n <p>When you use the Security Hub API to filter findings by product name, you use the <code>aws/securityhub/ProductName</code> attribute under <code>ProductFields</code>.</p>\n <p>Security Hub does not synchronize those two attributes.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the product that generated the finding.</p>\n <p>Security Hub populates this attribute automatically for each finding. You cannot update this attribute with <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is a custom integration.</p>\n <p>When you use the Security Hub console or API to filter findings by product name, you use this attribute.</p>"
|
||||
}
|
||||
},
|
||||
"CompanyName": {
|
||||
"target": "com.amazonaws.securityhub#NonEmptyString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the company for the product that generated the finding.</p>\n <p>Security Hub populates this attribute automatically for each finding. You cannot be updated using <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is when you use a custom integration.</p>\n <p>When you use the Security Hub console to filter findings by company name, you use this attribute.</p>\n <p>When you use the Security Hub API to filter findings by company name, you use the <code>aws/securityhub/CompanyName</code> attribute under <code>ProductFields</code>.</p>\n <p>Security Hub does not synchronize those two attributes.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the company for the product that generated the finding.</p>\n <p>Security Hub populates this attribute automatically for each finding. You cannot update this attribute with <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is a custom integration.</p>\n <p>When you use the Security Hub console or API to filter findings by company name, you use this attribute.</p>"
|
||||
}
|
||||
},
|
||||
"Region": {
|
||||
|
@ -12722,13 +12737,13 @@
|
|||
"ProductName": {
|
||||
"target": "com.amazonaws.securityhub#StringFilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the solution (product) that generates findings.</p>\n <p>Note that this is a filter against the <code>aws/securityhub/ProductName</code> field in <code>ProductFields</code>. It is not a filter for the top-level <code>ProductName</code> field.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the solution (product) that generates findings.</p>"
|
||||
}
|
||||
},
|
||||
"CompanyName": {
|
||||
"target": "com.amazonaws.securityhub#StringFilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the findings provider (company) that owns the solution (product) that\n generates findings.</p>\n <p>Note that this is a filter against the <code>aws/securityhub/CompanyName</code> field in <code>ProductFields</code>. It is not a filter for the top-level <code>CompanyName</code> field.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the findings provider (company) that owns the solution (product) that\n generates findings.</p>"
|
||||
}
|
||||
},
|
||||
"UserDefinedFields": {
|
||||
|
@ -14435,7 +14450,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Used to enable finding aggregation. Must be called from the aggregation Region.</p>\n <p>For more details about cross-Region replication, see <a href=\"securityhub/latest/userguide/finding-aggregation.html\">Configuring finding aggregation</a> in the <i>Security Hub User Guide</i>.\n </p>",
|
||||
"smithy.api#documentation": "<p>Used to enable finding aggregation. Must be called from the aggregation Region.</p>\n <p>For more details about cross-Region replication, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html\">Configuring finding aggregation</a> in the <i>Security Hub User Guide</i>.\n </p>",
|
||||
"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": "<p>Whether the maximum number of allowed member accounts are already associated with the\n Security Hub administrator account.</p>"
|
||||
}
|
||||
},
|
||||
"AutoEnableStandards": {
|
||||
"target": "com.amazonaws.securityhub#AutoEnableStandards",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Whether to automatically enable Security Hub <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html\">default standards</a> \n for new member accounts in the organization.</p>\n <p>The default value of this parameter is equal to <code>DEFAULT</code>.</p> \n <p>If equal to <code>DEFAULT</code>, then Security Hub default standards are automatically enabled for new member \n accounts. If equal to <code>NONE</code>, then default standards are not automatically enabled for new member \n accounts.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -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": "<p>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 <i>Security Hub<a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html\">User\n Guide</a>\n </i>.</p>\n <p>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.</p>\n <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code>CreateMembers</code> to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the <code>us-west-2</code>\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.</p>\n <p>The following throttling limits apply to using Security Hub API operations.</p>\n <ul>\n <li>\n <p>\n <code>BatchEnableStandards</code> - <code>RateLimit</code> of 1\n request per second, <code>BurstLimit</code> of 1 request per second.</p>\n </li>\n <li>\n <p>\n <code>GetFindings</code> - <code>RateLimit</code> of 3 requests per second.\n <code>BurstLimit</code> of 6 requests per second.</p>\n </li>\n <li>\n <p>\n <code>UpdateFindings</code> - <code>RateLimit</code> of 1 request per\n second. <code>BurstLimit</code> of 5 requests per second.</p>\n </li>\n <li>\n <p>\n <code>UpdateStandardsControl</code> - <code>RateLimit</code> of\n 1 request per second, <code>BurstLimit</code> of 5 requests per second.</p>\n </li>\n <li>\n <p>All other operations - <code>RateLimit</code> of 10 requests per second.\n <code>BurstLimit</code> of 30 requests per second.</p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html\">\n <i>Security HubUser\n Guide</i>\n </a>.</p> \n <p>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.</p>\n <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code>CreateMembers</code> to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the <code>us-west-2</code>\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.</p>\n <p>The following throttling limits apply to using Security Hub API operations.</p>\n <ul>\n <li>\n <p>\n <code>BatchEnableStandards</code> - <code>RateLimit</code> of 1\n request per second, <code>BurstLimit</code> of 1 request per second.</p>\n </li>\n <li>\n <p>\n <code>GetFindings</code> - <code>RateLimit</code> of 3 requests per second.\n <code>BurstLimit</code> of 6 requests per second.</p>\n </li>\n <li>\n <p>\n <code>UpdateFindings</code> - <code>RateLimit</code> of 1 request per\n second. <code>BurstLimit</code> of 5 requests per second.</p>\n </li>\n <li>\n <p>\n <code>UpdateStandardsControl</code> - <code>RateLimit</code> of\n 1 request per second, <code>BurstLimit</code> of 5 requests per second.</p>\n </li>\n <li>\n <p>All other operations - <code>RateLimit</code> of 10 requests per second.\n <code>BurstLimit</code> of 30 requests per second.</p>\n </li>\n </ul>",
|
||||
"smithy.api#title": "AWS SecurityHub"
|
||||
},
|
||||
"version": "2018-10-26",
|
||||
|
@ -21318,6 +21351,12 @@
|
|||
"smithy.api#documentation": "<p>Whether to automatically enable Security Hub for new accounts in the organization.</p>\n <p>By default, this is <code>false</code>, and new accounts are not added\n automatically.</p>\n <p>To automatically enable Security Hub for new accounts, set this to <code>true</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"AutoEnableStandards": {
|
||||
"target": "com.amazonaws.securityhub#AutoEnableStandards",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Whether to automatically enable Security Hub <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html\">default standards</a> \n for new member accounts in the organization.</p>\n <p>By default, this parameter is equal to <code>DEFAULT</code>, and new member accounts are automatically enabled with default Security Hub standards.</p>\n <p>To opt out of enabling default standards for new member accounts, set this parameter equal to <code>NONE</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
@ -221,7 +221,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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:</p>\n <ul>\n <li>\n <p>\n <code>Key=Owner,Value=DbAdmin</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Owner,Value=SysAdmin</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Owner,Value=Dev</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Stack,Value=Production</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Stack,Value=Pre-Production</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Stack,Value=Test</code>\n </p>\n </li>\n </ul>\n <p>Each resource can have a maximum of 50 tags.</p>\n <p>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. </p>\n <p>For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging your Amazon EC2\n resources</a> in the <i>Amazon EC2 User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>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:</p>\n <ul>\n <li>\n <p>\n <code>Key=Owner,Value=DbAdmin</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Owner,Value=SysAdmin</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Owner,Value=Dev</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Stack,Value=Production</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Stack,Value=Pre-Production</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Stack,Value=Test</code>\n </p>\n </li>\n </ul>\n <p>Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.</p>\n <p>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.</p>\n <p>For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging your Amazon EC2\n resources</a> in the <i>Amazon EC2 User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#AddTagsToResourceRequest": {
|
||||
|
@ -237,7 +237,7 @@
|
|||
"ResourceId": {
|
||||
"target": "com.amazonaws.ssm#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The resource ID you want to tag.</p>\n <p>Use the ID of the resource. Here are some examples:</p>\n <p>\n <code>MaintenanceWindow</code>: <code>mw-012345abcde</code>\n </p>\n <p>\n <code>PatchBaseline</code>: <code>pb-012345abcde</code>\n </p>\n <p>\n <code>OpsMetadata</code> object: <code>ResourceID</code> for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from\n the strings that come after the word <code>opsmetadata</code> in the ARN. For example, an\n OpsMetadata object with an ARN of\n <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code> has a\n <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or\n <code>/aws/ssm/MyGroup/appmanager</code>.</p>\n <p>For the <code>Document</code> and <code>Parameter</code> values, use the name of the\n resource.</p>\n <p>\n <code>ManagedInstance</code>: <code>mi-012345abcde</code>\n </p>\n <note>\n <p>The <code>ManagedInstance</code> 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 <code>mi-<i>ID_number</i>\n </code>. For example,\n <code>mi-1a2b3c4d5e6f</code>.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>The resource ID you want to tag.</p>\n <p>Use the ID of the resource. Here are some examples:</p>\n <p>\n <code>MaintenanceWindow</code>: <code>mw-012345abcde</code>\n </p>\n <p>\n <code>PatchBaseline</code>: <code>pb-012345abcde</code>\n </p>\n <p>\n <code>Automation</code>: <code>example-c160-4567-8519-012345abcde</code>\n </p>\n <p>\n <code>OpsMetadata</code> object: <code>ResourceID</code> for tagging is created from the\n Amazon Resource Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from\n the strings that come after the word <code>opsmetadata</code> in the ARN. For example, an\n OpsMetadata object with an ARN of\n <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code> has a\n <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or\n <code>/aws/ssm/MyGroup/appmanager</code>.</p>\n <p>For the <code>Document</code> and <code>Parameter</code> values, use the name of the\n resource.</p>\n <p>\n <code>ManagedInstance</code>: <code>mi-012345abcde</code>\n </p>\n <note>\n <p>The <code>ManagedInstance</code> 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 <code>mi-<i>ID_number</i>\n </code>. For example,\n <code>mi-1a2b3c4d5e6f</code>.</p>\n </note>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -879,6 +879,13 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The association name.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduleOffset": {
|
||||
"target": "com.amazonaws.ssm#ScheduleOffset",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>Number of days to wait after the scheduled day to run an association.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -1070,6 +1077,13 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduleOffset": {
|
||||
"target": "com.amazonaws.ssm#ScheduleOffset",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>Number of days to wait after the scheduled day to run an association.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -1771,6 +1785,13 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduleOffset": {
|
||||
"target": "com.amazonaws.ssm#ScheduleOffset",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>Number of days to wait after the scheduled day to run an association.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -4445,6 +4466,13 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Use this action to create an association in multiple Regions and multiple accounts.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduleOffset": {
|
||||
"target": "com.amazonaws.ssm#ScheduleOffset",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>Number of days to wait after the scheduled day to run an association.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
@ -4567,6 +4595,13 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduleOffset": {
|
||||
"target": "com.amazonaws.ssm#ScheduleOffset",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, 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 <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html\">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>\n <note>\n <p>To use offsets, you must specify the <code>ApplyOnlyAtCronInterval</code> parameter. This\n option tells the system not to run an association immediately after you create it. </p>\n </note>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -21506,7 +21541,7 @@
|
|||
"ResourceId": {
|
||||
"target": "com.amazonaws.ssm#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the resource from which you want to remove tags. For example:</p>\n <p>ManagedInstance: mi-012345abcde</p>\n <p>MaintenanceWindow: mw-012345abcde</p>\n <p>PatchBaseline: pb-012345abcde</p>\n <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource\n Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that\n come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with\n an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code>\n has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or\n <code>/aws/ssm/MyGroup/appmanager</code>.</p>\n <p>For the Document and Parameter values, use the name of the resource.</p>\n <note>\n <p>The <code>ManagedInstance</code> 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.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>The ID of the resource from which you want to remove tags. For example:</p>\n <p>ManagedInstance: mi-012345abcde</p>\n <p>MaintenanceWindow: mw-012345abcde</p>\n <p>\n <code>Automation</code>: <code>example-c160-4567-8519-012345abcde</code>\n </p>\n <p>PatchBaseline: pb-012345abcde</p>\n <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource\n Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that\n come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with\n an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code>\n has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or\n <code>/aws/ssm/MyGroup/appmanager</code>.</p>\n <p>For the Document and Parameter values, use the name of the resource.</p>\n <note>\n <p>The <code>ManagedInstance</code> 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.</p>\n </note>",
|
||||
"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": "<p>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:</p>\n <ul>\n <li>\n <p>\n <code>Key=environment,Value=test</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=OS,Value=Windows</code>\n </p>\n </li>\n </ul>\n <note>\n <p>To add tags to an existing patch baseline, use the <a>AddTagsToResource</a>\n operation.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>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:</p>\n <ul>\n <li>\n <p>\n <code>Key=environment,Value=test</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=OS,Value=Windows</code>\n </p>\n </li>\n </ul>\n <note>\n <p>To add tags to an existing automation, use the <a>AddTagsToResource</a>\n operation.</p>\n </note>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -24806,6 +24850,13 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduleOffset": {
|
||||
"target": "com.amazonaws.ssm#ScheduleOffset",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of <code>cron(0 0 ? * THU#2 *)</code>, 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 <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html\">Reference: Cron and rate expressions for Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>\n <note>\n <p>To use offsets, you must specify the <code>ApplyOnlyAtCronInterval</code> parameter. This\n option tells the system not to run an association immediately after you create it. </p>\n </note>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
@ -381,7 +381,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>Valid Values: <code>GLACIER</code> | <code>DEEP_ARCHIVE</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.storagegateway#AssignTapePoolInput": {
|
||||
|
@ -397,7 +397,7 @@
|
|||
"PoolId": {
|
||||
"target": "com.amazonaws.storagegateway#PoolId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>Valid Values: <code>GLACIER</code> | <code>DEEP_ARCHIVE</code>\n </p>",
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -647,7 +647,7 @@
|
|||
"PoolId": {
|
||||
"target": "com.amazonaws.storagegateway#PoolId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>Valid Values: <code>GLACIER</code> | <code>DEEP_ARCHIVE</code>\n </p>",
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -896,7 +896,7 @@
|
|||
"VolumeUsedInBytes": {
|
||||
"target": "com.amazonaws.storagegateway#VolumeUsedInBytes",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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. <code>VolumeUsedInBytes</code> is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.</p>\n\n <note>\n <p>This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>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. <code>VolumeUsedInBytes</code> is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.</p>\n\n <note>\n <p>This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.</p>\n\n <p>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.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"KMSKey": {
|
||||
|
@ -1288,7 +1288,7 @@
|
|||
"DefaultStorageClass": {
|
||||
"target": "com.amazonaws.storagegateway#StorageClass",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_INTELLIGENT_TIERING</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"ObjectACL": {
|
||||
|
@ -1454,7 +1454,7 @@
|
|||
"DefaultStorageClass": {
|
||||
"target": "com.amazonaws.storagegateway#StorageClass",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_INTELLIGENT_TIERING</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"ObjectACL": {
|
||||
|
@ -1971,7 +1971,7 @@
|
|||
"PoolId": {
|
||||
"target": "com.amazonaws.storagegateway#PoolId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>Valid Values: <code>GLACIER</code> | <code>DEEP_ARCHIVE</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"Worm": {
|
||||
|
@ -2078,7 +2078,7 @@
|
|||
"PoolId": {
|
||||
"target": "com.amazonaws.storagegateway#PoolId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>Valid Values: <code>GLACIER</code> | <code>DEEP_ARCHIVE</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"Worm": {
|
||||
|
@ -2427,7 +2427,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes a snapshot of a volume.</p>\n\n <p>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 <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html\">Backing up your\n volumes</a>. In the <code>DeleteSnapshotSchedule</code> 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.</p>\n\n <note>\n\n <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html\">DescribeSnapshots</a>\n in the <i>Amazon Elastic Compute Cloud API Reference</i>.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Deletes a snapshot of a volume.</p>\n\n <p>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 <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/backing-up-volumes.html\">Backing up your\n volumes</a>. In the <code>DeleteSnapshotSchedule</code> request, you identify the\n volume by providing its Amazon Resource Name (ARN). This operation is only supported for\n cached volume gateway types.</p>\n\n <note>\n\n <p>To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n go to <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html\">DescribeSnapshots</a>\n in the <i>Amazon Elastic Compute Cloud API Reference</i>.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.storagegateway#DeleteSnapshotScheduleInput": {
|
||||
|
@ -3122,7 +3122,7 @@
|
|||
"LastSoftwareUpdate": {
|
||||
"target": "com.amazonaws.storagegateway#LastSoftwareUpdate",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
"smithy.api#documentation": "<p>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</p>"
|
||||
}
|
||||
},
|
||||
"Ec2InstanceId": {
|
||||
|
@ -3152,7 +3152,7 @@
|
|||
"CloudWatchLogGroupARN": {
|
||||
"target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway.</p>"
|
||||
"smithy.api#documentation": "<p>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</p>"
|
||||
}
|
||||
},
|
||||
"HostEnvironment": {
|
||||
|
@ -6162,7 +6162,7 @@
|
|||
"DefaultStorageClass": {
|
||||
"target": "com.amazonaws.storagegateway#StorageClass",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_INTELLIGENT_TIERING</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"ObjectACL": {
|
||||
|
@ -6323,7 +6323,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to Amazon S3.</p>\n\n <p>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.</p>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification\">Getting file upload notification</a> in the <i>Storage Gateway User\n Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to S3. Amazon S3.</p>\n\n <p>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.</p>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification\">Getting file upload notification</a> in the <i>Storage Gateway User\n Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.storagegateway#NotifyWhenUploadedInput": {
|
||||
|
@ -6564,7 +6564,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>You can subscribe to be notified through an Amazon CloudWatch event when your\n <code>RefreshCache</code> operation completes. For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>Storage Gateway\n User Guide</i>. This operation is Only supported for S3 File Gateways.</p>\n\n <p>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 <code>RefreshCache</code>\n operation completes.</p>\n\n <p>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 <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>Storage Gateway\n User Guide</i>.</p>\n\n <p>If you invoke the RefreshCache API when two requests are already being processed, any\n new request will cause an <code>InvalidGatewayRequestException</code> error because too\n many requests were sent to the server.</p>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>Storage Gateway\n User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>You can subscribe to be notified through an Amazon CloudWatch event when your\n <code>RefreshCache</code> operation completes. For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>Storage Gateway\n User Guide</i>. This operation is Only supported for S3 File Gateways.</p>\n\n <p>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 <code>RefreshCache</code>\n operation completes.</p>\n\n <p>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 <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>Storage Gateway\n User Guide</i>.</p>\n\n <important>\n <ul>\n <li>\n <p>Wait at least 60 seconds between consecutive RefreshCache API requests.</p>\n </li>\n <li>\n <p>RefreshCache does not evict cache entries if invoked consecutively within 60\n seconds of a previous RefreshCache request.</p>\n </li>\n <li>\n <p>If you invoke the RefreshCache API when two requests are already being\n processed, any new request will cause an\n <code>InvalidGatewayRequestException</code> error because too many requests\n were sent to the server.</p>\n </li>\n </ul>\n </important>\n\n <note>\n <p>The S3 bucket name does not need to be included when entering the list of folders in\n the FolderList parameter.</p>\n </note>\n\n \n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>Storage Gateway\n User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.storagegateway#RefreshCacheInput": {
|
||||
|
@ -6911,7 +6911,7 @@
|
|||
"DefaultStorageClass": {
|
||||
"target": "com.amazonaws.storagegateway#StorageClass",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_INTELLIGENT_TIERING</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"ObjectACL": {
|
||||
|
@ -7902,7 +7902,7 @@
|
|||
"PoolId": {
|
||||
"target": "com.amazonaws.storagegateway#PoolId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n\n <p>Valid Values: <code>GLACIER</code> | <code>DEEP_ARCHIVE</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>\n\n <p>Valid Values: <code>GLACIER</code> | <code>DEEP_ARCHIVE</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>\n\n <p>Valid Values: <code>GLACIER</code> | <code>DEEP_ARCHIVE</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"RetentionStartDate": {
|
||||
|
@ -8766,7 +8766,7 @@
|
|||
"DefaultStorageClass": {
|
||||
"target": "com.amazonaws.storagegateway#StorageClass",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_INTELLIGENT_TIERING</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"ObjectACL": {
|
||||
|
@ -8893,7 +8893,7 @@
|
|||
"DefaultStorageClass": {
|
||||
"target": "com.amazonaws.storagegateway#StorageClass",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_INTELLIGENT_TIERING</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is <code>S3_STANDARD</code>. Optional.</p>\n\n <p>Valid Values: <code>S3_STANDARD</code> | <code>S3_INTELLIGENT_TIERING</code> |\n <code>S3_STANDARD_IA</code> | <code>S3_ONEZONE_IA</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"ObjectACL": {
|
||||
|
|
|
@ -85,7 +85,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Analyzes an input document for relationships between detected items. </p>\n <p>The types of information returned are as follows: </p>\n <ul>\n <li>\n <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY\n <code>Block</code> object and a VALUE <code>Block</code> object. For example,\n <i>Name: Ana Silva Carolina</i> contains a key and value.\n <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is\n the value.</p>\n </li>\n <li>\n <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL\n <code>Block</code> object is returned for each cell in a table.</p>\n </li>\n <li>\n <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.\n All lines and words that are detected in the document are returned (including text that doesn't have a\n relationship with the value of <code>FeatureTypes</code>). </p>\n </li>\n </ul>\n \n <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,\n including the selection status.</p>\n <p>You can choose which type of analysis to perform by specifying the <code>FeatureTypes</code> list. \n </p>\n <p>The output is returned in a list of <code>Block</code> objects.</p>\n <p>\n <code>AnalyzeDocument</code> is a synchronous operation. To analyze documents \n asynchronously, use <a>StartDocumentAnalysis</a>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html\">Document Text Analysis</a>.</p>"
|
||||
"smithy.api#documentation": "<p>Analyzes an input document for relationships between detected items. </p>\n <p>The types of information returned are as follows: </p>\n <ul>\n <li>\n <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY\n <code>Block</code> object and a VALUE <code>Block</code> object. For example,\n <i>Name: Ana Silva Carolina</i> contains a key and value.\n <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is\n the value.</p>\n </li>\n <li>\n <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL\n <code>Block</code> object is returned for each cell in a table.</p>\n </li>\n <li>\n <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.\n All lines and words that are detected in the document are returned (including text that doesn't have a\n relationship with the value of <code>FeatureTypes</code>). </p>\n </li>\n <li>\n <p>Queries.A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that \n connect it to the query asked. This Block also contains a location and attached confidence score.</p>\n </li>\n </ul>\n \n <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,\n including the selection status.</p>\n \n <p>You can choose which type of analysis to perform by specifying the <code>FeatureTypes</code> list. \n </p>\n <p>The output is returned in a list of <code>Block</code> objects.</p>\n <p>\n <code>AnalyzeDocument</code> is a synchronous operation. To analyze documents \n asynchronously, use <a>StartDocumentAnalysis</a>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html\">Document Text Analysis</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.textract#AnalyzeDocumentRequest": {
|
||||
|
@ -94,7 +94,7 @@
|
|||
"Document": {
|
||||
"target": "com.amazonaws.textract#Document",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>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 <code>Bytes</code> field. </p>",
|
||||
"smithy.api#documentation": "<p>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.</p>\n <p>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 <code>Bytes</code> field. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -110,6 +110,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Sets the configuration for the human in the loop workflow for analyzing documents.</p>"
|
||||
}
|
||||
},
|
||||
"QueriesConfig": {
|
||||
"target": "com.amazonaws.textract#QueriesConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Contains Queries and the alias for those Queries, as determined by the input. </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -246,7 +252,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Analyzes identity documents for relevant information. This information is extracted\n and returned as <code>IdentityDocumentFields</code>, which records both the normalized\n field and value of the extracted text.</p>"
|
||||
"smithy.api#documentation": "<p>Analyzes identity documents for relevant information. This information is extracted\n and returned as <code>IdentityDocumentFields</code>, which records both the normalized\n field and value of the extracted text.Unlike other Amazon Textract operations, <code>AnalyzeID</code> \n doesn't return any Geometry data.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.textract#AnalyzeIDDetections": {
|
||||
|
@ -329,7 +335,7 @@
|
|||
"BlockType": {
|
||||
"target": "com.amazonaws.textract#BlockType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of text item that's recognized. In operations for text detection, the following\n types are returned:</p>\n <ul>\n <li>\n <p>\n <i>PAGE</i> - Contains a list of the LINE <code>Block</code> objects\n that are detected on a document page.</p>\n </li>\n <li>\n <p>\n <i>WORD</i> - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.</p>\n </li>\n <li>\n <p>\n <i>LINE</i> - A string of tab-delimited, contiguous words that are\n detected on a document page.</p>\n </li>\n </ul>\n <p>In text analysis operations, the following types are returned:</p>\n <ul>\n <li>\n <p>\n <i>PAGE</i> - Contains a list of child <code>Block</code> objects\n that are detected on a document page.</p>\n </li>\n <li>\n <p>\n <i>KEY_VALUE_SET</i> - Stores the KEY and VALUE <code>Block</code>\n objects for linked text that's detected on a document page. Use the\n <code>EntityType</code> field to determine if a KEY_VALUE_SET object is a KEY\n <code>Block</code> object or a VALUE <code>Block</code> object. </p>\n </li>\n <li>\n <p>\n <i>WORD</i> - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.</p>\n </li>\n <li>\n <p>\n <i>LINE</i> - A string of tab-delimited, contiguous words that are\n detected on a document page.</p>\n </li>\n <li>\n <p>\n <i>TABLE</i> - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each. </p>\n </li>\n <li>\n <p>\n <i>CELL</i> - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.</p>\n </li>\n <li>\n <p>\n <i>SELECTION_ELEMENT</i> - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of <code>SelectionStatus</code> to determine the status of the selection\n element.</p>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>The type of text item that's recognized. In operations for text detection, the following\n types are returned:</p>\n <ul>\n <li>\n <p>\n <i>PAGE</i> - Contains a list of the LINE <code>Block</code> objects\n that are detected on a document page.</p>\n </li>\n <li>\n <p>\n <i>WORD</i> - A word detected on a document page. A word is one or\n more ISO basic Latin script characters that aren't separated by spaces.</p>\n </li>\n <li>\n <p>\n <i>LINE</i> - A string of tab-delimited, contiguous words that are\n detected on a document page.</p>\n </li>\n </ul>\n <p>In text analysis operations, the following types are returned:</p>\n <ul>\n <li>\n <p>\n <i>PAGE</i> - Contains a list of child <code>Block</code> objects\n that are detected on a document page.</p>\n </li>\n <li>\n <p>\n <i>KEY_VALUE_SET</i> - Stores the KEY and VALUE <code>Block</code>\n objects for linked text that's detected on a document page. Use the\n <code>EntityType</code> field to determine if a KEY_VALUE_SET object is a KEY\n <code>Block</code> object or a VALUE <code>Block</code> object. </p>\n </li>\n <li>\n <p>\n <i>WORD</i> - A word that's detected on a document page. A word is\n one or more ISO basic Latin script characters that aren't separated by spaces.</p>\n </li>\n <li>\n <p>\n <i>LINE</i> - A string of tab-delimited, contiguous words that are\n detected on a document page.</p>\n </li>\n <li>\n <p>\n <i>TABLE</i> - A table that's detected on a document page. A table\n is grid-based information with two or more rows or columns, with a cell span of one\n row and one column each. </p>\n </li>\n <li>\n <p>\n <i>CELL</i> - A cell within a detected table. The cell is the parent\n of the block that contains the text in the cell.</p>\n </li>\n <li>\n <p>\n <i>SELECTION_ELEMENT</i> - A selection element such as an option\n button (radio button) or a check box that's detected on a document page. Use the\n value of <code>SelectionStatus</code> to determine the status of the selection\n element.</p>\n </li>\n <li>\n <p>\n <i>QUERY</i> - A question asked during the call of AnalyzeDocument. Contains an\n alias and an ID that attachs it to its answer.</p>\n </li>\n <li>\n <p>\n <i>QUERY_RESULT</i> - A response to a question asked during the call\n of analyze document. Comes with an alias and ID for ease of locating in a \n response. Also contains location and confidence score.</p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"Confidence": {
|
||||
|
@ -409,6 +415,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The page on which a block was detected. <code>Page</code> 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 <code>Page</code> is always 1.\n Synchronous operations don't return <code>Page</code> because every input document is\n considered to be a single-page document.</p>"
|
||||
}
|
||||
},
|
||||
"Query": {
|
||||
"target": "com.amazonaws.textract#Query",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p></p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>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. <code>DetectDocumentText</code> returns the detected text in an array of <a>Block</a> objects. </p>\n <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object\n is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is\n a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>\n \n <p>\n <code>DetectDocumentText</code> is a synchronous operation. To analyze documents \n asynchronously, use <a>StartDocumentTextDetection</a>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html\">Document Text Detection</a>.</p>"
|
||||
"smithy.api#documentation": "<p>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. <code>DetectDocumentText</code> returns the detected text in an array of <a>Block</a> objects. </p>\n <p>Each document page has as an associated <code>Block</code> of type PAGE. Each PAGE <code>Block</code> object\n is the parent of LINE <code>Block</code> objects that represent the lines of detected text on a page. A LINE <code>Block</code> object is\n a parent for each word that makes up the line. Words are represented by <code>Block</code> objects of type WORD.</p>\n \n <p>\n <code>DetectDocumentText</code> is a synchronous operation. To analyze documents \n asynchronously, use <a>StartDocumentTextDetection</a>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/how-it-works-detecting.html\">Document Text Detection</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.textract#DetectDocumentTextRequest": {
|
||||
|
@ -836,6 +856,10 @@
|
|||
{
|
||||
"value": "FORMS",
|
||||
"name": "FORMS"
|
||||
},
|
||||
{
|
||||
"value": "QUERIES",
|
||||
"name": "QUERIES"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -913,7 +937,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.</p>\n <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier\n (<code>JobId</code>). 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 <code>StartDocumentAnalysis</code>. To get the results of the text-detection operation,\n first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.\n If so, call <code>GetDocumentAnalysis</code>, and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartDocumentAnalysis</code>.</p>\n <p>\n <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects. The following\n types of information are returned: </p>\n <ul>\n <li>\n <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY\n <code>Block</code> object and a VALUE <code>Block</code> object. For example,\n <i>Name: Ana Silva Carolina</i> contains a key and value.\n <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is\n the value.</p>\n </li>\n <li>\n <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL\n <code>Block</code> object is returned for each cell in a table.</p>\n </li>\n <li>\n <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.\n All lines and words that are detected in the document are returned (including text that doesn't have a\n relationship with the value of the <code>StartDocumentAnalysis</code> \n <code>FeatureTypes</code> input parameter). </p>\n </li>\n </ul>\n \n <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,\n including the selection status.</p>\n \n \n \n <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are\n returned. If there are more results than specified in <code>MaxResults</code>, the value of\n <code>NextToken</code> 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 <code>GetDocumentAnalysis</code>, and populate the <code>NextToken</code> request\n parameter with the token value that's returned from the previous call to\n <code>GetDocumentAnalysis</code>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html\">Document Text Analysis</a>.</p>"
|
||||
"smithy.api#documentation": "<p>Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.</p>\n <p>You start asynchronous text analysis by calling <a>StartDocumentAnalysis</a>, which returns a job identifier\n (<code>JobId</code>). 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 <code>StartDocumentAnalysis</code>. To get the results of the text-detection operation,\n first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.\n If so, call <code>GetDocumentAnalysis</code>, and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartDocumentAnalysis</code>.</p>\n <p>\n <code>GetDocumentAnalysis</code> returns an array of <a>Block</a> objects. The following\n types of information are returned: </p>\n <ul>\n <li>\n <p>Form data (key-value pairs). The related information is returned in two <a>Block</a> objects, each of type <code>KEY_VALUE_SET</code>: a KEY\n <code>Block</code> object and a VALUE <code>Block</code> object. For example,\n <i>Name: Ana Silva Carolina</i> contains a key and value.\n <i>Name:</i> is the key. <i>Ana Silva Carolina</i> is\n the value.</p>\n </li>\n <li>\n <p>Table and table cell data. A TABLE <code>Block</code> object contains information about a detected table. A CELL\n <code>Block</code> object is returned for each cell in a table.</p>\n </li>\n <li>\n <p>Lines and words of text. A LINE <code>Block</code> object contains one or more WORD <code>Block</code> objects.\n All lines and words that are detected in the document are returned (including text that doesn't have a\n relationship with the value of the <code>StartDocumentAnalysis</code> \n <code>FeatureTypes</code> input parameter). </p>\n </li>\n <li>\n <p>Queries. A QUERIES_RESULT Block object contains the answer to the query, the alias associated and an ID that \n connect it to the query asked. This Block also contains a location and attached confidence score</p>\n </li>\n </ul>\n \n <p>Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables.\n A SELECTION_ELEMENT <code>Block</code> object contains information about a selection element,\n including the selection status.</p>\n \n \n <p>Use the <code>MaxResults</code> parameter to limit the number of blocks that are\n returned. If there are more results than specified in <code>MaxResults</code>, the value of\n <code>NextToken</code> 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 <code>GetDocumentAnalysis</code>, and populate the <code>NextToken</code> request\n parameter with the token value that's returned from the previous call to\n <code>GetDocumentAnalysis</code>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/how-it-works-analyzing.html\">Document Text Analysis</a>.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p></p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p></p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.textract#Query": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Text": {
|
||||
"target": "com.amazonaws.textract#QueryInput",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Question that Amazon Textract will apply to the document. An example would be \"What is the customer's SSN?\"</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Alias": {
|
||||
"target": "com.amazonaws.textract#QueryInput",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Alias attached to the query, for ease of location.</p>"
|
||||
}
|
||||
},
|
||||
"Pages": {
|
||||
"target": "com.amazonaws.textract#QueryPages",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>List of pages associated with the query. The following is a list of rules for using this parameter.</p>\n <ul>\n <li>\n <p>If a page is not specified, it is set to <code>[\"1\"]</code> by default.</p>\n </li>\n <li>\n <p>The following characters are allowed in the parameter's string: \n <code>0 1 2 3 4 5 6 7 8 9 - *</code>. No whitespace is allowed.</p>\n </li>\n <li>\n <p>When using <code>*</code> to indicate all pages, it must be the only element\n in the string.</p>\n </li>\n <li>\n <p>You can use page intervals, such as <code>[“1-3”, “1-1”, “4-*”]</code>. Where <code>*</code> indicates last page of \n document.</p>\n </li>\n <li>\n <p>Specified pages must be greater than 0 and less than or equal to the number of pages in the document.</p>\n </li>\n </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Each query contains the question you want to ask in the Text and the alias you want to associate.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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.</p>"
|
||||
}
|
||||
},
|
||||
"QueriesConfig": {
|
||||
"target": "com.amazonaws.textract#QueriesConfig"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -2327,7 +2442,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#documentation": "<p>The format of the input document isn't supported. Documents for operations can be in\n PNG, JPEG, PDF, or TIFF format.</p>",
|
||||
"smithy.api#error": "client"
|
||||
}
|
||||
},
|
||||
|
|
|
@ -179,7 +179,7 @@
|
|||
"HomeDirectoryMappings": {
|
||||
"target": "com.amazonaws.transfer#HomeDirectoryMappings",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> 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 <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n <p>In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to <code>/</code> and set <code>Target</code> to the\n <code>HomeDirectory</code> parameter value.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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 <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> 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 <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n <p>In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to <code>/</code> and set <code>Target</code> to the\n <code>HomeDirectory</code> parameter value.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"Policy": {
|
||||
|
@ -422,7 +422,7 @@
|
|||
"HomeDirectoryMappings": {
|
||||
"target": "com.amazonaws.transfer#HomeDirectoryMappings",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> 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 <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n\n <p>In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to <code>/</code> and set <code>Target</code> to the HomeDirectory\n parameter value.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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 <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> 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 <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n\n <p>In most cases, you can use this value instead of the session policy to lock your user\n down to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to <code>/</code> and set <code>Target</code> to the HomeDirectory\n parameter value.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"Policy": {
|
||||
|
@ -535,7 +535,7 @@
|
|||
"Steps": {
|
||||
"target": "com.amazonaws.transfer#WorkflowSteps",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the details for the steps that are in the specified workflow.</p>\n <p>\n The <code>TYPE</code> specifies which of the following actions is being taken for this step.\n </p>\n <ul>\n <li>\n <p>\n <i>Copy</i>: copy the file to another location</p>\n </li>\n <li>\n <p>\n <i>Custom</i>: custom step with a lambda target</p>\n </li>\n <li>\n <p>\n <i>Delete</i>: delete the file</p>\n </li>\n <li>\n <p>\n <i>Tag</i>: add a tag to the file</p>\n </li>\n </ul>\n <note>\n <p>\n Currently, copying and tagging are supported only on S3.\n </p>\n </note>\n <p>\n For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.\n </p>",
|
||||
"smithy.api#documentation": "<p>Specifies the details for the steps that are in the specified workflow.</p>\n <p>\n The <code>TYPE</code> specifies which of the following actions is being taken for this step.\n </p>\n <ul>\n <li>\n <p>\n <i>COPY</i>: copy the file to another location</p>\n </li>\n <li>\n <p>\n <i>CUSTOM</i>: custom step with a lambda target</p>\n </li>\n <li>\n <p>\n <i>DELETE</i>: delete the file</p>\n </li>\n <li>\n <p>\n <i>TAG</i>: add a tag to the file</p>\n </li>\n </ul>\n <note>\n <p>\n Currently, copying and tagging are supported only on S3.\n </p>\n </note>\n <p>\n For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.\n </p>",
|
||||
"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": "<p>One of the available step types.</p>\n <ul>\n <li>\n <p>\n <i>Copy</i>: copy the file to another location</p>\n </li>\n <li>\n <p>\n <i>Custom</i>: custom step with a lambda target</p>\n </li>\n <li>\n <p>\n <i>Delete</i>: delete the file</p>\n </li>\n <li>\n <p>\n <i>Tag</i>: add a tag to the file</p>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>One of the available step types.</p>\n <ul>\n <li>\n <p>\n <i>COPY</i>: copy the file to another location</p>\n </li>\n <li>\n <p>\n <i>CUSTOM</i>: custom step with a lambda target</p>\n </li>\n <li>\n <p>\n <i>DELETE</i>: delete the file</p>\n </li>\n <li>\n <p>\n <i>TAG</i>: add a tag to the file</p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"Outputs": {
|
||||
|
@ -1995,7 +2010,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Represents an object that contains entries and targets for\n <code>HomeDirectoryMappings</code>.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>Represents an object that contains entries and targets for\n <code>HomeDirectoryMappings</code>.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>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 <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> 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 <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n <p>In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to <code>/</code> and set <code>Target</code> to the\n <code>HomeDirectory</code> parameter value.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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 <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> 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 <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n <p>In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to <code>/</code> and set <code>Target</code> to the\n <code>HomeDirectory</code> parameter value.</p>\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"Policy": {
|
||||
|
@ -4563,7 +4590,7 @@
|
|||
"HomeDirectoryMappings": {
|
||||
"target": "com.amazonaws.transfer#HomeDirectoryMappings",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> 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 <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\":\n \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n\n <p>In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory\n parameter value.</p>\n\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry:\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
"smithy.api#documentation": "<p>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 <code>Entry</code> and <code>Target</code> pair, where <code>Entry</code> shows how the path\n is made visible and <code>Target</code> 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 <code>Target</code>. This value\n can only be set when <code>HomeDirectoryType</code> is set to\n <i>LOGICAL</i>.</p>\n\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example.</p>\n <p>\n <code>[ { \"Entry\": \"/directory1\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>\n\n <p>In most cases, you can use this value instead of the session policy to lock down your\n user to the designated home directory (\"<code>chroot</code>\"). To do this, you can set\n <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory\n parameter value.</p>\n\n <p>The following is an <code>Entry</code> and <code>Target</code> pair example for <code>chroot</code>.</p>\n <p>\n <code>[ { \"Entry\": \"/\", \"Target\": \"/bucket_name/home/mydirectory\" } ]</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"Policy": {
|
||||
|
@ -4761,7 +4788,7 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.transfer#WorkflowStepType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n Currently, the following step types are supported.\n </p>\n <ul>\n <li>\n <p>\n <i>Copy</i>: copy the file to another location</p>\n </li>\n <li>\n <p>\n <i>Custom</i>: custom step with a lambda target</p>\n </li>\n <li>\n <p>\n <i>Delete</i>: delete the file</p>\n </li>\n <li>\n <p>\n <i>Tag</i>: add a tag to the file</p>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>\n Currently, the following step types are supported.\n </p>\n <ul>\n <li>\n <p>\n <i>COPY</i>: copy the file to another location</p>\n </li>\n <li>\n <p>\n <i>CUSTOM</i>: custom step with a lambda target</p>\n </li>\n <li>\n <p>\n <i>DELETE</i>: delete the file</p>\n </li>\n <li>\n <p>\n <i>TAG</i>: add a tag to the file</p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"CopyStepDetails": {
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
"objectFields": {
|
||||
"target": "com.amazonaws.wisdom#ObjectFieldsList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The fields from the source that are made available to your agents in Wisdom. </p>\n <ul>\n <li>\n <p> For <a href=\"https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm\"> Salesforce</a>, you must include at least <code>Id</code>,\n <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>,\n <code>PublishStatus</code>, and <code>IsDeleted</code>. </p>\n </li>\n <li>\n <p>For <a href=\"https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api\"> ServiceNow</a>, you must include at least <code>number</code>,\n <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>,\n and <code>active</code>. </p>\n </li>\n </ul>\n <p>Make sure to include additional field(s); these are indexed and used to source\n recommendations. </p>",
|
||||
"smithy.api#documentation": "<p>The fields from the source that are made available to your agents in Wisdom. </p>\n <ul>\n <li>\n <p> For <a href=\"https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm\"> Salesforce</a>, you must include at least <code>Id</code>,\n <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>,\n <code>PublishStatus</code>, and <code>IsDeleted</code>. </p>\n </li>\n <li>\n <p>For <a href=\"https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api\"> ServiceNow</a>, you must include at least <code>number</code>,\n <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>,\n and <code>active</code>. </p>\n </li>\n </ul>\n <p>Make sure to include additional fields. These fields are indexed and used to source\n recommendations. </p>",
|
||||
"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": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -194,7 +188,7 @@
|
|||
"knowledgeBaseId": {
|
||||
"target": "com.amazonaws.wisdom#Uuid",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The the identifier of the knowledge base.</p>"
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -243,7 +237,7 @@
|
|||
"assistantArn": {
|
||||
"target": "com.amazonaws.wisdom#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -296,7 +290,7 @@
|
|||
"assistantArn": {
|
||||
"target": "com.amazonaws.wisdom#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -394,7 +388,7 @@
|
|||
"assistantArn": {
|
||||
"target": "com.amazonaws.wisdom#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -615,8 +606,7 @@
|
|||
"target": "com.amazonaws.wisdom#Url",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The URL of the content.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base.</p>"
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base.</p>"
|
||||
}
|
||||
},
|
||||
"contentArn": {
|
||||
|
@ -743,7 +739,7 @@
|
|||
"knowledgeBaseId": {
|
||||
"target": "com.amazonaws.wisdom#Uuid",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The the identifier of the knowledge base.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base.</p>",
|
||||
"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": "<p>Creates an Amazon Connect Wisdom assistant.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/assistants",
|
||||
"code": 200
|
||||
"method": "POST"
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
|
@ -889,9 +884,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/assistants/{assistantId}/associations",
|
||||
"code": 200
|
||||
"method": "POST"
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
|
@ -1030,9 +1024,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates Wisdom content. Before to calling this API, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html\">StartContentUpload</a> to\n upload an asset.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -1131,9 +1124,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a knowledge base.</p>\n <note>\n <p>When using this API, you cannot reuse <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html\">Amazon AppIntegrations</a>\n DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do,\n you'll get an <code>InvalidRequestException</code> error. </p>\n\n <p>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:</p>\n <ol>\n <li>\n <p>Call <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html\">DeleteKnowledgeBase</a>.</p>\n </li>\n <li>\n <p>Call <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html\">DeleteDataIntegration</a>.</p>\n </li>\n <li>\n <p>Call <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html\">CreateDataIntegration</a> to recreate the DataIntegration or a create different\n one.</p>\n </li>\n <li>\n <p>Call CreateKnowledgeBase.</p>\n </li>\n </ol>\n </note>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/knowledgeBases",
|
||||
"code": 200
|
||||
"method": "POST"
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
|
@ -1227,9 +1219,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/assistants/{assistantId}/sessions",
|
||||
"code": 200
|
||||
"method": "POST"
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
|
@ -1306,8 +1297,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes an assistant.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "DELETE",
|
||||
"uri": "/assistants/{assistantId}",
|
||||
"method": "DELETE",
|
||||
"code": 204
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
|
@ -1335,8 +1326,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes an assistant association.</p>",
|
||||
"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": "<p>Deletes the content.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -1455,13 +1446,16 @@
|
|||
},
|
||||
{
|
||||
"target": "com.amazonaws.wisdom#ResourceNotFoundException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.wisdom#ValidationException"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes the knowledge base.</p>\n <note>\n <p>When you use this API to delete an external knowledge base such as Salesforce or\n ServiceNow, you must also delete the <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html\">Amazon AppIntegrations</a> 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 <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html\">DeleteDataIntegration</a> and <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html\">CreateDataIntegration</a> in the <i>Amazon AppIntegrations API\n Reference</i>.</p>\n </note>",
|
||||
"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": "<p>Text in the document.</p>",
|
||||
"smithy.api#sensitive": {}
|
||||
"smithy.api#documentation": "<p>Text in the document.</p>"
|
||||
}
|
||||
},
|
||||
"highlights": {
|
||||
|
@ -1631,9 +1624,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves information about an assistant.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/assistants/{assistantId}",
|
||||
"code": 200
|
||||
"method": "GET"
|
||||
},
|
||||
"smithy.api#readonly": {}
|
||||
}
|
||||
|
@ -1660,9 +1652,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves information about an assistant association.</p>",
|
||||
"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": "<p>Retrieves content, including a pre-signed URL to download the content.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -1806,9 +1796,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves summary information about the content.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -1867,9 +1856,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves information about the knowledge base.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -1920,9 +1908,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves recommendations for the specified session. To avoid retrieving the same\n recommendations in subsequent calls, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html\">NotifyRecommendationsReceived</a>. This API supports long-polling behavior with the\n <code>waitTimeSeconds</code> parameter. Short poll is the default behavior and only returns\n recommendations already available. To perform a manual query against an assistant, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html\">QueryAssistant</a>.</p>",
|
||||
"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": "<p>The recommendations.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"triggers": {
|
||||
"target": "com.amazonaws.wisdom#RecommendationTriggerList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The triggers corresponding to recommendations.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -1996,9 +1989,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves information for a specified session.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base.</p>"
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base.</p>"
|
||||
}
|
||||
},
|
||||
"knowledgeBaseArn": {
|
||||
|
@ -2148,7 +2137,7 @@
|
|||
"knowledgeBaseId": {
|
||||
"target": "com.amazonaws.wisdom#Uuid",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The the identifier of the knowledge base.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -2270,7 +2259,7 @@
|
|||
"knowledgeBaseId": {
|
||||
"target": "com.amazonaws.wisdom#Uuid",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The the identifier of the knowledge base.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
@ -2305,7 +2294,7 @@
|
|||
"sourceConfiguration": {
|
||||
"target": "com.amazonaws.wisdom#SourceConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>[KEVIN]</p>"
|
||||
"smithy.api#documentation": "<p>Configuration information about the external data source.</p>"
|
||||
}
|
||||
},
|
||||
"renderingConfiguration": {
|
||||
|
@ -2379,15 +2368,14 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists information about assistant associations.</p>",
|
||||
"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": "<p>Lists information about assistants.</p>",
|
||||
"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": "<p>Lists the content.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -2605,15 +2591,14 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the knowledge bases.</p>",
|
||||
"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": "<p>Lists the tags for the specified resource.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/tags/{resourceArn}",
|
||||
"code": 200
|
||||
"method": "GET"
|
||||
},
|
||||
"smithy.api#readonly": {}
|
||||
}
|
||||
|
@ -2762,9 +2746,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Removes the specified recommendations from the specified assistant's queue of newly\n available recommendations. You can use this API in conjunction with <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html\">GetRecommendations</a> and a <code>waitTimeSeconds</code> input for long-polling\n behavior and avoiding duplicate recommendations.</p>",
|
||||
"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": "<p>Performs a manual search against the specified assistant. To retrieve recommendations for\n an assistant, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html\">GetRecommendations</a>.\n </p>",
|
||||
"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": "<p>The text associated with the recommendation trigger.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Data associated with the QUERY RecommendationTriggerType.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.wisdom#QueryResultsList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
@ -2993,6 +2992,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The relevance level of the recommendation.</p>"
|
||||
}
|
||||
},
|
||||
"type": {
|
||||
"target": "com.amazonaws.wisdom#RecommendationType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of recommendation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": "<p>The identifier of the recommendation trigger.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"type": {
|
||||
"target": "com.amazonaws.wisdom#RecommendationTriggerType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of recommendation trigger.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"source": {
|
||||
"target": "com.amazonaws.wisdom#RecommendationSourceType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The source of the recommendation trigger.</p>\n <ul>\n <li>\n <p>ISSUE_DETECTION: The corresponding recommendations were triggered\n by a Contact Lens issue.</p>\n </li>\n <li>\n <p>RULE_EVALUATION: The corresponding recommendations were triggered\n by a Contact Lens rule.</p>\n </li>\n </ul>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"data": {
|
||||
"target": "com.amazonaws.wisdom#RecommendationTriggerData",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A union type containing information related to the trigger.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"recommendationIds": {
|
||||
"target": "com.amazonaws.wisdom#RecommendationIdList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifiers of the recommendations.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A recommendation trigger provides context on the event that produced the referenced recommendations.\n Recommendations are only referenced in <code>recommendationIds</code> by a single RecommendationTrigger.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.wisdom#RecommendationTriggerData": {
|
||||
"type": "union",
|
||||
"members": {
|
||||
"query": {
|
||||
"target": "com.amazonaws.wisdom#QueryRecommendationTriggerData",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Data associated with the QUERY RecommendationTriggerType.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A union type containing information related to the trigger.</p>"
|
||||
}
|
||||
},
|
||||
"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": "<p>Removes a URI template from a knowledge base.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -3166,15 +3275,14 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Searches for content in a specified knowledge base. Can be used to get a specific content\n resource by its name.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -3268,15 +3376,14 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Searches for sessions.</p>",
|
||||
"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": "<p>The KMS key. For information about valid ID values, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id\">Key identifiers (KeyId)</a> in the\n <i>AWS Key Management Service Developer Guide</i>. </p>"
|
||||
"smithy.api#documentation": "<p>The KMS key. For information about valid ID values, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id\">Key identifiers (KeyId)</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -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": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
@ -3505,9 +3615,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html\">CreateContent</a> to finalize the content creation process or <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html\">UpdateContent</a> to modify an existing resource. You can only upload content to a\n knowledge base of type CUSTOM.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -3545,8 +3654,7 @@
|
|||
"target": "com.amazonaws.wisdom#Url",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The URL of the upload.</p>",
|
||||
"smithy.api#required": {},
|
||||
"smithy.api#sensitive": {}
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"urlExpiry": {
|
||||
|
@ -3607,9 +3715,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Adds the specified tags to the specified resource.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/tags/{resourceArn}",
|
||||
"code": 200
|
||||
"method": "POST"
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
|
@ -3691,9 +3798,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Removes the specified tags from the specified resource.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "DELETE",
|
||||
"uri": "/tags/{resourceArn}",
|
||||
"code": 200
|
||||
"method": "DELETE"
|
||||
},
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
|
@ -3748,9 +3854,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates information about the content.</p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
@ -3844,9 +3949,8 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates the template URI of a knowledge base. This is only supported for knowledge bases\n of type EXTERNAL. Include a single variable in <code>${variable}</code> format; this\n interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce\n article, it has an <code>Id</code> value, and you can set the template URI to\n <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view</code>.\n </p>",
|
||||
"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": "<p>The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>",
|
||||
"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": "<p>The input fails to satisfy the constraints specified by an AWS service.</p>",
|
||||
"smithy.api#documentation": "<p>The input fails to satisfy the constraints specified by a service.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"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": "<p>All Amazon Connect Wisdom functionality is accessible using the API. For example, you can create an\n assistant and a knowledge base.</p>\n\n <p>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. </p>",
|
||||
"smithy.api#title": "Amazon Connect Wisdom Service"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -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": "<p>Specifies a domain to be associated to Amazon WorkLink.</p>",
|
||||
"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": "<p>Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.</p>",
|
||||
"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": "<p>Imports the root certificate of a certificate authority (CA) used to obtain TLS\n certificates used by associated websites within the company network.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"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": "<p>Deletes a fleet. Prevents users from accessing previously associated websites. </p>",
|
||||
"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": "<p>Describes the configuration for delivering audit streams to the customer account.</p>",
|
||||
"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": "<p>Describes the networking configuration to access the internal websites associated with\n the specified fleet.</p>",
|
||||
"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": "<p>Provides information about a user's device.</p>",
|
||||
"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": "<p>Describes the device policy configuration for the specified fleet.</p>",
|
||||
"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": "<p>Provides information about the domain.</p>",
|
||||
"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": "<p>Provides basic information for the specified fleet, excluding identity provider,\n networking, and device configuration details.</p>",
|
||||
"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": "<p>Describes the identity provider configuration of the specified fleet.</p>",
|
||||
"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": "<p>Provides information about the certificate authority.</p>",
|
||||
"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": "<p>Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink. </p>",
|
||||
"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": "<p>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.</p>",
|
||||
"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": "<p>Removes a certificate authority (CA).</p>",
|
||||
"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": "<p>Retrieves a list of devices registered with the specified fleet.</p>",
|
||||
"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": "<p>Retrieves a list of domains associated to a specified fleet.</p>",
|
||||
"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": "<p>Retrieves a list of fleets for the current account and Region.</p>",
|
||||
"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": "<p>Retrieves a list of tags for the specified resource.</p>",
|
||||
"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": "<p>Retrieves a list of website authorization providers associated with a specified fleet.</p>",
|
||||
"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": "<p>Retrieves a list of certificate authorities added for the current account and\n Region.</p>",
|
||||
"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": "<p>Moves a domain to ACTIVE status if it was in the INACTIVE status.</p>",
|
||||
"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": "<p>Moves a domain to INACTIVE status if it was in the ACTIVE status.</p>",
|
||||
"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": "<p>Signs the user out from all of their devices. The user can sign in again if they have\n valid credentials.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"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": "<p>Removes one or more tags from the specified resource.</p>",
|
||||
"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": "<p>Updates the audit stream configuration for the fleet.</p>",
|
||||
"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": "<p>Updates the company network configuration for the fleet.</p>",
|
||||
"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": "<p>Updates the device policy configuration for the fleet.</p>",
|
||||
"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": "<p>Updates domain metadata, such as DisplayName.</p>",
|
||||
"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": "<p>Updates fleet metadata, such as DisplayName.</p>",
|
||||
"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": "<p>Updates the identity provider configuration for the fleet.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"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": "<p>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.</p>",
|
||||
"smithy.api#title": "Amazon WorkLink"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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"
|
||||
|
|
|
@ -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"
|
||||
|
|
|
@ -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(())
|
||||
}
|
||||
|
||||
|
|
|
@ -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<String>,
|
||||
#[clap(long)]
|
||||
sdk_version: String,
|
||||
sdk_version: Option<String>,
|
||||
#[clap(long)]
|
||||
date: String,
|
||||
date: Option<String>,
|
||||
},
|
||||
}
|
||||
|
||||
|
@ -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<ChangelogMeta> {
|
||||
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<Path>) -> Result<impl Iterator<Item = PathBuf>> {
|
||||
Ok(fs::read_dir(path.as_ref())
|
||||
.with_context(|| format!("failed to ls: {:?}", path.as_ref()))?
|
||||
|
|
Loading…
Reference in New Issue