mirror of https://github.com/smithy-lang/smithy-rs
John DiSanti
GitHub
parent
38f84dc5e9
commit
4bccda460f
|
|
@ -16,6 +16,8 @@ vNext (Month Day, Year)
|
|||
- :bug: Fix STS Assume Role with WebIdentity & Assume role with SAML to support clients with no credentials provided (#652)
|
||||
- Add support for WebIdentityToken providers via profile & environment variables. (#654)
|
||||
- (internal): Update sigv4 tests to work around behavior change in httparse 1.5. (#656)
|
||||
- Update AWS SDK models (#657)
|
||||
- :tada: Add Chime Identity, Chime Messaging, and Snow Device Management support (#657)
|
||||
|
||||
v0.20 (August 10th, 2021)
|
||||
--------------------------
|
||||
|
|
|
|||
|
|
@ -1628,6 +1628,12 @@
|
|||
},
|
||||
"mutualTlsAuthentication": {
|
||||
"target": "com.amazonaws.apigateway#MutualTlsAuthenticationInput"
|
||||
},
|
||||
"ownershipVerificationCertificateArn": {
|
||||
"target": "com.amazonaws.apigateway#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -3766,7 +3772,7 @@
|
|||
"domainNameStatus": {
|
||||
"target": "com.amazonaws.apigateway#DomainNameStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The status of the <a>DomainName</a> migration. The valid values are <code>AVAILABLE</code> and <code>UPDATING</code>. If the status is <code>UPDATING</code>, the domain cannot be modified further until the existing operation is complete. If it is <code>AVAILABLE</code>, the domain can be updated.</p>"
|
||||
"smithy.api#documentation": "<p>The status of the <a>DomainName</a> migration. The valid values are <code>AVAILABLE</code>, <code>UPDATING</code>, <code>PENDING_CERTIFICATE_REIMPORT</code>, and <code>PENDING_OWNERSHIP_VERIFICATION</code>. If the status is <code>UPDATING</code>, the domain cannot be modified further until the existing operation is complete. If it is <code>AVAILABLE</code>, the domain can be updated.</p>"
|
||||
}
|
||||
},
|
||||
"domainNameStatusMessage": {
|
||||
|
|
@ -3792,6 +3798,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.</p>"
|
||||
}
|
||||
},
|
||||
"ownershipVerificationCertificateArn": {
|
||||
"target": "com.amazonaws.apigateway#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -3813,6 +3825,14 @@
|
|||
{
|
||||
"value": "PENDING",
|
||||
"name": "PENDING"
|
||||
},
|
||||
{
|
||||
"value": "PENDING_CERTIFICATE_REIMPORT",
|
||||
"name": "PENDING_CERTIFICATE_REIMPORT"
|
||||
},
|
||||
{
|
||||
"value": "PENDING_OWNERSHIP_VERIFICATION",
|
||||
"name": "PENDING_OWNERSHIP_VERIFICATION"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -7875,7 +7895,7 @@
|
|||
"truststoreVersion": {
|
||||
"target": "com.amazonaws.apigateway#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The version of the S3 object that contains your truststore. To\n specify a version, you must have versioning enabled for the S3 bucket.</p>"
|
||||
"smithy.api#documentation": "<p>The version of the S3 object that contains your truststore. To\n specify a version, you must have versioning enabled for the S3 bucket.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -9176,7 +9196,7 @@
|
|||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The status code.</p>",
|
||||
"smithy.api#pattern": "[1-5]\\d\\d"
|
||||
"smithy.api#pattern": "^[1-5]\\d\\d$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.apigateway#String": {
|
||||
|
|
|
|||
|
|
@ -3631,7 +3631,7 @@
|
|||
"DomainNameStatus": {
|
||||
"target": "com.amazonaws.apigatewayv2#DomainNameStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>",
|
||||
"smithy.api#documentation": "<p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>",
|
||||
"smithy.api#jsonName": "domainNameStatus"
|
||||
}
|
||||
},
|
||||
|
|
@ -3662,6 +3662,13 @@
|
|||
"smithy.api#documentation": "<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>",
|
||||
"smithy.api#jsonName": "securityPolicy"
|
||||
}
|
||||
},
|
||||
"OwnershipVerificationCertificateArn": {
|
||||
"target": "com.amazonaws.apigatewayv2#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>",
|
||||
"smithy.api#jsonName": "ownershipVerificationCertificateArn"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -3680,7 +3687,7 @@
|
|||
"com.amazonaws.apigatewayv2#DomainNameStatus": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>",
|
||||
"smithy.api#documentation": "<p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>",
|
||||
"smithy.api#enum": [
|
||||
{
|
||||
"value": "AVAILABLE",
|
||||
|
|
@ -3689,6 +3696,14 @@
|
|||
{
|
||||
"value": "UPDATING",
|
||||
"name": "UPDATING"
|
||||
},
|
||||
{
|
||||
"value": "PENDING_CERTIFICATE_REIMPORT",
|
||||
"name": "PENDING_CERTIFICATE_REIMPORT"
|
||||
},
|
||||
{
|
||||
"value": "PENDING_OWNERSHIP_VERIFICATION",
|
||||
"name": "PENDING_OWNERSHIP_VERIFICATION"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -148,7 +148,7 @@
|
|||
"name": "athena"
|
||||
},
|
||||
"aws.protocols#awsJson1_1": {},
|
||||
"smithy.api#documentation": "<p>Amazon Athena is an interactive query service that lets you use standard SQL to\n analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and\n run ad-hoc queries and get results in seconds. Athena is serverless, so there is no\n infrastructure to set up or manage. You pay only for the queries you run. Athena scales\n automatically—executing queries in parallel—so results are fast, even with large\n datasets and complex queries. For more information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon\n Athena</a> in the <i>Amazon Athena User Guide</i>.</p>\n <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or\n later with the Amazon Athena API. Earlier version drivers do not support the API. For\n more information and to download the driver, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html\">Accessing\n Amazon Athena with JDBC</a>.</p>\n <p>For code samples using the AWS SDK for Java, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Amazon Athena is an interactive query service that lets you use standard SQL\n to analyze data directly in Amazon S3. You can point Athena at your\n data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay\n only for the queries you run. Athena scales automatically—executing queries\n in parallel—so results are fast, even with large datasets and complex queries. For more\n information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon Athena</a> in the <i>Amazon Athena User\n Guide</i>.</p>\n <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the\n driver or later with the Amazon Athena API. Earlier version drivers do not\n support the API. For more information and to download the driver, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html\">Accessing\n Amazon Athena with JDBC</a>.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
|
||||
"smithy.api#title": "Amazon Athena"
|
||||
}
|
||||
},
|
||||
|
|
@ -284,7 +284,7 @@
|
|||
"min": 1,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#Column": {
|
||||
|
|
@ -422,7 +422,7 @@
|
|||
"min": 0,
|
||||
"max": 255
|
||||
},
|
||||
"smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#CreateDataCatalog": {
|
||||
|
|
@ -442,7 +442,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same AWS account.</p>"
|
||||
"smithy.api#documentation": "<p>Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same Amazon Web Services account.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#CreateDataCatalogInput": {
|
||||
|
|
@ -451,14 +451,14 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.athena#CatalogNameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the data catalog to create. The catalog name must be unique for the AWS\n account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen\n characters.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the data catalog to create. The catalog name must be unique for the\n Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at\n sign, or hyphen characters.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.athena#DataCatalogType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog or\n <code>HIVE</code> for an external hive metastore.</p>\n <note>\n <p>Do not use the <code>GLUE</code> type. This refers to the\n <code>AwsDataCatalog</code> that already exists in your account, of which you\n can have only one. Specifying the <code>GLUE</code> type will result in an\n <code>INVALID_INPUT</code> error.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,\n <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an\n Glue Data Catalog.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -471,7 +471,7 @@
|
|||
"Parameters": {
|
||||
"target": "com.amazonaws.athena#ParametersMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the Lambda function or functions to use for creating the data catalog. This\n is a mapping whose values depend on the catalog type. </p>\n <ul>\n <li>\n <p>For the <code>HIVE</code> data catalog type, use the following syntax. The\n <code>metadata-function</code> parameter is required. <code>The\n sdk-version</code> parameter is optional and defaults to the currently\n supported version.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n sdk-version=<i>version_number</i>\n </code>\n </p>\n </li>\n <li>\n <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets\n of required parameters, but not both.</p>\n <ul>\n <li>\n <p>If you have one Lambda function that processes metadata and another\n for reading the actual data, use the following syntax. Both parameters\n are required.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n record-function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n <li>\n <p> If you have a composite Lambda function that processes both metadata\n and data, use the following syntax to specify your Lambda\n function.</p>\n <p>\n <code>function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type. </p>\n <ul>\n <li>\n <p>For the <code>HIVE</code> data catalog type, use the following syntax. The\n <code>metadata-function</code> parameter is required. <code>The\n sdk-version</code> parameter is optional and defaults to the currently\n supported version.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n sdk-version=<i>version_number</i>\n </code>\n </p>\n </li>\n <li>\n <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets\n of required parameters, but not both.</p>\n <ul>\n <li>\n <p>If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n record-function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n <li>\n <p> If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.</p>\n <p>\n <code>function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The\n <code>\n <i>catalog_id</i>\n </code> is the account ID of the\n Amazon Web Services account to which the Glue Data Catalog\n belongs.</p>\n <p>\n <code>catalog-id=<i>catalog_id</i>\n </code>\n </p>\n <ul>\n <li>\n <p>The <code>GLUE</code> data catalog type also applies to the default\n <code>AwsDataCatalog</code> that already exists in your account, of\n which you can have only one and cannot modify.</p>\n </li>\n <li>\n <p>Queries that specify a Glue Data Catalog other than the default\n <code>AwsDataCatalog</code> must be run on Athena engine\n version 2.</p>\n </li>\n <li>\n <p>In Regions where Athena engine version 2 is not available,\n creating new Glue data catalogs results in an\n <code>INVALID_INPUT</code> error.</p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
|
|
@ -503,7 +503,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.</p>\n <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -540,7 +540,7 @@
|
|||
"ClientRequestToken": {
|
||||
"target": "com.amazonaws.athena#IdempotencyToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another <code>CreateNamedQuery</code> request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the <code>QueryString</code>, an error is returned.</p>\n <important>\n <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for\n Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS\n CLI, you must provide this token or the action will fail.</p>\n </important>",
|
||||
"smithy.api#documentation": "<p>A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another <code>CreateNamedQuery</code> request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the <code>QueryString</code>, an error is returned.</p>\n <important>\n <p>This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.</p>\n </important>",
|
||||
"smithy.api#idempotencyToken": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -652,7 +652,7 @@
|
|||
"Configuration": {
|
||||
"target": "com.amazonaws.athena#WorkGroupConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The configuration for the workgroup, which includes the location in Amazon S3 where\n query results are stored, the encryption configuration, if any, used for encrypting\n query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the\n limit for the amount of bytes scanned (cutoff) per query, if it is specified, and\n whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the\n WorkGroupConfiguration override client-side settings. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The configuration for the workgroup, which includes the location in Amazon S3\n where query results are stored, the encryption configuration, if any, used for\n encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the\n workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is\n specified, and whether workgroup's settings (specified with\n <code>EnforceWorkGroupConfiguration</code>) in the\n <code>WorkGroupConfiguration</code> override client-side settings. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
|
|
@ -679,7 +679,7 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.athena#CatalogNameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the data catalog. The catalog name must be unique for the AWS account and\n can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at sign,\n or hyphen characters.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -692,19 +692,19 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.athena#DataCatalogType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of data catalog: <code>LAMBDA</code> for a federated catalog or\n <code>HIVE</code> for an external hive metastore. <code>GLUE</code> refers to the\n <code>AwsDataCatalog</code> that already exists in your account, of which you can\n have only one.</p>",
|
||||
"smithy.api#documentation": "<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog,\n <code>HIVE</code> for an external hive metastore, or <code>GLUE</code> for an\n Glue Data Catalog.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Parameters": {
|
||||
"target": "com.amazonaws.athena#ParametersMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the Lambda function or functions to use for the data catalog. This is a\n mapping whose values depend on the catalog type. </p>\n <ul>\n <li>\n <p>For the <code>HIVE</code> data catalog type, use the following syntax. The\n <code>metadata-function</code> parameter is required. <code>The\n sdk-version</code> parameter is optional and defaults to the currently\n supported version.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n sdk-version=<i>version_number</i>\n </code>\n </p>\n </li>\n <li>\n <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets\n of required parameters, but not both.</p>\n <ul>\n <li>\n <p>If you have one Lambda function that processes metadata and another\n for reading the actual data, use the following syntax. Both parameters\n are required.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n record-function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n <li>\n <p> If you have a composite Lambda function that processes both metadata\n and data, use the following syntax to specify your Lambda\n function.</p>\n <p>\n <code>function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type. </p>\n <ul>\n <li>\n <p>For the <code>HIVE</code> data catalog type, use the following syntax. The\n <code>metadata-function</code> parameter is required. <code>The\n sdk-version</code> parameter is optional and defaults to the currently\n supported version.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n sdk-version=<i>version_number</i>\n </code>\n </p>\n </li>\n <li>\n <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets\n of required parameters, but not both.</p>\n <ul>\n <li>\n <p>If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n record-function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n <li>\n <p> If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.</p>\n <p>\n <code>function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n </ul>\n </li>\n <li>\n <p>The <code>GLUE</code> type takes a catalog ID parameter and is required. The\n <code>\n <i>catalog_id</i>\n </code> is the account ID of the\n Amazon Web Services account to which the Glue catalog\n belongs.</p>\n <p>\n <code>catalog-id=<i>catalog_id</i>\n </code>\n </p>\n <ul>\n <li>\n <p>The <code>GLUE</code> data catalog type also applies to the default\n <code>AwsDataCatalog</code> that already exists in your account, of\n which you can have only one and cannot modify.</p>\n </li>\n <li>\n <p>Queries that specify a Glue Data Catalog other than the default\n <code>AwsDataCatalog</code> must be run on Athena engine\n version 2.</p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Contains information about a data catalog in an AWS account.</p>"
|
||||
"smithy.api#documentation": "<p>Contains information about a data catalog in an Amazon Web Services account.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#DataCatalogSummary": {
|
||||
|
|
@ -864,7 +864,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes the named query if you have access to the workgroup in which the query was\n saved.</p>\n <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Deletes the named query if you have access to the workgroup in which the query was\n saved.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -989,7 +989,7 @@
|
|||
"EncryptionOption": {
|
||||
"target": "com.amazonaws.athena#EncryptionOption",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys\n (<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 (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#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -1001,7 +1001,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for\n example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key 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": {
|
||||
|
|
@ -1029,13 +1029,13 @@
|
|||
"SelectedEngineVersion": {
|
||||
"target": "com.amazonaws.athena#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The engine version requested by the user. Possible values are determined by the output of <code>ListEngineVersions</code>, including Auto. The default is Auto.</p>"
|
||||
"smithy.api#documentation": "<p>The engine version requested by the user. Possible values are determined by the output\n of <code>ListEngineVersions</code>, including Auto. The default is Auto.</p>"
|
||||
}
|
||||
},
|
||||
"EffectiveEngineVersion": {
|
||||
"target": "com.amazonaws.athena#NameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Read only. The engine version on which the query runs. If the user requests\n a valid engine version other than Auto, the effective engine version is the same as the\n engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a <code>CreateWorkGroup</code> or <code>UpdateWorkGroup</code> operation, the \n <code>EffectiveEngineVersion</code> field is ignored.</p>"
|
||||
"smithy.api#documentation": "<p>Read only. The engine version on which the query runs. If the user requests a valid\n engine version other than Auto, the effective engine version is the same as the engine\n version that the user requested. If the user requests Auto, the effective engine version\n is chosen by Athena. When a request to update the engine version is made by\n a <code>CreateWorkGroup</code> or <code>UpdateWorkGroup</code> operation, the\n <code>EffectiveEngineVersion</code> field is ignored.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1329,7 +1329,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Streams the results of a single query execution specified by\n <code>QueryExecutionId</code> from the Athena query results location in Amazon S3.\n For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> in the <i>Amazon\n Athena User Guide</i>. This request does not execute the query but returns\n results. Use <a>StartQueryExecution</a> to run a query.</p>\n <p>To stream query results successfully, the IAM principal with permission to call\n <code>GetQueryResults</code> also must have permissions to the Amazon S3\n <code>GetObject</code> action for the Athena query results location.</p>\n <important>\n <p>IAM principals with permission to the Amazon S3 <code>GetObject</code> action for\n the query results location are able to retrieve query results from Amazon S3 even if\n permission to the <code>GetQueryResults</code> action is denied. To restrict user or\n role access, ensure that Amazon S3 permissions to the Athena query location are\n denied.</p>\n </important>",
|
||||
"smithy.api#documentation": "<p>Streams the results of a single query execution specified by\n <code>QueryExecutionId</code> from the Athena query results location in\n Amazon S3. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> in the <i>Amazon Athena User Guide</i>. This request does not execute the query\n but returns results. Use <a>StartQueryExecution</a> to run a query.</p>\n <p>To stream query results successfully, the IAM principal with permission to call\n <code>GetQueryResults</code> also must have permissions to the Amazon S3\n <code>GetObject</code> action for the Athena query results location.</p>\n <important>\n <p>IAM principals with permission to the Amazon S3\n <code>GetObject</code> action for the query results location are able to retrieve\n query results from Amazon S3 even if permission to the\n <code>GetQueryResults</code> action is denied. To restrict user or role access,\n ensure that Amazon S3 permissions to the Athena query location\n are denied.</p>\n </important>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -1350,7 +1350,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -1367,7 +1367,7 @@
|
|||
"UpdateCount": {
|
||||
"target": "com.amazonaws.athena#Long",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The number of rows inserted with a CREATE TABLE AS SELECT statement. </p>"
|
||||
"smithy.api#documentation": "<p>The number of rows inserted with a <code>CREATE TABLE AS SELECT</code> statement.\n </p>"
|
||||
}
|
||||
},
|
||||
"ResultSet": {
|
||||
|
|
@ -1379,7 +1379,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1533,7 +1533,7 @@
|
|||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#ListDataCatalogs": {
|
||||
|
|
@ -1553,7 +1553,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the data catalogs in the current AWS account.</p>",
|
||||
"smithy.api#documentation": "<p>Lists the data catalogs in the current Amazon Web Services account.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -1568,7 +1568,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the NextToken from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -1591,7 +1591,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the NextToken from the response object of the previous page call.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1638,7 +1638,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -1661,7 +1661,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the NextToken from the response object of the previous page call.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1692,7 +1692,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -1715,7 +1715,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1737,7 +1737,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides a list of available query IDs only for queries saved in the specified\n workgroup. Requires that you have access to the specified workgroup. If a workgroup is\n not specified, lists the saved queries for the primary workgroup.</p>\n <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Provides a list of available query IDs only for queries saved in the specified\n workgroup. Requires that you have access to the specified workgroup. If a workgroup is\n not specified, lists the saved queries for the primary workgroup.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -1751,7 +1751,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -1780,7 +1780,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1823,7 +1823,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -1846,7 +1846,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1868,7 +1868,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides a list of available query execution IDs for the queries in the specified\n workgroup. If a workgroup is not specified, returns a list of query execution IDs for\n the primary workgroup. Requires you to have access to the workgroup in which the queries\n ran.</p>\n <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Provides a list of available query execution IDs for the queries in the specified\n workgroup. If a workgroup is not specified, returns a list of query execution IDs for\n the primary workgroup. Requires you to have access to the workgroup in which the queries\n ran.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -1882,7 +1882,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -1971,7 +1971,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the NextToken from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -1994,7 +1994,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the NextToken\n from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the NextToken from the response object of the previous page call.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -2019,7 +2019,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the tags associated with an Athena workgroup or data catalog resource.</p>",
|
||||
"smithy.api#documentation": "<p>Lists the tags associated with an Athena workgroup or data catalog\n resource.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -2100,7 +2100,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -2123,7 +2123,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.athena#Token",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue pagination if\n a previous request was truncated. To obtain the next set of pages, pass in the\n <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
"smithy.api#documentation": "<p>A token generated by the Athena service that specifies where to continue\n pagination if a previous request was truncated. To obtain the next set of pages, pass in\n the <code>NextToken</code> from the response object of the previous page call.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -2241,7 +2241,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An exception that Athena received when it called a custom metastore. Occurs if the\n error is not caused by user input (<code>InvalidRequestException</code>) or from the\n Athena platform (<code>InternalServerException</code>). For example, if a user-created\n Lambda function is missing permissions, the Lambda <code>4XX</code> exception is\n returned in a <code>MetadataException</code>.</p>",
|
||||
"smithy.api#documentation": "<p>An exception that Athena received when it called a custom metastore.\n Occurs if the error is not caused by user input (<code>InvalidRequestException</code>)\n or from the Athena platform (<code>InternalServerException</code>). For\n example, if a user-created Lambda function is missing permissions, the\n Lambda\n <code>4XX</code> exception is returned in a <code>MetadataException</code>.</p>",
|
||||
"smithy.api#error": "client"
|
||||
}
|
||||
},
|
||||
|
|
@ -2428,13 +2428,13 @@
|
|||
"StatementType": {
|
||||
"target": "com.amazonaws.athena#StatementType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of query statement that was run. <code>DDL</code> indicates DDL query\n statements. <code>DML</code> indicates DML (Data Manipulation Language) query\n statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates\n query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or\n <code>DESCRIBE <table></code>.</p>"
|
||||
"smithy.api#documentation": "<p>The type of query statement that was run. <code>DDL</code> indicates DDL query\n statements. <code>DML</code> indicates DML (Data Manipulation Language) query\n statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates\n query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or\n <code>DESCRIBE TABLE</code>.</p>"
|
||||
}
|
||||
},
|
||||
"ResultConfiguration": {
|
||||
"target": "com.amazonaws.athena#ResultConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The location in Amazon S3 where query results were stored and the encryption option,\n if any, used for query results. These are known as \"client-side settings\". If workgroup\n settings override client-side settings, then the query uses the location for the query\n results and the encryption configuration that are specified for the workgroup.</p>"
|
||||
"smithy.api#documentation": "<p>The location in Amazon S3 where query results were stored and the encryption\n option, if any, used for query results. These are known as \"client-side settings\". If\n workgroup settings override client-side settings, then the query uses the location for\n the query results and the encryption configuration that are specified for the\n workgroup.</p>"
|
||||
}
|
||||
},
|
||||
"QueryExecutionContext": {
|
||||
|
|
@ -2478,7 +2478,7 @@
|
|||
"Database": {
|
||||
"target": "com.amazonaws.athena#DatabaseString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the database used in the query execution.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the database used in the query execution. The database must exist in the catalog.</p>"
|
||||
}
|
||||
},
|
||||
"Catalog": {
|
||||
|
|
@ -2558,7 +2558,7 @@
|
|||
"DataManifestLocation": {
|
||||
"target": "com.amazonaws.athena#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The location and file name of a data manifest file. The manifest file is saved to the\n Athena query results location in Amazon S3. The manifest file tracks files that the\n query wrote to Amazon S3. If the query fails, the manifest file also tracks files that\n the query intended to write. The manifest is useful for identifying orphaned files\n resulting from a failed query. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Working with Query Results, Output Files, and\n Query History</a> in the <i>Amazon Athena User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The location and file name of a data manifest file. The manifest file is saved to the\n Athena query results location in Amazon S3. The manifest file\n tracks files that the query wrote to Amazon S3. If the query fails, the manifest\n file also tracks files that the query intended to write. The manifest is useful for\n identifying orphaned files resulting from a failed query. For more information, see\n <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Working with Query\n Results, Output Files, and Query History</a> in the <i>Amazon Athena User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"TotalExecutionTimeInMillis": {
|
||||
|
|
@ -2570,19 +2570,19 @@
|
|||
"QueryQueueTimeInMillis": {
|
||||
"target": "com.amazonaws.athena#Long",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The number of milliseconds that the query was in your query queue waiting for\n resources. Note that if transient errors occur, Athena might automatically add the query\n back to the queue.</p>"
|
||||
"smithy.api#documentation": "<p>The number of milliseconds that the query was in your query queue waiting for\n resources. Note that if transient errors occur, Athena might automatically\n add the query back to the queue.</p>"
|
||||
}
|
||||
},
|
||||
"QueryPlanningTimeInMillis": {
|
||||
"target": "com.amazonaws.athena#Long",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The number of milliseconds that Athena took to plan the query processing flow. This\n includes the time spent retrieving table partitions from the data source. Note that\n because the query engine performs the query planning, query planning time is a subset of\n engine processing time.</p>"
|
||||
"smithy.api#documentation": "<p>The number of milliseconds that Athena took to plan the query processing\n flow. This includes the time spent retrieving table partitions from the data source.\n Note that because the query engine performs the query planning, query planning time is a\n subset of engine processing time.</p>"
|
||||
}
|
||||
},
|
||||
"ServiceProcessingTimeInMillis": {
|
||||
"target": "com.amazonaws.athena#Long",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The number of milliseconds that Athena took to finalize and publish the query results\n after the query engine finished running the query.</p>"
|
||||
"smithy.api#documentation": "<p>The number of milliseconds that Athena took to finalize and publish the\n query results after the query engine finished running the query.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2596,7 +2596,7 @@
|
|||
"State": {
|
||||
"target": "com.amazonaws.athena#QueryExecutionState",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The state of query execution. <code>QUEUED</code> indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as resources are\n available. <code>RUNNING</code> indicates that the query is in execution phase.\n <code>SUCCEEDED</code> indicates that the query completed without errors.\n <code>FAILED</code> indicates that the query experienced an error and did not\n complete processing. <code>CANCELLED</code> indicates that a user input interrupted\n query execution.</p>\n <note>\n <p>Athena automatically retries your queries in cases of certain transient errors. As\n a result, you may see the query state transition from <code>RUNNING</code> or\n <code>FAILED</code> to <code>QUEUED</code>. </p>\n </note>"
|
||||
"smithy.api#documentation": "<p>The state of query execution. <code>QUEUED</code> indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as\n resources are available. <code>RUNNING</code> indicates that the query is in execution\n phase. <code>SUCCEEDED</code> indicates that the query completed without errors.\n <code>FAILED</code> indicates that the query experienced an error and did not\n complete processing. <code>CANCELLED</code> indicates that a user input interrupted\n query execution.</p>\n <note>\n <p>Athena automatically retries your queries in cases of certain\n transient errors. As a result, you may see the query state transition from\n <code>RUNNING</code> or <code>FAILED</code> to <code>QUEUED</code>. </p>\n </note>"
|
||||
}
|
||||
},
|
||||
"StateChangeReason": {
|
||||
|
|
@ -2652,18 +2652,18 @@
|
|||
"OutputLocation": {
|
||||
"target": "com.amazonaws.athena#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The location in Amazon S3 where your query results are stored, such as\n <code>s3://path/to/query/bucket/</code>. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using <a>WorkGroupConfiguration</a>. If none of them is set, Athena issues an error\n that no output location is provided. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a>. If\n workgroup settings override client-side settings, then the query uses the settings\n specified for the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The location in Amazon S3 where your query results are stored, such as\n <code>s3://path/to/query/bucket/</code>. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using <a>WorkGroupConfiguration</a>. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a>. If\n workgroup settings override client-side settings, then the query uses the settings\n specified for the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"target": "com.amazonaws.athena#EncryptionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for\n example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information. This is a\n client-side setting. If workgroup settings override client-side settings, then the query\n uses the encryption configuration that is specified for the workgroup, and also uses the\n 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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The location in Amazon S3 where query results are stored and the encryption option, if\n any, used for query results. These are known as \"client-side settings\". If workgroup\n settings override client-side settings, then the query uses the workgroup\n settings.</p>"
|
||||
"smithy.api#documentation": "<p>The location in Amazon S3 where query results are stored and the encryption\n option, if any, used for query results. These are known as \"client-side settings\". If\n workgroup settings override client-side settings, then the query uses the workgroup\n settings.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#ResultConfigurationUpdates": {
|
||||
|
|
@ -2672,13 +2672,13 @@
|
|||
"OutputLocation": {
|
||||
"target": "com.amazonaws.athena#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The location in Amazon S3 where your query results are stored, such as\n <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> If\n workgroup settings override client-side settings, then the query uses the location for\n the query results and the encryption configuration that are specified for the workgroup.\n The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration\n (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The location in Amazon S3 where your query results are stored, such as\n <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> If\n workgroup settings override client-side settings, then the query uses the location for\n the query results and the encryption configuration that are specified for the workgroup.\n The \"workgroup settings override\" is specified in\n <code>EnforceWorkGroupConfiguration</code> (true/false) in the\n <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
}
|
||||
},
|
||||
"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 OutputLocation in\n ResultConfigurationUpdates (the client-side setting), the OutputLocation in the\n workgroup's ResultConfiguration 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": {
|
||||
|
|
@ -2690,7 +2690,7 @@
|
|||
"RemoveEncryptionConfiguration": {
|
||||
"target": "com.amazonaws.athena#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If set to \"true\", indicates that the previously-specified encryption configuration\n (also known as the client-side setting) for queries in this workgroup should be ignored\n and set to null. If set to \"false\" or not set, and a value is present in the\n EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the\n EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the\n 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\", indicates that the previously-specified encryption configuration\n (also known as the client-side setting) for queries in this workgroup should be ignored\n and set to null. If set to \"false\" or not set, and a value is present in the\n <code>EncryptionConfiguration</code> in <code>ResultConfigurationUpdates</code> (the\n client-side setting), the <code>EncryptionConfiguration</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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2772,7 +2772,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to\n have access to the workgroup in which the query ran. Running queries against an external\n catalog requires <a>GetDataCatalog</a> permission to the catalog. For code\n samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to\n have access to the workgroup in which the query ran. Running queries against an external\n catalog requires <a>GetDataCatalog</a> permission to the catalog. For code\n samples using the Amazon Web Services SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -2789,7 +2789,7 @@
|
|||
"ClientRequestToken": {
|
||||
"target": "com.amazonaws.athena#IdempotencyToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another <code>StartQueryExecution</code> request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the <code>QueryString</code>, an error is returned.</p>\n <important>\n <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for\n Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS\n CLI, you must provide this token or the action will fail.</p>\n </important>",
|
||||
"smithy.api#documentation": "<p>A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another <code>StartQueryExecution</code> request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the <code>QueryString</code>, an error is returned.</p>\n <important>\n <p>This token is listed as not required because Amazon Web Services SDKs (for example\n the Amazon Web Services SDK for Java) auto-generate the token for users. If you are\n not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide\n this token or the action will fail.</p>\n </important>",
|
||||
"smithy.api#idempotencyToken": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -2831,7 +2831,7 @@
|
|||
"min": 1,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z_][a-zA-Z0-9_@:]{1,256}"
|
||||
"smithy.api#pattern": "^[a-zA-Z_][a-zA-Z0-9_@:]{1,256}$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#StatementType": {
|
||||
|
|
@ -2870,7 +2870,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Stops a query execution. Requires you to have access to the workgroup in which the\n query ran.</p>\n <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Stops a query execution. Requires you to have access to the workgroup in which the\n query ran.</p>\n <p>For code samples using the Amazon Web Services SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and\n Code Samples</a> in the <i>Amazon Athena User\n Guide</i>.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -2919,7 +2919,7 @@
|
|||
"TableType": {
|
||||
"target": "com.amazonaws.athena#TableTypeString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of table. In Athena, only <code>EXTERNAL_TABLE</code> is supported.</p>"
|
||||
"smithy.api#documentation": "<p>The type of table. In Athena, only <code>EXTERNAL_TABLE</code> is\n supported.</p>"
|
||||
}
|
||||
},
|
||||
"Columns": {
|
||||
|
|
@ -2977,7 +2977,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A label that you assign to a resource. In Athena, a resource can be a workgroup or\n data catalog. Each tag consists of a key and an optional value, both of which you\n define. For example, you can use tags to categorize Athena workgroups or data catalogs\n by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to\n search and filter workgroups or data catalogs in your account. For best practices, see\n <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode\n characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use\n letters and numbers representable in UTF-8, and the following characters: + - = . _ : /\n @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you\n specify more than one tag, separate them by commas. </p>"
|
||||
"smithy.api#documentation": "<p>A label that you assign to a resource. In Athena, a resource can be a\n workgroup or data catalog. Each tag consists of a key and an optional value, both of\n which you define. For example, you can use tags to categorize Athena\n workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of\n tag keys to make it easier to search and filter workgroups or data catalogs in your\n account. For best practices, see <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode\n characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use\n letters and numbers representable in UTF-8, and the following characters: + - = . _ : /\n @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you\n specify more than one tag, separate them by commas. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#TagKey": {
|
||||
|
|
@ -3021,7 +3021,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Adds one or more tags to an Athena resource. A tag is a label that you assign to a\n resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of\n a key and an optional value, both of which you define. For example, you can use tags to\n categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a\n consistent set of tag keys to make it easier to search and filter workgroups or data\n catalogs in your account. For best practices, see <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode\n characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use\n letters and numbers representable in UTF-8, and the following characters: + - = . _ : /\n @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you\n specify more than one tag, separate them by commas.</p>"
|
||||
"smithy.api#documentation": "<p>Adds one or more tags to an Athena resource. A tag is a label that you\n assign to a resource. In Athena, a resource can be a workgroup or data\n catalog. Each tag consists of a key and an optional value, both of which you define. For\n example, you can use tags to categorize Athena workgroups or data catalogs\n by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to\n search and filter workgroups or data catalogs in your account. For best practices, see\n <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">Tagging Best Practices</a>. Tag keys can be from 1 to 128 UTF-8 Unicode\n characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use\n letters and numbers representable in UTF-8, and the following characters: + - = . _ : /\n @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you\n specify more than one tag, separate them by commas.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#TagResourceInput": {
|
||||
|
|
@ -3030,14 +3030,14 @@
|
|||
"ResourceARN": {
|
||||
"target": "com.amazonaws.athena#AmazonResourceName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are\n to be added.</p>",
|
||||
"smithy.api#documentation": "<p>Specifies the ARN of the Athena resource (workgroup or data catalog) to\n which tags are to be added.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.athena#TagList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A collection of one or more tags, separated by commas, to be added to an Athena\n workgroup or data catalog resource.</p>",
|
||||
"smithy.api#documentation": "<p>A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -3102,7 +3102,7 @@
|
|||
"min": 0,
|
||||
"max": 4096
|
||||
},
|
||||
"smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#UnprocessedNamedQueryId": {
|
||||
|
|
@ -3241,14 +3241,14 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.athena#CatalogNameString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the data catalog to update. The catalog name must be unique for the AWS\n account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen\n characters.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the data catalog to update. The catalog name must be unique for the\n Amazon Web Services account and can use a maximum of 128 alphanumeric, underscore, at\n sign, or hyphen characters.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.athena#DataCatalogType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the type of data catalog to update. Specify <code>LAMBDA</code> for a\n federated catalog or <code>HIVE</code> for an external hive metastore.</p>\n <note>\n <p>Do not use the <code>GLUE</code> type. This refers to the\n <code>AwsDataCatalog</code> that already exists in your account, of which you\n can have only one. Specifying the <code>GLUE</code> type will result in an\n <code>INVALID_INPUT</code> error.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Specifies the type of data catalog to update. Specify <code>LAMBDA</code> for a\n federated catalog, <code>HIVE</code> for an external hive metastore, or\n <code>GLUE</code> for an Glue Data Catalog.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -3261,7 +3261,7 @@
|
|||
"Parameters": {
|
||||
"target": "com.amazonaws.athena#ParametersMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the Lambda function or functions to use for updating the data catalog. This\n is a mapping whose values depend on the catalog type. </p>\n <ul>\n <li>\n <p>For the <code>HIVE</code> data catalog type, use the following syntax. The\n <code>metadata-function</code> parameter is required. <code>The\n sdk-version</code> parameter is optional and defaults to the currently\n supported version.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n sdk-version=<i>version_number</i>\n </code>\n </p>\n </li>\n <li>\n <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets\n of required parameters, but not both.</p>\n <ul>\n <li>\n <p>If you have one Lambda function that processes metadata and another\n for reading the actual data, use the following syntax. Both parameters\n are required.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n record-function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n <li>\n <p> If you have a composite Lambda function that processes both metadata\n and data, use the following syntax to specify your Lambda\n function.</p>\n <p>\n <code>function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>Specifies the Lambda function or functions to use for updating the data\n catalog. This is a mapping whose values depend on the catalog type. </p>\n <ul>\n <li>\n <p>For the <code>HIVE</code> data catalog type, use the following syntax. The\n <code>metadata-function</code> parameter is required. <code>The\n sdk-version</code> parameter is optional and defaults to the currently\n supported version.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n sdk-version=<i>version_number</i>\n </code>\n </p>\n </li>\n <li>\n <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets\n of required parameters, but not both.</p>\n <ul>\n <li>\n <p>If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.</p>\n <p>\n <code>metadata-function=<i>lambda_arn</i>,\n record-function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n <li>\n <p> If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.</p>\n <p>\n <code>function=<i>lambda_arn</i>\n </code>\n </p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -3402,7 +3402,7 @@
|
|||
"Configuration": {
|
||||
"target": "com.amazonaws.athena#WorkGroupConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The configuration of the workgroup, which includes the location in Amazon S3 where\n query results are stored, the encryption configuration, if any, used for query results;\n whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup\n settings override client-side settings; and the data usage limits for the amount of data\n scanned per query or per workgroup. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The configuration of the workgroup, which includes the location in Amazon S3\n where query results are stored, the encryption configuration, if any, used for query\n results; whether the Amazon CloudWatch Metrics are enabled for the workgroup;\n whether workgroup settings override client-side settings; and the data usage limits for\n the amount of data scanned per query or per workgroup. The workgroup settings override\n is specified in <code>EnforceWorkGroupConfiguration</code> (true/false) in the\n <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
|
|
@ -3419,7 +3419,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A workgroup, which contains a name, description, creation time, state, and other\n configuration, listed under <a>WorkGroup$Configuration</a>. Each workgroup\n enables you to isolate queries for you or your group of users from other queries in the\n same account, to configure the query results location and the encryption configuration\n (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and\n to establish per-query data usage control limits for all queries in a workgroup. The\n workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false)\n in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
"smithy.api#documentation": "<p>A workgroup, which contains a name, description, creation time, state, and other\n configuration, listed under <a>WorkGroup$Configuration</a>. Each workgroup\n enables you to isolate queries for you or your group of users from other queries in the\n same account, to configure the query results location and the encryption configuration\n (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch,\n and to establish per-query data usage control limits for all queries in a workgroup. The\n workgroup settings override is specified in <code>EnforceWorkGroupConfiguration</code>\n (true/false) in the <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#WorkGroupConfiguration": {
|
||||
|
|
@ -3428,7 +3428,7 @@
|
|||
"ResultConfiguration": {
|
||||
"target": "com.amazonaws.athena#ResultConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The configuration for the workgroup, which includes the location in Amazon S3 where\n query results are stored and the encryption option, if any, used for query results. To\n run the query, you must specify the query results location using one of the ways: either\n in the workgroup using this setting, or for individual queries (client-side), using\n <a>ResultConfiguration$OutputLocation</a>. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query\n Results</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The configuration for the workgroup, which includes the location in Amazon S3\n where query results are stored and the encryption option, if any, used for query\n results. To run the query, you must specify the query results location using one of the\n ways: either in the workgroup using this setting, or for individual queries\n (client-side), using <a>ResultConfiguration$OutputLocation</a>. If none of\n them is set, Athena issues an error that no output location is provided. For\n more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a>.</p>"
|
||||
}
|
||||
},
|
||||
"EnforceWorkGroupConfiguration": {
|
||||
|
|
@ -3452,18 +3452,18 @@
|
|||
"RequesterPaysEnabled": {
|
||||
"target": "com.amazonaws.athena#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If set to <code>true</code>, allows members assigned to a workgroup to reference\n Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup\n members cannot query data from Requester Pays buckets, and queries that retrieve data\n from Requester Pays buckets cause an error. The default is <code>false</code>. For more\n information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a>\n in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>If set to <code>true</code>, allows members assigned to a workgroup to reference\n Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>,\n workgroup members cannot query data from Requester Pays buckets, and queries that\n retrieve data from Requester Pays buckets cause an error. The default is\n <code>false</code>. For more information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester\n Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer\n Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"EngineVersion": {
|
||||
"target": "com.amazonaws.athena#EngineVersion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The engine version that all queries running on\n the workgroup use. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>"
|
||||
"smithy.api#documentation": "<p>The engine version that all queries running on the workgroup use. Queries on the\n <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine\n regardless of this setting.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The configuration of the workgroup, which includes the location in Amazon S3 where\n query results are stored, the encryption option, if any, used for query results, whether\n the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup\n settings override query settings, and the data usage limits for the amount of data\n scanned per query or per workgroup. The workgroup settings override is specified in\n EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>. </p>"
|
||||
"smithy.api#documentation": "<p>The configuration of the workgroup, which includes the location in Amazon S3\n where query results are stored, the encryption option, if any, used for query results,\n whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether\n workgroup settings override query settings, and the data usage limits for the amount of\n data scanned per query or per workgroup. The workgroup settings override is specified in\n <code>EnforceWorkGroupConfiguration</code> (true/false) in the\n <code>WorkGroupConfiguration</code>. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#WorkGroupConfigurationUpdates": {
|
||||
|
|
@ -3484,7 +3484,7 @@
|
|||
"PublishCloudWatchMetricsEnabled": {
|
||||
"target": "com.amazonaws.athena#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether this workgroup enables publishing metrics to Amazon\n CloudWatch.</p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>"
|
||||
}
|
||||
},
|
||||
"BytesScannedCutoffPerQuery": {
|
||||
|
|
@ -3502,18 +3502,18 @@
|
|||
"RequesterPaysEnabled": {
|
||||
"target": "com.amazonaws.athena#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If set to <code>true</code>, allows members assigned to a workgroup to specify Amazon\n S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup members\n cannot query data from Requester Pays buckets, and queries that retrieve data from\n Requester Pays buckets cause an error. The default is <code>false</code>. For more\n information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a>\n in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>If set to <code>true</code>, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup\n members cannot query data from Requester Pays buckets, and queries that retrieve data\n from Requester Pays buckets cause an error. The default is <code>false</code>. For more\n information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a>\n in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"EngineVersion": {
|
||||
"target": "com.amazonaws.athena#EngineVersion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>"
|
||||
"smithy.api#documentation": "<p>The engine version requested when a workgroup is updated. After the update, all\n queries on the workgroup run on the requested engine version. If no value was previously\n set, the default is Auto. Queries on the <code>AmazonAthenaPreviewFunctionality</code>\n workgroup run on the preview engine regardless of this setting.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The configuration information that will be updated for this workgroup, which includes\n the location in Amazon S3 where query results are stored, the encryption option, if any,\n used for query results, whether the Amazon CloudWatch Metrics are enabled for the\n workgroup, whether the workgroup settings override the client-side settings, and the\n data usage limit for the amount of bytes scanned per query, if it is specified.</p>"
|
||||
"smithy.api#documentation": "<p>The configuration information that will be updated for this workgroup, which includes\n the location in Amazon S3 where query results are stored, the encryption option,\n if any, used for query results, whether the Amazon CloudWatch Metrics are enabled\n for the workgroup, whether the workgroup settings override the client-side settings, and\n the data usage limit for the amount of bytes scanned per query, if it is\n specified.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#WorkGroupDescriptionString": {
|
||||
|
|
@ -3528,7 +3528,7 @@
|
|||
"com.amazonaws.athena#WorkGroupName": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "[a-zA-Z0-9._-]{1,128}"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9._-]{1,128}$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.athena#WorkGroupState": {
|
||||
|
|
@ -3576,7 +3576,7 @@
|
|||
"EngineVersion": {
|
||||
"target": "com.amazonaws.athena#EngineVersion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The engine version setting for all queries on the workgroup. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>"
|
||||
"smithy.api#documentation": "<p>The engine version setting for all queries on the workgroup. Queries on the\n <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine\n regardless of this setting.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -2970,6 +2970,20 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#DesiredConfiguration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"LaunchTemplate": {
|
||||
"target": "com.amazonaws.autoscaling#LaunchTemplateSpecification"
|
||||
},
|
||||
"MixedInstancesPolicy": {
|
||||
"target": "com.amazonaws.autoscaling#MixedInstancesPolicy"
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the desired configuration for an instance refresh. </p>\n <p>If you specify a desired configuration, you must specify either a\n <code>LaunchTemplate</code> or a <code>MixedInstancesPolicy</code>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#DetachInstances": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
@ -3806,6 +3820,15 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Additional progress details for an Auto Scaling group that has a warm pool.</p>"
|
||||
}
|
||||
},
|
||||
"Preferences": {
|
||||
"target": "com.amazonaws.autoscaling#RefreshPreferences"
|
||||
},
|
||||
"DesiredConfiguration": {
|
||||
"target": "com.amazonaws.autoscaling#DesiredConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the specific update you want to deploy.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -3979,7 +4002,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes an instances distribution for an Auto Scaling group with a <a>MixedInstancesPolicy</a>.</p>\n <p>The instances distribution specifies the distribution of On-Demand Instances and Spot\n Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates\n instance types to fulfill On-Demand and Spot capacities.</p>\n <p>When you update <code>SpotAllocationStrategy</code>, <code>SpotInstancePools</code>,\n or <code>SpotMaxPrice</code>, this update action does not deploy any changes across the\n running Amazon EC2 instances in the group. Your existing Spot Instances continue to run\n as long as the maximum price for those instances is higher than the current Spot price.\n When scale out occurs, Amazon EC2 Auto Scaling launches instances based on the new settings. When scale\n in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination\n policies.</p>"
|
||||
"smithy.api#documentation": "<p>Describes an instances distribution for an Auto Scaling group with a <a>MixedInstancesPolicy</a>.</p>\n <p>The instances distribution specifies the distribution of On-Demand Instances and Spot\n Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates\n instance types to fulfill On-Demand and Spot capacities.</p>\n <p>When you modify <code>SpotAllocationStrategy</code>, <code>SpotInstancePools</code>,\n or <code>SpotMaxPrice</code> in the <a>UpdateAutoScalingGroup</a> API call,\n this update action does not deploy any changes across the running Amazon EC2 instances\n in the group. Your existing Spot Instances continue to run as long as the maximum price\n for those instances is higher than the current Spot price. When scale out occurs,\n Amazon EC2 Auto Scaling launches instances based on the new settings. When scale in occurs, Amazon EC2 Auto Scaling\n terminates instances according to the group's termination policies.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#InstancesToUpdate": {
|
||||
|
|
@ -4235,7 +4258,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes a launch template and overrides. </p>\n <p>You specify these properties as part of a mixed instances policy. </p>\n <p>When you update the launch template or overrides, existing Amazon EC2 instances continue to\n run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When\n scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination\n policies.</p>"
|
||||
"smithy.api#documentation": "<p>Describes a launch template and overrides. </p>\n <p>You specify these properties as part of a mixed instances policy. </p>\n <p>When you update the launch template or overrides in the <a>UpdateAutoScalingGroup</a> API call, existing Amazon EC2 instances continue to\n run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When\n scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination\n policies.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#LaunchTemplateName": {
|
||||
|
|
@ -4297,7 +4320,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the Amazon EC2 launch template and the launch template version that can be used\n by an Auto Scaling group to configure Amazon EC2 instances.</p>\n <p>The launch template that is specified must be configured for use with an Auto Scaling group.\n For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html\">Creating a launch\n template for an Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html\">Launch\n templates</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#LifecycleActionResult": {
|
||||
|
|
@ -4867,7 +4890,7 @@
|
|||
"LaunchTemplate": {
|
||||
"target": "com.amazonaws.autoscaling#LaunchTemplate",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the launch template to use and optionally the instance types (overrides)\n that are used to provision EC2 instances to fulfill On-Demand and Spot capacities.\n Required when creating a mixed instances policy.</p>"
|
||||
"smithy.api#documentation": "<p>Specifies the launch template to use and the instance types (overrides) that are used\n to provision EC2 instances to fulfill On-Demand and Spot capacities. Required when\n creating a mixed instances policy.</p>"
|
||||
}
|
||||
},
|
||||
"InstancesDistribution": {
|
||||
|
|
@ -4878,7 +4901,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling\n group can provision a combination of On-Demand Instances and Spot Instances across\n multiple instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple\n instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User\n Guide</i>.</p>\n <p>You can create a mixed instances policy for a new Auto Scaling group, or you can create it for\n an existing group by updating the group to specify <code>MixedInstancesPolicy</code> as\n the top-level property instead of a launch configuration or launch template.</p>"
|
||||
"smithy.api#documentation": "<p>Describes a mixed instances policy. A mixed instances policy contains the instance\n types Amazon EC2 Auto Scaling can launch, and other information Amazon EC2 Auto Scaling can use to launch instances to\n help you optimize your costs. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple\n instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User\n Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#MonitoringEnabled": {
|
||||
|
|
@ -5822,7 +5845,7 @@
|
|||
"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, as a percentage of the desired capacity of\n the Auto Scaling group (rounded up to the nearest integer). The default is <code>90</code>.\n </p>"
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"InstanceWarmup": {
|
||||
|
|
@ -5842,10 +5865,16 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The amount of time, in seconds, to wait after a checkpoint before continuing. This\n property is optional, but if you specify a value for it, you must also specify a value\n for <code>CheckpointPercentages</code>. If you specify a value for\n <code>CheckpointPercentages</code> and not for <code>CheckpointDelay</code>, the\n <code>CheckpointDelay</code> defaults to <code>3600</code> (1 hour). </p>"
|
||||
}
|
||||
},
|
||||
"SkipMatching": {
|
||||
"target": "com.amazonaws.autoscaling#SkipMatching",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A boolean value that indicates whether skip matching is enabled. If true, then\n Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired\n configuration is specified, then it skips replacing instances that have the same\n configuration that is already set on the group. The default is\n <code>false</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes information used to start an instance refresh. </p>\n <p>All properties are optional. However, if you specify a value for\n <code>CheckpointDelay</code>, you must also provide a value for\n <code>CheckpointPercentages</code>. </p>"
|
||||
"smithy.api#documentation": "<p>Describes the preferences for an instance refresh.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#RefreshStrategy": {
|
||||
|
|
@ -6467,6 +6496,12 @@
|
|||
"smithy.api#box": {}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#SkipMatching": {
|
||||
"type": "boolean",
|
||||
"traits": {
|
||||
"smithy.api#box": {}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#SpotInstancePools": {
|
||||
"type": "integer",
|
||||
"traits": {
|
||||
|
|
@ -6502,7 +6537,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Starts a new instance refresh operation, which triggers a rolling replacement of\n previously launched instances in the Auto Scaling group with a new group of instances.</p>\n <p>This operation is part of the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">instance refresh\n feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.</p>\n <p>If the call succeeds, it creates a new instance refresh request with a unique ID that\n you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that\n have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an\n instance refresh operation in progress, use the <a>CancelInstanceRefresh</a>\n API. </p>"
|
||||
"smithy.api#documentation": "<p>Starts a new instance refresh operation. An instance refresh performs a rolling\n replacement of all or some instances in an Auto Scaling group. Each instance is terminated first\n and then replaced, which temporarily reduces the capacity available within your Auto Scaling\n group.</p>\n <p>This operation is part of the <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">instance refresh\n feature</a> in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group. </p>\n <p>If the call succeeds, it creates a new instance refresh request with a unique ID that\n you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that\n have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an\n instance refresh operation in progress, use the <a>CancelInstanceRefresh</a>\n API. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.autoscaling#StartInstanceRefreshAnswer": {
|
||||
|
|
@ -6529,13 +6564,19 @@
|
|||
"Strategy": {
|
||||
"target": "com.amazonaws.autoscaling#RefreshStrategy",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The strategy to use for the instance refresh. The only valid value is\n <code>Rolling</code>.</p>\n <p>A rolling update is an update that is applied to all instances in an Auto Scaling group until\n all instances have been updated. A rolling update can fail due to failed health checks\n or if instances are on standby or are protected from scale in. If the rolling update\n process fails, any instances that were already replaced are not rolled back to their\n previous configuration. </p>"
|
||||
"smithy.api#documentation": "<p>The strategy to use for the instance refresh. The only valid value is\n <code>Rolling</code>.</p>\n <p>A rolling update helps you update your instances gradually. A rolling update can fail\n due to failed health checks or if instances are on standby or are protected from scale\n in. If the rolling update process fails, any instances that are replaced are not rolled\n back to their previous configuration. </p>"
|
||||
}
|
||||
},
|
||||
"DesiredConfiguration": {
|
||||
"target": "com.amazonaws.autoscaling#DesiredConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The desired configuration. For example, the desired configuration can specify a new\n launch template or a new version of the current launch template.</p>\n <p>Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to\n reflect the new desired configuration. </p>\n <note>\n <p>When you specify a new launch template or a new version of the current launch\n template for your desired configuration, consider enabling the\n <code>SkipMatching</code> property in preferences. If it's enabled, Amazon EC2 Auto Scaling\n skips replacing instances that already use the specified launch template and\n version. This can help you reduce the number of replacements that are required to\n apply updates. </p>\n </note>"
|
||||
}
|
||||
},
|
||||
"Preferences": {
|
||||
"target": "com.amazonaws.autoscaling#RefreshPreferences",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Set of preferences associated with the instance refresh request.</p>\n <p>If not provided, the default values are used. For <code>MinHealthyPercentage</code>,\n the default value is <code>90</code>. For <code>InstanceWarmup</code>, the default is to\n use the value specified for the health check grace period for the Auto Scaling group.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_RefreshPreferences.html\">RefreshPreferences</a> in the <i>Amazon EC2 Auto Scaling API\n Reference</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Set of preferences associated with the instance refresh request. If not provided, the\n default values are used.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -871,7 +871,10 @@
|
|||
"type": "structure",
|
||||
"members": {
|
||||
"InvitedBy": {
|
||||
"target": "com.amazonaws.chime#Identity"
|
||||
"target": "com.amazonaws.chime#Identity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the member who invited another member.</p>"
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.chime#ChannelMembershipType",
|
||||
|
|
@ -893,7 +896,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The membership information, including member ARNs, the channel ARN, and membership types.</p>"
|
||||
"smithy.api#documentation": "<p>The membership information, including member ARNs, the channel ARN, and membership\n types.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.chime#BatchCreateAttendee": {
|
||||
|
|
@ -1011,7 +1014,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Adds a specified number of users to a channel. </p>",
|
||||
"smithy.api#documentation": "<p>Adds a specified number of users to a channel.</p>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -1068,7 +1071,7 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.chime#ChannelMembershipType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of \n <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals \n <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.</p>"
|
||||
"smithy.api#documentation": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default\n members are always returned as part of <code>ListChannelMemberships</code>. Hidden members\n are only returned if the type filter in <code>ListChannelMemberships</code> equals\n <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported\n by moderators.</p>"
|
||||
}
|
||||
},
|
||||
"MemberArns": {
|
||||
|
|
@ -1099,7 +1102,7 @@
|
|||
"Errors": {
|
||||
"target": "com.amazonaws.chime#BatchCreateChannelMembershipErrors",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.</p>"
|
||||
"smithy.api#documentation": "<p>If the action fails for one or more of the memberships in the request, a list of the\n memberships is returned, along with error codes and error messages.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1846,10 +1849,7 @@
|
|||
"target": "com.amazonaws.chime#ChannelSummary"
|
||||
},
|
||||
"AppInstanceUserMembershipSummary": {
|
||||
"target": "com.amazonaws.chime#AppInstanceUserMembershipSummary",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns the channel membership data for an <code>AppInstance</code>.</p>"
|
||||
}
|
||||
"target": "com.amazonaws.chime#AppInstanceUserMembershipSummary"
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -2088,7 +2088,10 @@
|
|||
"type": "structure",
|
||||
"members": {
|
||||
"ChannelSummary": {
|
||||
"target": "com.amazonaws.chime#ChannelSummary"
|
||||
"target": "com.amazonaws.chime#ChannelSummary",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Summary of the details of a <code>Channel</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -2264,7 +2267,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The request could not be processed because of conflict in the current state of the\n resource.</p>",
|
||||
"smithy.api#documentation": "<p>The request could not be processed because of conflict in the current state of the\n resource.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 409
|
||||
}
|
||||
|
|
@ -2907,7 +2910,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a channel to which you can add users and send messages.</p>\n\n <p>\n <b>Restriction</b>: You can't change a channel's privacy.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Creates a channel to which you can add users and send messages.</p>\n\n <p>\n <b>Restriction</b>: You can't change a channel's\n privacy.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -2953,7 +2956,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Permanently bans a member from a channel. Moderators can't add banned members to a channel.\n To undo a ban, you first have to <code>DeleteChannelBan</code>, and then\n <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or\n channels.</p>\n <p>If you ban a user who is already part of a channel, that user is automatically kicked from the channel.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Permanently bans a member from a channel. Moderators can't add banned members to a\n channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then\n <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or\n channels.</p>\n <p>If you ban a user who is already part of a channel, that user is automatically kicked\n from the channel.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -3003,7 +3006,7 @@
|
|||
"Member": {
|
||||
"target": "com.amazonaws.chime#Identity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The <code>ChannelArn</code> and <code>BannedIdentity</code> of the member in the ban response.</p>"
|
||||
"smithy.api#documentation": "<p>The <code>ChannelArn</code> and <code>BannedIdentity</code> of the member in the ban\n response.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -3043,7 +3046,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Adds a user to a channel. The <code>InvitedBy</code> response field is derived from the\n request header. A channel member can:</p>\n\n <ul>\n <li>\n <p>List messages</p>\n </li>\n <li>\n <p>Send messages</p>\n </li>\n <li>\n <p>Receive messages</p>\n </li>\n <li>\n <p>Edit their own messages</p>\n </li>\n <li>\n <p>Leave the channel</p>\n </li>\n </ul>\n\n <p>Privacy settings impact this action as follows:</p>\n\n <ul>\n <li>\n <p>Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.</p>\n </li>\n <li>\n <p>Private Channels: You must be a member to list or send messages.</p>\n </li>\n </ul>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Adds a user to a channel. The <code>InvitedBy</code> response field is derived from the\n request header. A channel member can:</p>\n\n <ul>\n <li>\n <p>List messages</p>\n </li>\n <li>\n <p>Send messages</p>\n </li>\n <li>\n <p>Receive messages</p>\n </li>\n <li>\n <p>Edit their own messages</p>\n </li>\n <li>\n <p>Leave the channel</p>\n </li>\n </ul>\n\n <p>Privacy settings impact this action as follows:</p>\n\n <ul>\n <li>\n <p>Public Channels: You do not need to be a member to list messages, but you must be\n a member to send messages.</p>\n </li>\n <li>\n <p>Private Channels: You must be a member to list or send messages.</p>\n </li>\n </ul>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -3075,7 +3078,7 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.chime#ChannelMembershipType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of \n<code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals \n<code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.</p>",
|
||||
"smithy.api#documentation": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default\n members are always returned as part of <code>ListChannelMemberships</code>. Hidden members\n are only returned if the type filter in <code>ListChannelMemberships</code> equals\n <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported\n by moderators.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -3140,7 +3143,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>\n\n <ul>\n <li>\n <p>Add and remove other members of the channel.</p>\n </li>\n <li>\n <p>Add and remove other moderators of the channel.</p>\n </li>\n <li>\n <p>Add and remove user bans for the channel.</p>\n </li>\n <li>\n <p>Redact messages in the channel.</p>\n </li>\n <li>\n <p>List messages in the channel.</p>\n </li>\n </ul>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>\n\n <ul>\n <li>\n <p>Add and remove other members of the channel.</p>\n </li>\n <li>\n <p>Add and remove other moderators of the channel.</p>\n </li>\n <li>\n <p>Add and remove user bans for the channel.</p>\n </li>\n <li>\n <p>Redact messages in the channel.</p>\n </li>\n <li>\n <p>List messages in the channel.</p>\n </li>\n </ul>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -3215,13 +3218,13 @@
|
|||
"Mode": {
|
||||
"target": "com.amazonaws.chime#ChannelMode",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators, moderators, and channel members can add themselves \n and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.</p>"
|
||||
"smithy.api#documentation": "<p>The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators,\n moderators, and channel members can add themselves and other members to unrestricted\n channels. Only administrators and moderators can add members to restricted channels.</p>"
|
||||
}
|
||||
},
|
||||
"Privacy": {
|
||||
"target": "com.amazonaws.chime#ChannelPrivacy",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private channels aren't discoverable by users outside the channel. \n Public channels are discoverable by anyone in the <code>AppInstance</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private\n channels aren't discoverable by users outside the channel. Public channels are discoverable\n by anyone in the <code>AppInstance</code>.</p>"
|
||||
}
|
||||
},
|
||||
"Metadata": {
|
||||
|
|
@ -4919,7 +4922,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Immediately makes a channel and its memberships inaccessible and marks them for\n deletion. This is an irreversible process.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -4956,7 +4959,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Removes a user from a channel's ban list.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Removes a user from a channel's ban list.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -5024,7 +5027,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Removes a member from a channel.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Removes a member from a channel.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -5089,7 +5092,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes a channel message. Only admins can perform this action. Deletion makes messages\n inaccessible immediately. A background process deletes any revisions created by\n <code>UpdateChannelMessage</code>.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Deletes a channel message. Only admins can perform this action. Deletion makes messages\n inaccessible immediately. A background process deletes any revisions created by\n <code>UpdateChannelMessage</code>.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -5154,7 +5157,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes a channel moderator.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Deletes a channel moderator.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -6284,7 +6287,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nReturns the full details of an \n<code>AppInstanceUser</code>\n.\n</p>",
|
||||
"smithy.api#documentation": "<p>Returns the full details of an <code>AppInstanceUser</code>.</p>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "identity-"
|
||||
},
|
||||
|
|
@ -6348,7 +6351,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns the full details of a channel in an Amazon Chime <code>AppInstance</code>.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Returns the full details of a channel in an Amazon Chime\n <code>AppInstance</code>.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -6391,7 +6394,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns the full details of a channel ban.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Returns the full details of a channel ban.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -6473,7 +6476,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns the full details of a user's channel membership.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Returns the full details of a user's channel membership.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -6513,7 +6516,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nReturns the details of a channel based on the membership of the specified <code>AppInstanceUser</code>.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p> Returns the details of a channel based on the membership of the specified\n <code>AppInstanceUser</code>.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -6631,7 +6634,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns the full details of a channel moderated by the specified <code>AppInstanceUser</code>.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Returns the full details of a channel moderated by the specified\n <code>AppInstanceUser</code>.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -6713,7 +6716,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns the full details of a single ChannelModerator.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Returns the full details of a single ChannelModerator.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -7151,7 +7154,7 @@
|
|||
"Region": {
|
||||
"target": "com.amazonaws.chime#TranscribeMedicalRegion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the Region closest to the meeting's Region.</p>"
|
||||
"smithy.api#documentation": "<p>The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -7190,7 +7193,7 @@
|
|||
"Region": {
|
||||
"target": "com.amazonaws.chime#TranscribeRegion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the Region closest to the meeting's Region.</p>"
|
||||
"smithy.api#documentation": "<p>The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -7816,7 +7819,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Gets the full details of a channel message.</p>\n\n <note>\n <p>The x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the \n value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Gets the full details of a channel message.</p>\n\n <note>\n <p>The x-amz-chime-bearer request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -9905,7 +9908,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\nList all \n<code>AppInstanceUsers</code>\ncreated under a single <code>AppInstance</code>.\n</p>",
|
||||
"smithy.api#documentation": "<p>List all <code>AppInstanceUsers</code>\n created under a single <code>AppInstance</code>.\n </p>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "identity-"
|
||||
},
|
||||
|
|
@ -10331,7 +10334,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists all the users banned from a particular channel.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Lists all the users banned from a particular channel.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -10433,7 +10436,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists all channel memberships in a channel.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Lists all channel memberships in a channel.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -10478,7 +10481,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an\n <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their\n own. </p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an\n <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -10558,7 +10561,7 @@
|
|||
"Type": {
|
||||
"target": "com.amazonaws.chime#ChannelMembershipType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of \n <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals \n <code>HIDDEN</code>. Otherwise hidden members are not returned.</p>",
|
||||
"smithy.api#documentation": "<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default\n members are always returned as part of <code>ListChannelMemberships</code>. Hidden members\n are only returned if the type filter in <code>ListChannelMemberships</code> equals\n <code>HIDDEN</code>. Otherwise hidden members are not returned.</p>",
|
||||
"smithy.api#httpQuery": "type"
|
||||
}
|
||||
},
|
||||
|
|
@ -10572,7 +10575,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.chime#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token passed by previous API calls until all requested channel memberships are returned.</p>",
|
||||
"smithy.api#documentation": "<p>The token passed by previous API calls until all requested channel memberships are\n returned.</p>",
|
||||
"smithy.api#httpQuery": "next-token"
|
||||
}
|
||||
},
|
||||
|
|
@ -10603,7 +10606,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.chime#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token passed by previous API calls until all requested channel memberships are returned.</p>"
|
||||
"smithy.api#documentation": "<p>The token passed by previous API calls until all requested channel memberships are\n returned.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -10637,7 +10640,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>List all the messages in a channel. Returns a paginated list of <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending order.</p>\n <note>\n <p>Redacted messages appear in the results as empty, since they are only redacted, not deleted.\n Deleted messages do not appear in the results. This action always returns the latest\n version of an edited message.</p>\n <p>Also, the x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the \n value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>List all the messages in a channel. Returns a paginated list of\n <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending\n order.</p>\n <note>\n <p>Redacted messages appear in the results as empty, since they are only redacted, not\n deleted. Deleted messages do not appear in the results. This action always returns the\n latest version of an edited message.</p>\n <p>Also, the x-amz-chime-bearer request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -10667,7 +10670,7 @@
|
|||
"SortOrder": {
|
||||
"target": "com.amazonaws.chime#SortOrder",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The order in which you want messages sorted. Default is Descending, based on time created.</p>",
|
||||
"smithy.api#documentation": "<p>The order in which you want messages sorted. Default is Descending, based on time\n created.</p>",
|
||||
"smithy.api#httpQuery": "sort-order"
|
||||
}
|
||||
},
|
||||
|
|
@ -10760,7 +10763,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists all the moderators for a channel.</p>\n\n <note>\n\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Lists all the moderators for a channel.</p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -10797,7 +10800,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.chime#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token passed by previous API calls until all requested moderators are returned.</p>",
|
||||
"smithy.api#documentation": "<p>The token passed by previous API calls until all requested moderators are\n returned.</p>",
|
||||
"smithy.api#httpQuery": "next-token"
|
||||
}
|
||||
},
|
||||
|
|
@ -10822,7 +10825,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.chime#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token passed by previous API calls until all requested moderators are returned.</p>"
|
||||
"smithy.api#documentation": "<p>The token passed by previous API calls until all requested moderators are\n returned.</p>"
|
||||
}
|
||||
},
|
||||
"ChannelModerators": {
|
||||
|
|
@ -10862,7 +10865,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.</p>\n\n <p class=\"title\">\n <b>Functionality & restrictions</b>\n </p>\n <ul>\n <li>\n <p>Use privacy = <code>PUBLIC</code> to retrieve all public channels in the account.</p>\n </li>\n <li>\n <p>Only an <code>AppInstanceAdmin</code> can set privacy = <code>PRIVATE</code> to list the\n private channels in an account.</p>\n </li>\n </ul>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Lists all Channels created under a single Chime App as a paginated list. You can specify\n filters to narrow results.</p>\n\n <p class=\"title\">\n <b>Functionality & restrictions</b>\n </p>\n <ul>\n <li>\n <p>Use privacy = <code>PUBLIC</code> to retrieve all public channels in the\n account.</p>\n </li>\n <li>\n <p>Only an <code>AppInstanceAdmin</code> can set privacy = <code>PRIVATE</code> to\n list the private channels in an account.</p>\n </li>\n </ul>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -10907,7 +10910,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -10943,7 +10946,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.chime#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token returned from previous API requests until the number of channels moderated by the user is reached.</p>",
|
||||
"smithy.api#documentation": "<p>The token returned from previous API requests until the number of channels moderated by\n the user is reached.</p>",
|
||||
"smithy.api#httpQuery": "next-token"
|
||||
}
|
||||
},
|
||||
|
|
@ -10968,7 +10971,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.chime#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token returned from previous API requests until the number of channels moderated by the user is reached.</p>"
|
||||
"smithy.api#documentation": "<p>The token returned from previous API requests until the number of channels moderated by\n the user is reached.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -10987,7 +10990,7 @@
|
|||
"Privacy": {
|
||||
"target": "com.amazonaws.chime#ChannelPrivacy",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The privacy setting. <code>PUBLIC</code> retrieves all the public channels. <code>PRIVATE</code> retrieves private channels. Only an \n <code>AppInstanceAdmin</code> can retrieve private channels.\n</p>",
|
||||
"smithy.api#documentation": "<p>The privacy setting. <code>PUBLIC</code> retrieves all the public channels.\n <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code>\n can retrieve private channels. </p>",
|
||||
"smithy.api#httpQuery": "privacy"
|
||||
}
|
||||
},
|
||||
|
|
@ -11026,7 +11029,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.chime#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token returned from previous API requests until the number of channels is reached.</p>"
|
||||
"smithy.api#documentation": "<p>The token returned from previous API requests until the number of channels is\n reached.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -14671,7 +14674,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Redacts message content, but not metadata. The message exists in the back end, but the\n action returns null content, and the state shows as redacted.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -15457,7 +15460,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Sends a message to a particular channel that the member is a part of.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n\n <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata. <code>CONTROL</code> messages can contain 30 bytes of \n data and no metadata.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Sends a message to a particular channel that the member is a part of.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n\n <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata.\n <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -16523,6 +16526,10 @@
|
|||
{
|
||||
"value": "eu-west-1",
|
||||
"name": "EU_WEST_1"
|
||||
},
|
||||
{
|
||||
"value": "auto",
|
||||
"name": "AUTO"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -16620,6 +16627,10 @@
|
|||
{
|
||||
"value": "sa-east-1",
|
||||
"name": "SA_EAST_1"
|
||||
},
|
||||
{
|
||||
"value": "auto",
|
||||
"name": "AUTO"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -17679,7 +17690,7 @@
|
|||
"AppInstanceArn": {
|
||||
"target": "com.amazonaws.chime#ChimeArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the <code>AppInstance</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The ARN of the <code>AppInstance</code>. </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -17874,7 +17885,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Update a channel's attributes.</p>\n <p>\n <b>Restriction</b>: You can't change a channel's privacy.\n</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Update a channel's attributes.</p>\n <p>\n <b>Restriction</b>: You can't change a channel's privacy. </p>\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -17917,7 +17928,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates the content of a message.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>Updates the content of a message.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
@ -18017,7 +18028,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The details of the time when a user last read messages in a channel.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes \n the API call as the value in the header.</p>\n </note>",
|
||||
"smithy.api#documentation": "<p>The details of the time when a user last read messages in a channel.</p>\n\n <note>\n <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the\n <code>AppInstanceUserArn</code> of the user that makes the API call as the value in\n the header.</p>\n </note>",
|
||||
"smithy.api#endpoint": {
|
||||
"hostPrefix": "messaging-"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -285,6 +285,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The connection type used for connecting to an Amazon EC2 environment. Valid values are\n <code>CONNECT_SSH</code> (default) and <code>CONNECT_SSM</code> (connected through\n Amazon EC2 Systems Manager).</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/cloud9/latest/user-guide/ec2-ssm.html\">Accessing no-ingress EC2 instances with\n Amazon EC2 Systems Manager</a> in the <i>Cloud9 User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"dryRun": {
|
||||
"target": "com.amazonaws.cloud9#NullableBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1155,6 +1161,21 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloud9#ManagedCredentialsAction": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#enum": [
|
||||
{
|
||||
"value": "ENABLE",
|
||||
"name": "ENABLE"
|
||||
},
|
||||
{
|
||||
"value": "DISABLE",
|
||||
"name": "DISABLE"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloud9#ManagedCredentialsStatus": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -1249,6 +1270,12 @@
|
|||
"smithy.api#error": "client"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloud9#NullableBoolean": {
|
||||
"type": "boolean",
|
||||
"traits": {
|
||||
"smithy.api#box": {}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloud9#Permissions": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -1605,6 +1632,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Any new or replacement description for the environment.</p>"
|
||||
}
|
||||
},
|
||||
"managedCredentialsAction": {
|
||||
"target": "com.amazonaws.cloud9#ManagedCredentialsAction",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary\n credentials for an Cloud9 environment by using one of the following values:</p>\n <ul>\n <li>\n <p>\n <code>ENABLE</code>\n </p>\n </li>\n <li>\n <p>\n <code>DISABLE</code>\n </p>\n </li>\n </ul>\n <note>\n <p>Only the environment owner can change the status of managed temporary credentials. An <code>AccessDeniedException</code> is thrown if an attempt to turn on or turn off managed temporary credentials is made by an account that's not the environment\n owner.</p> \n </note>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Access denied. Check your permissions.</p>",
|
||||
"smithy.api#documentation": "<p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>",
|
||||
"smithy.api#error": "client",
|
||||
"smithy.api#httpError": 403
|
||||
}
|
||||
|
|
@ -1794,22 +1794,40 @@
|
|||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.clouddirectory#NextToken"
|
||||
"target": "com.amazonaws.clouddirectory#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The pagination token.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"target": "com.amazonaws.clouddirectory#NumberResults"
|
||||
"target": "com.amazonaws.clouddirectory#NumberResults",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum number of items to be retrieved in a single call. This is an approximate\n number.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists parent objects that are associated with a given object in pagination\n fashion.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.clouddirectory#BatchListObjectParentsResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ParentLinks": {
|
||||
"target": "com.amazonaws.clouddirectory#ObjectIdentifierAndLinkNameList"
|
||||
"target": "com.amazonaws.clouddirectory#ObjectIdentifierAndLinkNameList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns a list of parent reference and LinkName Tuples.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.clouddirectory#NextToken"
|
||||
"target": "com.amazonaws.clouddirectory#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Represents the output of a <a>ListObjectParents</a> response operation.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.clouddirectory#BatchListObjectPolicies": {
|
||||
|
|
@ -2174,7 +2192,10 @@
|
|||
}
|
||||
},
|
||||
"ListObjectParents": {
|
||||
"target": "com.amazonaws.clouddirectory#BatchListObjectParents"
|
||||
"target": "com.amazonaws.clouddirectory#BatchListObjectParents",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists parent objects that are associated with a given object in pagination\n fashion.</p>"
|
||||
}
|
||||
},
|
||||
"ListObjectPolicies": {
|
||||
"target": "com.amazonaws.clouddirectory#BatchListObjectPolicies",
|
||||
|
|
@ -2375,7 +2396,10 @@
|
|||
}
|
||||
},
|
||||
"ListObjectParents": {
|
||||
"target": "com.amazonaws.clouddirectory#BatchListObjectParentsResponse"
|
||||
"target": "com.amazonaws.clouddirectory#BatchListObjectParentsResponse",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The list of parent objects to retrieve.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -5450,7 +5474,7 @@
|
|||
"min": 1,
|
||||
"max": 64
|
||||
},
|
||||
"smithy.api#pattern": "[^\\/\\[\\]\\(\\):\\{\\}#@!?\\s\\\\;]+"
|
||||
"smithy.api#pattern": "^[^\\/\\[\\]\\(\\):\\{\\}#@!?\\s\\\\;]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.clouddirectory#LinkNameAlreadyInUseException": {
|
||||
|
|
@ -7799,7 +7823,7 @@
|
|||
"Selector": {
|
||||
"target": "com.amazonaws.clouddirectory#SelectorObjectReference",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html\">Access Objects</a>. You can identify an object in one of the following ways:</p>\n <ul>\n <li>\n <p>\n <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier</p>\n </li>\n <li>\n <p>\n <i>/some/path</i> - Identifies the object based on path</p>\n </li>\n <li>\n <p>\n <i>#SomeBatchReference</i> - Identifies the object in a batch call</p>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html\">Access Objects</a>. You can identify an object in one of the following ways:</p>\n <ul>\n <li>\n <p>\n <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </p>\n </li>\n <li>\n <p>\n <i>/some/path</i> - Identifies the object based on path</p>\n </li>\n <li>\n <p>\n <i>#SomeBatchReference</i> - Identifies the object in a batch call</p>\n </li>\n </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -8334,13 +8358,13 @@
|
|||
"SchemaArn": {
|
||||
"target": "com.amazonaws.clouddirectory#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.</p>"
|
||||
"smithy.api#documentation": "<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.\n If this value is set, FacetName must also be set.</p>"
|
||||
}
|
||||
},
|
||||
"FacetName": {
|
||||
"target": "com.amazonaws.clouddirectory#FacetName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the facet.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the facet. If this value is set, SchemaArn must also be set.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -85,7 +85,7 @@
|
|||
"com.amazonaws.configservice#AccountId": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "\\d{12}"
|
||||
"smithy.api#pattern": "^\\d{12}$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#AggregateComplianceByConfigRule": {
|
||||
|
|
@ -1345,7 +1345,7 @@
|
|||
"min": 1,
|
||||
"max": 128
|
||||
},
|
||||
"smithy.api#pattern": ".*\\S.*"
|
||||
"smithy.api#pattern": "\\S"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#ConfigRuleNames": {
|
||||
|
|
@ -1491,7 +1491,7 @@
|
|||
"com.amazonaws.configservice#ConfigurationAggregatorArn": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:config-aggregator/config-aggregator-[a-z\\d]+"
|
||||
"smithy.api#pattern": "^arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:config-aggregator/config-aggregator-[a-z\\d]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#ConfigurationAggregatorList": {
|
||||
|
|
@ -1507,7 +1507,7 @@
|
|||
"min": 1,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[\\w\\-]+"
|
||||
"smithy.api#pattern": "^[\\w\\-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#ConfigurationAggregatorNameList": {
|
||||
|
|
@ -2080,7 +2080,7 @@
|
|||
"min": 1,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z][-a-zA-Z0-9]*"
|
||||
"smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#ConformancePackNamesList": {
|
||||
|
|
@ -7523,7 +7523,7 @@
|
|||
"min": 1,
|
||||
"max": 64
|
||||
},
|
||||
"smithy.api#pattern": ".*\\S.*"
|
||||
"smithy.api#pattern": "\\S"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#OrganizationConfigRuleNames": {
|
||||
|
|
@ -7728,7 +7728,7 @@
|
|||
"min": 1,
|
||||
"max": 128
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z][-a-zA-Z0-9]*"
|
||||
"smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#OrganizationConformancePackNames": {
|
||||
|
|
@ -9081,7 +9081,7 @@
|
|||
"min": 0,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[\\s\\S]*"
|
||||
"smithy.api#pattern": "^[\\s\\S]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#QueryExpression": {
|
||||
|
|
@ -9091,7 +9091,7 @@
|
|||
"min": 1,
|
||||
"max": 4096
|
||||
},
|
||||
"smithy.api#pattern": "[\\s\\S]*"
|
||||
"smithy.api#pattern": "^[\\s\\S]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#QueryId": {
|
||||
|
|
@ -10271,6 +10271,50 @@
|
|||
{
|
||||
"value": "AWS::SSM::FileData",
|
||||
"name": "FileData"
|
||||
},
|
||||
{
|
||||
"value": "AWS::Backup::BackupPlan",
|
||||
"name": "BackupPlan"
|
||||
},
|
||||
{
|
||||
"value": "AWS::Backup::BackupSelection",
|
||||
"name": "BackupSelection"
|
||||
},
|
||||
{
|
||||
"value": "AWS::Backup::BackupVault",
|
||||
"name": "BackupVault"
|
||||
},
|
||||
{
|
||||
"value": "AWS::Backup::RecoveryPoint",
|
||||
"name": "BackupRecoveryPoint"
|
||||
},
|
||||
{
|
||||
"value": "AWS::ECR::Repository",
|
||||
"name": "ECRRepository"
|
||||
},
|
||||
{
|
||||
"value": "AWS::ECS::Cluster",
|
||||
"name": "ECSCluster"
|
||||
},
|
||||
{
|
||||
"value": "AWS::ECS::Service",
|
||||
"name": "ECSService"
|
||||
},
|
||||
{
|
||||
"value": "AWS::ECS::TaskDefinition",
|
||||
"name": "ECSTaskDefinition"
|
||||
},
|
||||
{
|
||||
"value": "AWS::EFS::AccessPoint",
|
||||
"name": "EFSAccessPoint"
|
||||
},
|
||||
{
|
||||
"value": "AWS::EFS::FileSystem",
|
||||
"name": "EFSFileSystem"
|
||||
},
|
||||
{
|
||||
"value": "AWS::EKS::Cluster",
|
||||
"name": "EKSCluster"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -10381,7 +10425,7 @@
|
|||
"min": 1,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[\\w\\-]+"
|
||||
"smithy.api#pattern": "^[\\w\\-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#RetentionConfigurationNameList": {
|
||||
|
|
@ -10421,7 +10465,7 @@
|
|||
"min": 1,
|
||||
"max": 128
|
||||
},
|
||||
"smithy.api#pattern": "[A-Za-z0-9-]+"
|
||||
"smithy.api#pattern": "^[A-Za-z0-9-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#Scope": {
|
||||
|
|
@ -11511,7 +11555,7 @@
|
|||
"min": 1,
|
||||
"max": 1024
|
||||
},
|
||||
"smithy.api#pattern": "s3://.*"
|
||||
"smithy.api#pattern": "^s3://"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.configservice#TooManyTagsException": {
|
||||
|
|
|
|||
|
|
@ -58,6 +58,177 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatus": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AgentStatusARN": {
|
||||
"target": "com.amazonaws.connect#ARN",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"AgentStatusId": {
|
||||
"target": "com.amazonaws.connect#AgentStatusId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
"target": "com.amazonaws.connect#AgentStatusName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
"target": "com.amazonaws.connect#AgentStatusDescription",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The description of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.connect#AgentStatusType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of agent status.</p>"
|
||||
}
|
||||
},
|
||||
"DisplayOrder": {
|
||||
"target": "com.amazonaws.connect#AgentStatusOrderNumber",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The display order of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"State": {
|
||||
"target": "com.amazonaws.connect#AgentStatusState",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The state of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.connect#TagMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>One or more tags.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Contains information about an agent status.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusDescription": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 1,
|
||||
"max": 250
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusId": {
|
||||
"type": "string"
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusName": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 1,
|
||||
"max": 127
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusOrderNumber": {
|
||||
"type": "integer",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#range": {
|
||||
"min": 1,
|
||||
"max": 50
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusState": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#enum": [
|
||||
{
|
||||
"value": "ENABLED",
|
||||
"name": "ENABLED"
|
||||
},
|
||||
{
|
||||
"value": "DISABLED",
|
||||
"name": "DISABLED"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusSummary": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Id": {
|
||||
"target": "com.amazonaws.connect#AgentStatusId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for an agent status.</p>"
|
||||
}
|
||||
},
|
||||
"Arn": {
|
||||
"target": "com.amazonaws.connect#ARN",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
"target": "com.amazonaws.connect#AgentStatusName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
"target": "com.amazonaws.connect#AgentStatusType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of the agent status.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Summary information for an agent status.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusSummaryList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"target": "com.amazonaws.connect#AgentStatusSummary"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusType": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#enum": [
|
||||
{
|
||||
"value": "ROUTABLE",
|
||||
"name": "ROUTABLE"
|
||||
},
|
||||
{
|
||||
"value": "CUSTOM",
|
||||
"name": "CUSTOM"
|
||||
},
|
||||
{
|
||||
"value": "OFFLINE",
|
||||
"name": "OFFLINE"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentStatusTypes": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"target": "com.amazonaws.connect#AgentStatusType"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 0,
|
||||
"max": 3
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#AgentUsername": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -104,9 +275,15 @@
|
|||
{
|
||||
"target": "com.amazonaws.connect#AssociateSecurityKey"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#CreateAgentStatus"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#CreateContactFlow"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#CreateHoursOfOperation"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#CreateInstance"
|
||||
},
|
||||
|
|
@ -131,6 +308,9 @@
|
|||
{
|
||||
"target": "com.amazonaws.connect#CreateUserHierarchyGroup"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#DeleteHoursOfOperation"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#DeleteInstance"
|
||||
},
|
||||
|
|
@ -149,6 +329,9 @@
|
|||
{
|
||||
"target": "com.amazonaws.connect#DeleteUserHierarchyGroup"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#DescribeAgentStatus"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#DescribeContactFlow"
|
||||
},
|
||||
|
|
@ -218,6 +401,9 @@
|
|||
{
|
||||
"target": "com.amazonaws.connect#GetMetricData"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ListAgentStatuses"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ListApprovedOrigins"
|
||||
},
|
||||
|
|
@ -317,6 +503,9 @@
|
|||
{
|
||||
"target": "com.amazonaws.connect#UntagResource"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#UpdateAgentStatus"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#UpdateContactAttributes"
|
||||
},
|
||||
|
|
@ -326,6 +515,9 @@
|
|||
{
|
||||
"target": "com.amazonaws.connect#UpdateContactFlowName"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#UpdateHoursOfOperation"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#UpdateInstanceAttribute"
|
||||
},
|
||||
|
|
@ -965,6 +1157,9 @@
|
|||
"com.amazonaws.connect#AutoAccept": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"com.amazonaws.connect#Boolean": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"com.amazonaws.connect#BotName": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -1063,15 +1258,6 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CommonDescriptionLength250": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 0,
|
||||
"max": 250
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CommonNameLength127": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -1318,6 +1504,109 @@
|
|||
"target": "com.amazonaws.connect#Reference"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CreateAgentStatus": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.connect#CreateAgentStatusRequest"
|
||||
},
|
||||
"output": {
|
||||
"target": "com.amazonaws.connect#CreateAgentStatusResponse"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.connect#DuplicateResourceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InternalServiceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidParameterException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidRequestException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#LimitExceededException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ResourceNotFoundException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ThrottlingException"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p>\n <p>Creates an agent status for the specified Amazon Connect instance.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "PUT",
|
||||
"uri": "/agent-status/{InstanceId}",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CreateAgentStatusRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceId": {
|
||||
"target": "com.amazonaws.connect#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
"target": "com.amazonaws.connect#AgentStatusName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the status.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
"target": "com.amazonaws.connect#AgentStatusDescription",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The description of the status.</p>"
|
||||
}
|
||||
},
|
||||
"State": {
|
||||
"target": "com.amazonaws.connect#AgentStatusState",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The state of the status.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"DisplayOrder": {
|
||||
"target": "com.amazonaws.connect#AgentStatusOrderNumber",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>The display order of the status.</p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.connect#TagMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>One or more tags.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CreateAgentStatusResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AgentStatusARN": {
|
||||
"target": "com.amazonaws.connect#ARN",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"AgentStatusId": {
|
||||
"target": "com.amazonaws.connect#AgentStatusId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the agent status.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CreateContactFlow": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
@ -1424,6 +1713,109 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CreateHoursOfOperation": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.connect#CreateHoursOfOperationRequest"
|
||||
},
|
||||
"output": {
|
||||
"target": "com.amazonaws.connect#CreateHoursOfOperationResponse"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.connect#DuplicateResourceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InternalServiceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidParameterException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidRequestException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#LimitExceededException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ResourceNotFoundException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ThrottlingException"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p>\n <p>Creates hours of operation. </p>",
|
||||
"smithy.api#http": {
|
||||
"method": "PUT",
|
||||
"uri": "/hours-of-operations/{InstanceId}",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CreateHoursOfOperationRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceId": {
|
||||
"target": "com.amazonaws.connect#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
"target": "com.amazonaws.connect#CommonNameLength127",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the hours of operation.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationDescription",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The description of the hours of operation.</p>"
|
||||
}
|
||||
},
|
||||
"TimeZone": {
|
||||
"target": "com.amazonaws.connect#TimeZone",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The time zone of the hours of operation.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Config": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationConfigList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Configuration information for the hours of operation: day, start time, and end time.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.connect#TagMap",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>One or more tags.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CreateHoursOfOperationResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"HoursOfOperationId": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the hours of operation.</p>"
|
||||
}
|
||||
},
|
||||
"HoursOfOperationArn": {
|
||||
"target": "com.amazonaws.connect#ARN",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the hours of operation.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#CreateInstance": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
@ -2421,6 +2813,58 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#DeleteHoursOfOperation": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.connect#DeleteHoursOfOperationRequest"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.connect#InternalServiceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidParameterException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidRequestException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ResourceNotFoundException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ThrottlingException"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p>\n <p>Deletes an hours of operation.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "DELETE",
|
||||
"uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#DeleteHoursOfOperationRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceId": {
|
||||
"target": "com.amazonaws.connect#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"HoursOfOperationId": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the hours of operation.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#DeleteInstance": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
@ -2724,6 +3168,72 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#DescribeAgentStatus": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.connect#DescribeAgentStatusRequest"
|
||||
},
|
||||
"output": {
|
||||
"target": "com.amazonaws.connect#DescribeAgentStatusResponse"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.connect#InternalServiceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidParameterException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidRequestException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ResourceNotFoundException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ThrottlingException"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p>\n <p>Describes an agent status.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/agent-status/{InstanceId}/{AgentStatusId}",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#DescribeAgentStatusRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceId": {
|
||||
"target": "com.amazonaws.connect#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"AgentStatusId": {
|
||||
"target": "com.amazonaws.connect#AgentStatusId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the agent status.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#DescribeAgentStatusResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AgentStatus": {
|
||||
"target": "com.amazonaws.connect#AgentStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The agent status.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#DescribeContactFlow": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
@ -4916,7 +5426,7 @@
|
|||
}
|
||||
},
|
||||
"Description": {
|
||||
"target": "com.amazonaws.connect#CommonDescriptionLength250",
|
||||
"target": "com.amazonaws.connect#HoursOfOperationDescription",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The description for the hours of operation.</p>"
|
||||
}
|
||||
|
|
@ -4950,19 +5460,22 @@
|
|||
"Day": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationDays",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The day that the hours of operation applies to.</p>"
|
||||
"smithy.api#documentation": "<p>The day that the hours of operation applies to.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"StartTime": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationTimeSlice",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The start time that your contact center is open.</p>"
|
||||
"smithy.api#documentation": "<p>The start time that your contact center is open.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"EndTime": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationTimeSlice",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The end time that your contact center is closes.</p>"
|
||||
"smithy.api#documentation": "<p>The end time that your contact center is closes.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4974,6 +5487,12 @@
|
|||
"type": "list",
|
||||
"member": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationConfig"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 0,
|
||||
"max": 100
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#HoursOfOperationDays": {
|
||||
|
|
@ -5011,6 +5530,15 @@
|
|||
]
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#HoursOfOperationDescription": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 1,
|
||||
"max": 250
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#HoursOfOperationId": {
|
||||
"type": "string"
|
||||
},
|
||||
|
|
@ -5055,13 +5583,17 @@
|
|||
"Hours": {
|
||||
"target": "com.amazonaws.connect#Hours24Format",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The hours.</p>"
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>The hours.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Minutes": {
|
||||
"target": "com.amazonaws.connect#MinutesLimit60",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The minutes.</p>"
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>The minutes.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5700,6 +6232,98 @@
|
|||
"smithy.api#httpError": 429
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#ListAgentStatusRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceId": {
|
||||
"target": "com.amazonaws.connect#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.connect#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.</p>",
|
||||
"smithy.api#httpQuery": "nextToken"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"target": "com.amazonaws.connect#MaxResult1000",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>The maximum number of results to return per page.</p>",
|
||||
"smithy.api#httpQuery": "maxResults"
|
||||
}
|
||||
},
|
||||
"AgentStatusTypes": {
|
||||
"target": "com.amazonaws.connect#AgentStatusTypes",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Available agent status types.</p>",
|
||||
"smithy.api#httpQuery": "AgentStatusTypes"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#ListAgentStatusResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.connect#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If there are additional results, this is the token for the next set of results.</p>"
|
||||
}
|
||||
},
|
||||
"AgentStatusSummaryList": {
|
||||
"target": "com.amazonaws.connect#AgentStatusSummaryList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A summary of agent statuses.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#ListAgentStatuses": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.connect#ListAgentStatusRequest"
|
||||
},
|
||||
"output": {
|
||||
"target": "com.amazonaws.connect#ListAgentStatusResponse"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.connect#InternalServiceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidParameterException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidRequestException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ResourceNotFoundException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ThrottlingException"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p>\n <p>Lists agent statuses.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/agent-status/{InstanceId}",
|
||||
"code": 200
|
||||
},
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
"items": "AgentStatusSummaryList",
|
||||
"pageSize": "MaxResults"
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#ListApprovedOrigins": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
@ -10731,7 +11355,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Adds the specified tags to the specified resource.</p>\n <p>The supported resource types are users, routing profiles, queues, quick connects, and\n contact flows.</p>\n <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based\n Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Adds the specified tags to the specified resource.</p>\n <p>The supported resource types are users, routing profiles, queues, quick connects, \n contact flows, agent status, and hours of operation.</p>\n <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based\n Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/tags/{resourceArn}",
|
||||
|
|
@ -10898,6 +11522,104 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#UpdateAgentStatus": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.connect#UpdateAgentStatusRequest"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.connect#DuplicateResourceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InternalServiceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidParameterException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidRequestException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#LimitExceededException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ResourceNotFoundException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ThrottlingException"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p>\n <p>Updates agent status.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/agent-status/{InstanceId}/{AgentStatusId}",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#UpdateAgentStatusDescription": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 0,
|
||||
"max": 250
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#UpdateAgentStatusRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceId": {
|
||||
"target": "com.amazonaws.connect#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"AgentStatusId": {
|
||||
"target": "com.amazonaws.connect#AgentStatusId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the agent status.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
"target": "com.amazonaws.connect#AgentStatusName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
"target": "com.amazonaws.connect#UpdateAgentStatusDescription",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The description of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"State": {
|
||||
"target": "com.amazonaws.connect#AgentStatusState",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The state of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"DisplayOrder": {
|
||||
"target": "com.amazonaws.connect#AgentStatusOrderNumber",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>The display order of the agent status.</p>"
|
||||
}
|
||||
},
|
||||
"ResetOrderNumber": {
|
||||
"target": "com.amazonaws.connect#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A number indicating the reset order of the agent status.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#UpdateContactAttributes": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
@ -11088,6 +11810,94 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#UpdateHoursOfOperation": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.connect#UpdateHoursOfOperationRequest"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.connect#DuplicateResourceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InternalServiceException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidParameterException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#InvalidRequestException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ResourceNotFoundException"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.connect#ThrottlingException"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and is subject to change.</p>\n <p>Updates the hours of operation.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}",
|
||||
"code": 200
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#UpdateHoursOfOperationDescription": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 0,
|
||||
"max": 250
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#UpdateHoursOfOperationRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InstanceId": {
|
||||
"target": "com.amazonaws.connect#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"HoursOfOperationId": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier of the hours of operation.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
"target": "com.amazonaws.connect#CommonNameLength127",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the hours of operation.</p>"
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
"target": "com.amazonaws.connect#UpdateHoursOfOperationDescription",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The description of the hours of operation.</p>"
|
||||
}
|
||||
},
|
||||
"TimeZone": {
|
||||
"target": "com.amazonaws.connect#TimeZone",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The time zone of the hours of operation.</p>"
|
||||
}
|
||||
},
|
||||
"Config": {
|
||||
"target": "com.amazonaws.connect#HoursOfOperationConfigList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Configuration information of the hours of operation.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.connect#UpdateInstanceAttribute": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
|
|
|
|||
|
|
@ -233,7 +233,7 @@
|
|||
"min": 3,
|
||||
"max": 63
|
||||
},
|
||||
"smithy.api#pattern": "\\S+"
|
||||
"smithy.api#pattern": "^\\S+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#BucketPrefix": {
|
||||
|
|
@ -291,7 +291,7 @@
|
|||
"min": 0,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[\\w/!@#+=.-]+"
|
||||
"smithy.api#pattern": "^[\\w/!@#+=.-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#CreateDomain": {
|
||||
|
|
@ -320,7 +320,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a domain, which is a container for all customer data, such as customer profile\n attributes, object types, profile keys, and encryption keys. You can create multiple\n domains, and each domain can have multiple third-party integrations.</p>\n <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can\n be associated with one domain.</p>",
|
||||
"smithy.api#documentation": "<p>Creates a domain, which is a container for all customer data, such as customer profile\n attributes, object types, profile keys, and encryption keys. You can create multiple\n domains, and each domain can have multiple third-party integrations.</p>\n <p>Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can\n be associated with one domain.</p>\n <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to\n enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity\n resolution</a>: set <code>Matching</code> to true. </p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/domains/{DomainName}",
|
||||
|
|
@ -361,7 +361,7 @@
|
|||
"Matching": {
|
||||
"target": "com.amazonaws.customerprofiles#MatchingRequest",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>"
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \n<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>\nAPI to return and review the results. </p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
|
|
@ -404,7 +404,7 @@
|
|||
"Matching": {
|
||||
"target": "com.amazonaws.customerprofiles#MatchingResponse",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>"
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \n<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>\nAPI to return and review the results. </p>"
|
||||
}
|
||||
},
|
||||
"CreatedAt": {
|
||||
|
|
@ -1448,7 +1448,7 @@
|
|||
"min": 0,
|
||||
"max": 2048
|
||||
},
|
||||
"smithy.api#pattern": "[\\w!@#\\-.?,\\s]*"
|
||||
"smithy.api#pattern": "^[\\w!@#\\-.?,\\s]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#FlowName": {
|
||||
|
|
@ -1458,7 +1458,7 @@
|
|||
"min": 0,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z0-9][\\w!@#.-]+"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9][\\w!@#.-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#Gender": {
|
||||
|
|
@ -1564,7 +1564,7 @@
|
|||
"Matching": {
|
||||
"target": "com.amazonaws.customerprofiles#MatchingResponse",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>"
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \n<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>\nAPI to return and review the results. </p>"
|
||||
}
|
||||
},
|
||||
"CreatedAt": {
|
||||
|
|
@ -1715,7 +1715,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and subject to change.</p>\n <p>Before calling this API, use <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> or\n <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to\n enable identity resolution: set <code>Matching</code> to true.</p>\n <p>GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process. </p>\n <important>\n <p>Amazon Connect runs a batch process every Saturday at 12AM UTC to identify matching profiles.\n The results are returned up to seven days after the Saturday run.</p>\n </important>\n\n <p>Amazon Connect uses the following profile attributes to identify matches:</p>\n <ul>\n <li>\n <p>PhoneNumber</p>\n </li>\n <li>\n <p>HomePhoneNumber</p>\n </li>\n <li>\n <p>BusinessPhoneNumber</p>\n </li>\n <li>\n <p>MobilePhoneNumber</p>\n </li>\n <li>\n <p>EmailAddress</p>\n </li>\n <li>\n <p>PersonalEmailAddress</p>\n </li>\n <li>\n <p>BusinessEmailAddress</p>\n </li>\n <li>\n <p>FullName</p>\n </li>\n <li>\n <p>BusinessName</p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>This API is in preview release for Amazon Connect and subject to change.</p>\n <p>Before calling this API, use <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> or\n <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html\">UpdateDomain</a> to\n enable identity resolution: set <code>Matching</code> to true.</p>\n <p>GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process. </p>\n <important>\n <p>Amazon Connect starts a batch process every Saturday at 12AM UTC to identify matching profiles.\n The results are returned up to seven days after the Saturday run.</p>\n </important>\n\n <p>Amazon Connect uses the following profile attributes to identify matches:</p>\n <ul>\n <li>\n <p>PhoneNumber</p>\n </li>\n <li>\n <p>HomePhoneNumber</p>\n </li>\n <li>\n <p>BusinessPhoneNumber</p>\n </li>\n <li>\n <p>MobilePhoneNumber</p>\n </li>\n <li>\n <p>EmailAddress</p>\n </li>\n <li>\n <p>PersonalEmailAddress</p>\n </li>\n <li>\n <p>BusinessEmailAddress</p>\n </li>\n <li>\n <p>FullName</p>\n </li>\n <li>\n <p>BusinessName</p>\n </li>\n </ul>\n <p>For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing\n email addresses such as <b>JOHN_DOE@ANYCOMPANY.COM</b> and\n <b>johndoe@anycompany.com</b>, or different phone number\n formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/domains/{DomainName}/matches",
|
||||
|
|
@ -2044,7 +2044,7 @@
|
|||
"min": 20,
|
||||
"max": 2048
|
||||
},
|
||||
"smithy.api#pattern": "arn:aws:kms:.*:[0-9]+:.*"
|
||||
"smithy.api#pattern": "^arn:aws:kms:.*:[0-9]+:"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#ListAccountIntegrations": {
|
||||
|
|
@ -2668,6 +2668,12 @@
|
|||
"smithy.api#documentation": "<p>The unique identifier of a customer profile.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"ObjectFilter": {
|
||||
"target": "com.amazonaws.customerprofiles#ObjectFilter",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Applies a filter to the response to include profile objects with the specified index values.\n This filter is only supported for ObjectTypeName _asset and _case.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2940,7 +2946,7 @@
|
|||
"FieldSourceProfileIds": {
|
||||
"target": "com.amazonaws.customerprofiles#FieldSourceProfileIds",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifiers of the fields in the profile that has the information you want to apply to the\n merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the \n identifier of the EmailAddress field in Profile1. </p>"
|
||||
"smithy.api#documentation": "<p>The identifiers of the fields in the profile that has the information you want to apply\n to the merge. For example, say you want to merge EmailAddress from Profile1 into\n MainProfile. This would be the identifier of the EmailAddress field in Profile1. </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -2963,7 +2969,29 @@
|
|||
"min": 0,
|
||||
"max": 512
|
||||
},
|
||||
"smithy.api#pattern": "\\S+"
|
||||
"smithy.api#pattern": "^\\S+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#ObjectFilter": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"KeyName": {
|
||||
"target": "com.amazonaws.customerprofiles#name",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber.\n The predefined keys you can use to search for _case include: _caseId.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"Values": {
|
||||
"target": "com.amazonaws.customerprofiles#requestValueList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of key values.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filter applied to ListProfileObjects response to include profile objects with the specified index values.\n This filter is only supported for ObjectTypeName _asset and _case.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#ObjectTypeField": {
|
||||
|
|
@ -2998,7 +3026,7 @@
|
|||
"StandardIdentifiers": {
|
||||
"target": "com.amazonaws.customerprofiles#StandardIdentifierList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an\n object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a\n key a is marked as SECONDARY, it will be used to search for profiles after all other\n PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is\n not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the\n profile does not already exist before the object is ingested, otherwise it is only used for\n matching objects to profiles.</p>"
|
||||
"smithy.api#documentation": "<p>The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an\n object to a PROFILE, ASSET or CASE respectively. UNIQUE means that it can be used to uniquely identify an object.\n If a key a is marked as SECONDARY, it will be used to search for profiles after all other\n PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is\n not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the\n profile does not already exist before the object is ingested, otherwise it is only used for\n matching objects to profiles.</p>"
|
||||
}
|
||||
},
|
||||
"FieldNames": {
|
||||
|
|
@ -3289,7 +3317,7 @@
|
|||
"min": 0,
|
||||
"max": 2048
|
||||
},
|
||||
"smithy.api#pattern": ".+"
|
||||
"smithy.api#pattern": "^.+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#PutIntegration": {
|
||||
|
|
@ -4280,6 +4308,14 @@
|
|||
"value": "PROFILE",
|
||||
"name": "PROFILE"
|
||||
},
|
||||
{
|
||||
"value": "ASSET",
|
||||
"name": "ASSET"
|
||||
},
|
||||
{
|
||||
"value": "CASE",
|
||||
"name": "CASE"
|
||||
},
|
||||
{
|
||||
"value": "UNIQUE",
|
||||
"name": "UNIQUE"
|
||||
|
|
@ -4312,7 +4348,7 @@
|
|||
"min": 0,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "^arn:[a-z0-9]{1,10}:profile"
|
||||
"smithy.api#pattern": "^arn:[a-z0-9]{1,10}:profile$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.customerprofiles#TagKey": {
|
||||
|
|
@ -4736,7 +4772,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.</p>\n <p>After a domain is created, the name can’t be changed.</p>",
|
||||
"smithy.api#documentation": "<p>Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.</p>\n <p>After a domain is created, the name can’t be changed.</p>\n <p>Use this API or <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html\">CreateDomain</a> to\n enable <a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">identity\n resolution</a>: set <code>Matching</code> to true. </p>",
|
||||
"smithy.api#http": {
|
||||
"method": "PUT",
|
||||
"uri": "/domains/{DomainName}",
|
||||
|
|
@ -4776,7 +4812,7 @@
|
|||
"Matching": {
|
||||
"target": "com.amazonaws.customerprofiles#MatchingRequest",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>"
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \n<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>\nAPI to return and review the results. </p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
|
|
@ -4818,7 +4854,7 @@
|
|||
"Matching": {
|
||||
"target": "com.amazonaws.customerprofiles#MatchingResponse",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. This process runs every Saturday at 12AM.</p>"
|
||||
"smithy.api#documentation": "<p>The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. \nAfter that batch process completes, use the \n<a href=\"https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html\">GetMatches</a>\nAPI to return and review the results. </p>"
|
||||
}
|
||||
},
|
||||
"CreatedAt": {
|
||||
|
|
@ -5280,7 +5316,7 @@
|
|||
"com.amazonaws.customerprofiles#uuid": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "[a-f0-9]{32}"
|
||||
"smithy.api#pattern": "^[a-f0-9]{32}$"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3989,6 +3989,10 @@
|
|||
{
|
||||
"value": "XML",
|
||||
"name": "XML"
|
||||
},
|
||||
{
|
||||
"value": "TABLEAUHYPER",
|
||||
"name": "TABLEAUHYPER"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -382,7 +382,7 @@
|
|||
"name": "ebs"
|
||||
},
|
||||
"aws.protocols#restJson1": {},
|
||||
"smithy.api#documentation": "<p>You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create EBS snapshots, write data directly to \n \t\tyour snapshots, read data on your snapshots, and identify the differences or changes between \n \t\ttwo snapshots. If you’re an independent software vendor (ISV) who offers backup services for \n \t\tAmazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on \n \t\tyour EBS volumes through snapshots. This can be done without having to create new volumes \n \t\tfrom snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.</p>\n \t\t\n \t <p>You can create incremental snapshots directly from data on-premises into EBS volumes and the \n \t\tcloud to use for quick disaster recovery. With the ability to write and read snapshots, you can \n \t\twrite your on-premises data to an EBS snapshot during a disaster. Then after recovery, you can \n \t\trestore it back to AWS or on-premises from the snapshot. You no longer need to build and \n \t\tmaintain complex mechanisms to copy data to and from Amazon EBS.</p>\n\n\n <p>This API reference provides detailed information about the actions, data types,\n parameters, and errors of the EBS direct APIs. For more information about the elements that\n make up the EBS direct APIs, and examples of how to use them effectively, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html\">Accessing the Contents of an EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User\n Guide</i>. For more information about the supported AWS Regions, endpoints,\n and service quotas for the EBS direct APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ebs-service.html\">Amazon Elastic Block Store Endpoints and Quotas</a> in\n the <i>AWS General Reference</i>.</p>",
|
||||
"smithy.api#documentation": "<p>You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to \n \t\tyour snapshots, read data on your snapshots, and identify the differences or changes between \n \t\ttwo snapshots. If you’re an independent software vendor (ISV) who offers backup services for \n \t\tAmazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on \n \t\tyour Amazon EBS volumes through snapshots. This can be done without having to create new volumes \n \t\tfrom snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.</p>\n \t\t\n \t <p>You can create incremental snapshots directly from data on-premises into volumes and the \n \t\tcloud to use for quick disaster recovery. With the ability to write and read snapshots, you can \n \t\twrite your on-premises data to an snapshot during a disaster. Then after recovery, you can \n \t\trestore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and \n \t\tmaintain complex mechanisms to copy data to and from Amazon EBS.</p>\n\n\n <p>This API reference provides detailed information about the actions, data types,\n parameters, and errors of the EBS direct APIs. For more information about the elements that\n make up the EBS direct APIs, and examples of how to use them effectively, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html\">Accessing the Contents of an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User\n Guide</i>. For more information about the supported Amazon Web Services Regions, endpoints,\n and service quotas for the EBS direct APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ebs-service.html\">Amazon Elastic Block Store Endpoints and Quotas</a> in\n the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"smithy.api#title": "Amazon Elastic Block Store"
|
||||
}
|
||||
},
|
||||
|
|
@ -524,7 +524,7 @@
|
|||
"min": 1,
|
||||
"max": 2048
|
||||
},
|
||||
"smithy.api#pattern": "arn:aws[a-z\\-]*:kms:.*:[0-9]{12}:key/.*",
|
||||
"smithy.api#pattern": "^arn:aws[a-z\\-]*:kms:.*:[0-9]{12}:key/",
|
||||
"smithy.api#sensitive": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -635,7 +635,7 @@
|
|||
"BlockSize": {
|
||||
"target": "com.amazonaws.ebs#BlockSize",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The size of the block.</p>"
|
||||
"smithy.api#documentation": "<p>The size of the blocks in the snapshot, in bytes.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
|
@ -746,7 +746,7 @@
|
|||
"BlockSize": {
|
||||
"target": "com.amazonaws.ebs#BlockSize",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The size of the block.</p>"
|
||||
"smithy.api#documentation": "<p>The size of the blocks in the snapshot, in bytes.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
|
@ -774,7 +774,7 @@
|
|||
"min": 1,
|
||||
"max": 24
|
||||
},
|
||||
"smithy.api#pattern": "\\S+"
|
||||
"smithy.api#pattern": "^\\S+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ebs#PageToken": {
|
||||
|
|
@ -830,7 +830,7 @@
|
|||
"smithy.api#auth": [
|
||||
"aws.auth#sigv4"
|
||||
],
|
||||
"smithy.api#documentation": "<p>Writes a block of data to a snapshot. If the specified block contains\n data, the existing data is overwritten. The target snapshot must be in the\n <code>pending</code> state.</p> \t\n \t <p>Data written to a snapshot must be aligned with 512-byte sectors.</p>",
|
||||
"smithy.api#documentation": "<p>Writes a block of data to a snapshot. If the specified block contains\n data, the existing data is overwritten. The target snapshot must be in the\n <code>pending</code> state.</p> \t\n \t <p>Data written to a snapshot must be aligned with 512-KiB sectors.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "PUT",
|
||||
"uri": "/snapshots/{SnapshotId}/blocks/{BlockIndex}",
|
||||
|
|
@ -868,7 +868,7 @@
|
|||
"DataLength": {
|
||||
"target": "com.amazonaws.ebs#DataLength",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The size of the data to write to the block, in bytes. Currently, the only supported\n size is <code>524288</code>.</p>\n <p>Valid values: <code>524288</code>\n </p>",
|
||||
"smithy.api#documentation": "<p>The size of the data to write to the block, in bytes. Currently, the only supported\n size is <code>524288</code> bytes.</p>\n <p>Valid values: <code>524288</code>\n </p>",
|
||||
"smithy.api#httpHeader": "x-amz-Data-Length",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -1099,20 +1099,20 @@
|
|||
"ClientToken": {
|
||||
"target": "com.amazonaws.ebs#IdempotencyToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent \n request, if the original request completes successfully. The subsequent retries with the same \n client token return the result from the original successful request and they have no additional \n effect.</p>\n <p>If you do not specify a client token, one is automatically generated by the AWS SDK.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html\">\n \t\tIdempotency for StartSnapshot API</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent \n request, if the original request completes successfully. The subsequent retries with the same \n client token return the result from the original successful request and they have no additional \n effect.</p>\n <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html\">\n \t\tIdempotency for StartSnapshot API</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"smithy.api#idempotencyToken": {}
|
||||
}
|
||||
},
|
||||
"Encrypted": {
|
||||
"target": "com.amazonaws.ebs#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify\n <code>true</code>. To create an unencrypted snapshot, omit this parameter.</p>\n <p>If you specify a value for <b>ParentSnapshotId</b>, omit\n this parameter.</p>\n <p>If you specify <code>true</code>, the snapshot is encrypted using the CMK specified\n using the <b>KmsKeyArn</b> parameter. If no value is specified\n for <b>KmsKeyArn</b>, the default CMK for your account is \n \tused. If no default CMK has been specified for your account, the AWS managed CMK is used. \n \tTo set a default CMK for your account, use <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyEbsDefaultKmsKeyId.html\">\n \t\tModifyEbsDefaultKmsKeyId</a>.</p>\n <p>If your account is enabled for encryption by default, you cannot set this parameter to\n <code>false</code>. In this case, you can omit this parameter.</p>\n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-encryption\">\n Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify\n <code>true</code>. To create an unencrypted snapshot, omit this parameter.</p>\n <p>If you specify a value for <b>ParentSnapshotId</b>, omit\n this parameter.</p>\n <p>If you specify <code>true</code>, the snapshot is encrypted using the KMS key specified\n using the <b>KmsKeyArn</b> parameter. If no value is specified\n for <b>KmsKeyArn</b>, the default KMS key for your account is \n used. If no default KMS key has been specified for your account, the Amazon Web Services managed KMS key is used. \n To set a default KMS key for your account, use <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyEbsDefaultKmsKeyId.html\">\n \t\tModifyEbsDefaultKmsKeyId</a>.</p>\n <p>If your account is enabled for encryption by default, you cannot set this parameter to\n <code>false</code>. In this case, you can omit this parameter.</p>\n\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-encryption\">\n Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"KmsKeyArn": {
|
||||
"target": "com.amazonaws.ebs#KmsKeyArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) \n \tcustomer master key (CMK) to be used to encrypt the snapshot. If you do not specify a \n \tCMK, the default AWS managed CMK is used.</p>\n <p>If you specify a <b>ParentSnapshotId</b>, omit this\n parameter; the snapshot will be encrypted using the same CMK that was used to encrypt\n the parent snapshot.</p>\n <p>If <b>Encrypted</b> is set to <code>true</code>, \n \tyou must specify a CMK ARN. </p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) \n \tkey to be used to encrypt the snapshot. If you do not specify a \n KMS key, the default Amazon Web Services managed KMS key is used.</p>\n <p>If you specify a <b>ParentSnapshotId</b>, omit this\n parameter; the snapshot will be encrypted using the same KMS key that was used to encrypt\n the parent snapshot.</p>\n <p>If <b>Encrypted</b> is set to <code>true</code>, \n you must specify a KMS key ARN. </p>"
|
||||
}
|
||||
},
|
||||
"Timeout": {
|
||||
|
|
@ -1141,7 +1141,7 @@
|
|||
"OwnerId": {
|
||||
"target": "com.amazonaws.ebs#OwnerId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS account ID of the snapshot owner.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services account ID of the snapshot owner.</p>"
|
||||
}
|
||||
},
|
||||
"Status": {
|
||||
|
|
@ -1183,7 +1183,7 @@
|
|||
"KmsKeyArn": {
|
||||
"target": "com.amazonaws.ebs#KmsKeyArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer\n master key (CMK) used to encrypt the snapshot.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -10080,7 +10080,7 @@
|
|||
"target": "com.amazonaws.ec2#KeyPair"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public\n key and displays the private key for you to save to a file. The private key is returned\n as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name\n already exists, Amazon EC2 returns an error.</p>\n <p>You can have up to five thousand key pairs per Region.</p>\n\t\t <p>The key pair returned to you is available only in the Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using <a>ImportKeyPair</a>.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Creates an ED25519 or 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public\n key and displays the private key for you to save to a file. The private key is returned\n as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name\n already exists, Amazon EC2 returns an error.</p>\n\t\t <p>The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using <a>ImportKeyPair</a>.</p>\n <p>You can have up to 5,000 key pairs per Amazon Web Services Region.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 key pairs</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ec2#CreateKeyPairRequest": {
|
||||
|
|
@ -10101,6 +10101,12 @@
|
|||
"smithy.api#xmlName": "dryRun"
|
||||
}
|
||||
},
|
||||
"KeyType": {
|
||||
"target": "com.amazonaws.ec2#KeyType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of key pair. Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.</p>\n <p>Default: <code>rsa</code>\n </p>"
|
||||
}
|
||||
},
|
||||
"TagSpecifications": {
|
||||
"target": "com.amazonaws.ec2#TagSpecificationList",
|
||||
"traits": {
|
||||
|
|
@ -11477,7 +11483,7 @@
|
|||
"target": "com.amazonaws.ec2#CreateSecurityGroupResult"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a security group.</p>\n <p>A security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in \n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i> and \n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <p>When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.</p>\n <p>You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.</p>\n <p>You can add or remove rules from your security groups using \n\t\t\t\t\t<a>AuthorizeSecurityGroupIngress</a>,\n\t\t\t\t\t<a>AuthorizeSecurityGroupEgress</a>,\n\t\t\t\t\t<a>RevokeSecurityGroupIngress</a>, and\n\t\t\t\t\t<a>RevokeSecurityGroupEgress</a>.</p>\n <p>For more information about VPC security group limits, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html\">Amazon VPC Limits</a>.</p>"
|
||||
"smithy.api#documentation": "<p>Creates a security group.</p>\n <p>A security group acts as a virtual firewall for your instance to control inbound and outbound traffic.\n For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 security groups</a> in \n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i> and \n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security groups for your VPC</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <p>When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.</p>\n <p>You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.</p>\n <p>You can add or remove rules from your security groups using \n\t\t\t\t\t<a>AuthorizeSecurityGroupIngress</a>,\n\t\t\t\t\t<a>AuthorizeSecurityGroupEgress</a>,\n\t\t\t\t\t<a>RevokeSecurityGroupIngress</a>, and\n\t\t\t\t\t<a>RevokeSecurityGroupEgress</a>.</p>\n <p>For more information about VPC security group limits, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html\">Amazon VPC Limits</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ec2#CreateSecurityGroupRequest": {
|
||||
|
|
@ -21062,7 +21068,7 @@
|
|||
"target": "com.amazonaws.ec2#DescribeKeyPairsResult"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the specified key pairs or all of your key pairs.</p>\n <p>For more information about key pairs, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Describes the specified key pairs or all of your key pairs.</p>\n <p>For more information about key pairs, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 key pairs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"smithy.api#suppress": [
|
||||
"WaitableTraitInvalidErrorType"
|
||||
],
|
||||
|
|
@ -23856,7 +23862,7 @@
|
|||
"target": "com.amazonaws.ec2#DescribeSecurityGroupsResult"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the specified security groups or all of your security groups.</p>\n <p>A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in \n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i> and \n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>Describes the specified security groups or all of your security groups.</p>\n <p>A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 security groups</a> in \n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i> and \n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security groups for your VPC</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -37092,7 +37098,7 @@
|
|||
"target": "com.amazonaws.ec2#ImportKeyPairResult"
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Imports the public key from an RSA key pair that you created with a third-party tool. \n Compare this with <a>CreateKeyPair</a>, in which Amazon Web Services creates the key pair and gives the keys to you \n (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. \n The private key is never transferred between you and Amazon Web Services.</p>\n <p>For more information about key pairs, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. \n Compare this with <a>CreateKeyPair</a>, in which Amazon Web Services creates the key pair and gives the keys to you \n (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. \n The private key is never transferred between you and Amazon Web Services.</p>\n <p>For more information about key pairs, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 key pairs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ec2#ImportKeyPairRequest": {
|
||||
|
|
@ -42547,7 +42553,7 @@
|
|||
"target": "com.amazonaws.ec2#SensitiveUserData",
|
||||
"traits": {
|
||||
"aws.protocols#ec2QueryName": "KeyMaterial",
|
||||
"smithy.api#documentation": "<p>An unencrypted PEM encoded RSA private key.</p>",
|
||||
"smithy.api#documentation": "<p>An unencrypted PEM encoded RSA or ED25519 private key.</p>",
|
||||
"smithy.api#xmlName": "keyMaterial"
|
||||
}
|
||||
},
|
||||
|
|
@ -42607,7 +42613,7 @@
|
|||
"target": "com.amazonaws.ec2#String",
|
||||
"traits": {
|
||||
"aws.protocols#ec2QueryName": "KeyFingerprint",
|
||||
"smithy.api#documentation": "<p>If you used <a>CreateKeyPair</a> to create the key pair, this is the SHA-1 digest of the DER encoded private key. \n If you used <a>ImportKeyPair</a> to provide Amazon Web Services the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.</p>",
|
||||
"smithy.api#documentation": "<p>If you used <a>CreateKeyPair</a> to create the key pair:</p>\n <ul>\n <li>\n <p>For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. \n </p>\n </li>\n <li>\n <p>For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which \n is the default for OpenSSH, starting with <a href=\"http://www.openssh.com/txt/release-6.8\">OpenSSH 6.8</a>.</p>\n </li>\n </ul>\n <p>If you used <a>ImportKeyPair</a> to provide Amazon Web Services the public key:</p>\n <ul>\n <li>\n <p>For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.</p>\n </li>\n <li>\n <p>For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256\n digest, which is the default for OpenSSH, starting with <a href=\"http://www.openssh.com/txt/release-6.8\">OpenSSH 6.8</a>.</p>\n </li>\n </ul>",
|
||||
"smithy.api#xmlName": "keyFingerprint"
|
||||
}
|
||||
},
|
||||
|
|
@ -42619,6 +42625,14 @@
|
|||
"smithy.api#xmlName": "keyName"
|
||||
}
|
||||
},
|
||||
"KeyType": {
|
||||
"target": "com.amazonaws.ec2#KeyType",
|
||||
"traits": {
|
||||
"aws.protocols#ec2QueryName": "KeyType",
|
||||
"smithy.api#documentation": "<p>The type of key pair.</p>",
|
||||
"smithy.api#xmlName": "keyType"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.ec2#TagList",
|
||||
"traits": {
|
||||
|
|
@ -42644,6 +42658,21 @@
|
|||
"com.amazonaws.ec2#KeyPairName": {
|
||||
"type": "string"
|
||||
},
|
||||
"com.amazonaws.ec2#KeyType": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#enum": [
|
||||
{
|
||||
"value": "rsa",
|
||||
"name": "rsa"
|
||||
},
|
||||
{
|
||||
"value": "ed25519",
|
||||
"name": "ed25519"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ec2#KmsKeyId": {
|
||||
"type": "string"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -603,7 +603,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the <a>RunTask</a> or <a>CreateCluster</a> APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the <a>CreateCluster</a> API.</p>\n\t\t <p>Only capacity providers that are already associated with a cluster and have an\n\t\t\t\t<code>ACTIVE</code> or <code>UPDATING</code> status can be used in a capacity\n\t\t\tprovider strategy. The <a>PutClusterCapacityProviders</a> API is used to\n\t\t\tassociate a capacity provider with a cluster.</p>\n\t\t <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the <a>CreateCapacityProvider</a> API operation.</p>\n\t\t <p>To use a Fargate capacity provider, specify either the <code>FARGATE</code> or\n\t\t\t\t<code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.</p>"
|
||||
"smithy.api#documentation": "<p>The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the <a>RunTask</a> or <a>CreateCluster</a> APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the <a>CreateCluster</a> API.</p>\n\t\t <p>Only capacity providers that are already associated with a cluster and have an\n\t\t\t\t<code>ACTIVE</code> or <code>UPDATING</code> status can be used in a capacity\n\t\t\tprovider strategy. The <a>PutClusterCapacityProviders</a> API is used to\n\t\t\tassociate a capacity provider with a cluster.</p>\n\t\t <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the <a>CreateCapacityProvider</a> API operation.</p>\n\t\t <p>To use a Fargate capacity provider, specify either the <code>FARGATE</code> or\n\t\t\t\t<code>FARGATE_SPOT</code> capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.</p> \n <p>A capacity provider strategy may contain a maximum of 6 capacity providers.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ecs#CapacityProviderStrategyItemBase": {
|
||||
|
|
@ -679,7 +679,7 @@
|
|||
"clusterArn": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the cluster, the account ID of the cluster owner, the <code>cluster</code> namespace, and then the cluster name. For example, <code>arn:aws:ecs:region:012345678910:cluster/test</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the cluster, the Amazon Web Services account ID of the cluster owner, the <code>cluster</code> namespace, and then the cluster name. For example, <code>arn:aws:ecs:region:012345678910:cluster/test</code>.</p>"
|
||||
}
|
||||
},
|
||||
"clusterName": {
|
||||
|
|
@ -1364,7 +1364,7 @@
|
|||
"containerInstanceArn": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
|
||||
}
|
||||
},
|
||||
"ec2InstanceId": {
|
||||
|
|
@ -1766,7 +1766,7 @@
|
|||
"defaultCapacityProviderStrategy": {
|
||||
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The capacity provider strategy to set as the default for the cluster. When a default\n\t\t\tcapacity provider strategy is set for a cluster, when calling the <a>RunTask</a> or <a>CreateService</a> APIs wtih no capacity\n\t\t\tprovider strategy or launch type specified, the default capacity provider strategy for\n\t\t\tthe cluster is used.</p>\n\t\t <p>If a default capacity provider strategy is not defined for a cluster during creation,\n\t\t\tit can be defined later with the <a>PutClusterCapacityProviders</a> API\n\t\t\toperation.</p>"
|
||||
"smithy.api#documentation": "<p>The capacity provider strategy to set as the default for the cluster. When a default\n\t\t\tcapacity provider strategy is set for a cluster, when calling the <a>RunTask</a> or <a>CreateService</a> APIs with no capacity\n\t\t\tprovider strategy or launch type specified, the default capacity provider strategy for\n\t\t\tthe cluster is used.</p>\n\t\t <p>If a default capacity provider strategy is not defined for a cluster during creation,\n\t\t\tit can be defined later with the <a>PutClusterCapacityProviders</a> API\n\t\t\toperation.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1875,7 +1875,7 @@
|
|||
"capacityProviderStrategy": {
|
||||
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The capacity provider strategy to use for the service.</p>\n\t\t <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>\n\t\t\tparameter must be omitted. If no <code>capacityProviderStrategy</code> or\n\t\t\t\t<code>launchType</code> is specified, the\n\t\t\t\t<code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>"
|
||||
"smithy.api#documentation": "<p>The capacity provider strategy to use for the service.</p>\n\t\t <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>\n\t\t\tparameter must be omitted. If no <code>capacityProviderStrategy</code> or\n\t\t\t\t<code>launchType</code> is specified, the\n\t\t\t\t<code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>\n\t\t <p>A capacity provider strategy may contain a maximum of 6 capacity providers.</p>"
|
||||
}
|
||||
},
|
||||
"platformVersion": {
|
||||
|
|
@ -1899,13 +1899,13 @@
|
|||
"placementConstraints": {
|
||||
"target": "com.amazonaws.ecs#PlacementConstraints",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints per task (this limit includes constraints in the\n\t\t\ttask definition and those specified at runtime). </p>"
|
||||
"smithy.api#documentation": "<p>An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints per task (this limit includes constraints in the\n\t\t\ttask definition and those specified at runtime).</p>"
|
||||
}
|
||||
},
|
||||
"placementStrategy": {
|
||||
"target": "com.amazonaws.ecs#PlacementStrategies",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of five strategy rules per service.</p>"
|
||||
"smithy.api#documentation": "<p>The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of 5 strategy rules per service.</p>"
|
||||
}
|
||||
},
|
||||
"networkConfiguration": {
|
||||
|
|
@ -2712,7 +2712,7 @@
|
|||
"containerInstance": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The container instance ID or full ARN of the container instance to deregister.\n\t\t\tThe ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>",
|
||||
"smithy.api#documentation": "<p>The container instance ID or full ARN of the container instance to deregister.\n\t\t\tThe ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -2891,7 +2891,7 @@
|
|||
"include": {
|
||||
"target": "com.amazonaws.ecs#ClusterFieldList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Whether to include additional information about the clusters in the response. If this\n\t\t\tfield is omitted, this information isn't included.</p>\n\t\t <p>If <code>ATTACHMENTS</code> is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.</p>\n\t\t <p>If <code>SETTINGS</code> is specified, the settings for the cluster are\n\t\t\tincluded.</p>\n\t\t <p>If <code>STATISTICS</code> is specified, the task and service count is included,\n\t\t\tseparated by launch type.</p>\n\t\t <p>If <code>TAGS</code> is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.</p>"
|
||||
"smithy.api#documentation": "<p>Whether to include additional information about the clusters in the response. If this\n\t\t\tfield is omitted, this information isn't included.</p>\n\t\t <p>If <code>ATTACHMENTS</code> is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.</p>\n\t\t <p>If <code>SETTINGS</code> is specified, the settings for the cluster are\n\t\t\tincluded.</p>\n\t\t <p>If <code>CONFIGURATIONS</code> is specified, the configuration for the cluster is\n\t\t\tincluded.</p>\n\t\t <p>If <code>STATISTICS</code> is specified, the task and service count is included,\n\t\t\tseparated by launch type.</p>\n\t\t <p>If <code>TAGS</code> is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -3440,7 +3440,7 @@
|
|||
"containerInstance": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The container instance ID or full ARN of the container instance.\n\t\t\tThe ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The container instance ID or full ARN of the container instance.\n\t\t\tThe ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID</code>.</p>"
|
||||
}
|
||||
},
|
||||
"cluster": {
|
||||
|
|
@ -4001,7 +4001,7 @@
|
|||
"command": {
|
||||
"target": "com.amazonaws.ecs#StringList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with <code>CMD</code> to execute the command\n\t\t\targuments directly, or <code>CMD-SHELL</code> to run the command with the container's\n\t\t\tdefault shell. For example:</p>\n\t\t <p>\n\t\t\t <code>[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]</code>\n\t\t </p>\n\t\t <p>An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see <code>HealthCheck</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a>\n\t\t\tsection of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a>.</p>",
|
||||
"smithy.api#documentation": "<p>A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with <code>CMD</code> to execute the command\n\t\t\targuments directly, or <code>CMD-SHELL</code> to run the command with the container's\n\t\t\tdefault shell. </p>\n\t\t <p> When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, you should enclose the list of commands in brackets, as shown below.</p>\n\t\t <p>\n\t\t\t <code>[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]</code>\n\t\t </p>\n\t\t <p>You do not need to include the brackets when you use the Amazon Web Services Management Consoleas shown below.</p>\n\t\t <p>\n\t\t\t <code> \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" </code>\n\t\t </p>\n\t\t <p>An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see <code>HealthCheck</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a>\n\t\t\tsection of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -5517,7 +5517,7 @@
|
|||
"expression": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A cluster query language expression to apply to the constraint. You cannot specify an\n\t\t\texpression if the constraint type is <code>distinctInstance</code>. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>A cluster query language expression to apply to the constraint. The expression can\n\t\t\thave a maximum length of 2000 characters. You can't specify an expression if the\n\t\t\tconstraint type is <code>distinctInstance</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster query language</a> in the\n\t\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -6402,7 +6402,7 @@
|
|||
"capacityProviderStrategy": {
|
||||
"target": "com.amazonaws.ecs#CapacityProviderStrategy",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The capacity provider strategy to use for the task.</p>\n\t\t <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>\n\t\t\tparameter must be omitted. If no <code>capacityProviderStrategy</code> or\n\t\t\t\t<code>launchType</code> is specified, the\n\t\t\t\t<code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>\n\t\t <p>When you use cluster auto scaling, you must specify <code>capacityProviderStrategy</code> and not <code>launchType</code>. </p>"
|
||||
"smithy.api#documentation": "<p>The capacity provider strategy to use for the task.</p>\n\t\t <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code>\n\t\t\tparameter must be omitted. If no <code>capacityProviderStrategy</code> or\n\t\t\t\t<code>launchType</code> is specified, the\n\t\t\t\t<code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>\n\t\t <p>When you use cluster auto scaling, you must specify <code>capacityProviderStrategy</code> and not <code>launchType</code>. </p>\n\t\t <p>A capacity provider strategy may contain a maximum of 6 capacity providers.</p>"
|
||||
}
|
||||
},
|
||||
"cluster": {
|
||||
|
|
@ -6432,7 +6432,7 @@
|
|||
"group": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).</p>"
|
||||
"smithy.api#documentation": "<p>The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, <code>family:my-family-name</code>).</p>"
|
||||
}
|
||||
},
|
||||
"launchType": {
|
||||
|
|
@ -6444,13 +6444,13 @@
|
|||
"networkConfiguration": {
|
||||
"target": "com.amazonaws.ecs#NetworkConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the <code>awsvpc</code> network mode to receive their own elastic\n\t\t\tnetwork interface, and it is not supported for other network modes. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the <code>awsvpc</code> network mode to receive their own elastic\n\t\t\tnetwork interface, and it is not supported for other network modes. For more\n\t\t\tinformation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task networking</a>\n\t\t\tin the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"overrides": {
|
||||
"target": "com.amazonaws.ecs#TaskOverride",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that is specified in the task definition or Docker\n\t\t\timage) with a <code>command</code> override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an <code>environment</code> override.</p>\n\t\t <note>\n\t\t\t <p>A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.</p>\n\t\t </note>"
|
||||
"smithy.api#documentation": "<p>A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that is specified in the task definition or Docker\n\t\t\timage) with a <code>command</code> override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an <code>environment</code> override.</p>\n\t\t <p>A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.</p>"
|
||||
}
|
||||
},
|
||||
"placementConstraints": {
|
||||
|
|
@ -6462,13 +6462,13 @@
|
|||
"placementStrategy": {
|
||||
"target": "com.amazonaws.ecs#PlacementStrategies",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The placement strategy objects to use for the task. You can specify a maximum of five\n\t\t\tstrategy rules per task.</p>"
|
||||
"smithy.api#documentation": "<p>The placement strategy objects to use for the task. You can specify a maximum of 5\n\t\t\tstrategy rules per task.</p>"
|
||||
}
|
||||
},
|
||||
"platformVersion": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The platform version the task should run. A platform version is only specified for\n\t\t\ttasks using the Fargate launch type. If one is not specified, the\n\t\t\t\t<code>LATEST</code> platform version is used by default. For more information, see\n\t\t\t\t<a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">Fargate Platform\n\t\t\t\tVersions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The platform version the task should use. A platform version is only specified for\n\t\t\ttasks hosted on Fargate. If one is not specified, the <code>LATEST</code>\n\t\t\tplatform version is used by default. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">Fargate platform versions</a> in the\n\t\t\t<i>Amazon Elastic Container Service Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"propagateTags": {
|
||||
|
|
@ -6480,7 +6480,7 @@
|
|||
"referenceId": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The reference ID to use for the task.</p>"
|
||||
"smithy.api#documentation": "<p>The reference ID to use for the task. The reference ID can have a maximum length of\n\t\t\t1024 characters.</p>"
|
||||
}
|
||||
},
|
||||
"startedBy": {
|
||||
|
|
@ -6634,7 +6634,7 @@
|
|||
"serviceArn": {
|
||||
"target": "com.amazonaws.ecs#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN that identifies the service. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the service, the account ID of the service owner, the <code>service</code> namespace, and then the service name. For example, <code>arn:aws:ecs:region:012345678910:service/my-service</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The ARN that identifies the service. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the service, the Amazon Web Services account ID of the service owner, the <code>service</code> namespace, and then the service name. For example, <code>arn:aws:ecs:region:012345678910:service/my-service</code>.</p>"
|
||||
}
|
||||
},
|
||||
"serviceName": {
|
||||
|
|
|
|||
|
|
@ -114,7 +114,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A tag is a key-value pair where the key and value are case-sensitive. \n You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. \n For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html\">Resource-level permissions</a>.</p>\n <p>\n For example, you can use cost-allocation tags to your ElastiCache resources, \n AWS generates a cost allocation report as a comma-separated value (CSV) file \n with your usage and costs aggregated by your tags. \n You can apply tags that represent business categories (such as cost centers, application names, or owners) \n to organize your costs across multiple services.</p>\n <p>For more information, \n see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html\">Using Cost Allocation Tags in Amazon ElastiCache</a> \n in the <i>ElastiCache User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>A tag is a key-value pair where the key and value are case-sensitive. \n You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. \n For more information, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/IAM.ResourceLevelPermissions.html\">Resource-level permissions</a>.</p>\n <p>\n For example, you can use cost-allocation tags to your ElastiCache resources, \n Amazon generates a cost allocation report as a comma-separated value (CSV) file \n with your usage and costs aggregated by your tags. \n You can apply tags that represent business categories (such as cost centers, application names, or owners) \n to organize your costs across multiple services.</p>\n <p>For more information, \n see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html\">Using Cost Allocation Tags in Amazon ElastiCache</a> \n in the <i>ElastiCache User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.elasticache#AddTagsToResourceMessage": {
|
||||
|
|
@ -123,7 +123,7 @@
|
|||
"ResourceName": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource to which the tags are to be added, \n for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> \n or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.\n ElastiCache resources are <i>cluster</i> and <i>snapshot</i>.</p>\n <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource to which the tags are to be added, \n for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> \n or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.\n ElastiCache resources are <i>cluster</i> and <i>snapshot</i>.</p>\n <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Service Namespaces</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -540,7 +540,7 @@
|
|||
"EC2SecurityGroupOwnerId": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an AWS access key ID - \n you must provide a valid AWS account number for this parameter.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an Amazon access key ID - \n you must provide a valid Amazon account number for this parameter.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -1036,7 +1036,7 @@
|
|||
"CacheNodeId": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.</p>"
|
||||
"smithy.api#documentation": "<p>The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's Amazon account.</p>"
|
||||
}
|
||||
},
|
||||
"CacheNodeStatus": {
|
||||
|
|
@ -1459,7 +1459,7 @@
|
|||
"OwnerId": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS account ID of the cache security group owner.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon account ID of the cache security group owner.</p>"
|
||||
}
|
||||
},
|
||||
"CacheSecurityGroupName": {
|
||||
|
|
@ -2467,7 +2467,7 @@
|
|||
"GlobalReplicationGroupIdSuffix": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix \n to the Global datastore ID when it is created. Each AWS Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions. </p>\n <p>For a full list of AWS Regions and their respective Global datastore iD prefixes, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastores-CLI.html\">Using the AWS CLI with Global datastores </a>.</p>",
|
||||
"smithy.api#documentation": "<p>The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix \n to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with \"dsdfu\" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions. </p>\n <p>For a full list of Amazon Regions and their respective Global datastore iD prefixes, see <a href=\"http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastores-CLI.html\">Using the Amazon CLI with Global datastores </a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -2562,7 +2562,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p>\n <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.</p>\n <p>A Redis (cluster mode disabled) replication group is a collection of clusters, \n where one of the clusters is a read/write primary and the others are read-only replicas. \n Writes to the primary are asynchronously propagated to the replicas.</p>\n <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). \n Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.\n \n </p>\n <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between \n 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. \n Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html\">Creating a Subnet Group</a>. For versions below 5.0.6, \n the limit is 250 per cluster.</p>\n <p>To request a limit increase, see \n <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> \n and choose the limit type <b>Nodes per cluster per instance type</b>. </p>\n <p>When a Redis (cluster mode disabled) replication group has been successfully created, \n you can add one or more read replicas to it, up to a total of 5 read replicas. \n If you need to increase or decrease the number of node groups (console: shards), \n you can avail yourself of ElastiCache for Redis' scaling. For more information,\n see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html\">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p>\n \n \n <note>\n <p>This operation is valid for Redis only.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p>\n <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.</p>\n <p>A Redis (cluster mode disabled) replication group is a collection of clusters, \n where one of the clusters is a read/write primary and the others are read-only replicas. \n Writes to the primary are asynchronously propagated to the replicas.</p>\n <p>A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). \n Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.\n \n </p>\n <p>The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between \n 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. \n Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see \n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Creating.html\">Creating a Subnet Group</a>. For versions below 5.0.6, \n the limit is 250 per cluster.</p>\n <p>To request a limit increase, see \n <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">Amazon Service Limits</a> \n and choose the limit type <b>Nodes per cluster per instance type</b>. </p>\n <p>When a Redis (cluster mode disabled) replication group has been successfully created, \n you can add one or more read replicas to it, up to a total of 5 read replicas. \n If you need to increase or decrease the number of node groups (console: shards), \n you can avail yourself of ElastiCache for Redis' scaling. For more information,\n see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html\">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p>\n \n \n <note>\n <p>This operation is valid for Redis only.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.elasticache#CreateReplicationGroupMessage": {
|
||||
|
|
@ -3689,6 +3689,9 @@
|
|||
"items": "CacheClusters",
|
||||
"pageSize": "MaxRecords"
|
||||
},
|
||||
"smithy.api#suppress": [
|
||||
"WaitableTraitInvalidErrorType"
|
||||
],
|
||||
"smithy.waiters#waitable": {
|
||||
"CacheClusterAvailable": {
|
||||
"documentation": "Wait until ElastiCache cluster is available.",
|
||||
|
|
@ -3745,6 +3748,88 @@
|
|||
}
|
||||
],
|
||||
"minDelay": 15
|
||||
},
|
||||
"CacheClusterDeleted": {
|
||||
"documentation": "Wait until ElastiCache cluster is deleted.",
|
||||
"acceptors": [
|
||||
{
|
||||
"state": "success",
|
||||
"matcher": {
|
||||
"output": {
|
||||
"path": "CacheClusters[].CacheClusterStatus",
|
||||
"expected": "deleted",
|
||||
"comparator": "allStringEquals"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"state": "success",
|
||||
"matcher": {
|
||||
"errorType": "CacheClusterNotFound"
|
||||
}
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": {
|
||||
"output": {
|
||||
"path": "CacheClusters[].CacheClusterStatus",
|
||||
"expected": "available",
|
||||
"comparator": "anyStringEquals"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": {
|
||||
"output": {
|
||||
"path": "CacheClusters[].CacheClusterStatus",
|
||||
"expected": "creating",
|
||||
"comparator": "anyStringEquals"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": {
|
||||
"output": {
|
||||
"path": "CacheClusters[].CacheClusterStatus",
|
||||
"expected": "incompatible-network",
|
||||
"comparator": "anyStringEquals"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": {
|
||||
"output": {
|
||||
"path": "CacheClusters[].CacheClusterStatus",
|
||||
"expected": "modifying",
|
||||
"comparator": "anyStringEquals"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": {
|
||||
"output": {
|
||||
"path": "CacheClusters[].CacheClusterStatus",
|
||||
"expected": "restore-failed",
|
||||
"comparator": "anyStringEquals"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": {
|
||||
"output": {
|
||||
"path": "CacheClusters[].CacheClusterStatus",
|
||||
"expected": "snapshotting",
|
||||
"comparator": "anyStringEquals"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"minDelay": 15
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -5014,7 +5099,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that AWS region.</p>"
|
||||
"smithy.api#documentation": "<p>Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage": {
|
||||
|
|
@ -5037,7 +5122,7 @@
|
|||
"ReplicationGroupRegion": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS region of secondary cluster you wish to remove from the Global datastore</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon region of secondary cluster you wish to remove from the Global datastore</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -5089,7 +5174,7 @@
|
|||
"EC2SecurityGroupOwnerId": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS account ID of the Amazon EC2 security group owner.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon account ID of the Amazon EC2 security group owner.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5267,7 +5352,7 @@
|
|||
"PrimaryRegion": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS region of the primary cluster of the Global datastore</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon region of the primary cluster of the Global datastore</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -5460,7 +5545,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary\n cluster automatically replicates updates to the secondary cluster.</p>\n \n \n <ul>\n <li>\n <p>The <b>GlobalReplicationGroupIdSuffix</b> represents the name of the Global datastore,\n which is what you use to associate a secondary cluster.</p> \n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary\n cluster automatically replicates updates to the secondary cluster.</p>\n \n \n <ul>\n <li>\n <p>The <b>GlobalReplicationGroupIdSuffix</b> represents the name of the Global datastore,\n which is what you use to associate a secondary cluster.</p> \n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.elasticache#GlobalReplicationGroupAlreadyExistsFault": {
|
||||
|
|
@ -5521,7 +5606,7 @@
|
|||
"ReplicationGroupRegion": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS region of the Global datastore member.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon region of the Global datastore member.</p>"
|
||||
}
|
||||
},
|
||||
"Role": {
|
||||
|
|
@ -5544,7 +5629,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A member of a Global datastore. It contains the Replication Group Id, the AWS region and the role of the replication group. </p>"
|
||||
"smithy.api#documentation": "<p>A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.elasticache#GlobalReplicationGroupMemberList": {
|
||||
|
|
@ -5616,7 +5701,7 @@
|
|||
"RegionalConfigurations": {
|
||||
"target": "com.amazonaws.elasticache#RegionalConfigurationList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global datastore</p>"
|
||||
"smithy.api#documentation": "<p>Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore</p>"
|
||||
}
|
||||
},
|
||||
"ApplyImmediately": {
|
||||
|
|
@ -6114,7 +6199,7 @@
|
|||
"ResourceName": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource for which you want the list of tags, \n for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> \n or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p>\n <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource for which you want the list of tags, \n for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> \n or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p>\n <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -6754,7 +6839,7 @@
|
|||
"MultiAZEnabled": {
|
||||
"target": "com.amazonaws.elasticache#BooleanOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.</p>"
|
||||
"smithy.api#documentation": "<p>A flag to indicate MultiAZ is enabled.</p>"
|
||||
}
|
||||
},
|
||||
"NodeGroupId": {
|
||||
|
|
@ -8125,7 +8210,7 @@
|
|||
"ReplicationGroupRegion": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS region where the cluster is stored</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon region where the cluster is stored</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -8212,7 +8297,7 @@
|
|||
"ResourceName": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource from which you want the tags removed, \n for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> \n or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p>\n <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource from which you want the tags removed, \n for example <code>arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster</code> \n or <code>arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot</code>.</p>\n <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Service Namespaces</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -8383,6 +8468,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns the destination, format and type of the logs. </p>"
|
||||
}
|
||||
},
|
||||
"ReplicationGroupCreateTime": {
|
||||
"target": "com.amazonaws.elasticache#TStamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The date and time when the cluster was created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -8967,7 +9058,7 @@
|
|||
"EC2SecurityGroupOwnerId": {
|
||||
"target": "com.amazonaws.elasticache#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an AWS access key ID - you must provide \n a valid AWS account number for this parameter.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon account number of the Amazon EC2 security group owner. \n Note that this is not the same thing as an Amazon access key ID - you must provide \n a valid Amazon account number for this parameter.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -9814,7 +9905,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on\n a specified node group (called shard in the console) in a replication group (called cluster in the console).</p>\n \n <p class=\"title\">\n <b>Note the following</b>\n </p>\n <ul>\n <li>\n <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) \n in any rolling 24-hour period.</p>\n </li>\n <li>\n <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p>\n <p> </p>\n </li>\n <li>\n <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, \n the first node replacement must complete before a subsequent call can be made.</p>\n </li>\n <li>\n <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,\n the AWS CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order of occurrance:</p> \n <ol>\n <li>\n <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>\n </p>\n </li>\n <li>\n <p>Replication group message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Recovering cache nodes <node-id></code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code>\n </p>\n </li>\n </ol>\n \n <p>For more information see:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html\">Viewing ElastiCache Events</a>\n in the <i>ElastiCache User Guide</i>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> in the ElastiCache API Reference</p>\n </li>\n </ul>\n </li>\n </ul>\n \n <p>Also see, <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test\">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on\n a specified node group (called shard in the console) in a replication group (called cluster in the console).</p>\n \n <p class=\"title\">\n <b>Note the following</b>\n </p>\n <ul>\n <li>\n <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) \n in any rolling 24-hour period.</p>\n </li>\n <li>\n <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p>\n <p> </p>\n </li>\n <li>\n <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, \n the first node replacement must complete before a subsequent call can be made.</p>\n </li>\n <li>\n <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console,\n the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order of occurrance:</p> \n <ol>\n <li>\n <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>\n </p>\n </li>\n <li>\n <p>Replication group message: <code>Failover from primary node <primary-node-id> to replica node <node-id> completed</code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Recovering cache nodes <node-id></code>\n </p>\n </li>\n <li>\n <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code>\n </p>\n </li>\n </ol>\n \n <p>For more information see:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html\">Viewing ElastiCache Events</a>\n in the <i>ElastiCache User Guide</i>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> in the ElastiCache API Reference</p>\n </li>\n </ul>\n </li>\n </ul>\n \n <p>Also see, <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test\">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.elasticache#TestFailoverMessage": {
|
||||
|
|
|
|||
|
|
@ -871,7 +871,7 @@
|
|||
"VisibleToAllUsers": {
|
||||
"target": "com.amazonaws.emr#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When <code>true</code>, IAM principals in the\n account can perform EMR cluster actions on the cluster that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.</p>\n <p>The default value is <code>false</code> if a value is not provided when creating a cluster using the EMR API <a>RunJobFlow</a> command or the CLI <a href=\"https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html\">create-cluster</a> command. The default value is <code>true</code> when a cluster is created using the Management Console. IAM principals that are allowed to perform actions on the cluster can use the <a>SetVisibleToAllUsers</a> action to change the value on a running cluster. For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users\">Understanding the EMR Cluster VisibleToAllUsers Setting</a> in the <i>Amazon EMR Management Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When <code>true</code>, IAM principals in the\n account can perform EMR cluster actions on the cluster that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.</p>\n <p>The default value is <code>true</code> if a value is not provided when creating a\n cluster using the EMR API <a>RunJobFlow</a> command, the CLI\n <a href=\"https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html\">create-cluster</a> command, or the Management Console. IAM principals that are\n allowed to perform actions on the cluster can use the <a>SetVisibleToAllUsers</a> action to change the value on a running cluster. For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users\">Understanding the EMR Cluster VisibleToAllUsers Setting</a> in the <i>Amazon EMRManagement Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"Applications": {
|
||||
|
|
@ -1538,13 +1538,13 @@
|
|||
"IdentityId": {
|
||||
"target": "com.amazonaws.emr#XmlStringMaxLen256",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity\n Store. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId\">UserId</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId\">GroupId</a> in the <i>Amazon Web Services SSO Identity Store API Reference</i>.\n Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
|
||||
"smithy.api#documentation": "<p>The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity\n Store. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId\">UserId</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-GroupId\">GroupId</a> in the <i>Amazon Web Services SSO Identity Store API Reference</i>.\n Either <code>IdentityName</code> or <code>IdentityId</code> must be specified, but not both.</p>"
|
||||
}
|
||||
},
|
||||
"IdentityName": {
|
||||
"target": "com.amazonaws.emr#XmlStringMaxLen256",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the user or group. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>Amazon Web Services SSO Identity Store API Reference</i>.\n Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the user or group. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>Amazon Web Services SSO Identity Store API Reference</i>.\n Either <code>IdentityName</code> or <code>IdentityId</code> must be specified, but not both.</p>"
|
||||
}
|
||||
},
|
||||
"IdentityType": {
|
||||
|
|
@ -1696,7 +1696,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides cluster-level details including status, hardware and software configuration,\n VPC settings, and so on. </p>",
|
||||
"smithy.api#documentation": "<p>Provides cluster-level details including status, hardware and software configuration,\n VPC settings, and so on.</p>",
|
||||
"smithy.waiters#waitable": {
|
||||
"ClusterRunning": {
|
||||
"acceptors": [
|
||||
|
|
@ -2524,7 +2524,7 @@
|
|||
},
|
||||
"aws.protocols#awsJson1_1": {},
|
||||
"smithy.api#documentation": "<p>Amazon EMR is a web service that makes it easier to process large amounts of data\n efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do\n tasks such as web indexing, data mining, log file analysis, machine learning, scientific\n simulation, and data warehouse management.</p>",
|
||||
"smithy.api#title": "Amazon Elastic MapReduce",
|
||||
"smithy.api#title": "Amazon EMR",
|
||||
"smithy.api#xmlNamespace": {
|
||||
"uri": "http://elasticmapreduce.amazonaws.com/doc/2009-03-31"
|
||||
}
|
||||
|
|
@ -3349,6 +3349,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically\n adds and terminates EC2 instances in response to the value of a CloudWatch metric. See\n PutAutoScalingPolicy.</p>"
|
||||
}
|
||||
},
|
||||
"CustomAmiId": {
|
||||
"target": "com.amazonaws.emr#XmlStringMaxLen256",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The custom AMI ID to use for the provisioned instance group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -3414,6 +3420,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically\n adds and terminates EC2 instances in response to the value of a CloudWatch metric. See\n <a>PutAutoScalingPolicy</a>.</p>"
|
||||
}
|
||||
},
|
||||
"CustomAmiId": {
|
||||
"target": "com.amazonaws.emr#XmlStringMaxLen256",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The custom AMI ID to use for the provisioned instance group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -3519,6 +3531,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The date/time the instance group was terminated.</p>"
|
||||
}
|
||||
},
|
||||
"CustomAmiId": {
|
||||
"target": "com.amazonaws.emr#XmlStringMaxLen256",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The custom AMI ID to use for the provisioned instance group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -3997,6 +4015,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>A configuration classification that applies when provisioning cluster instances, which\n can include configurations for applications and software that run on the cluster.</p>"
|
||||
}
|
||||
},
|
||||
"CustomAmiId": {
|
||||
"target": "com.amazonaws.emr#XmlStringMaxLen256",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The custom AMI ID to use for the instance type.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -4053,6 +4077,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Evaluates to <code>TRUE</code> when the specified <code>InstanceType</code> is\n EBS-optimized.</p>"
|
||||
}
|
||||
},
|
||||
"CustomAmiId": {
|
||||
"target": "com.amazonaws.emr#XmlStringMaxLen256",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The custom AMI ID to use for the instance type.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -4190,7 +4220,7 @@
|
|||
"VisibleToAllUsers": {
|
||||
"target": "com.amazonaws.emr#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When <code>true</code>, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.</p>\n <p>The default value is <code>false</code> if a value is not provided when creating a cluster using the EMR API <a>RunJobFlow</a> command or the CLI <a href=\"https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html\">create-cluster</a> command. The default value is <code>true</code> when a cluster is created using the Management Console. IAM principals that are authorized to perform actions on the cluster can use the <a>SetVisibleToAllUsers</a> action to change the value on a running cluster. For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users\">Understanding the EMR Cluster VisibleToAllUsers Setting</a> in the <i>Amazon EMR Management Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When <code>true</code>, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.</p>\n <p>The default value is <code>true</code> if a value is not provided when creating a\n cluster using the EMR API <a>RunJobFlow</a> command, the CLI\n <a href=\"https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html\">create-cluster</a> command, or the Management Console. IAM principals that are authorized to perform actions on the cluster can use the <a>SetVisibleToAllUsers</a> action to change the value on a running cluster. For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users\">Understanding the EMR Cluster VisibleToAllUsers Setting</a> in the <i>Amazon EMRManagement Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"JobFlowRole": {
|
||||
|
|
@ -5064,7 +5094,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.emr#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the next page of results. If <code>NextToken</code> is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The <code>ListReleaseLabels</code> request fails if the identity (AWS AccountID) and all filtering parameters are different from the original request, or if the <code>NextToken</code> is expired or tampered with.</p>"
|
||||
"smithy.api#documentation": "<p>Specifies the next page of results. If <code>NextToken</code> is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The <code>ListReleaseLabels</code> request fails if the identity (account ID) and all filtering parameters are different from the original request, or if the <code>NextToken</code> is expired or tampered with.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
|
|
@ -6320,7 +6350,7 @@
|
|||
"VisibleToAllUsers": {
|
||||
"target": "com.amazonaws.emr#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Set this value to <code>true</code> so that IAM principals in the account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to <code>false</code> for clusters created using the EMR API or the CLI <a href=\"https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html\">create-cluster</a> command.</p> \n <p>When set to <code>false</code>, only the IAM principal that created the cluster and the account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users\">Understanding the EMR Cluster VisibleToAllUsers Setting</a> in the <i>Amazon EMR Management Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Set this value to <code>true</code> so that IAM principals in the account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to <code>true</code> for clusters created using the EMR API or the CLI <a href=\"https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html\">create-cluster</a> command.</p> \n <p>When set to <code>false</code>, only the IAM principal that created the cluster and the account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users\">Understanding the EMR Cluster VisibleToAllUsers Setting</a> in the <i>Amazon EMRManagement Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"JobFlowRole": {
|
||||
|
|
@ -6740,7 +6770,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Sets the <a>Cluster$VisibleToAllUsers</a> value for an EMR cluster. When <code>true</code>, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.</p>\n <p>This action works on running clusters. When you create a cluster, use the <a>RunJobFlowInput$VisibleToAllUsers</a> parameter.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users\">Understanding the EMR Cluster VisibleToAllUsers Setting</a> in the <i>Amazon EMR Management Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Sets the <a>Cluster$VisibleToAllUsers</a> value for an EMR cluster. When <code>true</code>, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.</p>\n <p>This action works on running clusters. When you create a cluster, use the <a>RunJobFlowInput$VisibleToAllUsers</a> parameter.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/security_iam_emr-with-iam.html#security_set_visible_to_all_users\">Understanding the EMR Cluster VisibleToAllUsers Setting</a> in the <i>Amazon EMRManagement Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.emr#SetVisibleToAllUsersInput": {
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -73,7 +73,7 @@
|
|||
"region": {
|
||||
"target": "com.amazonaws.imagebuilder#NonEmptyString",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Region of the Amazon EC2 AMI.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services Region of the Amazon EC2 AMI.</p>"
|
||||
}
|
||||
},
|
||||
"image": {
|
||||
|
|
@ -144,7 +144,7 @@
|
|||
"launchPermission": {
|
||||
"target": "com.amazonaws.imagebuilder#LaunchPermissionConfiguration",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> Launch permissions can be used to configure which accounts can use the AMI to launch\n\t\t\tinstances.</p>"
|
||||
"smithy.api#documentation": "<p> Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch\n\t\t\tinstances.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -717,7 +717,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The defining characteristics of a specific version of an TOE component.</p>"
|
||||
"smithy.api#documentation": "<p>The defining characteristics of a specific version of an Amazon Web Services TOE component.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.imagebuilder#ComponentVersionArn": {
|
||||
|
|
@ -4844,7 +4844,7 @@
|
|||
"userIds": {
|
||||
"target": "com.amazonaws.imagebuilder#AccountList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The account ID.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services account ID.</p>"
|
||||
}
|
||||
},
|
||||
"userGroups": {
|
||||
|
|
@ -5071,7 +5071,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filters.</p>"
|
||||
"smithy.api#documentation": "<p>Use the following filters to streamline results:</p>\n\t\t <ul>\n <li>\n <p>\n <code>description</code>\n </p>\n </li>\n <li>\n <p>\n <code>name</code>\n </p>\n </li>\n <li>\n <p>\n <code>platform</code>\n </p>\n </li>\n <li>\n <p>\n <code>supportedOsVersion</code>\n </p>\n </li>\n <li>\n <p>\n <code>type</code>\n </p>\n </li>\n <li>\n <p>\n <code>version</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"byName": {
|
||||
|
|
@ -5175,7 +5175,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Request filters that are used to narrow the list of container images that are returned.</p>"
|
||||
"smithy.api#documentation": "<p>Use the following filters to streamline results:</p>\n\t\t <ul>\n <li>\n <p>\n <code>containerType</code>\n </p>\n </li>\n <li>\n <p>\n <code>name</code>\n </p>\n </li>\n <li>\n <p>\n <code>parentImage</code>\n </p>\n </li>\n <li>\n <p>\n <code>platform</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
|
@ -5267,7 +5267,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filters.</p>\n\t\t <ul>\n <li>\n\t\t\t\t <p>\n\t\t\t\t\t <code>name</code> - The name of this distribution configuration.</p>\n\t\t\t </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>You can filter on <code>name</code> to streamline results.</p>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
|
@ -5366,7 +5366,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filters.</p>"
|
||||
"smithy.api#documentation": "<p>Use the following filters to streamline results:</p>\n\t\t <ul>\n <li>\n <p>\n <code>name</code>\n </p>\n </li>\n <li>\n <p>\n <code>osVersion</code>\n </p>\n </li>\n <li>\n <p>\n <code>platform</code>\n </p>\n </li>\n <li>\n <p>\n <code>type</code>\n </p>\n </li>\n <li>\n <p>\n <code>version</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
|
@ -5564,7 +5564,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filters.</p>"
|
||||
"smithy.api#documentation": "<p>Use the following filters to streamline results:</p>\n\t\t <ul>\n <li>\n <p>\n <code>name</code>\n </p>\n </li>\n <li>\n <p>\n <code>version</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
|
@ -5656,7 +5656,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filters.</p>"
|
||||
"smithy.api#documentation": "<p>Use the following filters to streamline results:</p>\n\t\t <ul>\n <li>\n <p>\n <code>description</code>\n </p>\n </li>\n <li>\n <p>\n <code>distributionConfigurationArn</code>\n </p>\n </li>\n <li>\n <p>\n <code>imageRecipeArn</code>\n </p>\n </li>\n <li>\n <p>\n <code>infrastructureConfigurationArn</code>\n </p>\n </li>\n <li>\n <p>\n <code>name</code>\n </p>\n </li>\n <li>\n <p>\n <code>status</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
|
@ -5754,7 +5754,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filters.</p>"
|
||||
"smithy.api#documentation": "<p>Use the following filters to streamline results:</p>\n\t\t <ul>\n <li>\n <p>\n <code>name</code>\n </p>\n </li>\n <li>\n <p>\n <code>parentImage</code>\n </p>\n </li>\n <li>\n <p>\n <code>platform</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
|
@ -5852,7 +5852,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filters.</p>"
|
||||
"smithy.api#documentation": "<p>Use the following filters to streamline results:</p>\n\t\t <ul>\n <li>\n <p>\n <code>name</code>\n </p>\n </li>\n <li>\n <p>\n <code>osVersion</code>\n </p>\n </li>\n <li>\n <p>\n <code>platform</code>\n </p>\n </li>\n <li>\n <p>\n <code>type</code>\n </p>\n </li>\n <li>\n <p>\n <code>version</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"byName": {
|
||||
|
|
@ -5956,7 +5956,7 @@
|
|||
"filters": {
|
||||
"target": "com.amazonaws.imagebuilder#FilterList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The filters.</p>"
|
||||
"smithy.api#documentation": "<p>You can filter on <code>name</code> to streamline results.</p>"
|
||||
}
|
||||
},
|
||||
"maxResults": {
|
||||
|
|
|
|||
|
|
@ -5283,10 +5283,17 @@
|
|||
"type": {
|
||||
"target": "com.amazonaws.iotsitewise#InterpolationType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The interpolation type.</p>\n <p>Valid values: <code>LINEAR_INTERPOLATION</code>\n </p>",
|
||||
"smithy.api#documentation": "<p>The interpolation type.</p>\n <p>Valid values: <code>LINEAR_INTERPOLATION | LOCF_INTERPOLATION</code>\n </p>\n <p>For the <code>LOCF_INTERPOLATION</code> interpolation, if no data point is found for an interval, \n IoT SiteWise returns the same interpolated value calculated for the previous interval \n and carries forward this interpolated value until a new data point is found.</p>\n <p>For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. \n If the <code>LOCF_INTERPOLATION</code> interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise uses the data points from July 1, 2021, \n at 9 AM to July 2, 2021, at 9 AM to compute the first interpolated value. \n If no data points is found after 9 A.M. on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.</p>",
|
||||
"smithy.api#httpQuery": "type",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"intervalWindowInSeconds": {
|
||||
"target": "com.amazonaws.iotsitewise#IntervalWindowInSeconds",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The query interval for the window in seconds. IoT SiteWise computes each interpolated value by using data points \n from the timestamp of each interval minus the window to the timestamp of each interval plus the window. \n If not specified, the window is between the start time minus the interval and the end time plus the interval. </p>\n <note>\n <ul>\n <li>\n <p>If you specify a value for the <code>intervalWindowInSeconds</code> parameter, \n the <code>type</code> parameter must be <code>LINEAR_INTERPOLATION</code>.</p>\n </li>\n <li>\n <p>If no data point is found during the specified query window, \n IoT SiteWise won't return an interpolated value for the interval. \n This indicates that there's a gap in the ingested data points.</p>\n </li>\n </ul>\n </note>\n <p>For example, you can get the interpolated temperature values for a wind turbine \n every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, \n at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM - 2 hours) \n to 11 AM (9 AM + 2 hours) on July 2, 2021 to compute the first interpolated value, \n uses the data points from 7 AM (9 AM - 2 hours) to 11 AM (9 AM + 2 hours) on July 3, 2021 \n to compute the second interpolated value, and so on. </p>",
|
||||
"smithy.api#httpQuery": "intervalWindowInSeconds"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5617,6 +5624,16 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.iotsitewise#IntervalWindowInSeconds": {
|
||||
"type": "long",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#range": {
|
||||
"min": 1,
|
||||
"max": 320000000
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.iotsitewise#InvalidRequestException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -7973,7 +7990,7 @@
|
|||
"offset": {
|
||||
"target": "com.amazonaws.iotsitewise#Offset",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The offset for the tumbling window. The <code>offset</code> parameter accepts the following:</p>\n <ul>\n <li>\n <p>The offset time.</p>\n <p>For example, if you specify <code>18h</code> for <code>offset</code> \n and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>\n <ul>\n <li>\n <p>If you create the metric before or at 6:00 p.m. (UTC), \n you get the first aggregation result at 6 p.m. (UTC) on the day when you create the metric.</p>\n </li>\n <li>\n <p>If you create the metric after 6:00 p.m. (UTC), \n you get the first aggregation result at 6 p.m. (UTC) the next day.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>The ISO 8601 format.</p>\n <p>For example, if you specify <code>PT18H</code> for <code>offset</code> \n and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>\n <ul>\n <li>\n <p>If you create the metric before or at 6:00 p.m. (UTC), \n you get the first aggregation result at 6 p.m. (UTC) on the day when you create the metric.</p>\n </li>\n <li>\n <p>If you create the metric after 6:00 p.m. (UTC), \n you get the first aggregation result at 6 p.m. (UTC) the next day.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>The 24-hour clock.</p>\n <p>For example, if you specify <code>00:03:00</code> for <code>offset</code> \n and <code>5m</code> for <code>interval</code>, and you create the metric at 2 p.m. (UTC), \n you get the first aggregation result at 2:03 p.m. (UTC). \n You get the second aggregation result at 2:08 p.m. (UTC). </p>\n </li>\n <li>\n <p>The offset time zone.</p>\n <p>For example, if you specify <code>2021-07-23T18:00-08</code> for <code>offset</code> \n and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>\n <ul>\n <li>\n <p>If you create the metric before or at 6:00 p.m. (PST), \n you get the first aggregation result at 6 p.m. (PST) on the day when you create the metric.</p>\n </li>\n <li>\n <p>If you create the metric after 6:00 p.m. (PST), \n you get the first aggregation result at 6 p.m. (PST) the next day.</p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>The offset for the tumbling window. The <code>offset</code> parameter accepts the following:</p>\n <ul>\n <li>\n <p>The offset time.</p>\n <p>For example, if you specify <code>18h</code> for <code>offset</code> \n and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>\n <ul>\n <li>\n <p>If you create the metric before or at 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.</p>\n </li>\n <li>\n <p>If you create the metric after 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) the next day.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>The ISO 8601 format.</p>\n <p>For example, if you specify <code>PT18H</code> for <code>offset</code> \n and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>\n <ul>\n <li>\n <p>If you create the metric before or at 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.</p>\n </li>\n <li>\n <p>If you create the metric after 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) the next day.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>The 24-hour clock.</p>\n <p>For example, if you specify <code>00:03:00</code> for <code>offset</code> \n and <code>5m</code> for <code>interval</code>, and you create the metric at 2 PM (UTC), \n you get the first aggregation result at 2:03 PM (UTC). \n You get the second aggregation result at 2:08 PM (UTC). </p>\n </li>\n <li>\n <p>The offset time zone.</p>\n <p>For example, if you specify <code>2021-07-23T18:00-08</code> for <code>offset</code> \n and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>\n <ul>\n <li>\n <p>If you create the metric before or at 6:00 PM (PST), \n you get the first aggregation result at 6 PM (PST) on the day when you create the metric.</p>\n </li>\n <li>\n <p>If you create the metric after 6:00 PM (PST), \n you get the first aggregation result at 6 PM (PST) the next day.</p>\n </li>\n </ul>\n </li>\n </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -4918,7 +4918,7 @@
|
|||
"MasterRegion": {
|
||||
"target": "com.amazonaws.lambda#MasterRegion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>For Lambda@Edge functions, the Region of the master function. For example, <code>us-east-1</code> filters\n the list of functions to only include Lambda@Edge functions replicated from a master function in US East (N.\n Virginia). If specified, you must set <code>FunctionVersion</code> to <code>ALL</code>.</p>",
|
||||
"smithy.api#documentation": "<p>For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, <code>us-east-1</code> filters\n the list of functions to only include Lambda@Edge functions replicated from a master function in US East (N.\n Virginia). If specified, you must set <code>FunctionVersion</code> to <code>ALL</code>.</p>",
|
||||
"smithy.api#httpQuery": "MasterRegion"
|
||||
}
|
||||
},
|
||||
|
|
@ -6562,6 +6562,10 @@
|
|||
"value": "python3.8",
|
||||
"name": "python38"
|
||||
},
|
||||
{
|
||||
"value": "python3.9",
|
||||
"name": "python39"
|
||||
},
|
||||
{
|
||||
"value": "dotnetcore1.0",
|
||||
"name": "dotnetcore10"
|
||||
|
|
|
|||
|
|
@ -767,6 +767,10 @@
|
|||
{
|
||||
"value": "PROVISIONAL",
|
||||
"name": "PROVISIONAL"
|
||||
},
|
||||
{
|
||||
"value": "PERPETUAL",
|
||||
"name": "PERPETUAL"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -92,12 +92,44 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>The timestamp when the access key was created.</p>"
|
||||
}
|
||||
},
|
||||
"lastUsed": {
|
||||
"target": "com.amazonaws.lightsail#AccessKeyLastUsed",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object that describes the last time the access key was used.</p>\n\n <note>\n <p>This object does not include data in the response of a <a>CreateBucketAccessKey</a> action. If the access key has not been used, the\n <code>region</code> and <code>serviceName</code> values are <code>N/A</code>, and the\n <code>lastUsedDate</code> value is null.</p>\n </note>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes an access key for an Amazon Lightsail bucket.</p>\n\n <p>Access keys grant full programmatic access to the specified bucket and its objects. You\n can have a maximum of two access keys per bucket. Use the <a>CreateBucketAccessKey</a> action to create an access key for a specific bucket. For\n more information about access keys, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the\n <i>Amazon Lightsail Developer Guide</i>.</p>\n\n <important>\n <p>The <code>secretAccessKey</code> value is returned only in response to the\n <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you\n first create an access key; you cannot get the secret access key later. If you lose the\n secret access key, you must create a new access key.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lightsail#AccessKeyLastUsed": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"lastUsedDate": {
|
||||
"target": "com.amazonaws.lightsail#IsoDate",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The date and time when the access key was most recently used.</p>\n <p>This value is null if the access key has not been used.</p>"
|
||||
}
|
||||
},
|
||||
"region": {
|
||||
"target": "com.amazonaws.lightsail#string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS Region where this access key was most recently used.</p>\n <p>This value is <code>N/A</code> if the access key has not been used.</p>"
|
||||
}
|
||||
},
|
||||
"serviceName": {
|
||||
"target": "com.amazonaws.lightsail#string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the AWS service with which this access key was most recently used.</p>\n <p>This value is <code>N/A</code> if the access key has not been used.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the last time an access key was used.</p>\n\n <note>\n <p>This object does not include data in the response of a <a>CreateBucketAccessKey</a> action.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lightsail#AccessKeyList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -2924,7 +2956,7 @@
|
|||
"enableObjectVersioning": {
|
||||
"target": "com.amazonaws.lightsail#boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A Boolean value that indicates whether to enable versioning of objects in the\n bucket.</p>\n\n <p>For more information about versioning, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning\">Enabling and suspending bucket object versioning in Amazon Lightsail</a> in the\n <i>Amazon Lightsail Developer Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>A Boolean value that indicates whether to enable versioning of objects in the\n bucket.</p>\n\n <p>For more information about versioning, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning\">Enabling and suspending object versioning in a bucket in Amazon Lightsail</a> in the\n <i>Amazon Lightsail Developer Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.</p> \n <p>Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. \n After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. \n This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. \n This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.</p>\n <important>\n <p>CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK\n with your log group. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric\n Keys</a>.</p>\n </important>\n <p>It can take up to 5 minutes for this operation to take effect.</p>\n <p>If you attempt to associate a CMK with a log group but the CMK does not exist or the\n CMK is disabled, you receive an <code>InvalidParameterException</code> error. </p>"
|
||||
"smithy.api#documentation": "<p>Associates the specified Key Management Service customer master key (CMK) with the specified log group.</p> \n <p>Associating an KMS CMK with a log group overrides any existing associations between the log group and a CMK. \n After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. \n This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. \n This enables CloudWatch Logs to decrypt this data whenever it is requested.</p>\n <important>\n <p>CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK\n with your log group. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric\n Keys</a>.</p>\n </important>\n <p>It can take up to 5 minutes for this operation to take effect.</p>\n <p>If you attempt to associate a CMK with a log group but the CMK does not exist or the\n CMK is disabled, you receive an <code>InvalidParameterException</code> error. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest": {
|
||||
|
|
@ -76,7 +76,7 @@
|
|||
"kmsKeyId": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#KmsKeyId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. This must be a symmetric CMK.\n For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names - AWS Key Management Service (AWS KMS)</a> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a>.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. This must be a symmetric CMK.\n For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names - Key Management Service</a> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -188,7 +188,7 @@
|
|||
"destination": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.</p>",
|
||||
"smithy.api#documentation": "<p>The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services region.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -234,7 +234,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates a log group with the specified name. You can create up to 20,000 log groups per account.</p>\n <p>You must use the following guidelines when naming a log group:</p>\n <ul>\n <li>\n <p>Log group names must be unique within a region for an AWS account.</p>\n </li>\n <li>\n <p>Log group names can be between 1 and 512 characters long.</p>\n </li>\n <li>\n <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)</p>\n </li>\n </ul>\n <p>When you create a log group, by default the log events in the log group never expire. To set\n a retention policy so that events expire and are deleted after a specified time, use\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html\">PutRetentionPolicy</a>.</p>\n <p>If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. \n This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. \n This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.</p>\n <p>If you attempt to associate a CMK with the log group but the CMK does not exist or the\n CMK is disabled, you receive an <code>InvalidParameterException</code> error. </p>\n <important>\n <p> CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with\n your log group. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric\n Keys</a>.</p>\n </important>"
|
||||
"smithy.api#documentation": "<p>Creates a log group with the specified name. You can create up to 20,000 log groups per account.</p>\n <p>You must use the following guidelines when naming a log group:</p>\n <ul>\n <li>\n <p>Log group names must be unique within a region for an Amazon Web Services account.</p>\n </li>\n <li>\n <p>Log group names can be between 1 and 512 characters long.</p>\n </li>\n <li>\n <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)</p>\n </li>\n </ul>\n <p>When you create a log group, by default the log events in the log group never expire. To set\n a retention policy so that events expire and are deleted after a specified time, use\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html\">PutRetentionPolicy</a>.</p>\n <p>If you associate a Key Management Service customer master key (CMK) with the log group, ingested data is encrypted using the CMK. \n This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. \n This enables CloudWatch Logs to decrypt this data whenever it is requested.</p>\n <p>If you attempt to associate a CMK with the log group but the CMK does not exist or the\n CMK is disabled, you receive an <code>InvalidParameterException</code> error. </p>\n <important>\n <p>CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with\n your log group. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric\n Keys</a>.</p>\n </important>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": {
|
||||
|
|
@ -250,13 +250,13 @@
|
|||
"kmsKeyId": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#KmsKeyId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. \n For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names - AWS Key Management Service (AWS KMS)</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. \n For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names - Key Management Service</a>.</p>"
|
||||
}
|
||||
},
|
||||
"tags": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#Tags",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The key-value pairs to use for the tags.</p>"
|
||||
"smithy.api#documentation": "<p>The key-value pairs to use for the tags.</p>\n <p>CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the <code>aws:Resource/<i>key-name</i>\n </code> or <code>aws:TagKeys</code> condition keys. \n For more information about using tags to control access, see \n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html\">Controlling access to Amazon Web Services resources using tags</a>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -322,7 +322,7 @@
|
|||
"type": "integer",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#documentation": "<p>The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.</p>\n <p>If you omit <code>retentionInDays</code> in a <code>PutRetentionPolicy</code> operation, \n the events in the log group are always retained and never expire.</p>"
|
||||
"smithy.api#documentation": "<p>The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.</p>\n <p>To set a log group to never have log events expire, use\n <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html\">DeleteRetentionPolicy</a>.\n </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#DefaultValue": {
|
||||
|
|
@ -798,7 +798,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the specified log groups. You can list all your log groups or filter the results by prefix.\n The results are ASCII-sorted by log group name.</p>",
|
||||
"smithy.api#documentation": "<p>Lists the specified log groups. You can list all your log groups or filter the results by prefix.\n The results are ASCII-sorted by log group name.</p>\n <p>CloudWatch Logs doesn’t support IAM policies that control access to the <code>DescribeLogGroups</code> action by using the \n <code>aws:ResourceTag/<i>key-name</i>\n </code> condition key. Other CloudWatch Logs actions\n do support the use of the <code>aws:ResourceTag/<i>key-name</i>\n </code> condition key to control access.\n For more information about using tags to control access, see \n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html\">Controlling access to Amazon Web Services resources using tags</a>.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "nextToken",
|
||||
"outputToken": "nextToken",
|
||||
|
|
@ -1285,7 +1285,7 @@
|
|||
"accessPolicy": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#AccessPolicy",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An IAM policy document that governs which AWS accounts can create subscription filters\n against this destination.</p>"
|
||||
"smithy.api#documentation": "<p>An IAM policy document that governs which Amazon Web Services accounts can create subscription filters\n against this destination.</p>"
|
||||
}
|
||||
},
|
||||
"arn": {
|
||||
|
|
@ -1376,7 +1376,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.</p> \n <p>After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. \n All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.</p>\n <p>Note that it can take up to 5 minutes for this operation to take effect.</p>"
|
||||
"smithy.api#documentation": "<p>Disassociates the associated Key Management Service customer master key (CMK) from the specified log group.</p> \n <p>After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. \n All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.</p>\n <p>Note that it can take up to 5 minutes for this operation to take effect.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest": {
|
||||
|
|
@ -1860,7 +1860,7 @@
|
|||
"nextToken": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#NextToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>\n <p>Using this token works only when you specify <code>true</code> for <code>startFromHead</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"
|
||||
}
|
||||
},
|
||||
"limit": {
|
||||
|
|
@ -1872,7 +1872,7 @@
|
|||
"startFromHead": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#StartFromHead",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If the value is true, the earliest log events are returned first.\n If the value is false, the latest log events are returned first.\n The default value is false.</p>\n <p>If you are using <code>nextToken</code> in this operation, you must specify <code>true</code> for <code>startFromHead</code>.</p>"
|
||||
"smithy.api#documentation": "<p>If the value is true, the earliest log events are returned first.\n If the value is false, the latest log events are returned first.\n The default value is false.</p>\n <p>If you are using a previous <code>nextForwardToken</code> value as the <code>nextToken</code> in this operation, \n you must specify <code>true</code> for <code>startFromHead</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -2554,7 +2554,7 @@
|
|||
"name": "logs"
|
||||
},
|
||||
"aws.protocols#awsJson1_1": {},
|
||||
"smithy.api#documentation": "<p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, AWS CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the\n AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.</p> \n <p>You can use CloudWatch Logs to:</p>\n <ul>\n <li>\n <p>\n <b>Monitor logs from EC2 instances in real-time</b>: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs and\n send you a notification whenever the rate of errors exceeds a threshold that you specify.\n CloudWatch Logs uses your log data for monitoring so no code changes are required. For\n example, you can monitor application logs for specific literal terms (such as\n \"NullReferenceException\") or count the number of occurrences of a literal term at a\n particular position in log data (such as \"404\" status codes in an Apache access log). When\n the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch\n metric that you specify.</p>\n </li>\n <li>\n <p>\n <b>Monitor AWS CloudTrail logged events</b>: You can\n create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.</p>\n </li>\n <li>\n <p>\n <b>Archive log data</b>: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events older than this setting are automatically deleted. The CloudWatch Logs\n agent makes it easy to quickly send both rotated and non-rotated log data off of a host\n and into the log service. You can then access the raw log data when you need it.</p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from\n EC2 instances, CloudTrail, and other sources. You can then retrieve the associated\n log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the\n Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.</p> \n <p>You can use CloudWatch Logs to:</p>\n <ul>\n <li>\n <p>\n <b>Monitor logs from EC2 instances in real-time</b>: You\n can use CloudWatch Logs to monitor applications and systems using log data. For example,\n CloudWatch Logs can track the number of errors that occur in your application logs and\n send you a notification whenever the rate of errors exceeds a threshold that you specify.\n CloudWatch Logs uses your log data for monitoring so no code changes are required. For\n example, you can monitor application logs for specific literal terms (such as\n \"NullReferenceException\") or count the number of occurrences of a literal term at a\n particular position in log data (such as \"404\" status codes in an Apache access log). When\n the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch\n metric that you specify.</p>\n </li>\n <li>\n <p>\n <b>Monitor CloudTrail logged events</b>: You can\n create alarms in CloudWatch and receive notifications of particular API activity as\n captured by CloudTrail. You can use the notification to perform troubleshooting.</p>\n </li>\n <li>\n <p>\n <b>Archive log data</b>: You can use CloudWatch Logs to\n store your log data in highly durable storage. You can change the log retention setting so\n that any log events older than this setting are automatically deleted. The CloudWatch Logs\n agent makes it easy to quickly send both rotated and non-rotated log data off of a host\n and into the log service. You can then access the raw log data when you need it.</p>\n </li>\n </ul>",
|
||||
"smithy.api#title": "Amazon CloudWatch Logs",
|
||||
"smithy.api#xmlNamespace": {
|
||||
"uri": "http://monitoring.amazonaws.com/doc/2014-03-28/"
|
||||
|
|
@ -2706,7 +2706,7 @@
|
|||
"dimensions": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#Dimensions",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The fields to use as dimensions for the metric. One metric filter can include\n as many as three dimensions.</p>\n <important>\n <p>Metrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n <code>IPAddress</code> or <code>requestID</code> as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n </p>\n <p>To help prevent accidental high charges, Amazon disables a metric filter\n if it generates 1000 different name/value pairs for the dimensions that you \n have specified within a certain amount of time.</p>\n <p>You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html\">\n Creating a Billing Alarm to Monitor Your Estimated AWS Charges</a>.\n </p>\n </important>"
|
||||
"smithy.api#documentation": "<p>The fields to use as dimensions for the metric. One metric filter can include\n as many as three dimensions.</p>\n <important>\n <p>Metrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n <code>IPAddress</code> or <code>requestID</code> as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n </p>\n <p>To help prevent accidental high charges, Amazon disables a metric filter\n if it generates 1000 different name/value pairs for the dimensions that you \n have specified within a certain amount of time.</p>\n <p>You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html\">\n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges</a>.\n </p>\n </important>"
|
||||
}
|
||||
},
|
||||
"unit": {
|
||||
|
|
@ -2871,7 +2871,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates or updates an access policy associated with an existing\n destination. An access policy is an <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html\">IAM policy document</a> that is used\n to authorize claims to register a subscription filter against a given destination.</p>\n <p>If multiple AWS accounts are sending logs to this destination, each sender account must be \n listed separately in the policy. The policy does not support specifying <code>*</code>\n as the Principal or the use of the <code>aws:PrincipalOrgId</code> global key.</p>"
|
||||
"smithy.api#documentation": "<p>Creates or updates an access policy associated with an existing\n destination. An access policy is an <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html\">IAM policy document</a> that is used\n to authorize claims to register a subscription filter against a given destination.</p>\n <p>If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be \n listed separately in the policy. The policy does not support specifying <code>*</code>\n as the Principal or the use of the <code>aws:PrincipalOrgId</code> global key.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest": {
|
||||
|
|
@ -2959,7 +2959,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Uploads a batch of log events to the specified log stream.</p>\n <p>You must include the sequence token obtained from the response of the previous call. An\n upload in a newly created log stream does not require a sequence token. You can also get the\n sequence token in the <code>expectedSequenceToken</code> field from\n <code>InvalidSequenceTokenException</code>. If you call <code>PutLogEvents</code> twice\n within a narrow time period using the same value for <code>sequenceToken</code>, both calls\n might be successful or one might be rejected.</p>\n <p>The batch of events must satisfy the following constraints:</p>\n <ul>\n <li>\n <p>The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.</p>\n </li>\n <li>\n <p>None of the log events in the batch can be more than 2 hours in the future.</p>\n </li>\n <li>\n <p>None of the log events in the batch can be older than 14 days or older than the retention\n period of the log group.</p>\n </li>\n <li>\n <p>The log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time the event occurred, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the\n timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example,\n 2017-09-15T13:45:30.) </p>\n </li>\n <li>\n <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p>\n </li>\n <li>\n <p>The maximum number of log events in a batch is 10,000.</p>\n </li>\n <li>\n <p>There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.</p>\n </li>\n </ul> \n <p>If a call to <code>PutLogEvents</code> returns \"UnrecognizedClientException\" the most likely cause is an invalid AWS access key ID or secret key. </p>"
|
||||
"smithy.api#documentation": "<p>Uploads a batch of log events to the specified log stream.</p>\n <p>You must include the sequence token obtained from the response of the previous call. An\n upload in a newly created log stream does not require a sequence token. You can also get the\n sequence token in the <code>expectedSequenceToken</code> field from\n <code>InvalidSequenceTokenException</code>. If you call <code>PutLogEvents</code> twice\n within a narrow time period using the same value for <code>sequenceToken</code>, both calls\n might be successful or one might be rejected.</p>\n <p>The batch of events must satisfy the following constraints:</p>\n <ul>\n <li>\n <p>The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.</p>\n </li>\n <li>\n <p>None of the log events in the batch can be more than 2 hours in the future.</p>\n </li>\n <li>\n <p>None of the log events in the batch can be older than 14 days or older than the retention\n period of the log group.</p>\n </li>\n <li>\n <p>The log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time the event occurred, expressed as the number of milliseconds after\n Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the\n timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example,\n 2017-09-15T13:45:30.) </p>\n </li>\n <li>\n <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p>\n </li>\n <li>\n <p>The maximum number of log events in a batch is 10,000.</p>\n </li>\n <li>\n <p>There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.</p>\n </li>\n </ul> \n <p>If a call to <code>PutLogEvents</code> returns \"UnrecognizedClientException\" the most likely cause is an invalid Amazon Web Services access key ID or secret key. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#PutLogEventsRequest": {
|
||||
|
|
@ -3034,7 +3034,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates or updates a metric filter and associates it with the specified log group.\n Metric filters allow you to configure rules to extract metric data from log events ingested\n through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html\">PutLogEvents</a>.</p>\n <p>The maximum number of metric filters that can be associated with a log group is\n 100.</p>\n <p>When you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.</p>\n <important>\n <p>Metrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n <code>IPAddress</code> or <code>requestID</code> as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n </p>\n <p>To help prevent accidental high charges, Amazon disables a metric filter\n if it generates 1000 different name/value pairs for the dimensions that you \n have specified within a certain amount of time.</p>\n <p>You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html\">\n Creating a Billing Alarm to Monitor Your Estimated AWS Charges</a>.\n </p>\n </important>"
|
||||
"smithy.api#documentation": "<p>Creates or updates a metric filter and associates it with the specified log group.\n Metric filters allow you to configure rules to extract metric data from log events ingested\n through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html\">PutLogEvents</a>.</p>\n <p>The maximum number of metric filters that can be associated with a log group is\n 100.</p>\n <p>When you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.</p>\n <important>\n <p>Metrics extracted from log events are charged as custom metrics.\n To prevent unexpected high charges, do not specify high-cardinality fields such as \n <code>IPAddress</code> or <code>requestID</code> as dimensions. Each different value \n found for \n a dimension is treated as a separate metric and accrues charges as a separate custom metric.\n </p>\n <p>To help prevent accidental high charges, Amazon disables a metric filter\n if it generates 1000 different name/value pairs for the dimensions that you \n have specified within a certain amount of time.</p>\n <p>You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html\">\n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges</a>.\n </p>\n </important>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#PutMetricFilterRequest": {
|
||||
|
|
@ -3155,7 +3155,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates or updates a resource policy allowing other AWS services to put log events to\n this account, such as Amazon Route 53. An account can have up to 10 resource policies per AWS\n Region.</p>"
|
||||
"smithy.api#documentation": "<p>Creates or updates a resource policy allowing other Amazon Web Services services to put log events to\n this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services\n Region.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest": {
|
||||
|
|
@ -3170,7 +3170,7 @@
|
|||
"policyDocument": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#PolicyDocument",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.</p>\n <p>The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace <code>\"logArn\"</code> with the ARN of your CloudWatch Logs resource, such as a log group or log stream.</p>\n <p>\n <code>{ \n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\", \n \"Effect\": \"Allow\", \n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n }, \n \"Action\":\"logs:PutLogEvents\", \n \"Resource\": \"logArn\"\n }\n ]\n} </code>\n \n </p>"
|
||||
"smithy.api#documentation": "<p>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.</p>\n <p>The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace <code>\"logArn\"</code> with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.</p>\n <p>CloudWatch Logs also supports <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn\">aws:SourceArn</a>\n and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount\">aws:SourceAccount</a>\ncondition context keys.</p>\n <p>In the example resource policy, you would replace the value of <code>SourceArn</code> with the resource making the\n call from Route 53 to CloudWatch Logs and replace the value of <code>SourceAccount</code> with \n the Amazon Web Services account ID making that call.</p>\n <p></p>\n <p>\n <code>{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}</code>\n \n </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -3250,7 +3250,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates or updates a subscription filter and associates it with the specified log\n group. Subscription filters allow you to subscribe to a real-time stream of log events\n ingested through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html\">PutLogEvents</a> and have them delivered to a specific\n destination. When log events are sent to the \n receiving service, they are Base64 encoded\n and compressed with the gzip format.</p>\n <p>The following destinations are supported for subscription filters:</p>\n <ul>\n <li>\n <p>An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.</p>\n </li>\n <li>\n <p>A logical destination that belongs to a different account, for cross-account delivery.</p>\n </li>\n <li>\n <p>An Amazon Kinesis Firehose delivery stream that belongs to the same account as the\n subscription filter, for same-account delivery.</p>\n </li>\n <li>\n <p>An AWS Lambda function that belongs to the same account as the subscription filter,\n for same-account delivery.</p>\n </li>\n </ul> \n <p>Each log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in <code>filterName</code>.\n </p>\n <p>To perform a <code>PutSubscriptionFilter</code> operation, you must also have the \n <code>iam:PassRole</code> permission.</p>"
|
||||
"smithy.api#documentation": "<p>Creates or updates a subscription filter and associates it with the specified log\n group. Subscription filters allow you to subscribe to a real-time stream of log events\n ingested through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html\">PutLogEvents</a> and have them delivered to a specific\n destination. When log events are sent to the \n receiving service, they are Base64 encoded\n and compressed with the gzip format.</p>\n <p>The following destinations are supported for subscription filters:</p>\n <ul>\n <li>\n <p>An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.</p>\n </li>\n <li>\n <p>A logical destination that belongs to a different account, for cross-account delivery.</p>\n </li>\n <li>\n <p>An Amazon Kinesis Firehose delivery stream that belongs to the same account as the\n subscription filter, for same-account delivery.</p>\n </li>\n <li>\n <p>An Lambda function that belongs to the same account as the subscription filter,\n for same-account delivery.</p>\n </li>\n </ul> \n <p>Each log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in <code>filterName</code>.\n </p>\n <p>To perform a <code>PutSubscriptionFilter</code> operation, you must also have the \n <code>iam:PassRole</code> permission.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest": {
|
||||
|
|
@ -3280,7 +3280,7 @@
|
|||
"destinationArn": {
|
||||
"target": "com.amazonaws.cloudwatchlogs#DestinationArn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:</p>\n <ul>\n <li>\n <p>An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.</p>\n </li>\n <li>\n <p>A logical destination (specified using an ARN) belonging to a different account, \n for cross-account delivery.</p>\n <p>If you are setting up a cross-account subscription, the destination must have an \n IAM policy associated with it that allows the sender to send logs to the destination.\n For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html\">PutDestinationPolicy</a>.</p>\n </li>\n <li>\n <p>An Amazon Kinesis Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.</p>\n </li>\n <li>\n <p>An AWS Lambda function belonging to the same account as the subscription filter,\n for same-account delivery.</p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:</p>\n <ul>\n <li>\n <p>An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.</p>\n </li>\n <li>\n <p>A logical destination (specified using an ARN) belonging to a different account, \n for cross-account delivery.</p>\n <p>If you are setting up a cross-account subscription, the destination must have an \n IAM policy associated with it that allows the sender to send logs to the destination.\n For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html\">PutDestinationPolicy</a>.</p>\n </li>\n <li>\n <p>An Amazon Kinesis Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.</p>\n </li>\n <li>\n <p>A Lambda function belonging to the same account as the subscription filter,\n for same-account delivery.</p>\n </li>\n </ul>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -4059,7 +4059,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Adds or updates the specified tags for the specified log group.</p>\n <p>To list the tags for a log group, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html\">ListTagsLogGroup</a>.\n To remove tags, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagLogGroup.html\">UntagLogGroup</a>.</p>\n <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging\">Tag Log Groups in Amazon CloudWatch Logs</a>\n in the <i>Amazon CloudWatch Logs User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>Adds or updates the specified tags for the specified log group.</p>\n <p>To list the tags for a log group, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html\">ListTagsLogGroup</a>.\n To remove tags, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagLogGroup.html\">UntagLogGroup</a>.</p>\n <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging\">Tag Log Groups in Amazon CloudWatch Logs</a>\n in the <i>Amazon CloudWatch Logs User Guide</i>.</p>\n <p>CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the <code>aws:Resource/<i>key-name</i>\n </code> or <code>aws:TagKeys</code> condition keys. \n For more information about using tags to control access, see \n <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html\">Controlling access to Amazon Web Services resources using tags</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#TagLogGroupRequest": {
|
||||
|
|
@ -4195,7 +4195,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The most likely cause is an invalid AWS access key ID or secret key.</p>",
|
||||
"smithy.api#documentation": "<p>The most likely cause is an invalid Amazon Web Services access key ID or secret key.</p>",
|
||||
"smithy.api#error": "client"
|
||||
}
|
||||
},
|
||||
|
|
@ -4210,7 +4210,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Removes the specified tags from the specified log group.</p>\n <p>To list the tags for a log group, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html\">ListTagsLogGroup</a>.\n To add tags, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagLogGroup.html\">TagLogGroup</a>.</p>"
|
||||
"smithy.api#documentation": "<p>Removes the specified tags from the specified log group.</p>\n <p>To list the tags for a log group, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsLogGroup.html\">ListTagsLogGroup</a>.\n To add tags, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagLogGroup.html\">TagLogGroup</a>.</p>\n <p>CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the <code>aws:Resource/<i>key-name</i>\n </code> or <code>aws:TagKeys</code> condition keys. \n </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.cloudwatchlogs#UntagLogGroupRequest": {
|
||||
|
|
|
|||
|
|
@ -282,7 +282,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provided the identity of a the bot that was exported.</p>"
|
||||
"smithy.api#documentation": "<p>Provides the identity of a the bot that was exported.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.lexmodelsv2#BotFilter": {
|
||||
|
|
@ -2575,7 +2575,7 @@
|
|||
"multipleValuesSetting": {
|
||||
"target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the slot returns multiple values in one response.\n Multi-value slots are only available in the en-US locale. If you set\n this value to <code>true</code> in any other locale, Amazon Lex throws a\n <code>ValidationException</code>. </p>\n <p>If the <code>multipleValuesSetting</code> is not set, the default\n value is <code>false</code>.</p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the slot returns multiple values in one response.\n Multi-value slots are only available in the en-US locale. If you set\n this value to <code>true</code> in any other locale, Amazon Lex throws a\n <code>ValidationException</code>. </p>\n <p>If the <code>multipleValuesSetting</code> is not set, the default\n value is <code>false</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -5243,7 +5243,7 @@
|
|||
"multipleValuesSetting": {
|
||||
"target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether the slot accepts multiple values in a\n single utterance.</p>\n <p>If the <code>multipleValuesSetting</code> is not set, the default\n value is <code>false</code>.</p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether the slot accepts multiple values in a single\n utterance.</p>\n <p>If the <code>multipleValuesSetting</code> is not set, the default\n value is <code>false</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -5990,6 +5990,12 @@
|
|||
"smithy.api#documentation": "<p>The response that Amazon Lex sends to the user when the intent is\n complete.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"active": {
|
||||
"target": "com.amazonaws.lexmodelsv2#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies whether an intent's closing response is used. When this\n field is false, the closing response isn't sent to the user and no\n closing input from the user is used. If the <code>active</code> field\n isn't specified, the default is true.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -6012,6 +6018,12 @@
|
|||
"smithy.api#documentation": "<p>When the user answers \"no\" to the question defined in\n <code>promptSpecification</code>, Amazon Lex responds with this response\n to acknowledge that the intent was canceled. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"active": {
|
||||
"target": "com.amazonaws.lexmodelsv2#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies whether the intent's confirmation is sent to the user.\n When this field is false, confirmation and declination responses aren't\n sent and processing continues as if the responses aren't present. If\n the <code>active</code> field isn't specified, the default is\n true.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -7778,7 +7790,7 @@
|
|||
"allowMultipleValues": {
|
||||
"target": "com.amazonaws.lexmodelsv2#Boolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Indicates whether a slot can return multiple values. When\n <code>true</code>, the slot may return more than one value in a\n response. When <code>false</code>, the slot returns only a single\n value.</p>\n <p>Multi-value slots are only available in the en-US locale. If you\n set this value to <code>true</code> in any other locale, Amazon Lex throws a\n <code>ValidationException</code>.</p> \n <p>If the <code>allowMutlipleValues</code> is not set, the default\n value is <code>false</code>.</p>"
|
||||
"smithy.api#documentation": "<p>Indicates whether a slot can return multiple values. When\n <code>true</code>, the slot may return more than one value in a\n response. When <code>false</code>, the slot returns only a single\n value.</p>\n <p>Multi-value slots are only available in the en-US locale. If you set\n this value to <code>true</code> in any other locale, Amazon Lex throws a\n <code>ValidationException</code>.</p>\n <p>If the <code>allowMutlipleValues</code> is not set, the default\n value is <code>false</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -7992,7 +8004,7 @@
|
|||
"smithy.api#box": {},
|
||||
"smithy.api#range": {
|
||||
"min": 0,
|
||||
"max": 25
|
||||
"max": 100
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -10543,6 +10555,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>A response that Amazon Lex sends periodically to the user to indicate\n that the bot is still waiting for input from the user.</p>"
|
||||
}
|
||||
},
|
||||
"active": {
|
||||
"target": "com.amazonaws.lexmodelsv2#BoxedBoolean",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies whether the bot will wait for a user to respond. When this\n field is false, wait and continue responses for a slot aren't used and\n the bot expects an appropriate response within the configured timeout.\n If the <code>active</code> field isn't specified, the default is\n true.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
|
|||
|
|
@ -210,7 +210,7 @@
|
|||
"directoryId": {
|
||||
"target": "com.amazonaws.nimble#DirectoryId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.</p>",
|
||||
"smithy.api#documentation": "<p>The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.</p>",
|
||||
"smithy.api#jsonName": "directoryId"
|
||||
}
|
||||
},
|
||||
|
|
@ -611,6 +611,13 @@
|
|||
"smithy.api#jsonName": "launchProfileId"
|
||||
}
|
||||
},
|
||||
"ownedBy": {
|
||||
"target": "com.amazonaws.nimble#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The user ID of the user that owns the streaming session.</p>",
|
||||
"smithy.api#jsonName": "ownedBy"
|
||||
}
|
||||
},
|
||||
"streamingImageId": {
|
||||
"target": "com.amazonaws.nimble#StreamingImageId",
|
||||
"traits": {
|
||||
|
|
@ -773,7 +780,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Create a new Studio.</p> <p>When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal.</p> <p>The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.</p> <p>The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.</p> <p>You may optionally specify a KMS key in the StudioEncryptionConfiguration.</p> <p>In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an AWS KMS key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS KMS key when calling CreateStudio to encrypt this data using a key you own and manage.</p> <p>When providing an AWS KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.</p> <p>If you delete this grant, the studio will no longer be accessible to your portal users.</p> <p>If you delete the studio KMS key, your studio will no longer be accessible.</p>",
|
||||
"smithy.api#documentation": "<p>Create a new Studio.</p> <p>When creating a Studio, two IAM roles must be provided: the admin role and the user Role. These roles are assumed by your users when they log in to the Nimble Studio portal.</p> <p>The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.</p> <p>The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.</p> <p>You may optionally specify a KMS key in the StudioEncryptionConfiguration.</p> <p>In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.</p> <p>When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.</p> <p>If you delete this grant, the studio will no longer be accessible to your portal users.</p> <p>If you delete the studio KMS key, your studio will no longer be accessible.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/2020-08-01/studios",
|
||||
|
|
@ -2803,7 +2810,7 @@
|
|||
"directoryId": {
|
||||
"target": "com.amazonaws.nimble#DirectoryId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The directory ID of the AWS Directory Service for Microsoft AD to access using this launch profile.</p>",
|
||||
"smithy.api#documentation": "<p>The directory ID of the Directory Service for Microsoft Active Directory to access using this launch profile.</p>",
|
||||
"smithy.api#jsonName": "directoryId"
|
||||
}
|
||||
},
|
||||
|
|
@ -3520,7 +3527,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>List the streaming image resources available to this studio.</p> <p>This list will contain both images provided by AWS, as well as streaming images that you have created in your studio.</p>",
|
||||
"smithy.api#documentation": "<p>List the streaming image resources available to this studio.</p> <p>This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/2020-08-01/studios/{studioId}/streaming-images",
|
||||
|
|
@ -3620,7 +3627,7 @@
|
|||
"createdBy": {
|
||||
"target": "com.amazonaws.nimble#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The user ID.</p>",
|
||||
"smithy.api#documentation": "<p>The user ID of the user that created the streaming session.</p>",
|
||||
"smithy.api#httpQuery": "createdBy"
|
||||
}
|
||||
},
|
||||
|
|
@ -3631,6 +3638,13 @@
|
|||
"smithy.api#httpQuery": "nextToken"
|
||||
}
|
||||
},
|
||||
"ownedBy": {
|
||||
"target": "com.amazonaws.nimble#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The user ID of the user that owns the streaming session.</p>",
|
||||
"smithy.api#httpQuery": "ownedBy"
|
||||
}
|
||||
},
|
||||
"sessionIds": {
|
||||
"target": "com.amazonaws.nimble#__string",
|
||||
"traits": {
|
||||
|
|
@ -3885,7 +3899,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>List studios in your AWS account in the requested AWS Region.</p>",
|
||||
"smithy.api#documentation": "<p>List studios in your Amazon Web Services account in the requested Amazon Web Services Region.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/2020-08-01/studios",
|
||||
|
|
@ -4026,7 +4040,7 @@
|
|||
},
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 0,
|
||||
"min": 1,
|
||||
"max": 20
|
||||
}
|
||||
}
|
||||
|
|
@ -4059,7 +4073,7 @@
|
|||
},
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 0,
|
||||
"min": 1,
|
||||
"max": 20
|
||||
}
|
||||
}
|
||||
|
|
@ -4247,7 +4261,7 @@
|
|||
"min": 0,
|
||||
"max": 50
|
||||
},
|
||||
"smithy.api#pattern": "[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]"
|
||||
"smithy.api#pattern": "^[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.nimble#ResourceNotFoundException": {
|
||||
|
|
@ -4431,7 +4445,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Repairs the SSO configuration for a given studio.</p> <p>If the studio has a valid AWS SSO configuration currently associated with it, this operation will fail with a validation error.</p> <p>If the studio does not have a valid AWS SSO configuration currently associated with it, then a new AWS SSO application is created for the studio and the studio is changed to the READY state.</p> <p>After the AWS SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.</p>",
|
||||
"smithy.api#documentation": "<p>Repairs the SSO configuration for a given studio.</p> <p>If the studio has a valid Amazon Web Services SSO configuration currently associated with it, this operation will fail with a validation error.</p> <p>If the studio does not have a valid Amazon Web Services SSO configuration currently associated with it, then a new Amazon Web Services SSO application is created for the studio and the studio is changed to the READY state.</p> <p>After the Amazon Web Services SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "PUT",
|
||||
"uri": "/2020-08-01/studios/{studioId}/sso-configuration",
|
||||
|
|
@ -4700,7 +4714,7 @@
|
|||
"smithy.api#length": {
|
||||
"min": 4
|
||||
},
|
||||
"smithy.api#pattern": "^arn:.*"
|
||||
"smithy.api#pattern": "^arn:"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.nimble#StreamingImageEncryptionConfigurationKeyType": {
|
||||
|
|
@ -4767,13 +4781,6 @@
|
|||
"smithy.api#pattern": "^[a-zA-Z]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.nimble#StreamingImageSessionId": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The streaming image session ID.</p>",
|
||||
"smithy.api#pattern": "^[A-z0-9-_:]*\\.{1}[A-z0-9-_]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.nimble#StreamingImageState": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -4927,8 +4934,15 @@
|
|||
"smithy.api#jsonName": "launchProfileId"
|
||||
}
|
||||
},
|
||||
"ownedBy": {
|
||||
"target": "com.amazonaws.nimble#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The user ID of the user that owns the streaming session.</p>",
|
||||
"smithy.api#jsonName": "ownedBy"
|
||||
}
|
||||
},
|
||||
"sessionId": {
|
||||
"target": "com.amazonaws.nimble#StreamingImageSessionId",
|
||||
"target": "com.amazonaws.nimble#StreamingSessionId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The session ID.</p>",
|
||||
"smithy.api#jsonName": "sessionId"
|
||||
|
|
@ -4992,6 +5006,9 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.nimble#StreamingSessionId": {
|
||||
"type": "string"
|
||||
},
|
||||
"com.amazonaws.nimble#StreamingSessionList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -5105,6 +5122,13 @@
|
|||
"smithy.api#jsonName": "expiresAt"
|
||||
}
|
||||
},
|
||||
"ownedBy": {
|
||||
"target": "com.amazonaws.nimble#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The user ID of the user that owns the streaming session.</p>",
|
||||
"smithy.api#jsonName": "ownedBy"
|
||||
}
|
||||
},
|
||||
"state": {
|
||||
"target": "com.amazonaws.nimble#StreamingSessionStreamState",
|
||||
"traits": {
|
||||
|
|
@ -5240,14 +5264,14 @@
|
|||
"homeRegion": {
|
||||
"target": "com.amazonaws.nimble#Region",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS region where the studio resource is located.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services Region where the studio resource is located.</p>",
|
||||
"smithy.api#jsonName": "homeRegion"
|
||||
}
|
||||
},
|
||||
"ssoClientId": {
|
||||
"target": "com.amazonaws.nimble#__string",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble portal.</p>",
|
||||
"smithy.api#jsonName": "ssoClientId"
|
||||
}
|
||||
},
|
||||
|
|
@ -5877,7 +5901,7 @@
|
|||
"smithy.api#length": {
|
||||
"min": 4
|
||||
},
|
||||
"smithy.api#pattern": "^arn:.*"
|
||||
"smithy.api#pattern": "^arn:"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.nimble#StudioEncryptionConfigurationKeyType": {
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon QuickSight customizations associated with your Amazon Web Services account; or a QuickSight namespace in a specific Region;.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon QuickSight customizations associated with your Amazon Web Services account; or a QuickSight namespace in a specific Amazon Web Services Region;.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.quicksight#AccountSettings": {
|
||||
|
|
@ -1206,7 +1206,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Creates Amazon QuickSight customizations the current Region;. Currently, you can\n add a custom default theme by using the <code>CreateAccountCustomization</code> or\n <code>UpdateAccountCustomization</code> API operation. To further customize\n QuickSight by removing QuickSight sample assets and videos for all new users, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html\">Customizing QuickSight</a> in the <i>Amazon QuickSight User\n Guide.</i>\n </p>\n <p>You can create customizations for your Amazon Web Services account; or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account;. To find out which customizations apply, use\n the <code>DescribeAccountCustomization</code> API operation.</p>\n <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme \n as the namespace default, make sure that you first share the theme with the namespace. \n If you don't share it with the namespace, the theme isn't visible to your users \n even if you make it the default theme. \n To check if the theme is shared, view the current permissions by using the \n <code>\n <a>DescribeThemePermissions</a>\n </code> API operation.\n To share the theme, grant permissions by using the \n <code>\n <a>UpdateThemePermissions</a>\n </code> API operation. </p>",
|
||||
"smithy.api#documentation": "<p>Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can\n add a custom default theme by using the <code>CreateAccountCustomization</code> or\n <code>UpdateAccountCustomization</code> API operation. To further customize\n QuickSight by removing QuickSight sample assets and videos for all new users, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html\">Customizing QuickSight</a> in the <i>Amazon QuickSight User\n Guide.</i>\n </p>\n <p>You can create customizations for your Amazon Web Services account; or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account;. To find out which customizations apply, use\n the <code>DescribeAccountCustomization</code> API operation.</p>\n <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme \n as the namespace default, make sure that you first share the theme with the namespace. \n If you don't share it with the namespace, the theme isn't visible to your users \n even if you make it the default theme. \n To check if the theme is shared, view the current permissions by using the \n <code>\n <a>DescribeThemePermissions</a>\n </code> API operation.\n To share the theme, grant permissions by using the \n <code>\n <a>UpdateThemePermissions</a>\n </code> API operation. </p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/accounts/{AwsAccountId}/customizations",
|
||||
|
|
@ -1235,7 +1235,7 @@
|
|||
"AccountCustomization": {
|
||||
"target": "com.amazonaws.quicksight#AccountCustomization",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations you're adding in the current Region;. You can add\n these to an Amazon Web Services account; and a QuickSight namespace. </p>\n <p>For example, you can add a default theme by setting <code>AccountCustomization</code>\n to the midnight theme: <code>\"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }</code>. Or, you can add a custom theme by\n specifying <code>\"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }</code>. </p>",
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations you're adding in the current Amazon Web Services Region;. You can add\n these to an Amazon Web Services account; and a QuickSight namespace. </p>\n <p>For example, you can add a default theme by setting <code>AccountCustomization</code>\n to the midnight theme: <code>\"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }</code>. Or, you can add a custom theme by\n specifying <code>\"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }</code>. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -1271,7 +1271,7 @@
|
|||
"AccountCustomization": {
|
||||
"target": "com.amazonaws.quicksight#AccountCustomization",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations you're adding in the current Region;. </p>"
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations you're adding in the current Amazon Web Services Region;. </p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -1520,7 +1520,7 @@
|
|||
"SourceEntity": {
|
||||
"target": "com.amazonaws.quicksight#DashboardSourceEntity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The entity that you are using as a source when you create the dashboard. In\n <code>SourceEntity</code>, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a <code>SourceTemplate</code>\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the <a>CreateTemplate</a> API operation. For\n <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source\n template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account; and any\n QuickSight-supported Region;. </p>\n <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder. </p>",
|
||||
"smithy.api#documentation": "<p>The entity that you are using as a source when you create the dashboard. In\n <code>SourceEntity</code>, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a <code>SourceTemplate</code>\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the <a>CreateTemplate</a> API operation. For\n <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source\n template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account; and any\n QuickSight-supported Amazon Web Services Region;. </p>\n <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -1652,7 +1652,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -1739,7 +1739,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"IngestionArn": {
|
||||
|
|
@ -1826,7 +1826,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An ID for the data source. This ID is unique per Region; for each Amazon Web Services account;. </p>",
|
||||
"smithy.api#documentation": "<p>An ID for the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -1894,7 +1894,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"CreationStatus": {
|
||||
|
|
@ -2699,7 +2699,7 @@
|
|||
"CapacityRegion": {
|
||||
"target": "com.amazonaws.quicksight#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Region; that you want to use for the free SPICE capacity for the new namespace.\n This is set to the region that you run CreateNamespace in. </p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace.\n This is set to the region that you run CreateNamespace in. </p>"
|
||||
}
|
||||
},
|
||||
"CreationStatus": {
|
||||
|
|
@ -2889,7 +2889,7 @@
|
|||
"TemplateId": {
|
||||
"target": "com.amazonaws.quicksight#RestrictiveResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An ID for the template that you want to create. This template is unique per Region; in\n\t\t\teach Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in\n\t\t\teach Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -2909,7 +2909,7 @@
|
|||
"SourceEntity": {
|
||||
"target": "com.amazonaws.quicksight#TemplateSourceEntity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The entity that you are using as a source when you create the template. In\n\t\t\t<code>SourceEntity</code>, you specify the type of object you're using as source:\n\t\t\t<code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\t<code>SourceTemplate</code>, specify the ARN of the source template. For\n\t\t\t<code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>\n\t\t\tARN can contain any Amazon Web Services account; and any QuickSight-supported Region;. </p>\n\t\t <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or\n\t\t\t<code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder. </p>",
|
||||
"smithy.api#documentation": "<p>The entity that you are using as a source when you create the template. In\n\t\t\t<code>SourceEntity</code>, you specify the type of object you're using as source:\n\t\t\t<code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\t<code>SourceTemplate</code>, specify the ARN of the source template. For\n\t\t\t<code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>\n\t\t\tARN can contain any Amazon Web Services account; and any QuickSight-supported Amazon Web Services Region;. </p>\n\t\t <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or\n\t\t\t<code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -3129,7 +3129,7 @@
|
|||
"ThemeId": {
|
||||
"target": "com.amazonaws.quicksight#RestrictiveResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An ID for the theme that you want to create. The theme ID is unique per Region; in\n\t\t\teach Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region; in\n\t\t\teach Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -4079,7 +4079,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each \n Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each \n Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
|
|
@ -4578,7 +4578,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Deletes all Amazon QuickSight customizations in this Region; for the specified \n Amazon Web Services account; and QuickSight namespace.</p>",
|
||||
"smithy.api#documentation": "<p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified \n Amazon Web Services account; and QuickSight namespace.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "DELETE",
|
||||
"uri": "/accounts/{AwsAccountId}/customizations",
|
||||
|
|
@ -4592,7 +4592,7 @@
|
|||
"AwsAccountId": {
|
||||
"target": "com.amazonaws.quicksight#AwsAccountId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the Amazon Web Services account; that you want to delete QuickSight customizations from in\n this Region;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID for the Amazon Web Services account; that you want to delete QuickSight customizations from in\n this Amazon Web Services Region;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -4875,7 +4875,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -4894,7 +4894,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -4960,7 +4960,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -4979,7 +4979,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -6148,7 +6148,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the customizations associated with the provided Amazon Web Services account; and Amazon\n QuickSight namespace in an Region;. The QuickSight console evaluates which\n customizations to apply by running this API operation with the <code>Resolved</code> flag\n included. </p>\n <p>To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved. </p>\n <ul>\n <li>\n <p>\n <code>Amazon Web Services account;</code> - The Amazon Web Services account; exists at the top of the hierarchy.\n It has the potential to use all of the Regions; and AWS Services. When you\n subscribe to QuickSight, you choose one Region; to use as your home Region.\n That's where your free SPICE capacity is located. You can use QuickSight in any\n supported Region;. </p>\n </li>\n <li>\n <p>\n <code>Region;</code> - In each Region; where you sign in to QuickSight\n at least once, QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to QuickSight in any \n Region;, unless they are constrained to a namespace. </p>\n <p>To run the command in a different Region;, you change your Region settings.\n If you're using the AWS CLI, you can use one of the following options:</p>\n <ul>\n <li>\n <p>Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html\">command line options</a>. </p>\n </li>\n <li>\n <p>Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html\">named profiles</a>. </p>\n </li>\n <li>\n <p>Run <code>aws configure</code> to change your default Region;. Use\n Enter to key the same settings for your keys. For more information, see\n <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html\">Configuring the AWS CLI</a>.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <code>Namespace</code> - A QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same Amazon Web Services account;\n and Region;.</p>\n </li>\n <li>\n <p>\n <code>Applied customizations</code> - Within an Region;, a set of\n QuickSight customizations can apply to an Amazon Web Services account; or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n Amazon Web Services account;. All settings are isolated to a single Region;. To apply them in\n other Regions;, run the <code>CreateAccountCustomization</code> command in\n each Region; where you want to apply the same customizations. </p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>Describes the customizations associated with the provided Amazon Web Services account; and Amazon\n QuickSight namespace in an Amazon Web Services Region;. The QuickSight console evaluates which\n customizations to apply by running this API operation with the <code>Resolved</code> flag\n included. </p>\n <p>To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved. </p>\n <ul>\n <li>\n <p>\n <code>Amazon Web Services account;</code> - The Amazon Web Services account; exists at the top of the hierarchy.\n It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you\n subscribe to QuickSight, you choose one Amazon Web Services Region; to use as your home Region.\n That's where your free SPICE capacity is located. You can use QuickSight in any\n supported Amazon Web Services Region;. </p>\n </li>\n <li>\n <p>\n <code>Amazon Web Services Region;</code> - In each Amazon Web Services Region; where you sign in to QuickSight\n at least once, QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to QuickSight in any \n Amazon Web Services Region;, unless they are constrained to a namespace. </p>\n <p>To run the command in a different Amazon Web Services Region;, you change your Region settings.\n If you're using the AWS CLI, you can use one of the following options:</p>\n <ul>\n <li>\n <p>Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html\">command line options</a>. </p>\n </li>\n <li>\n <p>Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html\">named profiles</a>. </p>\n </li>\n <li>\n <p>Run <code>aws configure</code> to change your default Amazon Web Services Region;. Use\n Enter to key the same settings for your keys. For more information, see\n <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html\">Configuring the AWS CLI</a>.</p>\n </li>\n </ul>\n </li>\n <li>\n <p>\n <code>Namespace</code> - A QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same Amazon Web Services account;\n and Amazon Web Services Region;.</p>\n </li>\n <li>\n <p>\n <code>Applied customizations</code> - Within an Amazon Web Services Region;, a set of\n QuickSight customizations can apply to an Amazon Web Services account; or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n Amazon Web Services account;. All settings are isolated to a single Amazon Web Services Region;. To apply them in\n other Amazon Web Services Regions;, run the <code>CreateAccountCustomization</code> command in\n each Amazon Web Services Region; where you want to apply the same customizations. </p>\n </li>\n </ul>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/accounts/{AwsAccountId}/customizations",
|
||||
|
|
@ -6207,7 +6207,7 @@
|
|||
"AccountCustomization": {
|
||||
"target": "com.amazonaws.quicksight#AccountCustomization",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations that exist in the current Region;. </p>"
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations that exist in the current Amazon Web Services Region;. </p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -6281,7 +6281,7 @@
|
|||
"AccountSettings": {
|
||||
"target": "com.amazonaws.quicksight#AccountSettings",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The QuickSight settings for this Amazon Web Services account;. This information includes the edition of Amazon\n QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the\n QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes\n referred to as a QuickSight \"account\" even though it's technically not an account\n by itself. Instead, it's a subscription to the QuickSight service for your Amazon Web Services account;. The\n edition that you subscribe to applies to QuickSight in every Region; where you use it.</p>"
|
||||
"smithy.api#documentation": "<p>The QuickSight settings for this Amazon Web Services account;. This information includes the edition of Amazon\n QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the\n QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes\n referred to as a QuickSight \"account\" even though it's technically not an account\n by itself. Instead, it's a subscription to the QuickSight service for your Amazon Web Services account;. The\n edition that you subscribe to applies to QuickSight in every Amazon Web Services Region; where you use it.</p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -6741,7 +6741,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -6760,7 +6760,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"Permissions": {
|
||||
|
|
@ -6798,7 +6798,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -6911,7 +6911,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -6930,7 +6930,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"Permissions": {
|
||||
|
|
@ -6968,7 +6968,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -7606,7 +7606,7 @@
|
|||
"Namespace": {
|
||||
"target": "com.amazonaws.quicksight#NamespaceInfoV2",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Region;, creation status, and identity store. <code>DescribeNamespace</code> also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.</p>"
|
||||
"smithy.api#documentation": "<p>The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region;, creation status, and identity store. <code>DescribeNamespace</code> also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.</p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -9128,7 +9128,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Generates a session URL and authorization code that you can use to embed an Amazon\n QuickSight read-only dashboard in your web server code. Before you use this command,\n make sure that you have configured the dashboards and permissions. </p>\n <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not\n from the user's browser. The following rules apply to the combination of URL and\n authorization code:</p>\n <ul>\n <li>\n <p>They must be used together.</p>\n </li>\n <li>\n <p>They can be used one time only.</p>\n </li>\n <li>\n <p>They are valid for 5 minutes after you run this command.</p>\n </li>\n <li>\n <p>The resulting user session is valid for 10 hours.</p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html\">Embedded Analytics</a> in the <i>Amazon QuickSight User\n Guide</i>.</p>\n <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html\">Amazon QuickSight Developer Portal</a>.</p>",
|
||||
"smithy.api#documentation": "<p>Generates a session URL and authorization code that you can use to embed an Amazon\n QuickSight read-only dashboard in your web server code. Before you use this command,\n make sure that you have configured the dashboards and permissions. </p>\n <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not\n from the user's browser. The following rules apply to the combination of URL and\n authorization code:</p>\n <ul>\n <li>\n <p>They must be used together.</p>\n </li>\n <li>\n <p>They can be used one time only.</p>\n </li>\n <li>\n <p>They are valid for 5 minutes after you run this command.</p>\n </li>\n <li>\n <p>The resulting user session is valid for 10 hours.</p>\n </li>\n </ul>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html\">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User\n Guide</i>.</p>\n <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html\">Amazon QuickSight Developer Portal</a>.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url",
|
||||
|
|
@ -9279,7 +9279,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Generates a session URL and authorization code that you can use to embed the Amazon\n QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n <code>\n <a>UpdateUser</a>\n </code> API operation. Use <code>\n <a>RegisterUser</a>\n </code> API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the <i>Amazon QuickSight User\n Guide</i>:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html\">Embedding the Amazon QuickSight Console</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html\">Customizing Access to the Amazon QuickSight Console</a>\n </p>\n </li>\n </ul>",
|
||||
"smithy.api#documentation": "<p>Generates a session URL and authorization code that you can use to embed the Amazon\n QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n <code>\n <a>UpdateUser</a>\n </code> API operation. Use <code>\n <a>RegisterUser</a>\n </code> API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the <i>Amazon QuickSight User\n Guide</i>:</p>\n <ul>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users-get.html\">Embedding the Amazon QuickSight Console Using GetSessionEmbedUrl</a>\n </p>\n </li>\n <li>\n <p>\n <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html\">Customizing Access to the Amazon QuickSight Console</a>\n </p>\n </li>\n </ul>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/accounts/{AwsAccountId}/session-embed-url",
|
||||
|
|
@ -10566,7 +10566,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists all of the datasets belonging to the current Amazon Web Services account; in an Region;.</p>\n\t\t <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/*</code>.</p>",
|
||||
"smithy.api#documentation": "<p>Lists all of the datasets belonging to the current Amazon Web Services account; in an Amazon Web Services Region;.</p>\n\t\t <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/*</code>.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/accounts/{AwsAccountId}/data-sets",
|
||||
|
|
@ -10663,7 +10663,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists data sources in current Region; that belong to this Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account;.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "GET",
|
||||
"uri": "/accounts/{AwsAccountId}/data-sources",
|
||||
|
|
@ -11580,7 +11580,7 @@
|
|||
"Namespaces": {
|
||||
"target": "com.amazonaws.quicksight#Namespaces",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The information about the namespaces in this Amazon Web Services account;. The response includes \n the namespace ARN, name, Region;, notification email address, creation status, and \n identity store.</p>"
|
||||
"smithy.api#documentation": "<p>The information about the namespaces in this Amazon Web Services account;. The response includes \n the namespace ARN, name, Amazon Web Services Region;, notification email address, creation status, and \n identity store.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
|
@ -12835,7 +12835,7 @@
|
|||
"CapacityRegion": {
|
||||
"target": "com.amazonaws.quicksight#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The namespace Region;.</p>"
|
||||
"smithy.api#documentation": "<p>The namespace Amazon Web Services Region;.</p>"
|
||||
}
|
||||
},
|
||||
"CreationStatus": {
|
||||
|
|
@ -13631,7 +13631,7 @@
|
|||
"name": "quicksight"
|
||||
},
|
||||
"aws.protocols#restJson1": {},
|
||||
"smithy.api#documentation": "<fullname>Amazon QuickSight API Reference</fullname>\n <p>Amazon QuickSight is a fully managed, serverless business intelligence service for the\n Cloud that makes it easy to extend data and insights to every user in your\n organization. This API reference contains documentation for a programming interface that\n you can use to manage Amazon QuickSight. </p>",
|
||||
"smithy.api#documentation": "<fullname>Amazon QuickSight API Reference</fullname>\n <p>Amazon QuickSight is a fully managed, serverless business intelligence service for the\n Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your\n organization. This API reference contains documentation for a programming interface that\n you can use to manage Amazon QuickSight. </p>",
|
||||
"smithy.api#title": "Amazon QuickSight"
|
||||
}
|
||||
},
|
||||
|
|
@ -15336,7 +15336,7 @@
|
|||
"TemplateId": {
|
||||
"target": "com.amazonaws.quicksight#RestrictiveResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the template. This is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID for the template. This is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"LastUpdatedTime": {
|
||||
|
|
@ -15526,7 +15526,7 @@
|
|||
"TemplateId": {
|
||||
"target": "com.amazonaws.quicksight#RestrictiveResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the template. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
|
|
@ -15906,7 +15906,7 @@
|
|||
"ThemeId": {
|
||||
"target": "com.amazonaws.quicksight#RestrictiveResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the theme. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"LatestVersionNumber": {
|
||||
|
|
@ -16462,7 +16462,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates Amazon QuickSight customizations the current Region;. Currently, the only\n customization you can use is a theme.</p>\n <p>You can use customizations for your Amazon Web Services account; or, if you specify a namespace, for a\n QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account;. To find out which customizations apply, use\n the <code>DescribeAccountCustomization</code> API operation. </p>",
|
||||
"smithy.api#documentation": "<p>Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only\n customization you can use is a theme.</p>\n <p>You can use customizations for your Amazon Web Services account; or, if you specify a namespace, for a\n QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account;. To find out which customizations apply, use\n the <code>DescribeAccountCustomization</code> API operation. </p>",
|
||||
"smithy.api#http": {
|
||||
"method": "PUT",
|
||||
"uri": "/accounts/{AwsAccountId}/customizations",
|
||||
|
|
@ -16491,7 +16491,7 @@
|
|||
"AccountCustomization": {
|
||||
"target": "com.amazonaws.quicksight#AccountCustomization",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations you're updating in the current Region;. </p>",
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -16521,7 +16521,7 @@
|
|||
"AccountCustomization": {
|
||||
"target": "com.amazonaws.quicksight#AccountCustomization",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations you're updating in the current Region;. </p>"
|
||||
"smithy.api#documentation": "<p>The QuickSight customizations you're updating in the current Amazon Web Services Region;. </p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -17120,7 +17120,7 @@
|
|||
"SourceEntity": {
|
||||
"target": "com.amazonaws.quicksight#DashboardSourceEntity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The entity that you are using as a source when you update the dashboard. In\n <code>SourceEntity</code>, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a <code>SourceTemplate</code>\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the <a>CreateTemplate</a> API operation. For\n <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source\n template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account; and any\n QuickSight-supported Region;. </p>\n <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder. </p>",
|
||||
"smithy.api#documentation": "<p>The entity that you are using as a source when you update the dashboard. In\n <code>SourceEntity</code>, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a <code>SourceTemplate</code>\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the <a>CreateTemplate</a> API operation. For\n <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source\n template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account; and any\n QuickSight-supported Amazon Web Services Region;. </p>\n <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -17285,7 +17285,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset whose permissions you want to update. This ID is unique per \n\t\t\tRegion; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID for the dataset whose permissions you want to update. This ID is unique per \n\t\t\tAmazon Web Services Region; for each Amazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -17316,7 +17316,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset whose permissions you want to update. This ID is unique per \n\t\t\tRegion; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID for the dataset whose permissions you want to update. This ID is unique per \n\t\t\tAmazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -17348,7 +17348,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to update. This ID is unique per Region; for each\n\t\t\tAmazon Web Services account;.</p>",
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region; for each\n\t\t\tAmazon Web Services account;.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -17424,7 +17424,7 @@
|
|||
"DataSetId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"IngestionArn": {
|
||||
|
|
@ -17542,7 +17542,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;. </p>",
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;. </p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -17573,7 +17573,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"RequestId": {
|
||||
|
|
@ -17605,7 +17605,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;. </p>",
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;. </p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
|
|
@ -17655,7 +17655,7 @@
|
|||
"DataSourceId": {
|
||||
"target": "com.amazonaws.quicksight#ResourceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.</p>"
|
||||
"smithy.api#documentation": "<p>The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateStatus": {
|
||||
|
|
@ -18399,7 +18399,7 @@
|
|||
"SourceEntity": {
|
||||
"target": "com.amazonaws.quicksight#TemplateSourceEntity",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The entity that you are using as a source when you update the template. In\n\t\t\t<code>SourceEntity</code>, you specify the type of object you're using as source:\n\t\t\t<code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\t<code>SourceTemplate</code>, specify the ARN of the source template. For\n\t\t\t<code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>\n\t\t\tARN can contain any Amazon Web Services account; and any QuickSight-supported Region;. </p>\n\t\t <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or\n\t\t\t<code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder. </p>",
|
||||
"smithy.api#documentation": "<p>The entity that you are using as a source when you update the template. In\n\t\t\t<code>SourceEntity</code>, you specify the type of object you're using as source:\n\t\t\t<code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\t<code>SourceTemplate</code>, specify the ARN of the source template. For\n\t\t\t<code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>\n\t\t\tARN can contain any Amazon Web Services account; and any QuickSight-supported Amazon Web Services Region;. </p>\n\t\t <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or\n\t\t\t<code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder. </p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -2421,7 +2421,7 @@
|
|||
"AllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The amount of storage (in gibibytes) to allocate for the DB instance.</p>\n <p>Type: Integer</p>\n <p>\n <b>Amazon Aurora</b>\n </p>\n <p>Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.</p>\n\n <p>\n <b>MySQL</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p>\n </li>\n <li>\n <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>\n </li>\n <li>\n <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>\n </li>\n </ul>\n \n <p>\n <b>MariaDB</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p>\n </li>\n <li>\n <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>\n </li>\n <li>\n <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>\n </li>\n </ul>\n \n <p>\n <b>PostgreSQL</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p>\n </li>\n <li>\n <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>\n </li>\n <li>\n <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>\n </li>\n </ul>\n \n <p>\n <b>Oracle</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p>\n </li>\n <li>\n <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>\n </li>\n <li>\n <p>Magnetic storage (standard): Must be an integer from 10 to 3072.</p>\n </li>\n </ul>\n \n <p>\n <b>SQL Server</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2):</p>\n <ul>\n <li>\n <p>Enterprise and Standard editions: Must be an integer from 200 to 16384.</p>\n </li>\n <li>\n <p>Web and Express editions: Must be an integer from 20 to 16384.</p>\n </li>\n </ul> \n </li>\n <li>\n <p>Provisioned IOPS storage (io1):</p>\n <ul>\n <li>\n <p>Enterprise and Standard editions: Must be an integer from 200 to 16384.</p>\n </li>\n <li>\n <p>Web and Express editions: Must be an integer from 100 to 16384.</p>\n </li>\n </ul> \n </li>\n <li>\n <p>Magnetic storage (standard):</p>\n <ul>\n <li>\n <p>Enterprise and Standard editions: Must be an integer from 200 to 1024.</p>\n </li>\n <li>\n <p>Web and Express editions: Must be an integer from 20 to 1024.</p>\n </li>\n </ul> \n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>The amount of storage in gibibytes (GiB) to allocate for the DB instance.</p>\n <p>Type: Integer</p>\n <p>\n <b>Amazon Aurora</b>\n </p>\n <p>Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.</p>\n\n <p>\n <b>MySQL</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p>\n </li>\n <li>\n <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>\n </li>\n <li>\n <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>\n </li>\n </ul>\n \n <p>\n <b>MariaDB</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p>\n </li>\n <li>\n <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>\n </li>\n <li>\n <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>\n </li>\n </ul>\n \n <p>\n <b>PostgreSQL</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p>\n </li>\n <li>\n <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>\n </li>\n <li>\n <p>Magnetic storage (standard): Must be an integer from 5 to 3072.</p>\n </li>\n </ul>\n \n <p>\n <b>Oracle</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.</p>\n </li>\n <li>\n <p>Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.</p>\n </li>\n <li>\n <p>Magnetic storage (standard): Must be an integer from 10 to 3072.</p>\n </li>\n </ul>\n \n <p>\n <b>SQL Server</b>\n </p>\n <p>Constraints to the amount of storage for each storage type are the following:\n </p>\n <ul>\n <li>\n <p>General Purpose (SSD) storage (gp2):</p>\n <ul>\n <li>\n <p>Enterprise and Standard editions: Must be an integer from 200 to 16384.</p>\n </li>\n <li>\n <p>Web and Express editions: Must be an integer from 20 to 16384.</p>\n </li>\n </ul> \n </li>\n <li>\n <p>Provisioned IOPS storage (io1):</p>\n <ul>\n <li>\n <p>Enterprise and Standard editions: Must be an integer from 200 to 16384.</p>\n </li>\n <li>\n <p>Web and Express editions: Must be an integer from 100 to 16384.</p>\n </li>\n </ul> \n </li>\n <li>\n <p>Magnetic storage (standard):</p>\n <ul>\n <li>\n <p>Enterprise and Standard editions: Must be an integer from 200 to 1024.</p>\n </li>\n <li>\n <p>Web and Express editions: Must be an integer from 20 to 1024.</p>\n </li>\n </ul> \n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"DBInstanceClass": {
|
||||
|
|
@ -2687,7 +2687,7 @@
|
|||
"MaxAllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"EnableCustomerOwnedIp": {
|
||||
|
|
@ -2963,7 +2963,7 @@
|
|||
"MaxAllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -3831,6 +3831,12 @@
|
|||
"smithy.api#documentation": "<p>Specifies the current state of this DB cluster.</p>"
|
||||
}
|
||||
},
|
||||
"AutomaticRestartTime": {
|
||||
"target": "com.amazonaws.rds#TStamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The time when a stopped DB cluster is restarted automatically.</p>"
|
||||
}
|
||||
},
|
||||
"PercentProgress": {
|
||||
"target": "com.amazonaws.rds#String",
|
||||
"traits": {
|
||||
|
|
@ -5161,6 +5167,12 @@
|
|||
"smithy.api#documentation": "<p>Specifies the current state of this database.</p>\n <p>For information about DB instance statuses, see\n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status\">Viewing DB instance status</a> \n in the <i>Amazon RDS User Guide.</i>\n </p>"
|
||||
}
|
||||
},
|
||||
"AutomaticRestartTime": {
|
||||
"target": "com.amazonaws.rds#TStamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The time when a stopped DB instance is restarted automatically.</p>"
|
||||
}
|
||||
},
|
||||
"MasterUsername": {
|
||||
"target": "com.amazonaws.rds#String",
|
||||
"traits": {
|
||||
|
|
@ -5176,13 +5188,13 @@
|
|||
"Endpoint": {
|
||||
"target": "com.amazonaws.rds#Endpoint",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the connection endpoint.</p>"
|
||||
"smithy.api#documentation": "<p>Specifies the connection endpoint.</p>\n <note>\n <p>The endpoint might not be shown for instances whose status is <code>creating</code>.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"AllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the allocated storage size specified in gibibytes.</p>"
|
||||
"smithy.api#documentation": "<p>Specifies the allocated storage size specified in gibibytes (GiB).</p>"
|
||||
}
|
||||
},
|
||||
"InstanceCreateTime": {
|
||||
|
|
@ -5494,7 +5506,7 @@
|
|||
"MaxAllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>"
|
||||
"smithy.api#documentation": "<p>The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.</p>"
|
||||
}
|
||||
},
|
||||
"TagList": {
|
||||
|
|
@ -13642,7 +13654,7 @@
|
|||
"AllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The new amount of storage (in gibibytes) to allocate for the DB instance.\n </p>\n \n <p>For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.\n </p>\n \n <p>For the valid values for allocated storage for each engine,\n see <code>CreateDBInstance</code>.\n </p>"
|
||||
"smithy.api#documentation": "<p>The new amount of storage in gibibytes (GiB) to allocate for the DB instance.\n </p>\n \n <p>For MariaDB, MySQL, Oracle, and PostgreSQL, \n the value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.\n </p>\n \n <p>For the valid values for allocated storage for each engine,\n see <code>CreateDBInstance</code>.\n </p>"
|
||||
}
|
||||
},
|
||||
"DBInstanceClass": {
|
||||
|
|
@ -13876,7 +13888,7 @@
|
|||
"MaxAllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"CertificateRotationRestart": {
|
||||
|
|
@ -15597,7 +15609,7 @@
|
|||
"AllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The allocated storage size for the DB instance specified in gibibytes .</p>"
|
||||
"smithy.api#documentation": "<p>The allocated storage size for the DB instance specified in gibibytes (GiB).</p>"
|
||||
}
|
||||
},
|
||||
"MasterUserPassword": {
|
||||
|
|
@ -18101,7 +18113,7 @@
|
|||
"MaxAllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -18384,7 +18396,7 @@
|
|||
"MaxAllocatedStorage": {
|
||||
"target": "com.amazonaws.rds#IntegerOptional",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.</p>\n <p>For more information about this setting, including limitations that apply to it, see \n <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling\">\n Managing capacity automatically with Amazon RDS storage autoscaling</a> \n in the <i>Amazon RDS User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"SourceDBInstanceAutomatedBackupsArn": {
|
||||
|
|
@ -19913,7 +19925,7 @@
|
|||
"StorageSize": {
|
||||
"target": "com.amazonaws.rds#RangeList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The valid range of storage in gibibytes.\n For example, 100 to 16384. \n </p>"
|
||||
"smithy.api#documentation": "<p>The valid range of storage in gibibytes (GiB).\n For example, 100 to 16384. \n </p>"
|
||||
}
|
||||
},
|
||||
"ProvisionedIops": {
|
||||
|
|
|
|||
|
|
@ -166,6 +166,26 @@
|
|||
"smithy.api#documentation": "<p>Indicates whether or not the face has a beard, and the confidence level in the\n determination.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#BlackFrame": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"MaxPixelThreshold": {
|
||||
"target": "com.amazonaws.rekognition#MaxPixelThreshold",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n A threshold used to determine the maximum luminance value for a pixel to be considered black. In a full color range video,\n luminance values range from 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum black pixel\n value is computed as follows: max_black_pixel_value = minimum_luminance + MaxPixelThreshold *luminance_range.\n </p>\n <p>For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.</p>\n <p>The default value of MaxPixelThreshold is 0.2, which maps to a max_black_pixel_value of 51 for a full range video.\n You can lower this threshold to be more strict on black levels.</p>"
|
||||
}
|
||||
},
|
||||
"MinCoveragePercentage": {
|
||||
"target": "com.amazonaws.rekognition#MinCoveragePercentage",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n The minimum percentage of pixels in a frame that need to have a luminance below the max_black_pixel_value for a frame to be considered\n a black frame. Luminance is calculated using the BT.709 matrix.\n </p>\n <p>The default value is 99, which means at least 99% of all pixels in the frame are black pixels as per the <code>MaxPixelThreshold</code>\n set. You can reduce this value to allow more noise on the black frame.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n A filter that allows you to control the black frame detection by specifying the black levels\n and pixel coverage of black pixels in a frame. As videos can come from multiple sources, formats,\n and time periods, they may contain different standards and varying noise levels for black frames that need to be accounted for.\n For more information, see <a>StartSegmentDetection</a>.\n </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#BodyPart": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -396,7 +416,7 @@
|
|||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-]+"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9_.\\-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#CollectionIdList": {
|
||||
|
|
@ -638,18 +658,18 @@
|
|||
"Timestamp": {
|
||||
"target": "com.amazonaws.rekognition#Timestamp",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.</p>"
|
||||
"smithy.api#documentation": "<p>Time, in milliseconds from the beginning of the video, that the content moderation label was detected.</p>"
|
||||
}
|
||||
},
|
||||
"ModerationLabel": {
|
||||
"target": "com.amazonaws.rekognition#ModerationLabel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The unsafe content label detected by in the stored video.</p>"
|
||||
"smithy.api#documentation": "<p>The content moderation label detected by in the stored video.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Information about an unsafe content label detection in a stored video.</p>"
|
||||
"smithy.api#documentation": "<p>Information about an inappropriate, unwanted, or offensive content label detection in a stored video.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#ContentModerationDetections": {
|
||||
|
|
@ -888,7 +908,7 @@
|
|||
"OutputConfig": {
|
||||
"target": "com.amazonaws.rekognition#OutputConfig",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon S3 location to store the results of training.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon S3 bucket location to store the results of training.\n The S3 bucket can be in any AWS account as long as the caller has\n <code>s3:PutObject</code> permissions on the S3 bucket.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -915,7 +935,7 @@
|
|||
"KmsKeyId": {
|
||||
"target": "com.amazonaws.rekognition#KmsKeyId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK).\n You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK,\n or an alias for your CMK.\n The key is used to encrypt training and test images copied into the service for model training. Your \n source images are unaffected. The key is also used to encrypt training results and manifest files written\n to the output Amazon S3 bucket (<code>OutputConfig</code>).</p>\n <p>If you don't specify a value for <code>KmsKeyId</code>, images copied into the service are encrypted\n using a key that AWS owns and manages.</p>"
|
||||
"smithy.api#documentation": "<p>The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK).\n You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK,\n an alias for your CMK, or an alias ARN.\n The key is used to encrypt training and test images copied into the service for model training.\n Your source images are unaffected. The key is also used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (<code>OutputConfig</code>).</p>\n <p>If you choose to use your own CMK, you need the following permissions on the CMK.</p>\n <ul>\n <li>\n <p>kms:CreateGrant</p>\n </li>\n <li>\n <p>kms:DescribeKey</p>\n </li>\n <li>\n <p>kms:GenerateDataKey</p>\n </li>\n <li>\n <p>kms:Decrypt</p>\n </li>\n </ul>\n <p>If you don't specify a value for <code>KmsKeyId</code>, images copied into the service are encrypted\n using a key that AWS owns and manages.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -2199,7 +2219,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Detects text in the input image and converts it into machine-readable text.</p>\n <p>Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file. </p>\n <p>The <code>DetectText</code> operation returns text in an array of <a>TextDetection</a> elements, <code>TextDetections</code>. Each\n <code>TextDetection</code> element provides information about a single word or line of text\n that was detected in the image. </p>\n <p>A word is one or more ISO basic latin script characters that are not separated by spaces.\n <code>DetectText</code> can detect up to 50 words in an image.</p>\n <p>A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the <code>DetectText</code> operation\n returns multiple lines.</p>\n <p>To determine whether a <code>TextDetection</code> element is a line of text or a word,\n use the <code>TextDetection</code> object <code>Type</code> field. </p>\n <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.</p>\n \n <p>For more information, see DetectText in the Amazon Rekognition Developer Guide.</p>"
|
||||
"smithy.api#documentation": "<p>Detects text in the input image and converts it into machine-readable text.</p>\n <p>Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file. </p>\n <p>The <code>DetectText</code> operation returns text in an array of <a>TextDetection</a> elements, <code>TextDetections</code>. Each\n <code>TextDetection</code> element provides information about a single word or line of text\n that was detected in the image. </p>\n <p>A word is one or more ISO basic latin script characters that are not separated by spaces.\n <code>DetectText</code> can detect up to 100 words in an image.</p>\n <p>A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the <code>DetectText</code> operation\n returns multiple lines.</p>\n <p>To determine whether a <code>TextDetection</code> element is a line of text or a word,\n use the <code>TextDetection</code> object <code>Type</code> field. </p>\n <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.</p>\n \n <p>For more information, see DetectText in the Amazon Rekognition Developer Guide.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#DetectTextFilters": {
|
||||
|
|
@ -2423,7 +2443,7 @@
|
|||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-:]+"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9_.\\-:]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#EyeOpen": {
|
||||
|
|
@ -2652,7 +2672,7 @@
|
|||
"com.amazonaws.rekognition#FaceId": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
|
||||
"smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#FaceIdList": {
|
||||
|
|
@ -3034,7 +3054,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by\n <a>StartContentModeration</a>.</p>\n\n <p>Unsafe content analysis of a video is an asynchronous operation. You start analysis by calling\n <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to <code>StartContentModeration</code>.\n To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>\n \n <p>For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.</p>\n <p>\n <code>GetContentModeration</code> returns detected unsafe content labels,\n and the time they are detected, in an array, <code>ModerationLabels</code>, of\n <a>ContentModerationDetection</a> objects.\n </p>\n <p>By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying <code>NAME</code> for the <code>SortBy</code>\n input parameter. </p>\n <p>Since video analysis can return a large number of results, use the <code>MaxResults</code> parameter to limit\n the number of labels returned in a single call to <code>GetContentModeration</code>. If there are more results than\n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code>\n and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>\n returned from the previous call to <code>GetContentModeration</code>.</p>\n \n <p>For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>",
|
||||
"smithy.api#documentation": "<p>Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by\n <a>StartContentModeration</a>. For a list of moderation labels in Amazon Rekognition, see\n <a href=\"https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api\">Using the image and video moderation APIs</a>.</p>\n\n <p>Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling\n <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to <code>StartContentModeration</code>.\n To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>\n \n <p>For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.</p>\n <p>\n <code>GetContentModeration</code> returns detected inappropriate, unwanted, or offensive content moderation labels,\n and the time they are detected, in an array, <code>ModerationLabels</code>, of\n <a>ContentModerationDetection</a> objects.\n </p>\n <p>By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying <code>NAME</code> for the <code>SortBy</code>\n input parameter. </p>\n <p>Since video analysis can return a large number of results, use the <code>MaxResults</code> parameter to limit\n the number of labels returned in a single call to <code>GetContentModeration</code>. If there are more results than\n specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code>\n and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>\n returned from the previous call to <code>GetContentModeration</code>.</p>\n \n <p>For more information, see Content moderation in the Amazon Rekognition Developer Guide.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -3048,7 +3068,7 @@
|
|||
"JobId": {
|
||||
"target": "com.amazonaws.rekognition#JobId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the unsafe content job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetContentModeration</code>.</p>",
|
||||
"smithy.api#documentation": "<p>The identifier for the inappropriate, unwanted, or offensive content moderation job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetContentModeration</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -3061,7 +3081,7 @@
|
|||
"NextToken": {
|
||||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition\n returns a pagination token in the response. You can use this pagination token\n to retrieve the next set of unsafe content labels.</p>"
|
||||
"smithy.api#documentation": "<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition\n returns a pagination token in the response. You can use this pagination token\n to retrieve the next set of content moderation labels.</p>"
|
||||
}
|
||||
},
|
||||
"SortBy": {
|
||||
|
|
@ -3078,7 +3098,7 @@
|
|||
"JobStatus": {
|
||||
"target": "com.amazonaws.rekognition#VideoJobStatus",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The current status of the unsafe content analysis job.</p>"
|
||||
"smithy.api#documentation": "<p>The current status of the content moderation analysis job.</p>"
|
||||
}
|
||||
},
|
||||
"StatusMessage": {
|
||||
|
|
@ -3096,19 +3116,19 @@
|
|||
"ModerationLabels": {
|
||||
"target": "com.amazonaws.rekognition#ContentModerationDetections",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The detected unsafe content labels and the time(s) they were detected.</p>"
|
||||
"smithy.api#documentation": "<p>The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"target": "com.amazonaws.rekognition#PaginationToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent\n request to retrieve the next set of unsafe content labels. </p>"
|
||||
"smithy.api#documentation": "<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent\n request to retrieve the next set of content moderation labels. </p>"
|
||||
}
|
||||
},
|
||||
"ModerationModelVersion": {
|
||||
"target": "com.amazonaws.rekognition#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Version number of the moderation detection model that was used to detect unsafe content.</p>"
|
||||
"smithy.api#documentation": "<p>Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -3855,7 +3875,7 @@
|
|||
"min": 1,
|
||||
"max": 63
|
||||
},
|
||||
"smithy.api#pattern": "^[a-z0-9](-*[a-z0-9])*"
|
||||
"smithy.api#pattern": "^[a-z0-9](-*[a-z0-9])*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#HumanLoopQuotaExceededException": {
|
||||
|
|
@ -3951,7 +3971,7 @@
|
|||
"com.amazonaws.rekognition#ImageId": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
|
||||
"smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#ImageQuality": {
|
||||
|
|
@ -4268,13 +4288,13 @@
|
|||
"min": 1,
|
||||
"max": 256
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-:]+"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9_.\\-:]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#KinesisDataArn": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)"
|
||||
"smithy.api#pattern": "^(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#KinesisDataStream": {
|
||||
|
|
@ -4294,7 +4314,7 @@
|
|||
"com.amazonaws.rekognition#KinesisVideoArn": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)"
|
||||
"smithy.api#pattern": "^(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#KinesisVideoStream": {
|
||||
|
|
@ -4894,6 +4914,16 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#MaxPixelThreshold": {
|
||||
"type": "float",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#range": {
|
||||
"min": 0,
|
||||
"max": 1
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#MaxResults": {
|
||||
"type": "integer",
|
||||
"traits": {
|
||||
|
|
@ -4903,6 +4933,16 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#MinCoveragePercentage": {
|
||||
"type": "float",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#range": {
|
||||
"min": 0,
|
||||
"max": 100
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#ModerationLabel": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -4926,7 +4966,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides information about a single type of unsafe content found in an image or video. Each type of\n moderated content has a label within a hierarchical taxonomy. For more information, see\n Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>"
|
||||
"smithy.api#documentation": "<p>Provides information about a single type of inappropriate, unwanted, or offensive content found in an image or video. Each type of\n moderated content has a label within a hierarchical taxonomy. For more information, see\n Content moderation in the Amazon Rekognition Developer Guide.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#ModerationLabels": {
|
||||
|
|
@ -4994,7 +5034,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see\n <a>api-video</a>.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see\n <a>api-video</a>. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.\n For more information, see <a href=\"https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics\">Giving access to multiple Amazon SNS topics</a>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#OrientationCorrection": {
|
||||
|
|
@ -5250,7 +5290,7 @@
|
|||
"min": 20,
|
||||
"max": 2048
|
||||
},
|
||||
"smithy.api#pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)"
|
||||
"smithy.api#pattern": "^(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#ProjectDescription": {
|
||||
|
|
@ -5292,7 +5332,7 @@
|
|||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-]+"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9_.\\-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#ProjectStatus": {
|
||||
|
|
@ -5321,7 +5361,7 @@
|
|||
"min": 20,
|
||||
"max": 2048
|
||||
},
|
||||
"smithy.api#pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/version\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)"
|
||||
"smithy.api#pattern": "^(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/version\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#ProjectVersionDescription": {
|
||||
|
|
@ -5987,7 +6027,7 @@
|
|||
"com.amazonaws.rekognition#RekognitionUniqueId": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "[0-9A-Za-z]*"
|
||||
"smithy.api#pattern": "^[0-9A-Za-z]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#ResourceAlreadyExistsException": {
|
||||
|
|
@ -6086,7 +6126,7 @@
|
|||
"com.amazonaws.rekognition#RoleArn": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+"
|
||||
"smithy.api#pattern": "^arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#S3Bucket": {
|
||||
|
|
@ -6096,7 +6136,7 @@
|
|||
"min": 3,
|
||||
"max": 255
|
||||
},
|
||||
"smithy.api#pattern": "[0-9A-Za-z\\.\\-_]*"
|
||||
"smithy.api#pattern": "^[0-9A-Za-z\\.\\-_]*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#S3KeyPrefix": {
|
||||
|
|
@ -6155,7 +6195,7 @@
|
|||
"com.amazonaws.rekognition#SNSTopicArn": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "(^arn:aws:sns:.*:\\w{12}:.+$)"
|
||||
"smithy.api#pattern": "^(^arn:aws:sns:.*:\\w{12}:.+$)$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#SearchFaces": {
|
||||
|
|
@ -6417,6 +6457,24 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>If the segment is a shot detection, contains information about the shot detection.</p>"
|
||||
}
|
||||
},
|
||||
"StartFrameNumber": {
|
||||
"target": "com.amazonaws.rekognition#ULong",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n The frame number of the start of a video segment, using a frame index that starts with 0.\n </p>"
|
||||
}
|
||||
},
|
||||
"EndFrameNumber": {
|
||||
"target": "com.amazonaws.rekognition#ULong",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n The frame number at the end of a video segment, using a frame index that starts with 0.\n </p>"
|
||||
}
|
||||
},
|
||||
"DurationFrames": {
|
||||
"target": "com.amazonaws.rekognition#ULong",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n The duration of a video segment, expressed in frames.\n </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -6603,7 +6661,7 @@
|
|||
"NotificationChannel": {
|
||||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n celebrity recognition analysis to.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>"
|
||||
}
|
||||
},
|
||||
"JobTag": {
|
||||
|
|
@ -6663,7 +6721,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p> Starts asynchronous detection of unsafe content in a stored video.</p>\n <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name\n and the filename of the video. <code>StartContentModeration</code>\n returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.\n When unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>\n <p>To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>\n \n <p>For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>",
|
||||
"smithy.api#documentation": "<p> Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see\n <a href=\"https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api\">Using the image and video moderation APIs</a>.</p>\n <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name\n and the filename of the video. <code>StartContentModeration</code>\n returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.\n When content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>\n <p>To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier\n (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>\n \n <p>For more information, see Content moderation in the Amazon Rekognition Developer Guide.</p>",
|
||||
"smithy.api#idempotent": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -6673,7 +6731,7 @@
|
|||
"Video": {
|
||||
"target": "com.amazonaws.rekognition#Video",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The video in which you want to detect unsafe content. The video must be stored\n in an Amazon S3 bucket.</p>",
|
||||
"smithy.api#documentation": "<p>The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored\n in an Amazon S3 bucket.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -6692,7 +6750,7 @@
|
|||
"NotificationChannel": {
|
||||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n unsafe content analysis to.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n content analysis to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>"
|
||||
}
|
||||
},
|
||||
"JobTag": {
|
||||
|
|
@ -6709,7 +6767,7 @@
|
|||
"JobId": {
|
||||
"target": "com.amazonaws.rekognition#JobId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the unsafe content analysis job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetContentModeration</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The identifier for the content analysis job. Use <code>JobId</code> to identify the job in\n a subsequent call to <code>GetContentModeration</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -6775,7 +6833,7 @@
|
|||
"NotificationChannel": {
|
||||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n face detection operation.</p>"
|
||||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n face detection operation. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>"
|
||||
}
|
||||
},
|
||||
"FaceAttributes": {
|
||||
|
|
@ -6880,7 +6938,7 @@
|
|||
"NotificationChannel": {
|
||||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. </p>"
|
||||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>"
|
||||
}
|
||||
},
|
||||
"JobTag": {
|
||||
|
|
@ -6969,7 +7027,7 @@
|
|||
"NotificationChannel": {
|
||||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection\n operation to. </p>"
|
||||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection\n operation to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>"
|
||||
}
|
||||
},
|
||||
"JobTag": {
|
||||
|
|
@ -7052,7 +7110,7 @@
|
|||
"NotificationChannel": {
|
||||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection\n operation to.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection\n operation to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>"
|
||||
}
|
||||
},
|
||||
"JobTag": {
|
||||
|
|
@ -7222,7 +7280,7 @@
|
|||
"NotificationChannel": {
|
||||
"target": "com.amazonaws.rekognition#NotificationChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n segment detection operation.</p>"
|
||||
"smithy.api#documentation": "<p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the\n segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>"
|
||||
}
|
||||
},
|
||||
"JobTag": {
|
||||
|
|
@ -7330,6 +7388,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected segment. Confidence\n represents how certain Amazon Rekognition is that a segment is correctly identified. 0 is the lowest confidence.\n 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level\n lower than this specified value.</p>\n <p>If you don't specify <code>MinSegmentConfidence</code>, <code>GetSegmentDetection</code> returns \n segments with confidence values greater than or equal to 50 percent.</p>"
|
||||
}
|
||||
},
|
||||
"BlackFrame": {
|
||||
"target": "com.amazonaws.rekognition#BlackFrame",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame.\n Videos can come from multiple sources, formats, and time periods, with different standards and varying noise levels for black frames that need to be accounted for.\n </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
@ -7576,7 +7640,7 @@
|
|||
"com.amazonaws.rekognition#StreamProcessorArn": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#pattern": "(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:streamprocessor\\/.+$)"
|
||||
"smithy.api#pattern": "^(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:streamprocessor\\/.+$)$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#StreamProcessorInput": {
|
||||
|
|
@ -7606,7 +7670,7 @@
|
|||
"min": 1,
|
||||
"max": 128
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-]+"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9_.\\-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#StreamProcessorOutput": {
|
||||
|
|
@ -7848,6 +7912,22 @@
|
|||
{
|
||||
"value": "BlackFrames",
|
||||
"name": "BLACK_FRAMES"
|
||||
},
|
||||
{
|
||||
"value": "OpeningCredits",
|
||||
"name": "OPENING_CREDITS"
|
||||
},
|
||||
{
|
||||
"value": "StudioLogo",
|
||||
"name": "STUDIO_LOGO"
|
||||
},
|
||||
{
|
||||
"value": "Slate",
|
||||
"name": "SLATE"
|
||||
},
|
||||
{
|
||||
"value": "Content",
|
||||
"name": "CONTENT"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -8185,7 +8265,7 @@
|
|||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"smithy.api#pattern": "[a-zA-Z0-9_.\\-]+"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9_.\\-]+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#VersionNames": {
|
||||
|
|
@ -8214,6 +8294,21 @@
|
|||
"smithy.api#documentation": "<p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to\n specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#VideoColorRange": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#enum": [
|
||||
{
|
||||
"value": "FULL",
|
||||
"name": "FULL"
|
||||
},
|
||||
{
|
||||
"value": "LIMITED",
|
||||
"name": "LIMITED"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"com.amazonaws.rekognition#VideoJobStatus": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -8271,6 +8366,12 @@
|
|||
"traits": {
|
||||
"smithy.api#documentation": "<p>Horizontal pixel dimension of the video.</p>"
|
||||
}
|
||||
},
|
||||
"ColorRange": {
|
||||
"target": "com.amazonaws.rekognition#VideoColorRange",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).\n </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -35,6 +35,9 @@
|
|||
"operations": [
|
||||
{
|
||||
"target": "com.amazonaws.sagemakerruntime#InvokeEndpoint"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.sagemakerruntime#InvokeEndpointAsync"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
|
|
@ -70,7 +73,7 @@
|
|||
"min": 0,
|
||||
"max": 1024
|
||||
},
|
||||
"smithy.api#pattern": "\\p{ASCII}*",
|
||||
"smithy.api#pattern": "^\\p{ASCII}*$",
|
||||
"smithy.api#sensitive": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -81,7 +84,7 @@
|
|||
"min": 0,
|
||||
"max": 63
|
||||
},
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#Header": {
|
||||
|
|
@ -91,7 +94,7 @@
|
|||
"min": 0,
|
||||
"max": 1024
|
||||
},
|
||||
"smithy.api#pattern": "\\p{ASCII}*"
|
||||
"smithy.api#pattern": "^\\p{ASCII}*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#InferenceId": {
|
||||
|
|
@ -101,7 +104,17 @@
|
|||
"min": 1,
|
||||
"max": 64
|
||||
},
|
||||
"smithy.api#pattern": "\\A\\S[\\p{Print}]*\\z"
|
||||
"smithy.api#pattern": "^\\A\\S[\\p{Print}]*\\z$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#InputLocationHeader": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
"smithy.api#length": {
|
||||
"min": 1,
|
||||
"max": 1024
|
||||
},
|
||||
"smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#InternalFailure": {
|
||||
|
|
@ -148,6 +161,108 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#InvokeEndpointAsync": {
|
||||
"type": "operation",
|
||||
"input": {
|
||||
"target": "com.amazonaws.sagemakerruntime#InvokeEndpointAsyncInput"
|
||||
},
|
||||
"output": {
|
||||
"target": "com.amazonaws.sagemakerruntime#InvokeEndpointAsyncOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"target": "com.amazonaws.sagemakerruntime#InternalFailure"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.sagemakerruntime#ServiceUnavailable"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.sagemakerruntime#ValidationError"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>After you deploy a model into production using Amazon SageMaker hosting services, \n your client applications use this API to get inferences from the model hosted at \n the specified endpoint in an asynchronous manner.</p>\n \n <p>Inference requests sent to this API are enqueued for asynchronous processing. \n The processing of the inference request may or may not complete before the \n you receive a response from this API. The response from this API will \n not contain the result of the inference request but contain information \n about where you can locate it.</p>\n \n <p>Amazon SageMaker strips all <code>POST</code> headers except those supported by the API. \n Amazon SageMaker might add additional headers. You should not rely on the behavior \n of headers outside those enumerated in the request syntax.</p>\n \n <p>Calls to <code>InvokeEndpointAsync</code> are authenticated by using AWS Signature\n Version 4. For information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\">Authenticating Requests (AWS Signature Version 4)</a> in the <i>Amazon S3 API\n Reference</i>.</p>",
|
||||
"smithy.api#http": {
|
||||
"method": "POST",
|
||||
"uri": "/endpoints/{EndpointName}/async-invocations",
|
||||
"code": 202
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#InvokeEndpointAsyncInput": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"EndpointName": {
|
||||
"target": "com.amazonaws.sagemakerruntime#EndpointName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the endpoint that you specified when you created the endpoint using \n the <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html\">\n <code>CreateEndpoint</code>\n </a> API.</p>",
|
||||
"smithy.api#httpLabel": {},
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"target": "com.amazonaws.sagemakerruntime#Header",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The MIME type of the input data in the request body.</p>",
|
||||
"smithy.api#httpHeader": "X-Amzn-SageMaker-Content-Type"
|
||||
}
|
||||
},
|
||||
"Accept": {
|
||||
"target": "com.amazonaws.sagemakerruntime#Header",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The desired MIME type of the inference in the response.</p>",
|
||||
"smithy.api#httpHeader": "X-Amzn-SageMaker-Accept"
|
||||
}
|
||||
},
|
||||
"CustomAttributes": {
|
||||
"target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Provides additional information about a request for an inference submitted to \n a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is \n forwarded verbatim. You could use this value, for example, to provide an ID that you \n can use to track a request or to provide other metadata that a service endpoint was \n programmed to process. The value must consist of no more than 1024 \n visible US-ASCII characters as specified in \n <a href=\"https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6\">Section 3.3.6. \n Field Value Components</a> of the Hypertext Transfer Protocol (HTTP/1.1). </p>\n \n <p>The code in your model is responsible for setting or updating any custom attributes \n in the response. If your code does not set this value in the response, an empty \n value is returned. For example, if a custom attribute represents the trace ID, \n your model can prepend the custom attribute with <code>Trace ID</code>: in your post-processing function. </p>\n \n <p>This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK. </p>",
|
||||
"smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes"
|
||||
}
|
||||
},
|
||||
"InferenceId": {
|
||||
"target": "com.amazonaws.sagemakerruntime#InferenceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The identifier for the inference request. Amazon SageMaker will generate an identifier for you \n if none is specified. </p>",
|
||||
"smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Id"
|
||||
}
|
||||
},
|
||||
"InputLocation": {
|
||||
"target": "com.amazonaws.sagemakerruntime#InputLocationHeader",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon S3 URI where the inference request payload is stored.</p>",
|
||||
"smithy.api#httpHeader": "X-Amzn-SageMaker-InputLocation",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"RequestTTLSeconds": {
|
||||
"target": "com.amazonaws.sagemakerruntime#RequestTTLSecondsHeader",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Maximum age in seconds a request can be in the queue before it is marked as expired.</p>",
|
||||
"smithy.api#httpHeader": "X-Amzn-SageMaker-RequestTTLSeconds"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#InvokeEndpointAsyncOutput": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"InferenceId": {
|
||||
"target": "com.amazonaws.sagemakerruntime#Header",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Identifier for an inference request. This will be the same as the <code>InferenceId</code> specified \n in the input. Amazon SageMaker will generate an identifier for you if you do not specify one.</p>"
|
||||
}
|
||||
},
|
||||
"OutputLocation": {
|
||||
"target": "com.amazonaws.sagemakerruntime#Header",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon S3 URI where the inference response payload is stored.</p>",
|
||||
"smithy.api#httpHeader": "X-Amzn-SageMaker-OutputLocation"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#InvokeEndpointInput": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -295,6 +410,16 @@
|
|||
"smithy.api#httpError": 424
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#RequestTTLSecondsHeader": {
|
||||
"type": "integer",
|
||||
"traits": {
|
||||
"smithy.api#box": {},
|
||||
"smithy.api#range": {
|
||||
"min": 60,
|
||||
"max": 21600
|
||||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#ServiceUnavailable": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -321,7 +446,7 @@
|
|||
"min": 0,
|
||||
"max": 63
|
||||
},
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#TargetModelHeader": {
|
||||
|
|
@ -331,7 +456,7 @@
|
|||
"min": 1,
|
||||
"max": 1024
|
||||
},
|
||||
"smithy.api#pattern": "\\A\\S[\\p{Print}]*\\z"
|
||||
"smithy.api#pattern": "^\\A\\S[\\p{Print}]*\\z$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#TargetVariantHeader": {
|
||||
|
|
@ -341,7 +466,7 @@
|
|||
"min": 0,
|
||||
"max": 63
|
||||
},
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*"
|
||||
"smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.sagemakerruntime#ValidationError": {
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
|
|
@ -157,122 +157,6 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssmincidents#SSMIncidents": {
|
||||
"type": "service",
|
||||
"version": "2018-05-10",
|
||||
"operations": [
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#CreateReplicationSet"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#CreateResponsePlan"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#CreateTimelineEvent"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteIncidentRecord"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteReplicationSet"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteResourcePolicy"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteResponsePlan"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteTimelineEvent"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetIncidentRecord"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetReplicationSet"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetResourcePolicies"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetResponsePlan"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetTimelineEvent"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListIncidentRecords"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListRelatedItems"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListReplicationSets"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListResponsePlans"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListTagsForResource"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListTimelineEvents"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#PutResourcePolicy"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#StartIncident"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#TagResource"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UntagResource"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateDeletionProtection"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateIncidentRecord"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateRelatedItems"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateReplicationSet"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateResponsePlan"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateTimelineEvent"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"aws.api#service": {
|
||||
"sdkId": "SSM Incidents",
|
||||
"arnNamespace": "ssm-incidents",
|
||||
"cloudFormationName": "SSMIncidents",
|
||||
"cloudTrailEventSource": "ssm-incidents.amazonaws.com",
|
||||
"endpointPrefix": "ssm-incidents"
|
||||
},
|
||||
"aws.auth#sigv4": {
|
||||
"name": "ssm-incidents"
|
||||
},
|
||||
"aws.protocols#restJson1": {},
|
||||
"smithy.api#cors": {
|
||||
"additionalAllowedHeaders": [
|
||||
"x-amz-content-sha256",
|
||||
"x-amz-user-agent",
|
||||
"content-type",
|
||||
"x-amzn-platform-id"
|
||||
]
|
||||
},
|
||||
"smithy.api#documentation": "<p>AWS Systems Manager Incident Manager is an incident management console designed to help\n users mitigate and recover from incidents affecting their AWS-hosted applications. An incident\n is any unplanned interruption or reduction in quality of services. </p>\n <p>Incident Manager increases incident resolution by notifying responders of impact,\n highlighting relevant troubleshooting data, and providing collaboration tools to get services\n back up and running. To achieve the primary goal of reducing the time-to-resolution of\n critical incidents, Incident Manager automates response plans and enables responder team\n escalation. </p>",
|
||||
"smithy.api#title": "AWS Systems Manager Incident Manager"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssmincidents#Condition": {
|
||||
"type": "union",
|
||||
"members": {
|
||||
|
|
@ -546,8 +430,7 @@
|
|||
"target": "com.amazonaws.ssmincidents#ClientToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token ensuring that the action is called only once with the specified details.</p>",
|
||||
"smithy.api#idempotencyToken": {},
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#idempotencyToken": {}
|
||||
}
|
||||
},
|
||||
"incidentRecordArn": {
|
||||
|
|
@ -574,7 +457,7 @@
|
|||
"eventData": {
|
||||
"target": "com.amazonaws.ssmincidents#EventData",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A short description of the event.</p>",
|
||||
"smithy.api#documentation": "<p>A valid JSON string. There is no other schema imposed. A short description of the event.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -1555,7 +1438,7 @@
|
|||
"notificationTargets": {
|
||||
"target": "com.amazonaws.ssmincidents#NotificationTargetSet",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The SNS targets that\n AWS Chatbot uses\n to notify the chat channels and perform actions on the incident record.</p>"
|
||||
"smithy.api#documentation": "<p>The SNS targets that are notified when updates are made to an incident.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1727,7 +1610,7 @@
|
|||
"notificationTargets": {
|
||||
"target": "com.amazonaws.ssmincidents#NotificationTargetSet",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an\n incident. You can also make updates to the incident through the chat channel using the SNS\n topics. </p>"
|
||||
"smithy.api#documentation": "<p>The SNS targets that are notified when updates are made to an incident.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2349,7 +2232,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The SNS topic that's used by\n AWS\n Chatbot to notify the incidents chat channel.</p>"
|
||||
"smithy.api#documentation": "<p>The SNS targets that are notified when updates are made to an incident.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssmincidents#NotificationTargetSet": {
|
||||
|
|
@ -2618,6 +2501,12 @@
|
|||
"com.amazonaws.ssmincidents#ReplicationSet": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"arn": {
|
||||
"target": "com.amazonaws.ssmincidents#Arn",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the replication set.</p>"
|
||||
}
|
||||
},
|
||||
"regionMap": {
|
||||
"target": "com.amazonaws.ssmincidents#RegionInfoMap",
|
||||
"traits": {
|
||||
|
|
@ -2874,6 +2763,122 @@
|
|||
"smithy.api#pattern": "^arn:aws(-cn|-us-gov)?:iam::([0-9]{12})?:role/.+$"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssmincidents#SSMIncidents": {
|
||||
"type": "service",
|
||||
"version": "2018-05-10",
|
||||
"operations": [
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#CreateReplicationSet"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#CreateResponsePlan"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#CreateTimelineEvent"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteIncidentRecord"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteReplicationSet"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteResourcePolicy"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteResponsePlan"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#DeleteTimelineEvent"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetIncidentRecord"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetReplicationSet"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetResourcePolicies"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetResponsePlan"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#GetTimelineEvent"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListIncidentRecords"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListRelatedItems"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListReplicationSets"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListResponsePlans"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListTagsForResource"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#ListTimelineEvents"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#PutResourcePolicy"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#StartIncident"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#TagResource"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UntagResource"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateDeletionProtection"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateIncidentRecord"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateRelatedItems"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateReplicationSet"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateResponsePlan"
|
||||
},
|
||||
{
|
||||
"target": "com.amazonaws.ssmincidents#UpdateTimelineEvent"
|
||||
}
|
||||
],
|
||||
"traits": {
|
||||
"aws.api#service": {
|
||||
"sdkId": "SSM Incidents",
|
||||
"arnNamespace": "ssm-incidents",
|
||||
"cloudFormationName": "SSMIncidents",
|
||||
"cloudTrailEventSource": "ssm-incidents.amazonaws.com",
|
||||
"endpointPrefix": "ssm-incidents"
|
||||
},
|
||||
"aws.auth#sigv4": {
|
||||
"name": "ssm-incidents"
|
||||
},
|
||||
"aws.protocols#restJson1": {},
|
||||
"smithy.api#cors": {
|
||||
"additionalAllowedHeaders": [
|
||||
"x-amz-content-sha256",
|
||||
"x-amz-user-agent",
|
||||
"content-type",
|
||||
"x-amzn-platform-id"
|
||||
]
|
||||
},
|
||||
"smithy.api#documentation": "<p>AWS Systems Manager Incident Manager is an incident management console designed to help\n users mitigate and recover from incidents affecting their AWS-hosted applications. An incident\n is any unplanned interruption or reduction in quality of services. </p>\n <p>Incident Manager increases incident resolution by notifying responders of impact,\n highlighting relevant troubleshooting data, and providing collaboration tools to get services\n back up and running. To achieve the primary goal of reducing the time-to-resolution of\n critical incidents, Incident Manager automates response plans and enables responder team\n escalation. </p>",
|
||||
"smithy.api#title": "AWS Systems Manager Incident Manager"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssmincidents#ServiceCode": {
|
||||
"type": "string",
|
||||
"traits": {
|
||||
|
|
@ -3649,7 +3654,7 @@
|
|||
"notificationTargets": {
|
||||
"target": "com.amazonaws.ssmincidents#NotificationTargetSet",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an\n incident. You can also make updates to the incident through the chat channel using the\n SNS topics. </p>\n <p>Using multiple SNS topics creates redundancy in the case that a Region is down during\n the incident.</p>"
|
||||
"smithy.api#documentation": "<p>The SNS targets that are notified when updates are made to an incident.</p>\n <p>Using multiple SNS topics creates redundancy in the case that a Region is down during\n the incident.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -3902,13 +3907,13 @@
|
|||
"incidentTemplateNotificationTargets": {
|
||||
"target": "com.amazonaws.ssmincidents#NotificationTargetSet",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The SNS targets that\n AWS\n Chatbot uses to notify the chat channels and perform actions on the\n incident record.</p>"
|
||||
"smithy.api#documentation": "<p>The SNS targets that are notified when updates are made to an incident.</p>"
|
||||
}
|
||||
},
|
||||
"chatChannel": {
|
||||
"target": "com.amazonaws.ssmincidents#ChatChannel",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The\n AWS\n Chatbot chat channel used for collaboration during an\n incident.</p>"
|
||||
"smithy.api#documentation": "<p>The\n AWS\n Chatbot chat channel used for collaboration during an\n incident.</p>\n <p>Use the empty structure to remove the chat channel from the response plan.</p>"
|
||||
}
|
||||
},
|
||||
"engagements": {
|
||||
|
|
@ -3974,8 +3979,7 @@
|
|||
"target": "com.amazonaws.ssmincidents#ClientToken",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A token ensuring that the action is called only once with the specified details.</p>",
|
||||
"smithy.api#idempotencyToken": {},
|
||||
"smithy.api#required": {}
|
||||
"smithy.api#idempotencyToken": {}
|
||||
}
|
||||
},
|
||||
"incidentRecordArn": {
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@
|
|||
"AccountId": {
|
||||
"target": "com.amazonaws.ssm#AccountId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The account ID where the current document is shared.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services account ID where the current document is shared.</p>"
|
||||
}
|
||||
},
|
||||
"SharedDocumentVersion": {
|
||||
|
|
@ -70,7 +70,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Information includes the account ID where the current document is shared and the\n version shared with that account.</p>"
|
||||
"smithy.api#documentation": "<p>Information includes the Amazon Web Services account ID where the current document is shared and the\n version shared with that account.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#AccountSharingInfoList": {
|
||||
|
|
@ -82,7 +82,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of of accounts where the current document is shared and the version shared with\n each account.</p>"
|
||||
"smithy.api#documentation": "<p>A list of of Amazon Web Services accounts where the current document is shared and the version shared with\n each account.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#Accounts": {
|
||||
|
|
@ -829,7 +829,7 @@
|
|||
"InstanceId": {
|
||||
"target": "com.amazonaws.ssm#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the instance.</p>"
|
||||
"smithy.api#documentation": "<p>The instance ID.</p>"
|
||||
}
|
||||
},
|
||||
"AssociationId": {
|
||||
|
|
@ -936,7 +936,7 @@
|
|||
"InstanceId": {
|
||||
"target": "com.amazonaws.ssm#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the instance.</p>"
|
||||
"smithy.api#documentation": "<p>The instance ID.</p>"
|
||||
}
|
||||
},
|
||||
"AssociationVersion": {
|
||||
|
|
@ -1068,7 +1068,7 @@
|
|||
"TargetLocations": {
|
||||
"target": "com.amazonaws.ssm#TargetLocations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The combination of Regions and accounts where you want to run the\n association.</p>"
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1769,7 +1769,7 @@
|
|||
"TargetLocations": {
|
||||
"target": "com.amazonaws.ssm#TargetLocations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The combination of Regions and accounts where you wanted to run the association\n when this association version was created.</p>"
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2203,7 +2203,7 @@
|
|||
"TargetLocations": {
|
||||
"target": "com.amazonaws.ssm#TargetLocations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The combination of Regions and/or accounts where you want to run the\n Automation.</p>"
|
||||
"smithy.api#documentation": "<p>The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the\n Automation.</p>"
|
||||
}
|
||||
},
|
||||
"ProgressCounters": {
|
||||
|
|
@ -2520,7 +2520,7 @@
|
|||
"AutomationType": {
|
||||
"target": "com.amazonaws.ssm#AutomationType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Use this filter with <a>DescribeAutomationExecutions</a>. Specify either Local or\n CrossAccount. CrossAccount is an Automation that runs in multiple Regions and\n accounts. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html\">Running Automation workflows in multiple Regions and accounts</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>. </p>"
|
||||
"smithy.api#documentation": "<p>Use this filter with <a>DescribeAutomationExecutions</a>. Specify either Local or\n CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and\n Amazon Web Services accounts. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html\">Running Automation workflows in multiple Amazon Web Services Regions and accounts</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>. </p>"
|
||||
}
|
||||
},
|
||||
"AutomationSubtype": {
|
||||
|
|
@ -3104,7 +3104,7 @@
|
|||
"OutputS3Region": {
|
||||
"target": "com.amazonaws.ssm#S3Region",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.</p>"
|
||||
"smithy.api#documentation": "<p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Amazon Web Services Region of the S3 bucket.</p>"
|
||||
}
|
||||
},
|
||||
"OutputS3BucketName": {
|
||||
|
|
@ -4142,7 +4142,7 @@
|
|||
"IamRole": {
|
||||
"target": "com.amazonaws.ssm#IamRole",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Identity and Access Management (IAM) role that you want to assign to the managed\n instance. This IAMrole must provide AssumeRole permissions for the Amazon Web Services Systems Manager\n service principal <code>ssm.amazonaws.com</code>. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html\">Create an\n IAM service role for a hybrid environment</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the Identity and Access Management (IAM) role that you want to assign to\n the managed instance. This IAM role must provide AssumeRole permissions for the\n Amazon Web Services Systems Manager service principal <code>ssm.amazonaws.com</code>. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html\">Create an\n IAM service role for a hybrid environment</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -4310,14 +4310,14 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.ssm#DocumentARN",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the SSM document that contains the configuration information for the instance.\n You can specify Command or Automation runbooks.</p>\n <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.</p>\n <p>For SSM documents that are shared with you from other accounts, you must specify the\n complete SSM document ARN, in the following format:</p>\n <p>\n <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i>\n </code>\n </p>\n <p>For example:</p>\n <p>\n <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code>\n </p>\n <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or\n <code>My-Document</code>.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the SSM document that contains the configuration information for the instance.\n You can specify Command or Automation runbooks.</p>\n <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.</p>\n <p>For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the\n complete SSM document ARN, in the following format:</p>\n <p>\n <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i>\n </code>\n </p>\n <p>For example:</p>\n <p>\n <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code>\n </p>\n <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or\n <code>My-Document</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"InstanceId": {
|
||||
"target": "com.amazonaws.ssm#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the instance. </p>"
|
||||
"smithy.api#documentation": "<p>The instance ID.</p>\n <note>\n <p>\n <code>InstanceId</code> has been deprecated. To specify an instance ID for an association,\n use the <code>Targets</code> parameter. Requests that include the\n parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version\n 2.0 or later will fail. In addition, if you use the parameter\n <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>,\n <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>,\n <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you\n must use the <code>Targets</code> parameter.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"Parameters": {
|
||||
|
|
@ -4432,7 +4432,7 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.ssm#DocumentARN",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.</p>\n <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.</p>\n <p>For Systems Manager documents (SSM documents) that are shared with you from other accounts, you\n must specify the complete SSM document ARN, in the following format:</p>\n <p>\n <code>arn:<i>partition</i>:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i>\n </code>\n </p>\n <p>For example:</p>\n <p>\n <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code>\n </p>\n <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or\n <code>My-Document</code>.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.</p>\n <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.</p>\n <p>For Systems Manager documents (SSM documents) that are shared with you from other Amazon Web Services accounts, you\n must specify the complete SSM document ARN, in the following format:</p>\n <p>\n <code>arn:<i>partition</i>:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i>\n </code>\n </p>\n <p>For example:</p>\n <p>\n <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code>\n </p>\n <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or\n <code>My-Document</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -4457,7 +4457,7 @@
|
|||
"Targets": {
|
||||
"target": "com.amazonaws.ssm#Targets",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The targets for the association. You can target instances by using tags, Amazon Web Services resource\n groups, all instances in an account, or individual instance IDs. For more information about\n choosing targets for an association, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html\">Using targets and rate controls with State Manager associations</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The targets for the association. You can target instances by using tags, Amazon Web Services resource\n groups, all instances in an Amazon Web Services account, or individual instance IDs. For more information about\n choosing targets for an association, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html\">Using targets and rate controls with State Manager associations</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduleExpression": {
|
||||
|
|
@ -4523,7 +4523,7 @@
|
|||
"TargetLocations": {
|
||||
"target": "com.amazonaws.ssm#TargetLocations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A location is a combination of Regions and accounts where you want to run the\n association. Use this action to create an association in multiple Regions and multiple\n accounts.</p>"
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -4950,7 +4950,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 OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by\n purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to\n identify an environment or target Region. In this case, you could specify the following\n key-value pairs:</p>\n <ul>\n <li>\n <p>\n <code>Key=Environment,Value=Production</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Region,Value=us-east-2</code>\n </p>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by\n purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to\n identify an environment or target Amazon Web Services Region. In this case, you could specify the following\n key-value pairs:</p>\n <ul>\n <li>\n <p>\n <code>Key=Environment,Value=Production</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Region,Value=us-east-2</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -5109,7 +5109,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A resource data sync helps you view data from multiple sources in a single location.\n Amazon Web Services Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and\n <code>SyncFromSource</code>.</p>\n <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to\n synchronize Inventory data from multiple Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html\">Configuring resource data\n sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize\n operational work items (OpsItems) and operational data (OpsData) from multiple Regions to a\n single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple\n accounts and Regions or <code>EntireOrganization</code> by using Organizations. For more\n information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html\">Setting up Systems Manager\n Explorer to display data from multiple accounts and Regions</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n <p>A resource data sync is an asynchronous operation that returns immediately. After a\n successful initial sync is completed, the system continuously syncs data. To check the status of\n a sync, use the <a>ListResourceDataSync</a>.</p>\n <note>\n <p>By default, data isn't encrypted in Amazon S3. We strongly recommend that you\n enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you\n secure access to the Amazon S3 bucket by creating a restrictive bucket policy. </p>\n </note>"
|
||||
"smithy.api#documentation": "<p>A resource data sync helps you view data from multiple sources in a single location.\n Amazon Web Services Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and\n <code>SyncFromSource</code>.</p>\n <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to\n synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html\">Configuring resource data\n sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize\n operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a\n single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple\n Amazon Web Services accounts and Amazon Web Services Regions or <code>EntireOrganization</code> by using Organizations. For more\n information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html\">Setting up Systems Manager\n Explorer to display data from multiple accounts and Regions</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n <p>A resource data sync is an asynchronous operation that returns immediately. After a\n successful initial sync is completed, the system continuously syncs data. To check the status of\n a sync, use the <a>ListResourceDataSync</a>.</p>\n <note>\n <p>By default, data isn't encrypted in Amazon S3. We strongly recommend that you\n enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you\n secure access to the Amazon S3 bucket by creating a restrictive bucket policy. </p>\n </note>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#CreateResourceDataSyncRequest": {
|
||||
|
|
@ -5131,7 +5131,7 @@
|
|||
"SyncType": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specify <code>SyncToDestination</code> to create a resource data sync that synchronizes data\n to an S3 bucket for Inventory. If you specify <code>SyncToDestination</code>, you must provide a\n value for <code>S3Destination</code>. Specify <code>SyncFromSource</code> to synchronize data\n from a single account and multiple Regions, or multiple accounts and Regions, as\n listed in Organizations for Explorer. If you specify <code>SyncFromSource</code>, you must provide a\n value for <code>SyncSource</code>. The default value is <code>SyncToDestination</code>.</p>"
|
||||
"smithy.api#documentation": "<p>Specify <code>SyncToDestination</code> to create a resource data sync that synchronizes data\n to an S3 bucket for Inventory. If you specify <code>SyncToDestination</code>, you must provide a\n value for <code>S3Destination</code>. Specify <code>SyncFromSource</code> to synchronize data\n from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as\n listed in Organizations for Explorer. If you specify <code>SyncFromSource</code>, you must provide a\n value for <code>SyncSource</code>. The default value is <code>SyncToDestination</code>.</p>"
|
||||
}
|
||||
},
|
||||
"SyncSource": {
|
||||
|
|
@ -5249,7 +5249,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified\n instance.</p>\n <p>When you disassociate a document from an instance, it doesn't change the configuration of\n the instance. To change the configuration state of an instance after you disassociate a document,\n you must create a new document with the desired configuration and associate it with the\n instance.</p>"
|
||||
"smithy.api#documentation": "<p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified instance.\n If you created the association by using the <code>Targets</code> parameter, then you must delete\n the association by using the association ID.</p>\n <p>When you disassociate a document from an instance, it doesn't change the configuration of\n the instance. To change the configuration state of an instance after you disassociate a document,\n you must create a new document with the desired configuration and associate it with the\n instance.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#DeleteAssociationRequest": {
|
||||
|
|
@ -5264,7 +5264,7 @@
|
|||
"InstanceId": {
|
||||
"target": "com.amazonaws.ssm#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the instance.</p>"
|
||||
"smithy.api#documentation": "<p>The instance ID.</p>\n <note>\n <p>\n <code>InstanceId</code> has been deprecated. To specify an instance ID for an association,\n use the <code>Targets</code> parameter. Requests that include the\n parameter <code>InstanceID</code> with Systems Manager documents (SSM documents) that use schema version\n 2.0 or later will fail. In addition, if you use the parameter\n <code>InstanceId</code>, you can't use the parameters <code>AssociationName</code>,\n <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>,\n <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you\n must use the <code>Targets</code> parameter.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"AssociationId": {
|
||||
|
|
@ -5518,7 +5518,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Delete a parameter from the system.</p>"
|
||||
"smithy.api#documentation": "<p>Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds\n to create a parameter with the same name.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#DeleteParameterRequest": {
|
||||
|
|
@ -5551,7 +5551,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Delete a list of parameters.</p>"
|
||||
"smithy.api#documentation": "<p>Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to\n create a parameter with the same name.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#DeleteParametersRequest": {
|
||||
|
|
@ -5560,7 +5560,7 @@
|
|||
"Names": {
|
||||
"target": "com.amazonaws.ssm#ParameterNameList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The names of the parameters to delete.</p>",
|
||||
"smithy.api#documentation": "<p>The names of the parameters to delete. After deleting a parameter, wait for at least 30\n seconds to create a parameter with the same name.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -5992,7 +5992,7 @@
|
|||
"ActivationList": {
|
||||
"target": "com.amazonaws.ssm#ActivationList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of activations for your account.</p>"
|
||||
"smithy.api#documentation": "<p>A list of activations for your Amazon Web Services account.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
|
@ -6029,7 +6029,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the association for the specified target or instance. If you created the\n association by using the <code>Targets</code> parameter, then you must retrieve the association\n by using the association ID. If you created the association by specifying an instance ID and an\n Amazon Web Services Systems Manager document (SSM document), then you retrieve the association by specifying the document\n name and the instance ID. </p>"
|
||||
"smithy.api#documentation": "<p>Describes the association for the specified target or instance. If you created the\n association by using the <code>Targets</code> parameter, then you must retrieve the association\n by using the association ID.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#DescribeAssociationExecutionTargets": {
|
||||
|
|
@ -6512,7 +6512,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the\n document, you are the owner. If a document is shared, it can either be shared privately (by\n specifying a user's account ID) or publicly (<i>All</i>). </p>"
|
||||
"smithy.api#documentation": "<p>Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the\n document, you are the owner. If a document is shared, it can either be shared privately (by\n specifying a user's Amazon Web Services account ID) or publicly (<i>All</i>). </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#DescribeDocumentPermissionRequest": {
|
||||
|
|
@ -6553,13 +6553,13 @@
|
|||
"AccountIds": {
|
||||
"target": "com.amazonaws.ssm#AccountIdList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The account IDs that have permission to use this document. The ID can be either an\n account or <i>All</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The account IDs that have permission to use this document. The ID can be either an\n Amazon Web Services account or <i>All</i>.</p>"
|
||||
}
|
||||
},
|
||||
"AccountSharingInfoList": {
|
||||
"target": "com.amazonaws.ssm#AccountSharingInfoList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A list of accounts where the current document is shared and the version shared with\n each account.</p>"
|
||||
"smithy.api#documentation": "<p>A list of Amazon Web Services accounts where the current document is shared and the version shared with\n each account.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
|
@ -7671,7 +7671,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves the maintenance windows in an account.</p>",
|
||||
"smithy.api#documentation": "<p>Retrieves the maintenance windows in an Amazon Web Services account.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -7951,7 +7951,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the patch baselines in your account.</p>",
|
||||
"smithy.api#documentation": "<p>Lists the patch baselines in your Amazon Web Services account.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -10043,7 +10043,7 @@
|
|||
"Target": {
|
||||
"target": "com.amazonaws.ssm#SessionTarget",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the instance.</p>",
|
||||
"smithy.api#documentation": "<p>The instance ID.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -10131,7 +10131,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Retrieves the current snapshot for the patch baseline the instance uses. This API is\n primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p>\n <note>\n <p>If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local AWS credentials and the operation fails. To avoid\n this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of\n Amazon Web Services Systems Manager, with an SSM document that enables you to target an instance with a script or command.\n For example, run the command using the <code>AWS-RunShellScript</code> document or the\n <code>AWS-RunPowerShellScript</code> document.</p>\n </note>"
|
||||
"smithy.api#documentation": "<p>Retrieves the current snapshot for the patch baseline the instance uses. This API is\n primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p>\n <note>\n <p>If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid\n this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of\n Amazon Web Services Systems Manager, with an SSM document that enables you to target an instance with a script or command.\n For example, run the command using the <code>AWS-RunShellScript</code> document or the\n <code>AWS-RunPowerShellScript</code> document.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#GetDeployablePatchSnapshotForInstanceRequest": {
|
||||
|
|
@ -10165,7 +10165,7 @@
|
|||
"InstanceId": {
|
||||
"target": "com.amazonaws.ssm#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the instance.</p>"
|
||||
"smithy.api#documentation": "<p>The instance ID.</p>"
|
||||
}
|
||||
},
|
||||
"SnapshotId": {
|
||||
|
|
@ -10356,7 +10356,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Query inventory information.</p>",
|
||||
"smithy.api#documentation": "<p>Query inventory information. This includes instance status, such as <code>Stopped</code> or\n <code>Terminated</code>.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -11293,7 +11293,7 @@
|
|||
"Entities": {
|
||||
"target": "com.amazonaws.ssm#OpsEntityList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The list of aggregated and filtered OpsData.</p>"
|
||||
"smithy.api#documentation": "<p>The list of aggregated details and filtered OpsData.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
|
@ -11327,7 +11327,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Get information about a parameter by using the parameter name. Don't confuse this API\n operation with the <a>GetParameters</a> API operation.</p>"
|
||||
"smithy.api#documentation": "<p>Get information about a single parameter by specifying the parameter name.</p>\n <note>\n <p>To get information about more than one parameter at a time, use the <a>GetParameters</a> operation.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#GetParameterHistory": {
|
||||
|
|
@ -11416,7 +11416,7 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.ssm#PSParameterName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the parameter you want to query.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the parameter you want to query.</p>\n <p>To query by parameter label, use <code>\"Name\": \"name:label\"</code>. To query by parameter\n version, use <code>\"Name\": \"name:version\"</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -11457,7 +11457,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Get details of a parameter. Don't confuse this API operation with the <a>GetParameter</a> API operation.</p>"
|
||||
"smithy.api#documentation": "<p>Get information about one or more parameters by specifying multiple parameter names.</p>\n <note>\n <p>To get information about a single parameter, you can use the <a>GetParameter</a>\n operation instead.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#GetParametersByPath": {
|
||||
|
|
@ -11574,7 +11574,7 @@
|
|||
"Names": {
|
||||
"target": "com.amazonaws.ssm#ParameterNameList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Names of the parameters for which you want to query information.</p>",
|
||||
"smithy.api#documentation": "<p>Names of the parameters for which you want to query information.</p>\n <p>To query by parameter label, use <code>\"Name\": \"name:label\"</code>. To query by parameter\n version, use <code>\"Name\": \"name:version\"</code>.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -11691,7 +11691,7 @@
|
|||
"BaselineId": {
|
||||
"target": "com.amazonaws.ssm#BaselineId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the patch baseline to retrieve.</p>",
|
||||
"smithy.api#documentation": "<p>The ID of the patch baseline to retrieve.</p>\n <note>\n <p>To retrieve information about an Amazon Web Services managed patch baseline, specify the full Amazon\n Resource Name (ARN) of the baseline. For example, for the baseline\n <code>AWS-AmazonLinuxDefaultPatchBaseline</code>, specify\n <code>arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7</code> instead of\n <code>pb-0e392de35e7c563b7</code>.</p>\n </note>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -11810,7 +11810,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>\n <code>ServiceSetting</code> is an account-level setting for an Amazon Web Services service. This setting\n defines how a user interacts with or uses a service or a feature of a service. For example, if an\n Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services\n service team might create a default setting of <code>false</code>. This means the user can't use\n this feature unless they change the setting to <code>true</code> and intentionally opt in for a\n paid feature.</p>\n <p>Services map a <code>SettingId</code> object to a setting value. Amazon Web Services services teams define\n the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>,\n but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code>\n permission for the setting. Use the <a>UpdateServiceSetting</a> API operation to\n change the default setting. Or use the <a>ResetServiceSetting</a> to change the value\n back to the original value defined by the Amazon Web Services service team.</p>\n <p>Query the current service setting for the account. </p>"
|
||||
"smithy.api#documentation": "<p>\n <code>ServiceSetting</code> is an account-level setting for an Amazon Web Services service. This setting\n defines how a user interacts with or uses a service or a feature of a service. For example, if an\n Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services\n service team might create a default setting of <code>false</code>. This means the user can't use\n this feature unless they change the setting to <code>true</code> and intentionally opt in for a\n paid feature.</p>\n <p>Services map a <code>SettingId</code> object to a setting value. Amazon Web Services services teams define\n the default value for a <code>SettingId</code>. You can't create a new <code>SettingId</code>,\n but you can overwrite the default value if you have the <code>ssm:UpdateServiceSetting</code>\n permission for the setting. Use the <a>UpdateServiceSetting</a> API operation to\n change the default setting. Or use the <a>ResetServiceSetting</a> to change the value\n back to the original value defined by the Amazon Web Services service team.</p>\n <p>Query the current service setting for the Amazon Web Services account. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#GetServiceSettingRequest": {
|
||||
|
|
@ -14399,7 +14399,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns all State Manager associations in the current account and Region. You\n can limit the results to a specific State Manager association document or instance by specifying\n a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>",
|
||||
"smithy.api#documentation": "<p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You\n can limit the results to a specific State Manager association document or instance by specifying\n a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -14569,7 +14569,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Lists the commands requested by users of the account.</p>",
|
||||
"smithy.api#documentation": "<p>Lists the commands requested by users of the Amazon Web Services account.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -14812,7 +14812,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Information about approval reviews for a version of an SSM document.</p>"
|
||||
"smithy.api#documentation": "<p>Information about approval reviews for a version of a change template in Change Manager.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#ListDocumentMetadataHistoryRequest": {
|
||||
|
|
@ -14821,14 +14821,14 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.ssm#DocumentName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the document.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the change template.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"DocumentVersion": {
|
||||
"target": "com.amazonaws.ssm#DocumentVersion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The version of the document.</p>"
|
||||
"smithy.api#documentation": "<p>The version of the change template.</p>"
|
||||
}
|
||||
},
|
||||
"Metadata": {
|
||||
|
|
@ -14859,25 +14859,25 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.ssm#DocumentName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the document.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the change template.</p>"
|
||||
}
|
||||
},
|
||||
"DocumentVersion": {
|
||||
"target": "com.amazonaws.ssm#DocumentVersion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The version of the document.</p>"
|
||||
"smithy.api#documentation": "<p>The version of the change template.</p>"
|
||||
}
|
||||
},
|
||||
"Author": {
|
||||
"target": "com.amazonaws.ssm#DocumentAuthor",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The user ID of the person in the organization who requested the document review.</p>"
|
||||
"smithy.api#documentation": "<p>The user ID of the person in the organization who requested the review of the\n change template.</p>"
|
||||
}
|
||||
},
|
||||
"Metadata": {
|
||||
"target": "com.amazonaws.ssm#DocumentMetadataResponseInfo",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Information about the response to the document approval request.</p>"
|
||||
"smithy.api#documentation": "<p>Information about the response to the change template approval request.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
|
@ -14979,7 +14979,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns all Systems Manager (SSM) documents in the current account and Region. You can\n limit the results of this request by using a filter.</p>",
|
||||
"smithy.api#documentation": "<p>Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can\n limit the results of this request by using a filter.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -15166,7 +15166,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Returns a list of all OpsItem events in the current Region and account. You can\n limit the results to events associated with specific OpsItems by specifying a filter.</p>",
|
||||
"smithy.api#documentation": "<p>Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can\n limit the results to events associated with specific OpsItems by specifying a filter.</p>",
|
||||
"smithy.api#paginated": {
|
||||
"inputToken": "NextToken",
|
||||
"outputToken": "NextToken",
|
||||
|
|
@ -15468,7 +15468,7 @@
|
|||
"SyncType": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>View a list of resource data syncs according to the sync type. Specify\n <code>SyncToDestination</code> to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify <code>SyncFromSource</code> to view resource data syncs from Organizations\n or from multiple Regions.</p>"
|
||||
"smithy.api#documentation": "<p>View a list of resource data syncs according to the sync type. Specify\n <code>SyncToDestination</code> to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify <code>SyncFromSource</code> to view resource data syncs from Organizations\n or from multiple Amazon Web Services Regions.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
|
|
@ -15575,7 +15575,7 @@
|
|||
"S3Region": {
|
||||
"target": "com.amazonaws.ssm#S3Region",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Region where the S3 bucket is located.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services Region where the S3 bucket is located.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
@ -17336,7 +17336,7 @@
|
|||
"CreatedBy": {
|
||||
"target": "com.amazonaws.ssm#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the account that created the OpsItem.</p>"
|
||||
"smithy.api#documentation": "<p>The ARN of the Amazon Web Services account that created the OpsItem.</p>"
|
||||
}
|
||||
},
|
||||
"OpsItemType": {
|
||||
|
|
@ -17360,7 +17360,7 @@
|
|||
"LastModifiedBy": {
|
||||
"target": "com.amazonaws.ssm#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ARN of the account that last updated the OpsItem.</p>"
|
||||
"smithy.api#documentation": "<p>The ARN of the Amazon Web Services account that last updated the OpsItem.</p>"
|
||||
}
|
||||
},
|
||||
"LastModifiedTime": {
|
||||
|
|
@ -17461,7 +17461,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational issues impacting the performance and health of their Amazon Web Services resources. For\n more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">OpsCenter</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>. </p>"
|
||||
"smithy.api#documentation": "<p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and\n remediate operational work items (OpsItems) impacting the performance and health of their Amazon Web Services\n resources. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This\n means you can configure these services to automatically create an OpsItem in OpsCenter when a\n CloudWatch alarm enters the ALARM state or when EventBridge processes an event from\n any Amazon Web Services service that publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate\n issues with Amazon Web Services resources from a single console.</p>\n <p>To help you diagnose issues, each OpsItem includes contextually relevant information such as\n the name and ID of the Amazon Web Services resource that generated the OpsItem, alarm or event details, alarm\n history, and an alarm timeline graph. For the Amazon Web Services resource, OpsCenter aggregates information\n from Config, CloudTrail logs, and EventBridge, so you don't have\n to navigate across multiple console pages during your investigation. For more information, see\n <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html\">OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#OpsItemAlreadyExistsException": {
|
||||
|
|
@ -19027,7 +19027,7 @@
|
|||
"code": "ParameterLimitExceeded",
|
||||
"httpResponseCode": 429
|
||||
},
|
||||
"smithy.api#documentation": "<p>You have exceeded the number of parameters for this account. Delete one or more\n parameters and try again.</p>",
|
||||
"smithy.api#documentation": "<p>You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more\n parameters and try again.</p>",
|
||||
"smithy.api#error": "client"
|
||||
}
|
||||
},
|
||||
|
|
@ -20521,31 +20521,31 @@
|
|||
"TotalSteps": {
|
||||
"target": "com.amazonaws.ssm#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The total number of steps run in all specified Regions and accounts for the\n current Automation execution.</p>"
|
||||
"smithy.api#documentation": "<p>The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the\n current Automation execution.</p>"
|
||||
}
|
||||
},
|
||||
"SuccessSteps": {
|
||||
"target": "com.amazonaws.ssm#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The total number of steps that successfully completed in all specified Regions and\n accounts for the current Automation execution.</p>"
|
||||
"smithy.api#documentation": "<p>The total number of steps that successfully completed in all specified Amazon Web Services Regions and\n Amazon Web Services accounts for the current Automation execution.</p>"
|
||||
}
|
||||
},
|
||||
"FailedSteps": {
|
||||
"target": "com.amazonaws.ssm#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The total number of steps that failed to run in all specified Regions and\n accounts for the current Automation execution.</p>"
|
||||
"smithy.api#documentation": "<p>The total number of steps that failed to run in all specified Amazon Web Services Regions and\n Amazon Web Services accounts for the current Automation execution.</p>"
|
||||
}
|
||||
},
|
||||
"CancelledSteps": {
|
||||
"target": "com.amazonaws.ssm#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The total number of steps that the system cancelled in all specified Regions and\n accounts for the current Automation execution.</p>"
|
||||
"smithy.api#documentation": "<p>The total number of steps that the system cancelled in all specified Amazon Web Services Regions and\n Amazon Web Services accounts for the current Automation execution.</p>"
|
||||
}
|
||||
},
|
||||
"TimedOutSteps": {
|
||||
"target": "com.amazonaws.ssm#Integer",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The total number of steps that timed out in all specified Regions and accounts\n for the current Automation execution.</p>"
|
||||
"smithy.api#documentation": "<p>The total number of steps that timed out in all specified Amazon Web Services Regions and Amazon Web Services accounts\n for the current Automation execution.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -20792,7 +20792,7 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.ssm#PSParameterName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The fully qualified name of the parameter that you want to add to the system. The fully\n qualified name includes the complete hierarchy of the parameter path and name. For parameters in\n a hierarchy, you must include a leading forward slash character (/) when you create or reference\n a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code>\n </p>\n <p>Naming Constraints:</p>\n <ul>\n <li>\n <p>Parameter names are case sensitive.</p>\n </li>\n <li>\n <p>A parameter name must be unique within an Region</p>\n </li>\n <li>\n <p>A parameter name can't be prefixed with \"<code>aws</code>\" or \"<code>ssm</code>\"\n (case-insensitive).</p>\n </li>\n <li>\n <p>Parameter names can include only the following symbols and letters:\n <code>a-zA-Z0-9_.-</code>\n </p>\n <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter\n names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code>\n </p>\n </li>\n <li>\n <p>A parameter name can't include spaces.</p>\n </li>\n <li>\n <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p>\n </li>\n </ul>\n <p>For additional information about valid values for parameter names, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html\">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n <note>\n <p>The maximum length constraint listed below includes capacity for additional system\n attributes that aren't part of the name. The maximum length for a parameter name, including the\n full length of the parameter ARN, is 1011 characters. For example, the length of the following\n parameter name is 65 characters, not 20 characters:</p>\n <p>\n <code>arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName</code>\n </p>\n </note>",
|
||||
"smithy.api#documentation": "<p>The fully qualified name of the parameter that you want to add to the system. The fully\n qualified name includes the complete hierarchy of the parameter path and name. For parameters in\n a hierarchy, you must include a leading forward slash character (/) when you create or reference\n a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code>\n </p>\n <p>Naming Constraints:</p>\n <ul>\n <li>\n <p>Parameter names are case sensitive.</p>\n </li>\n <li>\n <p>A parameter name must be unique within an Amazon Web Services Region</p>\n </li>\n <li>\n <p>A parameter name can't be prefixed with \"<code>aws</code>\" or \"<code>ssm</code>\"\n (case-insensitive).</p>\n </li>\n <li>\n <p>Parameter names can include only the following symbols and letters:\n <code>a-zA-Z0-9_.-</code>\n </p>\n <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter\n names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code>\n </p>\n </li>\n <li>\n <p>A parameter name can't include spaces.</p>\n </li>\n <li>\n <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p>\n </li>\n </ul>\n <p>For additional information about valid values for parameter names, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html\">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n <note>\n <p>The maximum length constraint listed below includes capacity for additional system\n attributes that aren't part of the name. The maximum length for a parameter name, including the\n full length of the parameter ARN, is 1011 characters. For example, the length of the following\n parameter name is 65 characters, not 20 characters:</p>\n <p>\n <code>arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName</code>\n </p>\n </note>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -20818,7 +20818,7 @@
|
|||
"KeyId": {
|
||||
"target": "com.amazonaws.ssm#ParameterKeyId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Key Management Service (KMS) ID that you want to use to encrypt a\n parameter. Either the default KMS key automatically assigned to your account\n or a custom key. Required for parameters that use the <code>SecureString</code>\n data type.</p>\n <p>If you don't specify a key ID, the system uses the default key associated with your\n account.</p>\n <ul>\n <li>\n <p>To use your default KMS key, choose the <code>SecureString</code> data type, and do <i>not</i> specify the <code>Key ID</code> when you create the parameter. The system automatically populates\n <code>Key ID</code> with your default KMS key.</p>\n </li>\n <li>\n <p>To use a custom KMS key, choose the <code>SecureString</code>\n data type with the <code>Key ID</code> parameter.</p>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>The Key Management Service (KMS) ID that you want to use to encrypt a\n parameter. Either the default KMS key automatically assigned to your Amazon Web Services account\n or a custom key. Required for parameters that use the <code>SecureString</code>\n data type.</p>\n <p>If you don't specify a key ID, the system uses the default key associated with your\n Amazon Web Services account.</p>\n <ul>\n <li>\n <p>To use your default KMS key, choose the <code>SecureString</code> data type, and do <i>not</i> specify the <code>Key ID</code> when you create the parameter. The system automatically populates\n <code>Key ID</code> with your default KMS key.</p>\n </li>\n <li>\n <p>To use a custom KMS key, choose the <code>SecureString</code>\n data type with the <code>Key ID</code> parameter.</p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"Overwrite": {
|
||||
|
|
@ -20843,7 +20843,7 @@
|
|||
"Tier": {
|
||||
"target": "com.amazonaws.ssm#ParameterTier",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The parameter tier to assign to a parameter.</p>\n <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard\n parameters have a content size limit of 4 KB and can't be configured to use parameter policies.\n You can create a maximum of 10,000 standard parameters for each Region in an account.\n Standard parameters are offered at no additional cost. </p>\n <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter\n policies. You can create a maximum of 100,000 advanced parameters for each Region in an\n account. Advanced parameters incur a charge. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html\">Standard and\n advanced parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n <p>You can change a standard parameter to an advanced parameter any time. But you can't revert\n an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard\n parameter would result in data loss because the system would truncate the size of the parameter\n from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly,\n advanced parameters use a different form of encryption than standard parameters. </p>\n <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for\n an advanced parameter, you must delete it and recreate it as a new standard parameter. </p>\n <p>\n <b>Using the Default Tier Configuration</b>\n </p>\n <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in.\n Whenever you specify a tier in the request, Parameter Store creates or updates the parameter\n according to that request. However, if you don't specify a tier in a request, Parameter Store\n assigns the tier based on the current Parameter Store default tier configuration.</p>\n <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you\n use the advanced-parameter tier, you can specify one of the following as the default:</p>\n <ul>\n <li>\n <p>\n <b>Advanced</b>: With this option, Parameter Store evaluates all\n requests as advanced parameters. </p>\n </li>\n <li>\n <p>\n <b>Intelligent-Tiering</b>: With this option, Parameter Store\n evaluates each request to determine if the parameter is standard or advanced. </p>\n <p>If the request doesn't include any options that require an advanced parameter, the\n parameter is created in the standard-parameter tier. If one or more options requiring an\n advanced parameter are included in the request, Parameter Store create a parameter in the\n advanced-parameter tier.</p>\n <p>This approach helps control your parameter-related costs by always creating standard\n parameters unless an advanced parameter is necessary. </p>\n </li>\n </ul>\n <p>Options that require an advanced parameter include the following:</p>\n <ul>\n <li>\n <p>The content size of the parameter is more than 4 KB.</p>\n </li>\n <li>\n <p>The parameter uses a parameter policy.</p>\n </li>\n <li>\n <p>More than 10,000 parameters already exist in your account in the current\n Region.</p>\n </li>\n </ul>\n <p>For more information about configuring the default tier option, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html\">Specifying a\n default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The parameter tier to assign to a parameter.</p>\n <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard\n parameters have a content size limit of 4 KB and can't be configured to use parameter policies.\n You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account.\n Standard parameters are offered at no additional cost. </p>\n <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter\n policies. You can create a maximum of 100,000 advanced parameters for each Region in an\n Amazon Web Services account. Advanced parameters incur a charge. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html\">Standard and\n advanced parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n <p>You can change a standard parameter to an advanced parameter any time. But you can't revert\n an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard\n parameter would result in data loss because the system would truncate the size of the parameter\n from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly,\n advanced parameters use a different form of encryption than standard parameters. </p>\n <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for\n an advanced parameter, you must delete it and recreate it as a new standard parameter. </p>\n <p>\n <b>Using the Default Tier Configuration</b>\n </p>\n <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in.\n Whenever you specify a tier in the request, Parameter Store creates or updates the parameter\n according to that request. However, if you don't specify a tier in a request, Parameter Store\n assigns the tier based on the current Parameter Store default tier configuration.</p>\n <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you\n use the advanced-parameter tier, you can specify one of the following as the default:</p>\n <ul>\n <li>\n <p>\n <b>Advanced</b>: With this option, Parameter Store evaluates all\n requests as advanced parameters. </p>\n </li>\n <li>\n <p>\n <b>Intelligent-Tiering</b>: With this option, Parameter Store\n evaluates each request to determine if the parameter is standard or advanced. </p>\n <p>If the request doesn't include any options that require an advanced parameter, the\n parameter is created in the standard-parameter tier. If one or more options requiring an\n advanced parameter are included in the request, Parameter Store create a parameter in the\n advanced-parameter tier.</p>\n <p>This approach helps control your parameter-related costs by always creating standard\n parameters unless an advanced parameter is necessary. </p>\n </li>\n </ul>\n <p>Options that require an advanced parameter include the following:</p>\n <ul>\n <li>\n <p>The content size of the parameter is more than 4 KB.</p>\n </li>\n <li>\n <p>The parameter uses a parameter policy.</p>\n </li>\n <li>\n <p>More than 10,000 parameters already exist in your Amazon Web Services account in the current\n Amazon Web Services Region.</p>\n </li>\n </ul>\n <p>For more information about configuring the default tier option, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html\">Specifying a\n default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"Policies": {
|
||||
|
|
@ -20855,7 +20855,7 @@
|
|||
"DataType": {
|
||||
"target": "com.amazonaws.ssm#ParameterDataType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The data type for a <code>String</code> parameter. Supported data types include plain text\n and Amazon Machine Image (AMI) IDs.</p>\n <p>\n <b>The following data type values are supported.</b>\n </p>\n <ul>\n <li>\n <p>\n <code>text</code>\n </p>\n </li>\n <li>\n <p>\n <code>aws:ec2:image</code>\n </p>\n </li>\n </ul>\n <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>,\n Amazon Web Services Systems Manager validates the parameter value is in the required format, such as\n <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your\n account. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html\">Native parameter support\n for Amazon Machine Image (AMI) IDs</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>The data type for a <code>String</code> parameter. Supported data types include plain text\n and Amazon Machine Image (AMI) IDs.</p>\n <p>\n <b>The following data type values are supported.</b>\n </p>\n <ul>\n <li>\n <p>\n <code>text</code>\n </p>\n </li>\n <li>\n <p>\n <code>aws:ec2:image</code>\n </p>\n </li>\n </ul>\n <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>,\n Amazon Web Services Systems Manager validates the parameter value is in the required format, such as\n <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your\n Amazon Web Services account. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html\">Native parameter support\n for Amazon Machine Image (AMI) IDs</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -21525,7 +21525,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Information about the <code>AwsOrganizationsSource</code> resource data sync source. A sync\n source of this type can synchronize data from Organizations or, if an Amazon Web Services organization isn't\n present, from multiple Regions.</p>"
|
||||
"smithy.api#documentation": "<p>Information about the <code>AwsOrganizationsSource</code> resource data sync source. A sync\n source of this type can synchronize data from Organizations or, if an Amazon Web Services organization isn't\n present, from multiple Amazon Web Services Regions.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#ResourceDataSyncConflictException": {
|
||||
|
|
@ -21574,7 +21574,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Synchronize Amazon Web Services Systems Manager Inventory data from multiple accounts defined in Organizations to a\n centralized Amazon S3 bucket. Data is synchronized to individual key prefixes in the\n central bucket. Each key prefix represents a different account ID.</p>"
|
||||
"smithy.api#documentation": "<p>Synchronize Amazon Web Services Systems Manager Inventory data from multiple Amazon Web Services accounts defined in Organizations to a\n centralized Amazon S3 bucket. Data is synchronized to individual key prefixes in the\n central bucket. Each key prefix represents a different Amazon Web Services account ID.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#ResourceDataSyncDestinationDataSharingType": {
|
||||
|
|
@ -21620,7 +21620,7 @@
|
|||
"SyncType": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncType",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The type of resource data sync. If <code>SyncType</code> is <code>SyncToDestination</code>,\n then the resource data sync synchronizes data to an S3 bucket. If the <code>SyncType</code> is\n <code>SyncFromSource</code> then the resource data sync synchronizes data from Organizations or from\n multiple Regions.</p>"
|
||||
"smithy.api#documentation": "<p>The type of resource data sync. If <code>SyncType</code> is <code>SyncToDestination</code>,\n then the resource data sync synchronizes data to an S3 bucket. If the <code>SyncType</code> is\n <code>SyncFromSource</code> then the resource data sync synchronizes data from Organizations or from\n multiple Amazon Web Services Regions.</p>"
|
||||
}
|
||||
},
|
||||
"SyncSource": {
|
||||
|
|
@ -21796,7 +21796,7 @@
|
|||
"Region": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncS3Region",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Region with the S3 bucket targeted by the resource data sync.</p>",
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -21865,20 +21865,20 @@
|
|||
"SourceRegions": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncSourceRegionList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The <code>SyncSource</code> Regions included in the resource data sync.</p>",
|
||||
"smithy.api#documentation": "<p>The <code>SyncSource</code> Amazon Web Services Regions included in the resource data sync.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"IncludeFutureRegions": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Whether to automatically synchronize and aggregate data from new Regions when those\n Regions come online.</p>"
|
||||
"smithy.api#documentation": "<p>Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those\n Regions come online.</p>"
|
||||
}
|
||||
},
|
||||
"EnableAllOpsDataSources": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncEnableAllOpsDataSources",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager\n automatically enables all OpsData sources in the selected Regions for all accounts in\n your organization (or in the selected organization units). For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html\">About multiple account and Region resource data syncs</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager\n automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in\n your organization (or in the selected organization units). For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html\">About multiple account and Region resource data syncs</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -21928,13 +21928,13 @@
|
|||
"SourceRegions": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncSourceRegionList",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The <code>SyncSource</code> Regions included in the resource data sync.</p>"
|
||||
"smithy.api#documentation": "<p>The <code>SyncSource</code> Amazon Web Services Regions included in the resource data sync.</p>"
|
||||
}
|
||||
},
|
||||
"IncludeFutureRegions": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Whether to automatically synchronize and aggregate data from new Regions when those\n Regions come online.</p>"
|
||||
"smithy.api#documentation": "<p>Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those\n Regions come online.</p>"
|
||||
}
|
||||
},
|
||||
"State": {
|
||||
|
|
@ -21946,7 +21946,7 @@
|
|||
"EnableAllOpsDataSources": {
|
||||
"target": "com.amazonaws.ssm#ResourceDataSyncEnableAllOpsDataSources",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager\n automatically enables all OpsData sources in the selected Regions for all accounts in\n your organization (or in the selected organization units). For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html\">About multiple account and Region resource data syncs</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager\n automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in\n your organization (or in the selected organization units). For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resouce-data-sync-multiple-accounts-and-regions.html\">About multiple account and Region resource data syncs</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -22144,7 +22144,7 @@
|
|||
"StreamUrl": {
|
||||
"target": "com.amazonaws.ssm#StreamUrl",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and\n receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p>\n <p>\n <b>region</b> represents the Region identifier for an\n\t\t\t\t\t\tRegion supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported <b>region</b> values, see the <b>Region</b> column in <a href=\"https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region\">Systems Manager service endpoints</a> in the\n <i>Amazon Web Services General Reference</i>.</p>\n <p>\n <b>session-id</b> represents the ID of a Session Manager session, such as\n <code>1a2b3c4dEXAMPLE</code>.</p>"
|
||||
"smithy.api#documentation": "<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and\n receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p>\n <p>\n <b>region</b> represents the Region identifier for an\n\t\t\t\t\t\tAmazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported <b>region</b> values, see the <b>Region</b> column in <a href=\"https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region\">Systems Manager service endpoints</a> in the\n <i>Amazon Web Services General Reference</i>.</p>\n <p>\n <b>session-id</b> represents the ID of a Session Manager session, such as\n <code>1a2b3c4dEXAMPLE</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -22271,7 +22271,7 @@
|
|||
"TargetLocations": {
|
||||
"target": "com.amazonaws.ssm#TargetLocations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Information about the Regions and accounts targeted by the current Runbook\n operation.</p>"
|
||||
"smithy.api#documentation": "<p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook\n operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -22563,7 +22563,7 @@
|
|||
"OutputS3Region": {
|
||||
"target": "com.amazonaws.ssm#S3Region",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.</p>"
|
||||
"smithy.api#documentation": "<p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Amazon Web Services Region of the S3 bucket.</p>"
|
||||
}
|
||||
},
|
||||
"OutputS3BucketName": {
|
||||
|
|
@ -23257,7 +23257,7 @@
|
|||
"TargetLocations": {
|
||||
"target": "com.amazonaws.ssm#TargetLocations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A location is a combination of Regions and/or accounts where you want to run the\n automation. Use this operation to start an automation in multiple Regions and multiple\n accounts. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html\">Running Automation workflows in multiple Regions and accounts</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>. </p>"
|
||||
"smithy.api#documentation": "<p>A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the\n automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple\n Amazon Web Services accounts. For more information, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html\">Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>. </p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
|
|
@ -23364,7 +23364,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 a change request. Tags enable you to categorize a resource in different ways, such as by\n purpose, owner, or environment. For example, you might want to tag a change request to identify\n an environment or target Region. In this case, you could specify the following key-value\n pairs:</p>\n <ul>\n <li>\n <p>\n <code>Key=Environment,Value=Production</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Region,Value=us-east-2</code>\n </p>\n </li>\n </ul>"
|
||||
"smithy.api#documentation": "<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n a change request. Tags enable you to categorize a resource in different ways, such as by\n purpose, owner, or environment. For example, you might want to tag a change request to identify\n an environment or target Amazon Web Services Region. In this case, you could specify the following key-value\n pairs:</p>\n <ul>\n <li>\n <p>\n <code>Key=Environment,Value=Production</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=Region,Value=us-east-2</code>\n </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"ScheduledEndTime": {
|
||||
|
|
@ -23457,7 +23457,7 @@
|
|||
"StreamUrl": {
|
||||
"target": "com.amazonaws.ssm#StreamUrl",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and\n receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>\n </p>\n <p>\n <b>region</b> represents the Region identifier for an\n\t\t\t\t\t\tRegion supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported <b>region</b> values, see the <b>Region</b> column in <a href=\"https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region\">Systems Manager service endpoints</a> in the\n <i>Amazon Web Services General Reference</i>.</p>\n <p>\n <b>session-id</b> represents the ID of a Session Manager session, such as\n <code>1a2b3c4dEXAMPLE</code>.</p>"
|
||||
"smithy.api#documentation": "<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and\n receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>\n </p>\n <p>\n <b>region</b> represents the Region identifier for an\n\t\t\t\t\t\tAmazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported <b>region</b> values, see the <b>Region</b> column in <a href=\"https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region\">Systems Manager service endpoints</a> in the\n <i>Amazon Web Services General Reference</i>.</p>\n <p>\n <b>session-id</b> represents the ID of a Session Manager session, such as\n <code>1a2b3c4dEXAMPLE</code>.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -23640,7 +23640,7 @@
|
|||
"TargetLocation": {
|
||||
"target": "com.amazonaws.ssm#TargetLocation",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The combination of Regions and accounts targeted by the current Automation\n execution.</p>"
|
||||
"smithy.api#documentation": "<p>The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation\n execution.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -23905,7 +23905,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of search criteria that targets instances using a key-value pair that you\n specify.</p>\n <note>\n <p> One or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">Registering\n maintenance window tasks without targets</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n </note>\n <p>Supported formats include the following.</p>\n <ul>\n <li>\n <p>\n <code>Key=InstanceIds,Values=<i>instance-id-1</i>,<i>instance-id-2</i>,<i>instance-id-3</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=tag:<i>my-tag-key</i>,Values=<i>my-tag-value-1</i>,<i>my-tag-value-2</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=tag-key,Values=<i>my-tag-key-1</i>,<i>my-tag-key-2</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <b>Run Command and Maintenance window targets only</b>:\n <code>Key=resource-groups:Name,Values=<i>resource-group-name</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <b>Maintenance window targets only</b>:\n <code>Key=resource-groups:ResourceTypeFilters,Values=<i>resource-type-1</i>,<i>resource-type-2</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <b>Automation targets only</b>:\n <code>Key=ResourceGroup;Values=<i>resource-group-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>For example:</p>\n <ul>\n <li>\n <p>\n <code>Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=tag-key,Values=Name,Instance-Type,CostCenter</code>\n </p>\n </li>\n <li>\n <p>\n <b>Run Command and Maintenance window targets only</b>:\n <code>Key=resource-groups:Name,Values=ProductionResourceGroup</code>\n </p>\n <p>This example demonstrates how to target all resources in the resource group <b>ProductionResourceGroup</b> in your maintenance window.</p>\n </li>\n <li>\n <p>\n <b>Maintenance window targets only</b>:\n <code>Key=resource-groups:ResourceTypeFilters,Values=<i>AWS::EC2::INSTANCE</i>,<i>AWS::EC2::VPC</i>\n </code>\n </p>\n <p>This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2)\n instances and VPCs in your maintenance window.</p>\n </li>\n <li>\n <p>\n <b>Automation targets only</b>:\n <code>Key=ResourceGroup,Values=MyResourceGroup</code>\n </p>\n </li>\n <li>\n <p>\n <b>State Manager association targets only</b>:\n <code>Key=InstanceIds,Values=<i>*</i>\n </code>\n </p>\n <p>This example demonstrates how to target all managed instances in the Region where\n the association was created.</p>\n </li>\n </ul>\n <p>For more information about how to send commands that target instances using\n <code>Key,Value</code> parameters, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting\">Targeting multiple instances</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
"smithy.api#documentation": "<p>An array of search criteria that targets instances using a key-value pair that you\n specify.</p>\n <note>\n <p> One or more targets must be specified for maintenance window Run Command-type tasks.\n Depending on the task, targets are optional for other maintenance window task types (Automation,\n Lambda, and Step Functions). For more information about running tasks\n that don't specify targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">Registering\n maintenance window tasks without targets</a> in the\n <i>Amazon Web Services Systems Manager User Guide</i>.</p>\n </note>\n <p>Supported formats include the following.</p>\n <ul>\n <li>\n <p>\n <code>Key=InstanceIds,Values=<i>instance-id-1</i>,<i>instance-id-2</i>,<i>instance-id-3</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=tag:<i>my-tag-key</i>,Values=<i>my-tag-value-1</i>,<i>my-tag-value-2</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=tag-key,Values=<i>my-tag-key-1</i>,<i>my-tag-key-2</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <b>Run Command and Maintenance window targets only</b>:\n <code>Key=resource-groups:Name,Values=<i>resource-group-name</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <b>Maintenance window targets only</b>:\n <code>Key=resource-groups:ResourceTypeFilters,Values=<i>resource-type-1</i>,<i>resource-type-2</i>\n </code>\n </p>\n </li>\n <li>\n <p>\n <b>Automation targets only</b>:\n <code>Key=ResourceGroup;Values=<i>resource-group-name</i>\n </code>\n </p>\n </li>\n </ul>\n <p>For example:</p>\n <ul>\n <li>\n <p>\n <code>Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3</code>\n </p>\n </li>\n <li>\n <p>\n <code>Key=tag-key,Values=Name,Instance-Type,CostCenter</code>\n </p>\n </li>\n <li>\n <p>\n <b>Run Command and Maintenance window targets only</b>:\n <code>Key=resource-groups:Name,Values=ProductionResourceGroup</code>\n </p>\n <p>This example demonstrates how to target all resources in the resource group <b>ProductionResourceGroup</b> in your maintenance window.</p>\n </li>\n <li>\n <p>\n <b>Maintenance window targets only</b>:\n <code>Key=resource-groups:ResourceTypeFilters,Values=<i>AWS::EC2::INSTANCE</i>,<i>AWS::EC2::VPC</i>\n </code>\n </p>\n <p>This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2)\n instances and VPCs in your maintenance window.</p>\n </li>\n <li>\n <p>\n <b>Automation targets only</b>:\n <code>Key=ResourceGroup,Values=MyResourceGroup</code>\n </p>\n </li>\n <li>\n <p>\n <b>State Manager association targets only</b>:\n <code>Key=InstanceIds,Values=<i>*</i>\n </code>\n </p>\n <p>This example demonstrates how to target all managed instances in the Amazon Web Services Region where\n the association was created.</p>\n </li>\n </ul>\n <p>For more information about how to send commands that target instances using\n <code>Key,Value</code> parameters, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting\">Targeting multiple instances</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#TargetCount": {
|
||||
|
|
@ -23943,19 +23943,19 @@
|
|||
"Accounts": {
|
||||
"target": "com.amazonaws.ssm#Accounts",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The accounts targeted by the current Automation execution.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services accounts targeted by the current Automation execution.</p>"
|
||||
}
|
||||
},
|
||||
"Regions": {
|
||||
"target": "com.amazonaws.ssm#Regions",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The Regions targeted by the current Automation execution.</p>"
|
||||
"smithy.api#documentation": "<p>The Amazon Web Services Regions targeted by the current Automation execution.</p>"
|
||||
}
|
||||
},
|
||||
"TargetLocationMaxConcurrency": {
|
||||
"target": "com.amazonaws.ssm#MaxConcurrency",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The maximum number of Regions and accounts allowed to run the Automation\n concurrently.</p>"
|
||||
"smithy.api#documentation": "<p>The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation\n concurrently.</p>"
|
||||
}
|
||||
},
|
||||
"TargetLocationMaxErrors": {
|
||||
|
|
@ -23972,7 +23972,7 @@
|
|||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The combination of Regions and accounts targeted by the current Automation\n execution.</p>"
|
||||
"smithy.api#documentation": "<p>The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation\n execution.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#TargetLocations": {
|
||||
|
|
@ -24489,7 +24489,7 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.ssm#DocumentARN",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.</p>\n <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.</p>\n <p>For Systems Manager document (SSM document) that are shared with you from other accounts, you\n must specify the complete SSM document ARN, in the following format:</p>\n <p>\n <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i>\n </code>\n </p>\n <p>For example:</p>\n <p>\n <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code>\n </p>\n <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or\n <code>My-Document</code>.</p>"
|
||||
"smithy.api#documentation": "<p>The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.</p>\n <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.</p>\n <p>For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you\n must specify the complete SSM document ARN, in the following format:</p>\n <p>\n <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i>\n </code>\n </p>\n <p>For example:</p>\n <p>\n <code>arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document</code>\n </p>\n <p>For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need\n to specify the document name. For example, <code>AWS-ApplyPatchBaseline</code> or\n <code>My-Document</code>.</p>"
|
||||
}
|
||||
},
|
||||
"Targets": {
|
||||
|
|
@ -24555,7 +24555,7 @@
|
|||
"TargetLocations": {
|
||||
"target": "com.amazonaws.ssm#TargetLocations",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A location is a combination of Regions and accounts where you want to run the\n association. Use this action to update an association in multiple Regions and multiple\n accounts.</p>"
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -24600,7 +24600,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified\n instance.</p>"
|
||||
"smithy.api#documentation": "<p>Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified\n instance.</p>\n <p>\n <code>UpdateAssociationStatus</code> is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to\n report status updates about your associations and is only used for associations created with the\n <code>InstanceId</code> legacy parameter.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#UpdateAssociationStatusRequest": {
|
||||
|
|
@ -24616,7 +24616,7 @@
|
|||
"InstanceId": {
|
||||
"target": "com.amazonaws.ssm#InstanceId",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the instance.</p>",
|
||||
"smithy.api#documentation": "<p>The instance ID.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
|
|
@ -24763,7 +24763,7 @@
|
|||
}
|
||||
],
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Updates information related to approval reviews for a specific version of a document.</p>"
|
||||
"smithy.api#documentation": "<p>Updates information related to approval reviews for a specific version of a change template\n in Change Manager.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.ssm#UpdateDocumentMetadataRequest": {
|
||||
|
|
@ -24772,20 +24772,20 @@
|
|||
"Name": {
|
||||
"target": "com.amazonaws.ssm#DocumentName",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the document for which a version is to be updated.</p>",
|
||||
"smithy.api#documentation": "<p>The name of the change template for which a version's metadata is to be updated.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"DocumentVersion": {
|
||||
"target": "com.amazonaws.ssm#DocumentVersion",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The version of a document to update.</p>"
|
||||
"smithy.api#documentation": "<p>The version of a change template in which to update approval metadata.</p>"
|
||||
}
|
||||
},
|
||||
"DocumentReviews": {
|
||||
"target": "com.amazonaws.ssm#DocumentReviews",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The document review details to update.</p>",
|
||||
"smithy.api#documentation": "<p>The change template review details to update.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -35,12 +35,19 @@
|
|||
"ScreenshotName": {
|
||||
"target": "com.amazonaws.synthetics#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The name of the screenshot. This is generated the first time the canary is run after the <code>UpdateCanary</code> operation that\n specified for this canary to perform visual monitoring.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
},
|
||||
"IgnoreCoordinates": {
|
||||
"target": "com.amazonaws.synthetics#BaseScreenshotIgnoreCoordinates"
|
||||
"target": "com.amazonaws.synthetics#BaseScreenshotIgnoreCoordinates",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the \n CloudWatch Logs console to draw the boundaries on the screen. For more information, see {LINK}</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.synthetics#BaseScreenshotConfigIgnoreCoordinate": {
|
||||
|
|
@ -167,7 +174,10 @@
|
|||
"target": "com.amazonaws.synthetics#VpcConfigOutput"
|
||||
},
|
||||
"VisualReference": {
|
||||
"target": "com.amazonaws.synthetics#VisualReferenceOutput"
|
||||
"target": "com.amazonaws.synthetics#VisualReferenceOutput",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run to use as the baseline for screenshots, and the coordinates\n of any parts of the screen to ignore during the visual monitoring comparison.</p>"
|
||||
}
|
||||
},
|
||||
"Tags": {
|
||||
"target": "com.amazonaws.synthetics#TagMap",
|
||||
|
|
@ -214,7 +224,7 @@
|
|||
"ZipFile": {
|
||||
"target": "com.amazonaws.synthetics#Blob",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If you input your canary script directly into the canary instead of referring to an S3\n location, the value of this parameter is the base64-encoded contents of the .zip file that \n contains the script. It can be\n up to 5 MB.</p>"
|
||||
"smithy.api#documentation": "<p>If you input your canary script directly into the canary instead of referring to an S3\n location, the value of this parameter is the base64-encoded contents of the .zip file that \n contains the script. It must be smaller than 256 Kb.</p>"
|
||||
}
|
||||
},
|
||||
"Handler": {
|
||||
|
|
@ -1782,7 +1792,10 @@
|
|||
}
|
||||
},
|
||||
"VisualReference": {
|
||||
"target": "com.amazonaws.synthetics#VisualReferenceInput"
|
||||
"target": "com.amazonaws.synthetics#VisualReferenceInput",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Defines the screenshots to use as the baseline for comparisons during visual monitoring comparisons during future runs of this canary. If you omit this \n parameter, no changes are made to any baseline screenshots that the canary might be using already.</p>\n <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b>\n runtime or later. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html\">\n Visual monitoring</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html\">\n Visual monitoring blueprint</a>\n </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1807,25 +1820,41 @@
|
|||
"type": "structure",
|
||||
"members": {
|
||||
"BaseScreenshots": {
|
||||
"target": "com.amazonaws.synthetics#BaseScreenshots"
|
||||
"target": "com.amazonaws.synthetics#BaseScreenshots",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don't want to be used for\n visual monitoring, remove it from this array.</p>"
|
||||
}
|
||||
},
|
||||
"BaseCanaryRunId": {
|
||||
"target": "com.amazonaws.synthetics#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are \n <code>nextrun</code> to use the screenshots from the next run after this update is made, <code>lastrun</code> to use the screenshots from the most recent run \n before this update was made, or the value of <code>Id</code> in the <a href=\"https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html\">\n CanaryRun</a> from any past run of this canary.</p>",
|
||||
"smithy.api#required": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An object that specifies what screenshots to use as a baseline for visual monitoring by this canary, and optionally the parts of the screenshots to ignore during the visual monitoring comparison.</p>\n \n <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b>\n runtime or later. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html\">\n Visual monitoring</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html\">\n Visual monitoring blueprint</a>\n </p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.synthetics#VisualReferenceOutput": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"BaseScreenshots": {
|
||||
"target": "com.amazonaws.synthetics#BaseScreenshots"
|
||||
"target": "com.amazonaws.synthetics#BaseScreenshots",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>An array of screenshots that are used as the baseline for comparisons during visual monitoring.</p>"
|
||||
}
|
||||
},
|
||||
"BaseCanaryRunId": {
|
||||
"target": "com.amazonaws.synthetics#String"
|
||||
"target": "com.amazonaws.synthetics#String",
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>The ID of the canary run that produced the screenshots that are used as the baseline for visual monitoring comparisons during future runs of this canary.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"traits": {
|
||||
"smithy.api#documentation": "<p>If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates\n of any parts of those screenshots that are ignored during visual monitoring comparison.</p>\n <p>Visual monitoring is supported only on canaries running the <b>syn-puppeteer-node-3.2</b> runtime or later.</p>"
|
||||
}
|
||||
},
|
||||
"com.amazonaws.synthetics#VpcConfigInput": {
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue