From 4bccda460fc97da756165624d099596557c26f41 Mon Sep 17 00:00:00 2001 From: John DiSanti Date: Thu, 19 Aug 2021 12:13:39 -0700 Subject: [PATCH] Sync AWS models (#657) * Sync AWS models * Update changelog --- CHANGELOG.md | 2 + aws/sdk/aws-models/apigateway.json | 26 +- aws/sdk/aws-models/apigatewayv2.json | 19 +- aws/sdk/aws-models/athena.json | 166 +- aws/sdk/aws-models/autoscaling.json | 61 +- aws/sdk/aws-models/ce.json | 955 +++-- aws/sdk/aws-models/chime-sdk-identity.json | 1884 ++++++++ aws/sdk/aws-models/chime-sdk-messaging.json | 3774 +++++++++++++++++ aws/sdk/aws-models/chime.json | 127 +- aws/sdk/aws-models/cloud9.json | 33 + aws/sdk/aws-models/clouddirectory.json | 46 +- aws/sdk/aws-models/codebuild.json | 372 +- aws/sdk/aws-models/config.json | 68 +- aws/sdk/aws-models/connect.json | 842 +++- aws/sdk/aws-models/customer-profiles.json | 74 +- aws/sdk/aws-models/databrew.json | 4 + aws/sdk/aws-models/ds.json | 454 +- aws/sdk/aws-models/ebs.json | 24 +- aws/sdk/aws-models/ec2.json | 43 +- aws/sdk/aws-models/ecs.json | 40 +- aws/sdk/aws-models/elasticache.json | 133 +- aws/sdk/aws-models/elasticmapreduce.json | 48 +- aws/sdk/aws-models/eventbridge.json | 142 +- aws/sdk/aws-models/imagebuilder.json | 26 +- aws/sdk/aws-models/iotsitewise.json | 21 +- aws/sdk/aws-models/lambda.json | 6 +- aws/sdk/aws-models/license-manager.json | 4 + aws/sdk/aws-models/lightsail.json | 34 +- aws/sdk/aws-models/logs.json | 48 +- aws/sdk/aws-models/models.lex.v2.json | 28 +- aws/sdk/aws-models/nimble.json | 68 +- aws/sdk/aws-models/quicksight.json | 106 +- aws/sdk/aws-models/rds.json | 36 +- aws/sdk/aws-models/rekognition.json | 187 +- aws/sdk/aws-models/route53.json | 108 +- aws/sdk/aws-models/route53resolver.json | 68 +- aws/sdk/aws-models/runtime.sagemaker.json | 139 +- aws/sdk/aws-models/s3.json | 274 +- aws/sdk/aws-models/sagemaker.json | 344 +- .../aws-models/snow-device-management.json | 2093 +++++++++ aws/sdk/aws-models/ssm-incidents.json | 258 +- aws/sdk/aws-models/ssm.json | 196 +- aws/sdk/aws-models/synthetics.json | 43 +- aws/sdk/aws-models/transcribe.json | 1348 +++++- aws/sdk/aws-models/wafv2.json | 1081 ++++- 45 files changed, 13913 insertions(+), 1940 deletions(-) create mode 100644 aws/sdk/aws-models/chime-sdk-identity.json create mode 100644 aws/sdk/aws-models/chime-sdk-messaging.json create mode 100644 aws/sdk/aws-models/snow-device-management.json diff --git a/CHANGELOG.md b/CHANGELOG.md index eb23b08dae..f41167f045 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) -------------------------- diff --git a/aws/sdk/aws-models/apigateway.json b/aws/sdk/aws-models/apigateway.json index 09fd218ffc..35c837c089 100644 --- a/aws/sdk/aws-models/apigateway.json +++ b/aws/sdk/aws-models/apigateway.json @@ -1628,6 +1628,12 @@ }, "mutualTlsAuthentication": { "target": "com.amazonaws.apigateway#MutualTlsAuthenticationInput" + }, + "ownershipVerificationCertificateArn": { + "target": "com.amazonaws.apigateway#String", + "traits": { + "smithy.api#documentation": "

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.

" + } } }, "traits": { @@ -3766,7 +3772,7 @@ "domainNameStatus": { "target": "com.amazonaws.apigateway#DomainNameStatus", "traits": { - "smithy.api#documentation": "

The status of the DomainName 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.

" + "smithy.api#documentation": "

The status of the DomainName 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.

" } }, "domainNameStatusMessage": { @@ -3792,6 +3798,12 @@ "traits": { "smithy.api#documentation": "

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.

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

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.

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

The version of the S3 object that contains your truststore. To\n specify a version, you must have versioning enabled for the S3 bucket.

" + "smithy.api#documentation": "

The version of the S3 object that contains your truststore. To\n specify a version, you must have versioning enabled for the S3 bucket.

" } } }, @@ -9176,7 +9196,7 @@ "type": "string", "traits": { "smithy.api#documentation": "

The status code.

", - "smithy.api#pattern": "[1-5]\\d\\d" + "smithy.api#pattern": "^[1-5]\\d\\d$" } }, "com.amazonaws.apigateway#String": { diff --git a/aws/sdk/aws-models/apigatewayv2.json b/aws/sdk/aws-models/apigatewayv2.json index 06e71be9de..45b45862e0 100644 --- a/aws/sdk/aws-models/apigatewayv2.json +++ b/aws/sdk/aws-models/apigatewayv2.json @@ -3631,7 +3631,7 @@ "DomainNameStatus": { "target": "com.amazonaws.apigatewayv2#DomainNameStatus", "traits": { - "smithy.api#documentation": "

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.

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

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.

", "smithy.api#jsonName": "domainNameStatus" } }, @@ -3662,6 +3662,13 @@ "smithy.api#documentation": "

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.

", "smithy.api#jsonName": "securityPolicy" } + }, + "OwnershipVerificationCertificateArn": { + "target": "com.amazonaws.apigatewayv2#Arn", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#jsonName": "ownershipVerificationCertificateArn" + } } }, "traits": { @@ -3680,7 +3687,7 @@ "com.amazonaws.apigatewayv2#DomainNameStatus": { "type": "string", "traits": { - "smithy.api#documentation": "

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.

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

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.

", "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" } ] } diff --git a/aws/sdk/aws-models/athena.json b/aws/sdk/aws-models/athena.json index 1c099a6cc4..db53d0de74 100644 --- a/aws/sdk/aws-models/athena.json +++ b/aws/sdk/aws-models/athena.json @@ -148,7 +148,7 @@ "name": "athena" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

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 What is Amazon\n Athena in the Amazon Athena User Guide.

\n

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 Accessing\n Amazon Athena with JDBC.

\n

For code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.

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

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 What is Amazon Athena in the Amazon Athena User\n Guide.

\n

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 Accessing\n Amazon Athena with JDBC.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

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

Creates (registers) a data catalog with the specified name and properties. Catalogs\n created are visible to all users of the same AWS account.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.athena#CreateDataCatalogInput": { @@ -451,14 +451,14 @@ "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { - "smithy.api#documentation": "

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.

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

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.

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

The type of data catalog to create: LAMBDA for a federated catalog or\n HIVE for an external hive metastore.

\n \n

Do not use the GLUE type. This refers to the\n AwsDataCatalog that already exists in your account, of which you\n can have only one. Specifying the GLUE type will result in an\n INVALID_INPUT error.

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

The type of data catalog to create: LAMBDA for a federated catalog,\n HIVE for an external hive metastore, or GLUE for an\n Glue Data Catalog.

", "smithy.api#required": {} } }, @@ -471,7 +471,7 @@ "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

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.

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

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.

\n " } }, "Tags": { @@ -503,7 +503,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.

\n

For code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.

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

Creates a named query in the specified workgroup. Requires that you have access to the\n workgroup.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -540,7 +540,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another CreateNamedQuery request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

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.

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

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another CreateNamedQuery request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

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.

\n ", "smithy.api#idempotencyToken": {} } }, @@ -652,7 +652,7 @@ "Configuration": { "target": "com.amazonaws.athena#WorkGroupConfiguration", "traits": { - "smithy.api#documentation": "

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 WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

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 EnforceWorkGroupConfiguration) in the\n WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, "Description": { @@ -679,7 +679,7 @@ "Name": { "target": "com.amazonaws.athena#CatalogNameString", "traits": { - "smithy.api#documentation": "

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.

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

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.

", "smithy.api#required": {} } }, @@ -692,19 +692,19 @@ "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { - "smithy.api#documentation": "

The type of data catalog: LAMBDA for a federated catalog or\n HIVE for an external hive metastore. GLUE refers to the\n AwsDataCatalog that already exists in your account, of which you can\n have only one.

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

The type of data catalog to create: LAMBDA for a federated catalog,\n HIVE for an external hive metastore, or GLUE for an\n Glue Data Catalog.

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

Specifies the Lambda function or functions to use for the data catalog. This is a\n mapping whose values depend on the catalog type.

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

Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.

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

Contains information about a data catalog in an AWS account.

" + "smithy.api#documentation": "

Contains information about a data catalog in an Amazon Web Services account.

" } }, "com.amazonaws.athena#DataCatalogSummary": { @@ -864,7 +864,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the named query if you have access to the workgroup in which the query was\n saved.

\n

For code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.

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

Deletes the named query if you have access to the workgroup in which the query was\n saved.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -989,7 +989,7 @@ "EncryptionOption": { "target": "com.amazonaws.athena#EncryptionOption", "traits": { - "smithy.api#documentation": "

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

\n

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

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

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

\n

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

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

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

" + "smithy.api#documentation": "

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

" } }, "com.amazonaws.athena#EncryptionOption": { @@ -1029,13 +1029,13 @@ "SelectedEngineVersion": { "target": "com.amazonaws.athena#NameString", "traits": { - "smithy.api#documentation": "

The engine version requested by the user. Possible values are determined by the output of ListEngineVersions, including Auto. The default is Auto.

" + "smithy.api#documentation": "

The engine version requested by the user. Possible values are determined by the output\n of ListEngineVersions, including Auto. The default is Auto.

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

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 CreateWorkGroup or UpdateWorkGroup operation, the \n EffectiveEngineVersion field is ignored.

" + "smithy.api#documentation": "

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 CreateWorkGroup or UpdateWorkGroup operation, the\n EffectiveEngineVersion field is ignored.

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

Streams the results of a single query execution specified by\n QueryExecutionId from the Athena query results location in Amazon S3.\n For more information, see Query Results in the Amazon\n Athena User Guide. This request does not execute the query but returns\n results. Use StartQueryExecution to run a query.

\n

To stream query results successfully, the IAM principal with permission to call\n GetQueryResults also must have permissions to the Amazon S3\n GetObject action for the Athena query results location.

\n \n

IAM principals with permission to the Amazon S3 GetObject action for\n the query results location are able to retrieve query results from Amazon S3 even if\n permission to the GetQueryResults action is denied. To restrict user or\n role access, ensure that Amazon S3 permissions to the Athena query location are\n denied.

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

Streams the results of a single query execution specified by\n QueryExecutionId from the Athena query results location in\n Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query\n but returns results. Use StartQueryExecution to run a query.

\n

To stream query results successfully, the IAM principal with permission to call\n GetQueryResults also must have permissions to the Amazon S3\n GetObject action for the Athena query results location.

\n \n

IAM principals with permission to the Amazon S3\n GetObject action for the query results location are able to retrieve\n query results from Amazon S3 even if permission to the\n GetQueryResults action is denied. To restrict user or role access,\n ensure that Amazon S3 permissions to the Athena query location\n are denied.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1350,7 +1350,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -1367,7 +1367,7 @@ "UpdateCount": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

The number of rows inserted with a CREATE TABLE AS SELECT statement.

" + "smithy.api#documentation": "

The number of rows inserted with a CREATE TABLE AS SELECT statement.\n

" } }, "ResultSet": { @@ -1379,7 +1379,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } } } @@ -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": "

Lists the data catalogs in the current AWS account.

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

Lists the data catalogs in the current Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1568,7 +1568,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -1591,7 +1591,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } } @@ -1638,7 +1638,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -1661,7 +1661,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } } @@ -1692,7 +1692,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -1715,7 +1715,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

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

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.

\n

For code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.

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

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.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1751,7 +1751,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -1780,7 +1780,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } } } @@ -1823,7 +1823,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -1846,7 +1846,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

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

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.

\n

For code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.

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

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.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1882,7 +1882,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -1971,7 +1971,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -1994,7 +1994,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

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

Lists the tags associated with an Athena workgroup or data catalog resource.

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

Lists the tags associated with an Athena workgroup or data catalog\n resource.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2100,7 +2100,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

" } }, "MaxResults": { @@ -2123,7 +2123,7 @@ "NextToken": { "target": "com.amazonaws.athena#Token", "traits": { - "smithy.api#documentation": "

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 NextToken from the response object of the previous page call.

" + "smithy.api#documentation": "

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.

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

An exception that Athena received when it called a custom metastore. Occurs if the\n error is not caused by user input (InvalidRequestException) or from the\n Athena platform (InternalServerException). For example, if a user-created\n Lambda function is missing permissions, the Lambda 4XX exception is\n returned in a MetadataException.

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

An exception that Athena received when it called a custom metastore.\n Occurs if the error is not caused by user input (InvalidRequestException)\n or from the Athena platform (InternalServerException). For\n example, if a user-created Lambda function is missing permissions, the\n Lambda\n 4XX exception is returned in a MetadataException.

", "smithy.api#error": "client" } }, @@ -2428,13 +2428,13 @@ "StatementType": { "target": "com.amazonaws.athena#StatementType", "traits": { - "smithy.api#documentation": "

The type of query statement that was run. DDL indicates DDL query\n statements. DML indicates DML (Data Manipulation Language) query\n statements, such as CREATE TABLE AS SELECT. UTILITY indicates\n query statements other than DDL and DML, such as SHOW CREATE TABLE, or\n DESCRIBE .

" + "smithy.api#documentation": "

The type of query statement that was run. DDL indicates DDL query\n statements. DML indicates DML (Data Manipulation Language) query\n statements, such as CREATE TABLE AS SELECT. UTILITY indicates\n query statements other than DDL and DML, such as SHOW CREATE TABLE, or\n DESCRIBE TABLE.

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

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.

" + "smithy.api#documentation": "

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.

" } }, "QueryExecutionContext": { @@ -2478,7 +2478,7 @@ "Database": { "target": "com.amazonaws.athena#DatabaseString", "traits": { - "smithy.api#documentation": "

The name of the database used in the query execution.

" + "smithy.api#documentation": "

The name of the database used in the query execution. The database must exist in the catalog.

" } }, "Catalog": { @@ -2558,7 +2558,7 @@ "DataManifestLocation": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

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 Working with Query Results, Output Files, and\n Query History in the Amazon Athena User Guide.

" + "smithy.api#documentation": "

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 Working with Query\n Results, Output Files, and Query History in the Amazon Athena User Guide.

" } }, "TotalExecutionTimeInMillis": { @@ -2570,19 +2570,19 @@ "QueryQueueTimeInMillis": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

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

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.

" + "smithy.api#documentation": "

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.

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

The number of milliseconds that Athena took to finalize and publish the query results\n after the query engine finished running the query.

" + "smithy.api#documentation": "

The number of milliseconds that Athena took to finalize and publish the\n query results after the query engine finished running the query.

" } } }, @@ -2596,7 +2596,7 @@ "State": { "target": "com.amazonaws.athena#QueryExecutionState", "traits": { - "smithy.api#documentation": "

The state of query execution. QUEUED indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as resources are\n available. RUNNING indicates that the query is in execution phase.\n SUCCEEDED indicates that the query completed without errors.\n FAILED indicates that the query experienced an error and did not\n complete processing. CANCELLED indicates that a user input interrupted\n query execution.

\n \n

Athena automatically retries your queries in cases of certain transient errors. As\n a result, you may see the query state transition from RUNNING or\n FAILED to QUEUED.

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

The state of query execution. QUEUED indicates that the query has been\n submitted to the service, and Athena will execute the query as soon as\n resources are available. RUNNING indicates that the query is in execution\n phase. SUCCEEDED indicates that the query completed without errors.\n FAILED indicates that the query experienced an error and did not\n complete processing. CANCELLED indicates that a user input interrupted\n query execution.

\n \n

Athena automatically retries your queries in cases of certain\n transient errors. As a result, you may see the query state transition from\n RUNNING or FAILED to QUEUED.

\n " } }, "StateChangeReason": { @@ -2652,18 +2652,18 @@ "OutputLocation": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. 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 WorkGroupConfiguration. If none of them is set, Athena issues an error\n that no output location is provided. For more information, see Query Results. If\n workgroup settings override client-side settings, then the query uses the settings\n specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. 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 WorkGroupConfiguration. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Query Results. If\n workgroup settings override client-side settings, then the query uses the settings\n specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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

If query results are encrypted in Amazon S3, indicates the encryption option used (for\n example, SSE-KMS or CSE-KMS) 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 WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" + "smithy.api#documentation": "

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

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

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.athena#ResultConfigurationUpdates": { @@ -2672,13 +2672,13 @@ "OutputLocation": { "target": "com.amazonaws.athena#String", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. For more information, see Query Results 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 WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. For more information, see Query Results 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 EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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

If set to \"true\", indicates that the previously-specified query results location (also\n known as a client-side setting) for queries in this workgroup should be ignored and set\n to null. If set to \"false\" or not set, and a value is present in the 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 Workgroup Settings Override\n Client-Side Settings.

" + "smithy.api#documentation": "

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

" } }, "EncryptionConfiguration": { @@ -2690,7 +2690,7 @@ "RemoveEncryptionConfiguration": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

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 Workgroup Settings Override\n Client-Side Settings.

" + "smithy.api#documentation": "

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\n client-side setting), the EncryptionConfiguration in the workgroup's\n ResultConfiguration will be updated with the new value. For more\n information, see Workgroup Settings Override\n Client-Side Settings.

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

Runs the SQL query statements contained in the Query. Requires you to\n have access to the workgroup in which the query ran. Running queries against an external\n catalog requires GetDataCatalog permission to the catalog. For code\n samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.

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

Runs the SQL query statements contained in the Query. Requires you to\n have access to the workgroup in which the query ran. Running queries against an external\n catalog requires GetDataCatalog permission to the catalog. For code\n samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -2789,7 +2789,7 @@ "ClientRequestToken": { "target": "com.amazonaws.athena#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another StartQueryExecution request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

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.

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

A unique case-sensitive string used to ensure the request to create the query is\n idempotent (executes only once). If another StartQueryExecution request is\n received, the same response is returned and another query is not created. If a parameter\n has changed, for example, the QueryString, an error is returned.

\n \n

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.

\n ", "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": "

Stops a query execution. Requires you to have access to the workgroup in which the\n query ran.

\n

For code samples using the AWS SDK for Java, see Examples and\n Code Samples in the Amazon Athena User Guide.

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

Stops a query execution. Requires you to have access to the workgroup in which the\n query ran.

\n

For code samples using the Amazon Web Services SDK for Java, see Examples and\n Code Samples in the Amazon Athena User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -2919,7 +2919,7 @@ "TableType": { "target": "com.amazonaws.athena#TableTypeString", "traits": { - "smithy.api#documentation": "

The type of table. In Athena, only EXTERNAL_TABLE is supported.

" + "smithy.api#documentation": "

The type of table. In Athena, only EXTERNAL_TABLE is\n supported.

" } }, "Columns": { @@ -2977,7 +2977,7 @@ } }, "traits": { - "smithy.api#documentation": "

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 Tagging Best Practices. 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.

" + "smithy.api#documentation": "

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 Tagging Best Practices. 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.

" } }, "com.amazonaws.athena#TagKey": { @@ -3021,7 +3021,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 Tagging Best Practices. 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.

" + "smithy.api#documentation": "

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 Tagging Best Practices. 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.

" } }, "com.amazonaws.athena#TagResourceInput": { @@ -3030,14 +3030,14 @@ "ResourceARN": { "target": "com.amazonaws.athena#AmazonResourceName", "traits": { - "smithy.api#documentation": "

Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are\n to be added.

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

Specifies the ARN of the Athena resource (workgroup or data catalog) to\n which tags are to be added.

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

A collection of one or more tags, separated by commas, to be added to an Athena\n workgroup or data catalog resource.

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

A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.

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

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.

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

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.

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

Specifies the type of data catalog to update. Specify LAMBDA for a\n federated catalog or HIVE for an external hive metastore.

\n \n

Do not use the GLUE type. This refers to the\n AwsDataCatalog that already exists in your account, of which you\n can have only one. Specifying the GLUE type will result in an\n INVALID_INPUT error.

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

Specifies the type of data catalog to update. Specify LAMBDA for a\n federated catalog, HIVE for an external hive metastore, or\n GLUE for an Glue Data Catalog.

", "smithy.api#required": {} } }, @@ -3261,7 +3261,7 @@ "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

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.

\n
    \n
  • \n

    For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

    \n

    \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

    \n
    • \n
  • \n

    For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

    \n
      \n
    • \n

      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.

      \n

      \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

      \n
      • \n
    • \n

      If you have a composite Lambda function that processes both metadata\n and data, use the following syntax to specify your Lambda\n function.

      \n

      \n function=lambda_arn\n \n

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

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.

\n
    \n
  • \n

    For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

    \n

    \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

    \n
    • \n
  • \n

    For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

    \n
      \n
    • \n

      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.

      \n

      \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

      \n
      • \n
    • \n

      If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

      \n

      \n function=lambda_arn\n \n

      \n
      • \n
    \n
    • \n
" } } } @@ -3402,7 +3402,7 @@ "Configuration": { "target": "com.amazonaws.athena#WorkGroupConfiguration", "traits": { - "smithy.api#documentation": "

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 WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

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 EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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

A workgroup, which contains a name, description, creation time, state, and other\n configuration, listed under WorkGroup$Configuration. 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 WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

A workgroup, which contains a name, description, creation time, state, and other\n configuration, listed under WorkGroup$Configuration. 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 EnforceWorkGroupConfiguration\n (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, "com.amazonaws.athena#WorkGroupConfiguration": { @@ -3428,7 +3428,7 @@ "ResultConfiguration": { "target": "com.amazonaws.athena#ResultConfiguration", "traits": { - "smithy.api#documentation": "

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 ResultConfiguration$OutputLocation. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Query\n Results.

" + "smithy.api#documentation": "

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 ResultConfiguration$OutputLocation. If none of\n them is set, Athena issues an error that no output location is provided. For\n more information, see Query Results.

" } }, "EnforceWorkGroupConfiguration": { @@ -3452,18 +3452,18 @@ "RequesterPaysEnabled": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If set to true, allows members assigned to a workgroup to reference\n Amazon S3 Requester Pays buckets in queries. If set to false, 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 false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.

" + "smithy.api#documentation": "

If set to true, allows members assigned to a workgroup to reference\n Amazon S3 Requester Pays buckets in queries. If set to false,\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 false. For more information about Requester Pays buckets, see Requester\n Pays Buckets in the Amazon Simple Storage Service Developer\n Guide.

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

The engine version that all queries running on\n the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

" + "smithy.api#documentation": "

The engine version that all queries running on the workgroup use. Queries on the\n AmazonAthenaPreviewFunctionality workgroup run on the preview engine\n regardless of this setting.

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

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 WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

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 EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, "com.amazonaws.athena#WorkGroupConfigurationUpdates": { @@ -3484,7 +3484,7 @@ "PublishCloudWatchMetricsEnabled": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Indicates whether this workgroup enables publishing metrics to Amazon\n CloudWatch.

" + "smithy.api#documentation": "

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

" } }, "BytesScannedCutoffPerQuery": { @@ -3502,18 +3502,18 @@ "RequesterPaysEnabled": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If set to true, allows members assigned to a workgroup to specify Amazon\n S3 Requester Pays buckets in queries. If set to false, 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 false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.

" + "smithy.api#documentation": "

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, 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 false. For more\n information about Requester Pays buckets, see Requester Pays Buckets\n in the Amazon Simple Storage Service Developer Guide.

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

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 AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

" + "smithy.api#documentation": "

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 AmazonAthenaPreviewFunctionality\n workgroup run on the preview engine regardless of this setting.

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

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.

" + "smithy.api#documentation": "

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.

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

The engine version setting for all queries on the workgroup. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

" + "smithy.api#documentation": "

The engine version setting for all queries on the workgroup. Queries on the\n AmazonAthenaPreviewFunctionality workgroup run on the preview engine\n regardless of this setting.

" } } }, diff --git a/aws/sdk/aws-models/autoscaling.json b/aws/sdk/aws-models/autoscaling.json index 8e6d4d4bfb..5b35741823 100644 --- a/aws/sdk/aws-models/autoscaling.json +++ b/aws/sdk/aws-models/autoscaling.json @@ -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": "

Describes the desired configuration for an instance refresh.

\n

If you specify a desired configuration, you must specify either a\n LaunchTemplate or a MixedInstancesPolicy.

" + } + }, "com.amazonaws.autoscaling#DetachInstances": { "type": "operation", "input": { @@ -3806,6 +3820,15 @@ "traits": { "smithy.api#documentation": "

Additional progress details for an Auto Scaling group that has a warm pool.

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

Describes the specific update you want to deploy.

" + } } }, "traits": { @@ -3979,7 +4002,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.

\n

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.

\n

When you update SpotAllocationStrategy, SpotInstancePools,\n or SpotMaxPrice, 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.

" + "smithy.api#documentation": "

Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.

\n

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.

\n

When you modify SpotAllocationStrategy, SpotInstancePools,\n or SpotMaxPrice in the UpdateAutoScalingGroup 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.

" } }, "com.amazonaws.autoscaling#InstancesToUpdate": { @@ -4235,7 +4258,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a launch template and overrides.

\n

You specify these properties as part of a mixed instances policy.

\n

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.

" + "smithy.api#documentation": "

Describes a launch template and overrides.

\n

You specify these properties as part of a mixed instances policy.

\n

When you update the launch template or overrides in the UpdateAutoScalingGroup 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.

" } }, "com.amazonaws.autoscaling#LaunchTemplateName": { @@ -4297,7 +4320,7 @@ } }, "traits": { - "smithy.api#documentation": "

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.

\n

The launch template that is specified must be configured for use with an Auto Scaling group.\n For more information, see Creating a launch\n template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

" + "smithy.api#documentation": "

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 Launch\n templates in the Amazon EC2 Auto Scaling User Guide.

" } }, "com.amazonaws.autoscaling#LifecycleActionResult": { @@ -4867,7 +4890,7 @@ "LaunchTemplate": { "target": "com.amazonaws.autoscaling#LaunchTemplate", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "InstancesDistribution": { @@ -4878,7 +4901,7 @@ } }, "traits": { - "smithy.api#documentation": "

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 Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.

\n

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 MixedInstancesPolicy as\n the top-level property instead of a launch configuration or launch template.

" + "smithy.api#documentation": "

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 Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.

" } }, "com.amazonaws.autoscaling#MonitoringEnabled": { @@ -5822,7 +5845,7 @@ "MinHealthyPercentage": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

\n

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

" } }, "InstanceWarmup": { @@ -5842,10 +5865,16 @@ "traits": { "smithy.api#documentation": "

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 CheckpointPercentages. If you specify a value for\n CheckpointPercentages and not for CheckpointDelay, the\n CheckpointDelay defaults to 3600 (1 hour).

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

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 false.

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

Describes information used to start an instance refresh.

\n

All properties are optional. However, if you specify a value for\n CheckpointDelay, you must also provide a value for\n CheckpointPercentages.

" + "smithy.api#documentation": "

Describes the preferences for an instance refresh.

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

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.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

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 DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh operation in progress, use the CancelInstanceRefresh\n API.

" + "smithy.api#documentation": "

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.

\n

This operation is part of the instance refresh\n feature 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.

\n

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 DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh operation in progress, use the CancelInstanceRefresh\n API.

" } }, "com.amazonaws.autoscaling#StartInstanceRefreshAnswer": { @@ -6529,13 +6564,19 @@ "Strategy": { "target": "com.amazonaws.autoscaling#RefreshStrategy", "traits": { - "smithy.api#documentation": "

The strategy to use for the instance refresh. The only valid value is\n Rolling.

\n

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.

" + "smithy.api#documentation": "

The strategy to use for the instance refresh. The only valid value is\n Rolling.

\n

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.

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

The desired configuration. For example, the desired configuration can specify a new\n launch template or a new version of the current launch template.

\n

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to\n reflect the new desired configuration.

\n \n

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 SkipMatching 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.

\n " } }, "Preferences": { "target": "com.amazonaws.autoscaling#RefreshPreferences", "traits": { - "smithy.api#documentation": "

Set of preferences associated with the instance refresh request.

\n

If not provided, the default values are used. For MinHealthyPercentage,\n the default value is 90. For InstanceWarmup, the default is to\n use the value specified for the health check grace period for the Auto Scaling group.

\n

For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API\n Reference.

" + "smithy.api#documentation": "

Set of preferences associated with the instance refresh request. If not provided, the\n default values are used.

" } } } diff --git a/aws/sdk/aws-models/ce.json b/aws/sdk/aws-models/ce.json index 5024431ee4..0554e8bffb 100644 --- a/aws/sdk/aws-models/ce.json +++ b/aws/sdk/aws-models/ce.json @@ -136,7 +136,7 @@ "name": "ce" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data \n\t\t\tsuch as total monthly costs or total daily usage. You can also query for granular data, such as the number of \n\t\t\tdaily write operations for Amazon DynamoDB database tables in your production environment.

\n\t\t

Service Endpoint

\n\t\t

The Cost Explorer API provides the following endpoint:

\n\t\t
    \n
  • \n\t\t\t\t

    \n https://ce.us-east-1.amazonaws.com\n

    \n\t\t\t
    • \n
\n\t\t

For information about costs associated with the Cost Explorer API, see \n\t\t\tAWS Cost Management Pricing.

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

You can use the Cost Explorer API to programmatically query your cost and usage data. You\n can query for aggregated data such as total monthly costs or total daily usage. You can also\n query for granular data. This might include the number of daily write operations for Amazon\n DynamoDB database tables in your production environment.

\n\t\t

Service Endpoint

\n\t\t

The Cost Explorer API provides the following endpoint:

\n\t\t
    \n
  • \n\t\t\t\t

    \n https://ce.us-east-1.amazonaws.com\n

    \n\t\t\t
    • \n
\n\t\t

For information about the costs that are associated with the Cost Explorer API, see\n Amazon Web Services Cost\n Management Pricing.

", "smithy.api#title": "AWS Cost Explorer Service" } }, @@ -173,64 +173,64 @@ "AnomalyId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The unique identifier for the anomaly.\n

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

The unique identifier for the anomaly.

", "smithy.api#required": {} } }, "AnomalyStartDate": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

\n The first day the anomaly is detected.\n

" + "smithy.api#documentation": "

The first day the anomaly is detected.

" } }, "AnomalyEndDate": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

\n The last day the anomaly is detected.\n

" + "smithy.api#documentation": "

The last day the anomaly is detected.

" } }, "DimensionValue": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The dimension for the anomaly. For example, an AWS service in a service monitor.\n

" + "smithy.api#documentation": "

The dimension for the anomaly (for example, an Amazon Web Services service in a service\n monitor).

" } }, "RootCauses": { "target": "com.amazonaws.costexplorer#RootCauses", "traits": { - "smithy.api#documentation": "

\n The list of identified root causes for the anomaly.\n

" + "smithy.api#documentation": "

The list of identified root causes for the anomaly.

" } }, "AnomalyScore": { "target": "com.amazonaws.costexplorer#AnomalyScore", "traits": { - "smithy.api#documentation": "

\n The latest and maximum score for the anomaly.\n

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

The latest and maximum score for the anomaly.

", "smithy.api#required": {} } }, "Impact": { "target": "com.amazonaws.costexplorer#Impact", "traits": { - "smithy.api#documentation": "

\n The dollar impact for the anomaly.\n

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

The dollar impact for the anomaly.

", "smithy.api#required": {} } }, "MonitorArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.

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

The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.\n

", "smithy.api#required": {} } }, "Feedback": { "target": "com.amazonaws.costexplorer#AnomalyFeedbackType", "traits": { - "smithy.api#documentation": "

\n The feedback value.\n

" + "smithy.api#documentation": "

The feedback value.

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

\n An unusual cost pattern. This consists of the detailed metadata and the current status of the anomaly object.\n

" + "smithy.api#documentation": "

An unusual cost pattern. This consists of the detailed metadata and the current status\n of the anomaly object.

" } }, "com.amazonaws.costexplorer#AnomalyDateInterval": { @@ -239,19 +239,19 @@ "StartDate": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

\n The first date an anomaly was observed.\n

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

The first date an anomaly was observed.

", "smithy.api#required": {} } }, "EndDate": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

\n The last date an anomaly was observed.\n

" + "smithy.api#documentation": "

The last date an anomaly was observed.

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

\n The time period for an anomaly.\n

" + "smithy.api#documentation": "

The time period for an anomaly.

" } }, "com.amazonaws.costexplorer#AnomalyFeedbackType": { @@ -279,45 +279,45 @@ "MonitorArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) value.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) value.

" } }, "MonitorName": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The name of the monitor.\n

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

The name of the monitor.

", "smithy.api#required": {} } }, "CreationDate": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

\n The date when the monitor was created.\n

" + "smithy.api#documentation": "

The date when the monitor was created.

" } }, "LastUpdatedDate": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

\n The date when the monitor was last updated.\n

" + "smithy.api#documentation": "

The date when the monitor was last updated.

" } }, "LastEvaluatedDate": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

\n The date when the monitor last evaluated for anomalies.\n

" + "smithy.api#documentation": "

The date when the monitor last evaluated for anomalies.

" } }, "MonitorType": { "target": "com.amazonaws.costexplorer#MonitorType", "traits": { - "smithy.api#documentation": "

\n The possible type values.\n

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

The possible type values.

", "smithy.api#required": {} } }, "MonitorDimension": { "target": "com.amazonaws.costexplorer#MonitorDimension", "traits": { - "smithy.api#documentation": "

\n The dimensions to evaluate.\n

" + "smithy.api#documentation": "

The dimensions to evaluate.

" } }, "MonitorSpecification": { @@ -326,12 +326,12 @@ "DimensionalValueCount": { "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

\n The value for evaluated dimensions.\n

" + "smithy.api#documentation": "

The value for evaluated dimensions.

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

This object continuously inspects your account's cost data for anomalies, based on\n MonitorType and MonitorSpecification. The content consists\n of detailed metadata and the current status of the monitor object.

" + "smithy.api#documentation": "

This object continuously inspects your account's cost data for anomalies. It's based\n on MonitorType and MonitorSpecification. The content consists\n of detailed metadata and the current status of the monitor object.

" } }, "com.amazonaws.costexplorer#AnomalyMonitors": { @@ -346,20 +346,20 @@ "MaxScore": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { - "smithy.api#documentation": "

\n The maximum score observed during the AnomalyDateInterval.\n

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

The maximum score that's observed during the AnomalyDateInterval.

", "smithy.api#required": {} } }, "CurrentScore": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { - "smithy.api#documentation": "

\n The last observed score.\n

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

The last observed score.

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

Quantifies the anomaly. The higher score means that it is more anomalous.

" + "smithy.api#documentation": "

Quantifies the anomaly. The higher score means that it's more anomalous.

" } }, "com.amazonaws.costexplorer#AnomalySubscription": { @@ -368,53 +368,53 @@ "SubscriptionArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AnomalySubscription Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

The AnomalySubscription Amazon Resource Name (ARN).

" } }, "AccountId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n Your unique account identifier.\n

" + "smithy.api#documentation": "

Your unique account identifier.

" } }, "MonitorArnList": { "target": "com.amazonaws.costexplorer#MonitorArnList", "traits": { - "smithy.api#documentation": "

\n A list of cost anomaly monitors.\n

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

A list of cost anomaly monitors.

", "smithy.api#required": {} } }, "Subscribers": { "target": "com.amazonaws.costexplorer#Subscribers", "traits": { - "smithy.api#documentation": "

\n A list of subscribers to notify.\n

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

A list of subscribers to notify.

", "smithy.api#required": {} } }, "Threshold": { "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", "traits": { - "smithy.api#documentation": "

\n The dollar value that triggers a notification if the threshold is exceeded.\n

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

The dollar value that triggers a notification if the threshold is exceeded.

", "smithy.api#required": {} } }, "Frequency": { "target": "com.amazonaws.costexplorer#AnomalySubscriptionFrequency", "traits": { - "smithy.api#documentation": "

\n The frequency at which anomaly reports are sent over email.\n

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

The frequency that anomaly reports are sent over email.

", "smithy.api#required": {} } }, "SubscriptionName": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The name for the subscription.\n

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

The name for the subscription.

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

\n The association between a monitor, threshold, and list of subscribers used to deliver notifications about anomalies detected by a monitor that exceeds a threshold. The content consists of the detailed metadata and the current status of the AnomalySubscription object.\n

" + "smithy.api#documentation": "

The association between a monitor, threshold, and list of subscribers used to deliver\n notifications about anomalies detected by a monitor that exceeds a threshold. The\n content consists of the detailed metadata and the current status of the\n AnomalySubscription object.

" } }, "com.amazonaws.costexplorer#AnomalySubscriptionFrequency": { @@ -449,7 +449,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+" + "smithy.api#pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$" } }, "com.amazonaws.costexplorer#AttributeType": { @@ -504,21 +504,21 @@ "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

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

The unique identifier for your Cost Category.

", "smithy.api#required": {} } }, "EffectiveStart": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The Cost Category's effective start date.

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

The effective state data of your Cost Category.

", "smithy.api#required": {} } }, "EffectiveEnd": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The Cost Category's effective end date.

" + "smithy.api#documentation": "

The effective end data of your Cost Category.

" } }, "Name": { @@ -536,14 +536,20 @@ "Rules": { "target": "com.amazonaws.costexplorer#CostCategoryRulesList", "traits": { - "smithy.api#documentation": "

\n Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.\n

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

The rules are processed in order. If there are multiple rules that match the line\n item, then the first rule to match is used to determine that Cost Category value.\n

", "smithy.api#required": {} } }, + "SplitChargeRules": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRulesList", + "traits": { + "smithy.api#documentation": "

The split charge rules that are used to allocate your charges between your Cost\n Category values.

" + } + }, "ProcessingStatus": { "target": "com.amazonaws.costexplorer#CostCategoryProcessingStatusList", "traits": { - "smithy.api#documentation": "

\n The list of processing statuses for Cost Management products for a specific cost category.\n

" + "smithy.api#documentation": "

The list of processing statuses for Cost Management products for a specific cost\n category.

" } }, "DefaultValue": { @@ -551,7 +557,7 @@ } }, "traits": { - "smithy.api#documentation": "

The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.

" + "smithy.api#documentation": "

The structure of Cost Categories. This includes detailed metadata and the set of rules\n for the CostCategory object.

" } }, "com.amazonaws.costexplorer#CostCategoryInheritedValueDimension": { @@ -560,7 +566,7 @@ "DimensionName": { "target": "com.amazonaws.costexplorer#CostCategoryInheritedValueDimensionName", "traits": { - "smithy.api#documentation": "

The name of dimension for which to group costs.

\n\t

If you specify LINKED_ACCOUNT_NAME, the cost category value will be based on account name. If you specify TAG, the cost category value will be based on the value of the specified tag key.

" + "smithy.api#documentation": "

The name of the dimension that's used to group costs.

\n

If you specify LINKED_ACCOUNT_NAME, the cost category value is based on\n account name. If you specify TAG, the cost category value will be based on\n the value of the specified tag key.

" } }, "DimensionKey": { @@ -571,7 +577,7 @@ } }, "traits": { - "smithy.api#documentation": "

When creating or updating a cost category, you can define the CostCategoryRule rule type as INHERITED_VALUE. This rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

" + "smithy.api#documentation": "

When creating or updating a cost category, you can define the\n CostCategoryRule rule type as INHERITED_VALUE. This rule\n type adds the flexibility of defining a rule that dynamically inherits the cost category\n value from the dimension value defined by\n CostCategoryInheritedValueDimension. For example, if you want to\n dynamically group costs that are based on the value of a specific tag key, first choose\n an inherited value rule type, then choose the tag dimension and specify the tag key to\n use.

" } }, "com.amazonaws.costexplorer#CostCategoryInheritedValueDimensionName": { @@ -621,18 +627,18 @@ "Component": { "target": "com.amazonaws.costexplorer#CostCategoryStatusComponent", "traits": { - "smithy.api#documentation": "

\n The Cost Management product name of the applied status.\n

" + "smithy.api#documentation": "

The Cost Management product name of the applied status.

" } }, "Status": { "target": "com.amazonaws.costexplorer#CostCategoryStatus", "traits": { - "smithy.api#documentation": "

\n The process status for a specific cost category.\n

" + "smithy.api#documentation": "

The process status for a specific cost category.

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

\n The list of processing statuses for Cost Management products for a specific cost category.\n

" + "smithy.api#documentation": "

The list of processing statuses for Cost Management products for a specific cost\n category.

" } }, "com.amazonaws.costexplorer#CostCategoryProcessingStatusList": { @@ -647,7 +653,7 @@ "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

" + "smithy.api#documentation": "

The unique identifier for your Cost Category.

" } }, "Name": { @@ -656,31 +662,31 @@ "EffectiveStart": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The Cost Category's effective start date.

" + "smithy.api#documentation": "

The Cost Category's effective start date.

" } }, "EffectiveEnd": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The Cost Category's effective end date.

" + "smithy.api#documentation": "

The Cost Category's effective end date.

" } }, "NumberOfRules": { "target": "com.amazonaws.costexplorer#NonNegativeInteger", "traits": { - "smithy.api#documentation": "

\n The number of rules associated with a specific Cost Category.\n

" + "smithy.api#documentation": "

The number of rules that are associated with a specific Cost Category.

" } }, "ProcessingStatus": { "target": "com.amazonaws.costexplorer#CostCategoryProcessingStatusList", "traits": { - "smithy.api#documentation": "

\n The list of processing statuses for Cost Management products for a specific cost category.\n

" + "smithy.api#documentation": "

The list of processing statuses for Cost Management products for a specific cost\n category.

" } }, "Values": { "target": "com.amazonaws.costexplorer#CostCategoryValuesList", "traits": { - "smithy.api#documentation": "

\n A list of unique cost category values in a specific cost category.\n

" + "smithy.api#documentation": "

A list of unique cost category values in a specific cost category.

" } }, "DefaultValue": { @@ -688,7 +694,7 @@ } }, "traits": { - "smithy.api#documentation": "

A reference to a Cost Category containing only enough information to identify the Cost Category.

\n

You can use this information to retrieve the full Cost Category information using DescribeCostCategory.

" + "smithy.api#documentation": "

A reference to a Cost Category containing only enough information to identify the Cost\n Category.

\n

You can use this information to retrieve the full Cost Category information using\n DescribeCostCategory.

" } }, "com.amazonaws.costexplorer#CostCategoryReferencesList": { @@ -706,24 +712,24 @@ "Rule": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

An Expression\n object used to categorize costs. This supports dimensions, tags, and nested expressions.\n Currently the only dimensions supported are LINKED_ACCOUNT,\n SERVICE_CODE, RECORD_TYPE, and\n LINKED_ACCOUNT_NAME.

\n

Root level OR is not supported. We recommend that you create a separate\n rule instead.

\n \n

\n RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also\n supported for Cost Category expressions. This dimension uses different terms, depending\n on whether you're using the console or API/JSON editor. For a detailed comparison, see\n Term Comparisons in the AWS Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

An Expression\n object used to categorize costs. This supports dimensions, tags, and nested expressions.\n Currently the only dimensions supported are LINKED_ACCOUNT,\n SERVICE_CODE, RECORD_TYPE, and\n LINKED_ACCOUNT_NAME.

\n

Root level OR isn't supported. We recommend that you create a separate\n rule instead.

\n

\n RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also\n supported for Cost Category expressions. This dimension uses different terms, depending\n on whether you're using the console or API/JSON editor. For a detailed comparison, see\n Term Comparisons in the Billing and Cost Management User\n Guide.

" } }, "InheritedValue": { "target": "com.amazonaws.costexplorer#CostCategoryInheritedValueDimension", "traits": { - "smithy.api#documentation": "

The value the line item will be categorized as, if the line item contains the matched dimension.

" + "smithy.api#documentation": "

The value the line item is categorized as if the line item contains the matched\n dimension.

" } }, "Type": { "target": "com.amazonaws.costexplorer#CostCategoryRuleType", "traits": { - "smithy.api#documentation": "

You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

" + "smithy.api#documentation": "

You can define the CostCategoryRule rule type as either\n REGULAR or INHERITED_VALUE. The\n INHERITED_VALUE rule type adds the flexibility of defining a rule that\n dynamically inherits the cost category value from the dimension value defined by\n CostCategoryInheritedValueDimension. For example, if you want to\n dynamically group costs based on the value of a specific tag key, first choose an\n inherited value rule type, then choose the tag dimension and specify the tag key to\n use.

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

Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.

" + "smithy.api#documentation": "

Rules are processed in order. If there are multiple rules that match the line item,\n then the first rule to match is used to determine that Cost Category value.

" } }, "com.amazonaws.costexplorer#CostCategoryRuleType": { @@ -765,6 +771,141 @@ } } }, + "com.amazonaws.costexplorer#CostCategorySplitChargeMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FIXED", + "name": "FIXED" + }, + { + "value": "PROPORTIONAL", + "name": "PROPORTIONAL" + }, + { + "value": "EVEN", + "name": "EVEN" + } + ] + } + }, + "com.amazonaws.costexplorer#CostCategorySplitChargeRule": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

The Cost Category value that you want to split. That value can't be used as a source\n or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.

", + "smithy.api#required": {} + } + }, + "Targets": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRuleTargetsList", + "traits": { + "smithy.api#documentation": "

The Cost Category values that you want to split costs across. These values can't be\n used as a source in other split charge rules.

", + "smithy.api#required": {} + } + }, + "Method": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeMethod", + "traits": { + "smithy.api#documentation": "

The method that's used to define how to split your source costs across your targets.

\n

\n Proportional - Allocates charges across your targets based on the\n proportional weighted cost of each target.

\n

\n Fixed - Allocates charges across your targets based on your defined\n allocation percentage.

\n

>Even - Allocates costs evenly across all targets.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParametersList", + "traits": { + "smithy.api#documentation": "

The parameters for a split charge method. This is only required for the\n FIXED method.

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

Use the split charge rule to split the cost of one Cost Category value across several\n other target values.

" + } + }, + "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParameter": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParameterType", + "traits": { + "smithy.api#documentation": "

The parameter type.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParameterValuesList", + "traits": { + "smithy.api#documentation": "

The parameter values.

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

The parameters for a split charge method.

" + } + }, + "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParameterType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOCATION_PERCENTAGES", + "name": "ALLOCATION_PERCENTAGES" + } + ] + } + }, + "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParameterValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#GenericString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRuleParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.costexplorer#CostCategorySplitChargeRuleTargetsList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#GenericString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.costexplorer#CostCategorySplitChargeRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRule" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.costexplorer#CostCategoryStatus": { "type": "string", "traits": { @@ -794,7 +935,7 @@ "com.amazonaws.costexplorer#CostCategoryValue": { "type": "string", "traits": { - "smithy.api#documentation": "

The default value for the cost category.

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

The\n default value for the cost category.

", "smithy.api#length": { "min": 1, "max": 50 @@ -817,12 +958,12 @@ "MatchOptions": { "target": "com.amazonaws.costexplorer#MatchOptions", "traits": { - "smithy.api#documentation": "

\n The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.\n

" + "smithy.api#documentation": "

The match options that you can use to filter your results. MatchOptions is only\n applicable for actions related to cost category. The default values for\n MatchOptions is EQUALS and CASE_SENSITIVE.\n

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

The Cost Categories values used for filtering the costs.

\n\t\t

If Values and Key are not specified, the ABSENT \n MatchOption is applied to all Cost Categories. That is, filtering on resources that are not mapped to any Cost Categories.

\n

If Values is provided and Key is not specified, the ABSENT \n MatchOption is applied to the Cost Categories Key only. That is, filtering on resources without the given Cost Categories key.

" + "smithy.api#documentation": "

The Cost Categories values used for filtering the costs.

\n

If Values and Key are not specified, the ABSENT\n MatchOption is applied to all Cost Categories. That is, it filters on\n resources that aren't mapped to any Cost Categories.

\n

If Values is provided and Key isn't specified, the\n ABSENT\n MatchOption is applied to the Cost Categories Key only. That\n is, it filters on resources without the given Cost Categories key.

" } }, "com.amazonaws.costexplorer#CostCategoryValuesList": { @@ -843,7 +984,7 @@ "CoverageNormalizedUnits": { "target": "com.amazonaws.costexplorer#CoverageNormalizedUnits", "traits": { - "smithy.api#documentation": "

The amount of instance usage that the reservation covered, in normalized\n units.

" + "smithy.api#documentation": "

The amount of instance usage that the reservation covered, in normalized units.

" } }, "CoverageCost": { @@ -880,7 +1021,7 @@ } }, "traits": { - "smithy.api#documentation": "

Reservation\n coverage for a specified period, in\n hours.

" + "smithy.api#documentation": "

Reservation coverage for a specified period, in hours.

" } }, "com.amazonaws.costexplorer#CoverageCost": { @@ -961,7 +1102,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of instance usage, in normalized units. Normalized units enable you to\n see your EC2 usage for multiple sizes of instances in a uniform way. For example,\n suppose you run an xlarge instance and a 2xlarge instance. If you run both instances for\n the same amount of time, the 2xlarge instance uses twice as much of your reservation as\n the xlarge instance, even though both instances show only one instance-hour. Using\n normalized units instead of instance-hours, the xlarge instance used 8 normalized units,\n and the 2xlarge instance used 16 normalized units.

\n

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for\n Linux Instances.

" + "smithy.api#documentation": "

The amount of instance usage, in normalized units. You can use normalized units to see\n your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose\n that you run an xlarge instance and a 2xlarge instance. If you run both instances for\n the same amount of time, the 2xlarge instance uses twice as much of your reservation as\n the xlarge instance, even though both instances show only one instance-hour. When you\n use normalized units instead of instance-hours, the xlarge instance used 8 normalized\n units, and the 2xlarge instance used 16 normalized units.

\n

For more information, see Modifying Reserved Instances\n in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances.

" } }, "com.amazonaws.costexplorer#CoverageNormalizedUnitsPercentage": { @@ -996,7 +1137,7 @@ "AnomalyMonitor": { "target": "com.amazonaws.costexplorer#AnomalyMonitor", "traits": { - "smithy.api#documentation": "

The cost anomaly detection monitor object that you want to create.

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

The cost anomaly detection monitor object that you want to create.

", "smithy.api#required": {} } } @@ -1008,7 +1149,7 @@ "MonitorArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The unique identifier of your newly created cost anomaly detection monitor.

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

The unique identifier of your newly created cost anomaly detection monitor.

", "smithy.api#required": {} } } @@ -1040,7 +1181,7 @@ "AnomalySubscription": { "target": "com.amazonaws.costexplorer#AnomalySubscription", "traits": { - "smithy.api#documentation": "

\n The cost anomaly subscription object that you want to create.\n

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

The cost anomaly subscription object that you want to create.

", "smithy.api#required": {} } } @@ -1052,7 +1193,7 @@ "SubscriptionArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The unique identifier of your newly created cost anomaly subscription.\n

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

The unique identifier of your newly created cost anomaly subscription.

", "smithy.api#required": {} } } @@ -1102,6 +1243,12 @@ }, "DefaultValue": { "target": "com.amazonaws.costexplorer#CostCategoryValue" + }, + "SplitChargeRules": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRulesList", + "traits": { + "smithy.api#documentation": "

\n The split charge rules used to allocate your charges between your Cost Category values.\n

" + } } } }, @@ -1134,61 +1281,61 @@ "InstanceName": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The name you've given an instance. This field will show as blank if you haven't given the instance a name.

" + "smithy.api#documentation": "

The name that you given an instance. This field shows as blank if you haven't given\n the instance a name.

" } }, "Tags": { "target": "com.amazonaws.costexplorer#TagValuesList", "traits": { - "smithy.api#documentation": "

Cost allocation resource tags applied to the instance.

" + "smithy.api#documentation": "

Cost allocation resource tags that are applied to the instance.

" } }, "ResourceDetails": { "target": "com.amazonaws.costexplorer#ResourceDetails", "traits": { - "smithy.api#documentation": "

Details about the resource and utilization.

" + "smithy.api#documentation": "

Details about the resource and utilization.

" } }, "ResourceUtilization": { "target": "com.amazonaws.costexplorer#ResourceUtilization", "traits": { - "smithy.api#documentation": "

Utilization information of the current instance during the lookback period.

" + "smithy.api#documentation": "

Utilization information of the current instance during the lookback period.

" } }, "ReservationCoveredHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Number of hours during the lookback period covered by reservations.

" + "smithy.api#documentation": "

The number of hours during the lookback period that's covered by reservations.

" } }, "SavingsPlansCoveredHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Number of hours during the lookback period covered by Savings Plans.

" + "smithy.api#documentation": "

The number of hours during the lookback period that's covered by Savings Plans.

" } }, "OnDemandHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Number of hours during the lookback period billed at On-Demand rates.

" + "smithy.api#documentation": "

The number of hours during the lookback period that's billed at On-Demand\n rates.

" } }, "TotalRunningHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total number of hours the instance ran during the lookback period.

" + "smithy.api#documentation": "

The total number of hours that the instance ran during the lookback period.

" } }, "MonthlyCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Current On-Demand cost of operating this instance on a monthly basis.

" + "smithy.api#documentation": "

The current On-Demand cost of operating this instance on a monthly basis.

" } }, "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this\n instance.

" } } }, @@ -1214,20 +1361,20 @@ "Start": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

The beginning of the time period. The start\n date is inclusive. For example, if start is 2017-01-01, AWS\n retrieves cost and usage data starting at 2017-01-01 up to the end\n date. The start date must be equal to or no later than the current date to avoid a validation error.

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

The beginning of the time period. The start date is inclusive. For example, if\n start is 2017-01-01, Amazon Web Services retrieves cost and\n usage data starting at 2017-01-01 up to the end date. The start date must\n be equal to or no later than the current date to avoid a validation error.

", "smithy.api#required": {} } }, "End": { "target": "com.amazonaws.costexplorer#YearMonthDay", "traits": { - "smithy.api#documentation": "

The end of the time period. The end date is\n exclusive. For example, if end is 2017-05-01, AWS retrieves\n cost and usage data from the start date up to, but not including,\n 2017-05-01.

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

The end of the time period. The end date is exclusive. For example, if\n end is 2017-05-01, Amazon Web Services retrieves cost and\n usage data from the start date up to, but not including, 2017-05-01.

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

The time period of the request.\n

" + "smithy.api#documentation": "

The time period of the request.

" } }, "com.amazonaws.costexplorer#DeleteAnomalyMonitor": { @@ -1256,7 +1403,7 @@ "MonitorArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The unique identifier of the cost anomaly monitor that you want to delete.

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

The unique identifier of the cost anomaly monitor that you want to delete.

", "smithy.api#required": {} } } @@ -1292,7 +1439,7 @@ "SubscriptionArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The unique identifier of the cost anomaly subscription that you want to delete.

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

The unique identifier of the cost anomaly subscription that you want to delete.

", "smithy.api#required": {} } } @@ -1534,7 +1681,7 @@ "Key": { "target": "com.amazonaws.costexplorer#Dimension", "traits": { - "smithy.api#documentation": "

The names of the metadata types that you can use to filter and group your results.\n For example, AZ returns a list of Availability Zones.

" + "smithy.api#documentation": "

The names of the metadata types that you can use to filter and group your results. For\n example, AZ returns a list of Availability Zones.

" } }, "Values": { @@ -1546,7 +1693,7 @@ "MatchOptions": { "target": "com.amazonaws.costexplorer#MatchOptions", "traits": { - "smithy.api#documentation": "

The match options that you can use to filter your results.\n MatchOptions is only applicable for actions related to Cost Category.\n The default values for MatchOptions are EQUALS and\n CASE_SENSITIVE.

" + "smithy.api#documentation": "

The match options that you can use to filter your results. MatchOptions\n is only applicable for actions related to Cost Category. The default values for\n MatchOptions are EQUALS and\n CASE_SENSITIVE.

" } } }, @@ -1571,7 +1718,7 @@ } }, "traits": { - "smithy.api#documentation": "

The metadata of a specific type that you can use to filter and group your results.\n You can use GetDimensionValues to find specific values.

" + "smithy.api#documentation": "

The metadata of a specific type that you can use to filter and group your results. You\n can use GetDimensionValues to find specific values.

" } }, "com.amazonaws.costexplorer#DimensionValuesWithAttributesList": { @@ -1586,30 +1733,30 @@ "DiskReadOpsPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The maximum number of read operations per second.\n

" + "smithy.api#documentation": "

The maximum number of read operations per second.

" } }, "DiskWriteOpsPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The maximum number of write operations per second.\n

" + "smithy.api#documentation": "

The maximum number of write operations per second.

" } }, "DiskReadBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The maximum read throughput operations per second.\n

" + "smithy.api#documentation": "

The maximum read throughput operations per second.

" } }, "DiskWriteBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The maximum write throughput operations per second.\n

" + "smithy.api#documentation": "

The maximum write throughput operations per second.

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

\n The field that contains a list of disk (local storage) metrics associated with the current instance.\n

" + "smithy.api#documentation": "

The field that contains a list of disk (local storage) metrics that are associated\n with the current instance.

" } }, "com.amazonaws.costexplorer#EBSResourceUtilization": { @@ -1618,30 +1765,30 @@ "EbsReadOpsPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The maximum number of read operations per second.\n

" + "smithy.api#documentation": "

The maximum number of read operations per second.

" } }, "EbsWriteOpsPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The maximum number of write operations per second.\n

" + "smithy.api#documentation": "

The maximum number of write operations per second.

" } }, "EbsReadBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The maximum size of read operations per second\n

" + "smithy.api#documentation": "

The maximum size of read operations per second

" } }, "EbsWriteBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The maximum size of write operations per second.\n

" + "smithy.api#documentation": "

The maximum size of write operations per second.

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

\n The EBS field that contains a list of EBS metrics associated with the current instance.\n

" + "smithy.api#documentation": "

The EBS field that contains a list of EBS metrics that are associated with the current\n instance.

" } }, "com.amazonaws.costexplorer#EC2InstanceDetails": { @@ -1656,13 +1803,13 @@ "InstanceType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The type of instance that AWS recommends.

" + "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" } }, "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the recommended reservation.

" } }, "AvailabilityZone": { @@ -1674,30 +1821,30 @@ "Platform": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The platform of the recommended reservation. The platform is the specific\n combination of operating system, license model, and software on an instance.

" + "smithy.api#documentation": "

The platform of the recommended reservation. The platform is the specific combination\n of operating system, license model, and software on an instance.

" } }, "Tenancy": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is dedicated or shared.

" + "smithy.api#documentation": "

Determines whether the recommended reservation is dedicated or shared.

" } }, "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current-generation instance.

" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + "smithy.api#documentation": "

Determines whether the recommended reservation is size flexible.

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

Details about the Amazon EC2 instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

Details about the Amazon EC2 instances that Amazon Web Services recommends that you\n purchase.

" } }, "com.amazonaws.costexplorer#EC2ResourceDetails": { @@ -1706,60 +1853,60 @@ "HourlyOnDemandRate": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Hourly public On-Demand rate for the instance type.

" + "smithy.api#documentation": "

The hourly public On-Demand rate for the instance type.

" } }, "InstanceType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The type of AWS instance.

" + "smithy.api#documentation": "

The type of Amazon Web Services instance.

" } }, "Platform": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The platform of the AWS instance. The platform is the specific combination of\n operating system, license model, and software on an instance.

" + "smithy.api#documentation": "

The platform of the Amazon Web Services instance. The platform is the specific\n combination of operating system, license model, and software on an instance.

" } }, "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the instance.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the instance.

" } }, "Sku": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The SKU of the product.

" + "smithy.api#documentation": "

The SKU of the product.

" } }, "Memory": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Memory capacity of the AWS instance.

" + "smithy.api#documentation": "

The memory capacity of the Amazon Web Services instance.

" } }, "NetworkPerformance": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Network performance capacity of the AWS instance.

" + "smithy.api#documentation": "

The network performance capacity of the Amazon Web Services instance.

" } }, "Storage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The disk storage of the AWS instance (not EBS storage).

" + "smithy.api#documentation": "

The disk storage of the Amazon Web Services instance. This doesn't include EBS\n storage.

" } }, "Vcpu": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Number of VCPU cores in the AWS instance type.

" + "smithy.api#documentation": "

The number of VCPU cores in the Amazon Web Services instance type.

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

Details on the Amazon EC2 Resource.

" + "smithy.api#documentation": "

Details on the Amazon EC2 Resource.

" } }, "com.amazonaws.costexplorer#EC2ResourceUtilization": { @@ -1768,42 +1915,42 @@ "MaxCpuUtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Maximum observed or expected CPU utilization of the instance.

" + "smithy.api#documentation": "

The maximum observed or expected CPU utilization of the instance.

" } }, "MaxMemoryUtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Maximum observed or expected memory utilization of the instance.

" + "smithy.api#documentation": "

The maximum observed or expected memory utilization of the instance.

" } }, "MaxStorageUtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Maximum observed or expected storage utilization of the instance (does not measure EBS storage).

" + "smithy.api#documentation": "

The maximum observed or expected storage utilization of the instance. This doesn't\n include EBS storage.

" } }, "EBSResourceUtilization": { "target": "com.amazonaws.costexplorer#EBSResourceUtilization", "traits": { - "smithy.api#documentation": "

\n The EBS field that contains a list of EBS metrics associated with the current instance.\n

" + "smithy.api#documentation": "

The EBS field that contains a list of EBS metrics that are associated with the current\n instance.

" } }, "DiskResourceUtilization": { "target": "com.amazonaws.costexplorer#DiskResourceUtilization", "traits": { - "smithy.api#documentation": "

\n The field that contains a list of disk (local storage) metrics associated with the current instance.\n

" + "smithy.api#documentation": "

The field that contains a list of disk (local storage) metrics that are associated\n with the current instance.

" } }, "NetworkResourceUtilization": { "target": "com.amazonaws.costexplorer#NetworkResourceUtilization", "traits": { - "smithy.api#documentation": "

\n The network field that contains a list of network metrics associated with the current instance.\n

" + "smithy.api#documentation": "

The network field that contains a list of network metrics that are associated with\n the current instance.

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

Utilization metrics of the instance.

" + "smithy.api#documentation": "

Utilization metrics of the instance.

" } }, "com.amazonaws.costexplorer#EC2Specification": { @@ -1812,12 +1959,12 @@ "OfferingClass": { "target": "com.amazonaws.costexplorer#OfferingClass", "traits": { - "smithy.api#documentation": "

Whether you want a recommendation for standard or convertible\n reservations.

" + "smithy.api#documentation": "

Indicates whether you want a recommendation for standard or convertible\n reservations.

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

The Amazon EC2 hardware specifications that you want AWS to provide recommendations\n for.

" + "smithy.api#documentation": "

The Amazon EC2 hardware specifications that you want Amazon Web Services to provide\n recommendations for.

" } }, "com.amazonaws.costexplorer#ESInstanceDetails": { @@ -1826,36 +1973,36 @@ "InstanceClass": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The class of instance that AWS recommends.

" + "smithy.api#documentation": "

The class of instance that Amazon Web Services recommends.

" } }, "InstanceSize": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The size of instance that AWS recommends.

" + "smithy.api#documentation": "

The size of instance that Amazon Web Services recommends.

" } }, "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the recommended reservation.

" } }, "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current-generation instance.

" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + "smithy.api#documentation": "

Determines whether the recommended reservation is size flexible.

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

Details about the Amazon ES instances that AWS recommends that you\n purchase.

" + "smithy.api#documentation": "

Details about the Amazon ES instances that Amazon Web Services recommends that you\n purchase.

" } }, "com.amazonaws.costexplorer#ElastiCacheInstanceDetails": { @@ -1870,13 +2017,13 @@ "NodeType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The type of node that AWS recommends.

" + "smithy.api#documentation": "

The type of node that Amazon Web Services recommends.

" } }, "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the recommended reservation.

" } }, "ProductDescription": { @@ -1888,18 +2035,18 @@ "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current generation instance.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current generation instance.

" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + "smithy.api#documentation": "

Determines whether the recommended reservation is size flexible.

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

Details about the Amazon ElastiCache instances that AWS recommends that you\n purchase.

" + "smithy.api#documentation": "

Details about the Amazon ElastiCache instances that Amazon Web Services recommends that\n you purchase.

" } }, "com.amazonaws.costexplorer#Entity": { @@ -1947,12 +2094,12 @@ "CostCategories": { "target": "com.amazonaws.costexplorer#CostCategoryValues", "traits": { - "smithy.api#documentation": "

The filter based on CostCategory values.

" + "smithy.api#documentation": "

The filter that's based on CostCategory values.

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

Use Expression to filter by cost or by usage. There are two patterns:

\n
    \n
  • \n

    Simple dimension values - You can set the dimension name and values for the\n filters that you plan to use. For example, you can filter for\n REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The\n Expression example looks like:

    \n

    \n { \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\",\n “us-west-1” ] } }\n

    \n

    The list of dimension values are OR'd together to retrieve cost or usage\n data. You can create Expression and DimensionValues\n objects using either with* methods or set* methods in\n multiple lines.

    \n
    • \n
  • \n

    Compound dimension values with logical operations - You can use multiple\n Expression types and the logical operators\n AND/OR/NOT to create a list of one or more\n Expression objects. This allows you to filter on more advanced\n options. For example, you can filter on ((REGION == us-east-1 OR\n REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=\n DataTransfer). The Expression for that looks like\n this:

    \n

    \n { \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"REGION\",\n \"Values\": [ \"us-east-1\", \"us-west-1\" ] }}, {\"Tags\": { \"Key\": \"TagName\",\n \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\",\n \"Values\": [\"DataTransfer\"] }}} ] } \n

    \n \n

    Because each Expression can have only one operator, the\n service returns an error if more than one is specified. The following\n example shows an Expression object that creates an\n error.

    \n     \n

    \n { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\",\n \"Values\": [ \"DataTransfer\" ] } } \n

    \n
    • \n
\n \n

For the GetRightsizingRecommendation action, a combination of OR and NOT is not\n supported. OR is not supported between different dimensions, or dimensions and tags.\n NOT operators aren't supported.\n Dimensions\n are also limited to LINKED_ACCOUNT, REGION, or\n RIGHTSIZING_TYPE.

\n\t\t\t\t\t\n\t\t\t\t\t

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.

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

Use Expression to filter by cost or by usage. There are two patterns:

\n
    \n
  • \n

    Simple dimension values - You can set the dimension name and values for the\n filters that you plan to use. For example, you can filter for\n REGION==us-east-1 OR REGION==us-west-1. For\n GetRightsizingRecommendation, the Region is a full name (for\n example, REGION==US East (N. Virginia). The Expression\n example is as follows:

    \n

    \n { \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", “us-west-1” ]\n } }\n

    \n

    The list of dimension values are OR'd together to retrieve cost or usage data.\n You can create Expression and DimensionValues objects\n using either with* methods or set* methods in multiple\n lines.

    \n
    • \n
  • \n

    Compound dimension values with logical operations - You can use multiple\n Expression types and the logical operators\n AND/OR/NOT to create a list of one or more\n Expression objects. By doing this, you can filter on more\n advanced options. For example, you can filter on ((REGION == us-east-1 OR\n REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=\n DataTransfer). The Expression for that is as\n follows:

    \n

    \n { \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"REGION\", \"Values\": [\n \"us-east-1\", \"us-west-1\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\":\n [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\":\n [\"DataTransfer\"] }}} ] } \n

    \n \n

    Because each Expression can have only one operator, the\n service returns an error if more than one is specified. The following\n example shows an Expression object that creates an\n error.

    \n     \n

    \n { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\",\n \"Values\": [ \"DataTransfer\" ] } } \n

    \n
    • \n
\n \n

For the GetRightsizingRecommendation action, a combination of OR and\n NOT isn't supported. OR isn't supported between different dimensions, or dimensions\n and tags. NOT operators aren't supported. Dimensions are also limited to\n LINKED_ACCOUNT, REGION, or\n RIGHTSIZING_TYPE.

\n

For the GetReservationPurchaseRecommendation action, only NOT is\n supported. AND and OR aren't supported. Dimensions are limited to\n LINKED_ACCOUNT.

\n " } }, "com.amazonaws.costexplorer#Expressions": { @@ -2067,7 +2214,7 @@ } }, "traits": { - "smithy.api#documentation": "

The forecast created for your query.

" + "smithy.api#documentation": "

The forecast that's created for your query.

" } }, "com.amazonaws.costexplorer#ForecastResultsByTime": { @@ -2089,7 +2236,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "[\\S\\s]*" + "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.costexplorer#GetAnomalies": { @@ -2109,7 +2256,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account, during the time period\n specified by the DateInterval object.

" + "smithy.api#documentation": "

Retrieves all of the cost anomalies detected on your account during the time period that's\n specified by the DateInterval object.

" } }, "com.amazonaws.costexplorer#GetAnomaliesRequest": { @@ -2143,13 +2290,13 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#PageSize", "traits": { - "smithy.api#documentation": "

\n The number of entries a paginated response contains.\n

" + "smithy.api#documentation": "

The number of entries a paginated response contains.

" } } } @@ -2160,14 +2307,14 @@ "Anomalies": { "target": "com.amazonaws.costexplorer#Anomalies", "traits": { - "smithy.api#documentation": "

\n A list of cost anomalies.\n

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

A list of cost anomalies.

", "smithy.api#required": {} } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

" } } } @@ -2201,19 +2348,19 @@ "MonitorArnList": { "target": "com.amazonaws.costexplorer#Values", "traits": { - "smithy.api#documentation": "

\n A list of cost anomaly monitor ARNs.\n

" + "smithy.api#documentation": "

A list of cost anomaly monitor ARNs.

" } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#PageSize", "traits": { - "smithy.api#documentation": "

\n The number of entries a paginated response contains.\n

" + "smithy.api#documentation": "

The number of entries that a paginated response contains.

" } } } @@ -2224,14 +2371,14 @@ "AnomalyMonitors": { "target": "com.amazonaws.costexplorer#AnomalyMonitors", "traits": { - "smithy.api#documentation": "

\n A list of cost anomaly monitors that includes the detailed metadata for each monitor.\n

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

A list of cost anomaly monitors that includes the detailed metadata for each monitor.

", "smithy.api#required": {} } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

" } } } @@ -2265,25 +2412,25 @@ "SubscriptionArnList": { "target": "com.amazonaws.costexplorer#Values", "traits": { - "smithy.api#documentation": "

\n A list of cost anomaly subscription ARNs.\n

" + "smithy.api#documentation": "

A list of cost anomaly subscription ARNs.

" } }, "MonitorArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n Cost anomaly monitor ARNs.\n

" + "smithy.api#documentation": "

Cost anomaly monitor ARNs.

" } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#PageSize", "traits": { - "smithy.api#documentation": "

\n The number of entries a paginated response contains.\n

" + "smithy.api#documentation": "

The number of entries a paginated response contains.

" } } } @@ -2294,14 +2441,14 @@ "AnomalySubscriptions": { "target": "com.amazonaws.costexplorer#AnomalySubscriptions", "traits": { - "smithy.api#documentation": "

\n A list of cost anomaly subscriptions that includes the detailed metadata for each one.\n

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

A list of cost anomaly subscriptions that includes the detailed metadata for each one.

", "smithy.api#required": {} } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

\n The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.\n

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

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

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as \n\t\t\tBlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group \n\t\t\tyour data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list \n\t\t\tof valid dimensions, see the \n\t\t\tGetDimensionValues \n\t\t operation. Management account in an organization in AWS Organizations have access to all member accounts.

\n\t

For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.

" + "smithy.api#documentation": "

Retrieves cost and usage metrics for your account. You can specify which cost and\n usage-related metric that you want the request to return. For example, you can specify\n BlendedCosts or UsageQuantity. You can also filter and group your\n data by various dimensions, such as SERVICE or AZ, in a specific\n time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.

\n\t

For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.

" } }, "com.amazonaws.costexplorer#GetCostAndUsageRequest": { @@ -2341,40 +2488,40 @@ "TimePeriod": { "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

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

Sets the start date and end date for retrieving Amazon Web Services costs. The start date\n is inclusive, but the end date is exclusive. For example, if start is\n 2017-01-01 and end is 2017-05-01, then the cost and\n usage data is retrieved from 2017-01-01 up to and including\n 2017-04-30 but not including 2017-05-01.

", "smithy.api#required": {} } }, "Granularity": { "target": "com.amazonaws.costexplorer#Granularity", "traits": { - "smithy.api#documentation": "

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, \n\t the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

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

Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, \n\t the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT \n\t\t\tand get the costs that are associated with that account's usage of that service. You can nest Expression objects \n\t\t\tto define any combination of dimension filters. For more information, see \n\t\t\tExpression.

" + "smithy.api#documentation": "

Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT \n\t\t\tand get the costs that are associated with that account's usage of that service. You can nest Expression objects \n\t\t\tto define any combination of dimension filters. For more information, see \n\t\t\tExpression.

" } }, "Metrics": { "target": "com.amazonaws.costexplorer#MetricNames", "traits": { - "smithy.api#documentation": "

Which metrics are returned in the query. For more information about blended and unblended rates, see \n\t\t\tWhy does the \"blended\" annotation \n\t\t\t\tappear on some line items in my bill?.

\n\t\t

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, \n\t\t\tNetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

\n\t\t \n\t\t\t

If you return the UsageQuantity metric, the service aggregates all usage numbers without \n\t\t\t\ttaking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, \n\t\t\t\tthe results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units \n\t\t\t\t(for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or \n\t\t\t\tUsageTypeGroups.

\n\t\t \n\t\t

\n Metrics is required for GetCostAndUsage requests.

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

Which metrics are returned in the query. For more information about blended and unblended rates, see \n\t\t\tWhy does the \"blended\" annotation \n\t\t\t\tappear on some line items in my bill?.

\n\t\t

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, \n\t\t\tNetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

\n\t\t \n\t\t\t

If you return the UsageQuantity metric, the service aggregates all usage\n numbers without taking into account the units. For example, if you aggregate\n usageQuantity across all of Amazon EC2, the results aren't meaningful because\n Amazon EC2 compute hours and data transfer are measured in different units (for example,\n hours and GB). To get more meaningful UsageQuantity metrics, filter by\n UsageType or UsageTypeGroups.

\n\t\t \n\t\t

\n Metrics is required for GetCostAndUsage requests.

", "smithy.api#required": {} } }, "GroupBy": { "target": "com.amazonaws.costexplorer#GroupDefinitions", "traits": { - "smithy.api#documentation": "

You can group AWS costs using up to two different groups, either dimensions, tag keys,\n cost categories, or any two group by types.

\n\t\t

When you group by tag key, you get all tag values, including empty strings.

\n\t\t

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, \n\t\t\tOPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, \n\t\t TENANCY, RECORD_TYPE, and USAGE_TYPE.

" + "smithy.api#documentation": "

You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys,\n cost categories, or any two group by types.

\n\t

Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, \n\t\t\tOPERATION, PLATFORM, PURCHASE_TYPE, SERVICE,\n\t\t TENANCY, RECORD_TYPE, and USAGE_TYPE.

\n\t

When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

" } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } } @@ -2385,7 +2532,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } }, "GroupDefinitions": { @@ -2397,7 +2544,7 @@ "ResultsByTime": { "target": "com.amazonaws.costexplorer#ResultsByTime", "traits": { - "smithy.api#documentation": "

The time period that is covered by the results in the response.

" + "smithy.api#documentation": "

The time period that's covered by the results in the response.

" } }, "DimensionValueAttributes": { @@ -2434,7 +2581,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves cost and usage metrics with resources for your account. You can specify which cost and\n\t usage-related metric, such as BlendedCosts or UsageQuantity, that\n\t you want the request to return. You can also filter and group your data by various dimensions,\n\t such as SERVICE or AZ, in a specific time range. For a complete list\n\t of valid dimensions, see the GetDimensionValues operation. Management account in an organization in AWS\n\t Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

\n\t \n

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.

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

Retrieves cost and usage metrics with resources for your account. You can specify which cost and\n\t usage-related metric, such as BlendedCosts or UsageQuantity, that\n\t you want the request to return. You can also filter and group your data by various dimensions,\n\t such as SERVICE or AZ, in a specific time range. For a complete list\n\t of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

\n\t \n

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.

\n " } }, "com.amazonaws.costexplorer#GetCostAndUsageWithResourcesRequest": { @@ -2450,7 +2597,7 @@ "Granularity": { "target": "com.amazonaws.costexplorer#Granularity", "traits": { - "smithy.api#documentation": "

Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY. If\n\t Granularity isn't set, the response object doesn't include the\n\t Granularity, MONTHLY, DAILY, or HOURLY.

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

Sets the Amazon Web Services cost granularity to MONTHLY, DAILY, or HOURLY. If\n\t Granularity isn't set, the response object doesn't include the\n\t Granularity, MONTHLY, DAILY, or HOURLY.

", "smithy.api#required": {} } }, @@ -2476,7 +2623,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } } @@ -2487,7 +2634,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } }, "GroupDefinitions": { @@ -2536,7 +2683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of Cost Category names and values incurred cost.

\n\t \n

If some Cost Category names and values are not associated with any cost, they will not be returned by this API.

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

Retrieves an array of Cost Category names and values incurred cost.

\n \n

If some Cost Category names and values are not associated with any cost, they will not be returned by this API.

\n " } }, "com.amazonaws.costexplorer#GetCostCategoriesRequest": { @@ -2545,7 +2692,7 @@ "SearchString": { "target": "com.amazonaws.costexplorer#SearchString", "traits": { - "smithy.api#documentation": "

The value that you want to search the filter values for.

\n\t

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

" + "smithy.api#documentation": "

The value that you want to search the filter values for.

\n

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

" } }, "TimePeriod": { @@ -2563,19 +2710,19 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinitions", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n\t

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When using SortBy, NextPageToken and SearchString are not supported.

" + "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When using SortBy, NextPageToken and SearchString are not supported.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { - "smithy.api#documentation": "

This field is only used when SortBy is provided in the request.

\n\t

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n\t

For GetCostCategories, MaxResults has an upper limit of 1000.

" + "smithy.api#documentation": "

This field is only used when SortBy is provided in the request.

\n

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n

For GetCostCategories, MaxResults has an upper limit of 1000.

" } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

" + "smithy.api#documentation": "

If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

" } } } @@ -2586,7 +2733,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" } }, "CostCategoryNames": { @@ -2598,7 +2745,7 @@ "CostCategoryValues": { "target": "com.amazonaws.costexplorer#CostCategoryValuesList", "traits": { - "smithy.api#documentation": "

The Cost Category values.

\n\t

\n CostCategoryValues are not returned if CostCategoryName is not specified in the request.

" + "smithy.api#documentation": "

The Cost Category values.

\n

\n CostCategoryValues are not returned if CostCategoryName is not specified in the request.

" } }, "ReturnSize": { @@ -2664,7 +2811,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

\n\t\t \n\t
    \n
  • \n

    \n AZ\n

    \n
    • \n
  • \n

    \n INSTANCE_TYPE\n

    \n
    • \n
  • \n

    \n LINKED_ACCOUNT\n

    \n
    • \n
  • \n

    \n LINKED_ACCOUNT_NAME\n

    \n
    • \n
  • \n

    \n OPERATION\n

    \n
    • \n
  • \n

    \n PURCHASE_TYPE\n

    \n
    • \n
  • \n

    \n REGION\n

    \n
    • \n
  • \n

    \n SERVICE\n

    \n
    • \n
  • \n

    \n USAGE_TYPE\n

    \n
    • \n
  • \n

    \n USAGE_TYPE_GROUP\n

    \n
    • \n
  • \n

    \n RECORD_TYPE\n

    \n
    • \n
  • \n

    \n OPERATING_SYSTEM\n

    \n
    • \n
  • \n

    \n TENANCY\n

    \n
    • \n
  • \n

    \n SCOPE\n

    \n
    • \n
  • \n

    \n PLATFORM\n

    \n
    • \n
  • \n

    \n SUBSCRIPTION_ID\n

    \n
    • \n
  • \n

    \n LEGAL_ENTITY_NAME\n

    \n
    • \n
  • \n

    \n DEPLOYMENT_OPTION\n

    \n
    • \n
  • \n

    \n DATABASE_ENGINE\n

    \n
    • \n
  • \n

    \n INSTANCE_TYPE_FAMILY\n

    \n
    • \n
  • \n

    \n BILLING_ENTITY\n

    \n
    • \n
  • \n

    \n RESERVATION_ID\n

    \n
    • \n
  • \n

    \n SAVINGS_PLAN_ARN\n

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

The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

\n\t\t\n\t
    \n
  • \n

    \n AZ\n

    \n
    • \n
  • \n

    \n INSTANCE_TYPE\n

    \n
    • \n
  • \n

    \n LINKED_ACCOUNT\n

    \n
    • \n
  • \n

    \n LINKED_ACCOUNT_NAME\n

    \n
    • \n
  • \n

    \n OPERATION\n

    \n
    • \n
  • \n

    \n PURCHASE_TYPE\n

    \n
    • \n
  • \n

    \n REGION\n

    \n
    • \n
  • \n

    \n SERVICE\n

    \n
    • \n
  • \n

    \n USAGE_TYPE\n

    \n
    • \n
  • \n

    \n USAGE_TYPE_GROUP\n

    \n
    • \n
  • \n

    \n RECORD_TYPE\n

    \n
    • \n
  • \n

    \n OPERATING_SYSTEM\n

    \n
    • \n
  • \n

    \n TENANCY\n

    \n
    • \n
  • \n

    \n SCOPE\n

    \n
    • \n
  • \n

    \n PLATFORM\n

    \n
    • \n
  • \n

    \n SUBSCRIPTION_ID\n

    \n
    • \n
  • \n

    \n LEGAL_ENTITY_NAME\n

    \n
    • \n
  • \n

    \n DEPLOYMENT_OPTION\n

    \n
    • \n
  • \n

    \n DATABASE_ENGINE\n

    \n
    • \n
  • \n

    \n INSTANCE_TYPE_FAMILY\n

    \n
    • \n
  • \n

    \n BILLING_ENTITY\n

    \n
    • \n
  • \n

    \n RESERVATION_ID\n

    \n
    • \n
  • \n

    \n SAVINGS_PLAN_ARN\n

    \n
    • \n
" } }, "PredictionIntervalLevel": { @@ -2733,7 +2880,7 @@ "TimePeriod": { "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

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

The start date and end date for retrieving the dimension values. The start date is\n inclusive, but the end date is exclusive. For example, if start is\n 2017-01-01 and end is 2017-05-01, then the cost and\n usage data is retrieved from 2017-01-01 up to and including\n 2017-04-30 but not including 2017-05-01.

", "smithy.api#required": {} } }, @@ -2747,7 +2894,7 @@ "Context": { "target": "com.amazonaws.costexplorer#Context", "traits": { - "smithy.api#documentation": "

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the AWS ID of the member account.

    \n
    • \n
  • \n

    OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    OPERATION - The action performed. Examples include RunInstance and CreateBucket.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

    \n
    • \n
  • \n

    SERVICE - The AWS service such as Amazon DynamoDB.

    \n
    • \n
  • \n

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

    \n
    • \n
  • \n

    USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

    \n
    • \n
  • \n

    REGION - The AWS Region.

    \n
    • \n
  • \n

    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

    \n
    • \n
  • \n

    RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    \n
    • \n
\n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the AWS ID of the member account.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    REGION - The AWS Region.

    \n
    • \n
  • \n

    SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

    \n
    • \n
  • \n

    TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
\n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n
    \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

    \n
    • \n
  • \n

    PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

    \n
    • \n
  • \n

    REGION - The AWS Region.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the AWS ID of the member account.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

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

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    OPERATION - The action performed. Examples include RunInstance and CreateBucket.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

    \n
    • \n
  • \n

    SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

    \n
    • \n
  • \n

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

    \n
    • \n
  • \n

    USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

    \n
    • \n
  • \n

    RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    \n
    • \n
\n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

    \n
    • \n
  • \n

    TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
\n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n
    \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

    \n
    • \n
  • \n

    PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

    \n
    • \n
" } }, "Filter": { @@ -2756,19 +2903,19 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinitions", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n\t

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

" + "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { - "smithy.api#documentation": "

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n\t

For GetDimensionValues, MaxResults has an upper limit of 1000.

" + "smithy.api#documentation": "

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n

For GetDimensionValues, MaxResults has an upper limit of 1000.

" } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } } @@ -2779,14 +2926,14 @@ "DimensionValues": { "target": "com.amazonaws.costexplorer#DimensionValuesWithAttributesList", "traits": { - "smithy.api#documentation": "

The filters that you used to filter your request. Some dimensions are available only for a specific context.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the AWS ID of the member account.

    \n
    • \n
  • \n

    OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    OPERATION - The action performed. Examples include RunInstance and CreateBucket.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

    \n
    • \n
  • \n

    SERVICE - The AWS service such as Amazon DynamoDB.

    \n
    • \n
  • \n

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

    \n
    • \n
  • \n

    USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

    \n
    • \n
  • \n

    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

    \n
    • \n
  • \n

    RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    \n
    • \n
\n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the AWS ID of the member account.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    REGION - The AWS Region.

    \n
    • \n
  • \n

    SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

    \n
    • \n
  • \n

    TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
\n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n
    \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

    \n
    • \n
  • \n

    PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

    \n
    • \n
  • \n

    REGION - The AWS Region.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the AWS ID of the member account.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

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

The filters that you used to filter your request. Some dimensions are available only for a specific context.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    OPERATION - The action performed. Examples include RunInstance and CreateBucket.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

    \n
    • \n
  • \n

    SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

    \n
    • \n
  • \n

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

    \n
    • \n
  • \n

    USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

    \n
    • \n
  • \n

    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

    \n
    • \n
  • \n

    RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    \n
    • \n
\n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

    \n
    • \n
  • \n

    TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
\n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n
    \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

    \n
    • \n
  • \n

    PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

    \n
    • \n
", "smithy.api#required": {} } }, "ReturnSize": { "target": "com.amazonaws.costexplorer#PageSize", "traits": { - "smithy.api#documentation": "

The number of results that AWS returned at one time.

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

The number of results that Amazon Web Services returned at one time.

", "smithy.api#required": {} } }, @@ -2800,7 +2947,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } } @@ -2847,7 +2994,7 @@ "Granularity": { "target": "com.amazonaws.costexplorer#Granularity", "traits": { - "smithy.api#documentation": "

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

\n\t\t

If GroupBy is set, Granularity can't be set. If Granularity isn't set, \n\t\t\tthe response object doesn't include Granularity, either MONTHLY or DAILY.

\n\t\t

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

" + "smithy.api#documentation": "

The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.

\n\t\t

If GroupBy is set, Granularity can't be set. If Granularity isn't set, \n\t\t\tthe response object doesn't include Granularity, either MONTHLY or DAILY.

\n\t\t

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

" } }, "Filter": { @@ -2865,20 +3012,20 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } }, "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n\t

The following values are supported for Key:

\n
    \n
  • \n

    \n OnDemandCost\n

    \n
    • \n
  • \n

    \n CoverageHoursPercentage\n

    \n
    • \n
  • \n

    \n OnDemandHours\n

    \n
    • \n
  • \n

    \n ReservedHours\n

    \n
    • \n
  • \n

    \n TotalRunningHours\n

    \n
    • \n
  • \n

    \n CoverageNormalizedUnitsPercentage\n

    \n
    • \n
  • \n

    \n OnDemandNormalizedUnits\n

    \n
    • \n
  • \n

    \n ReservedNormalizedUnits\n

    \n
    • \n
  • \n

    \n TotalRunningNormalizedUnits\n

    \n
    • \n
  • \n

    \n Time\n

    \n
    • \n
\n\n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The following values are supported for Key:

\n
    \n
  • \n

    \n OnDemandCost\n

    \n
    • \n
  • \n

    \n CoverageHoursPercentage\n

    \n
    • \n
  • \n

    \n OnDemandHours\n

    \n
    • \n
  • \n

    \n ReservedHours\n

    \n
    • \n
  • \n

    \n TotalRunningHours\n

    \n
    • \n
  • \n

    \n CoverageNormalizedUnitsPercentage\n

    \n
    • \n
  • \n

    \n OnDemandNormalizedUnits\n

    \n
    • \n
  • \n

    \n ReservedNormalizedUnits\n

    \n
    • \n
  • \n

    \n TotalRunningNormalizedUnits\n

    \n
    • \n
  • \n

    \n Time\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

" } } }, @@ -2905,7 +3052,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

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

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. \n\t\t\tReservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

\n\t\t

AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage \n\t\t\tinto categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations \n\t\t\tin each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

\n\t\t

For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region \n\t\t\tand recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance \n\t\t\tin an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units \n\t\t\tso that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large \n\t\t\tbecause that is the smallest size instance in the c4 instance family.

" + "smithy.api#documentation": "

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. \n\t\t\tReservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

\n\t\t

Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage \n\t\t\tinto categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations \n\t\t\tin each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

\n\t\t

For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region \n\t\t\tand recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance \n\t\t\tin an instance family. This makes it easier to purchase a size-flexible RI. Amazon Web Services also shows the equal number of normalized units \n\t\t\tso that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large \n\t\t\tbecause that is the smallest size instance in the c4 instance family.

" } }, "com.amazonaws.costexplorer#GetReservationPurchaseRecommendationRequest": { @@ -2961,7 +3108,7 @@ "LookbackPeriodInDays": { "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

The number of previous days that you want AWS to consider when it calculates your recommendations.

" + "smithy.api#documentation": "

The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.

" } }, "TermInYears": { @@ -3073,20 +3220,20 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n\t \n\t

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n UtilizationPercentageInUnits\n

    \n
    • \n
  • \n

    \n PurchasedHours\n

    \n
    • \n
  • \n

    \n PurchasedUnits\n

    \n
    • \n
  • \n

    \n TotalActualHours\n

    \n
    • \n
  • \n

    \n TotalActualUnits\n

    \n
    • \n
  • \n

    \n UnusedHours\n

    \n
    • \n
  • \n

    \n UnusedUnits\n

    \n
    • \n
  • \n

    \n OnDemandCostOfRIHoursUsed\n

    \n
    • \n
  • \n

    \n NetRISavings\n

    \n
    • \n
  • \n

    \n TotalPotentialRISavings\n

    \n
    • \n
  • \n

    \n AmortizedUpfrontFee\n

    \n
    • \n
  • \n

    \n AmortizedRecurringFee\n

    \n
    • \n
  • \n

    \n TotalAmortizedFee\n

    \n
    • \n
  • \n

    \n RICostForUnusedHours\n

    \n
    • \n
  • \n

    \n RealizedSavings\n

    \n
    • \n
  • \n

    \n UnrealizedSavings\n

    \n
    • \n
\n\n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value by which you want to sort the data.

\n \n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n UtilizationPercentageInUnits\n

    \n
    • \n
  • \n

    \n PurchasedHours\n

    \n
    • \n
  • \n

    \n PurchasedUnits\n

    \n
    • \n
  • \n

    \n TotalActualHours\n

    \n
    • \n
  • \n

    \n TotalActualUnits\n

    \n
    • \n
  • \n

    \n UnusedHours\n

    \n
    • \n
  • \n

    \n UnusedUnits\n

    \n
    • \n
  • \n

    \n OnDemandCostOfRIHoursUsed\n

    \n
    • \n
  • \n

    \n NetRISavings\n

    \n
    • \n
  • \n

    \n TotalPotentialRISavings\n

    \n
    • \n
  • \n

    \n AmortizedUpfrontFee\n

    \n
    • \n
  • \n

    \n AmortizedRecurringFee\n

    \n
    • \n
  • \n

    \n TotalAmortizedFee\n

    \n
    • \n
  • \n

    \n RICostForUnusedHours\n

    \n
    • \n
  • \n

    \n RealizedSavings\n

    \n
    • \n
  • \n

    \n UnrealizedSavings\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

" } } } @@ -3110,7 +3257,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

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

Creates recommendations that\n help you save cost\n by identifying idle and underutilized Amazon EC2 instances.

\n

Recommendations are generated to either downsize or terminate instances, along with\n providing savings detail and metrics. For details on calculation and function, see\n Optimizing\n Your Cost with Rightsizing\n Recommendations\n in the AWS Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

Creates recommendations that\n help you save cost\n by identifying idle and underutilized Amazon EC2 instances.

\n

Recommendations are generated to either downsize or terminate instances, along with\n providing savings detail and metrics. For details on calculation and function, see\n Optimizing\n Your Cost with Rightsizing\n Recommendations\n in the Billing and Cost Management User\n Guide.

" } }, "com.amazonaws.costexplorer#GetRightsizingRecommendationRequest": { @@ -3281,7 +3428,7 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n\t \t

The following values are supported for Key:

\n
    \n
  • \n

    \n SpendCoveredBySavingsPlan\n

    \n
    • \n
  • \n

    \n OnDemandCost\n

    \n
    • \n
  • \n

    \n CoveragePercentage\n

    \n
    • \n
  • \n

    \n TotalCost\n

    \n
    • \n
  • \n

    \n InstanceFamily\n

    \n
    • \n
  • \n

    \n Region\n

    \n
    • \n
  • \n

    \n Service\n

    \n
    • \n
\n\n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The following values are supported for Key:

\n
    \n
  • \n

    \n SpendCoveredBySavingsPlan\n

    \n
    • \n
  • \n

    \n OnDemandCost\n

    \n
    • \n
  • \n

    \n CoveragePercentage\n

    \n
    • \n
  • \n

    \n TotalCost\n

    \n
    • \n
  • \n

    \n InstanceFamily\n

    \n
    • \n
  • \n

    \n Region\n

    \n
    • \n
  • \n

    \n Service\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" } } } @@ -3399,7 +3546,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } } @@ -3490,7 +3637,7 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n\t \n\t

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n TotalCommitment\n

    \n
    • \n
  • \n

    \n UsedCommitment\n

    \n
    • \n
  • \n

    \n UnusedCommitment\n

    \n
    • \n
  • \n

    \n NetSavings\n

    \n
    • \n
  • \n

    \n AmortizedRecurringCommitment\n

    \n
    • \n
  • \n

    \n AmortizedUpfrontCommitment\n

    \n
    • \n
\n\n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value by which you want to sort the data.

\n \n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n TotalCommitment\n

    \n
    • \n
  • \n

    \n UsedCommitment\n

    \n
    • \n
  • \n

    \n UnusedCommitment\n

    \n
    • \n
  • \n

    \n NetSavings\n

    \n
    • \n
  • \n

    \n AmortizedRecurringCommitment\n

    \n
    • \n
  • \n

    \n AmortizedUpfrontCommitment\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" } } } @@ -3550,7 +3697,7 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n\t

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n TotalCommitment\n

    \n
    • \n
  • \n

    \n UsedCommitment\n

    \n
    • \n
  • \n

    \n UnusedCommitment\n

    \n
    • \n
  • \n

    \n NetSavings\n

    \n
    • \n
\n\n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n TotalCommitment\n

    \n
    • \n
  • \n

    \n UsedCommitment\n

    \n
    • \n
  • \n

    \n UnusedCommitment\n

    \n
    • \n
  • \n

    \n NetSavings\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" } } } @@ -3630,19 +3777,19 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinitions", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n\t

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When using SortBy, NextPageToken and SearchString are not supported.

" + "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When using SortBy, NextPageToken and SearchString are not supported.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { - "smithy.api#documentation": "

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n\t

For GetTags, MaxResults has an upper limit of 1000.

" + "smithy.api#documentation": "

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n

For GetTags, MaxResults has an upper limit of 1000.

" } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } } } @@ -3653,7 +3800,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" } }, "Tags": { @@ -3666,7 +3813,7 @@ "ReturnSize": { "target": "com.amazonaws.costexplorer#PageSize", "traits": { - "smithy.api#documentation": "

The number of query results that AWS returns at a time.

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

The number of query results that Amazon Web Services returns at a time.

", "smithy.api#required": {} } }, @@ -3729,7 +3876,7 @@ "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:

\n\t\t \n\t
    \n
  • \n

    \n AZ\n

    \n
    • \n
  • \n

    \n INSTANCE_TYPE\n

    \n
    • \n
  • \n

    \n LINKED_ACCOUNT\n

    \n
    • \n
  • \n

    \n LINKED_ACCOUNT_NAME\n

    \n
    • \n
  • \n

    \n OPERATION\n

    \n
    • \n
  • \n

    \n PURCHASE_TYPE\n

    \n
    • \n
  • \n

    \n REGION\n

    \n
    • \n
  • \n

    \n SERVICE\n

    \n
    • \n
  • \n

    \n USAGE_TYPE\n

    \n
    • \n
  • \n

    \n USAGE_TYPE_GROUP\n

    \n
    • \n
  • \n

    \n RECORD_TYPE\n

    \n
    • \n
  • \n

    \n OPERATING_SYSTEM\n

    \n
    • \n
  • \n

    \n TENANCY\n

    \n
    • \n
  • \n

    \n SCOPE\n

    \n
    • \n
  • \n

    \n PLATFORM\n

    \n
    • \n
  • \n

    \n SUBSCRIPTION_ID\n

    \n
    • \n
  • \n

    \n LEGAL_ENTITY_NAME\n

    \n
    • \n
  • \n

    \n DEPLOYMENT_OPTION\n

    \n
    • \n
  • \n

    \n DATABASE_ENGINE\n

    \n
    • \n
  • \n

    \n INSTANCE_TYPE_FAMILY\n

    \n
    • \n
  • \n

    \n BILLING_ENTITY\n

    \n
    • \n
  • \n

    \n RESERVATION_ID\n

    \n
    • \n
  • \n

    \n SAVINGS_PLAN_ARN\n

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

The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:

\n\t\t\n\t
    \n
  • \n

    \n AZ\n

    \n
    • \n
  • \n

    \n INSTANCE_TYPE\n

    \n
    • \n
  • \n

    \n LINKED_ACCOUNT\n

    \n
    • \n
  • \n

    \n LINKED_ACCOUNT_NAME\n

    \n
    • \n
  • \n

    \n OPERATION\n

    \n
    • \n
  • \n

    \n PURCHASE_TYPE\n

    \n
    • \n
  • \n

    \n REGION\n

    \n
    • \n
  • \n

    \n SERVICE\n

    \n
    • \n
  • \n

    \n USAGE_TYPE\n

    \n
    • \n
  • \n

    \n USAGE_TYPE_GROUP\n

    \n
    • \n
  • \n

    \n RECORD_TYPE\n

    \n
    • \n
  • \n

    \n OPERATING_SYSTEM\n

    \n
    • \n
  • \n

    \n TENANCY\n

    \n
    • \n
  • \n

    \n SCOPE\n

    \n
    • \n
  • \n

    \n PLATFORM\n

    \n
    • \n
  • \n

    \n SUBSCRIPTION_ID\n

    \n
    • \n
  • \n

    \n LEGAL_ENTITY_NAME\n

    \n
    • \n
  • \n

    \n DEPLOYMENT_OPTION\n

    \n
    • \n
  • \n

    \n DATABASE_ENGINE\n

    \n
    • \n
  • \n

    \n INSTANCE_TYPE_FAMILY\n

    \n
    • \n
  • \n

    \n BILLING_ENTITY\n

    \n
    • \n
  • \n

    \n RESERVATION_ID\n

    \n
    • \n
  • \n

    \n SAVINGS_PLAN_ARN\n

    \n
    • \n
" } }, "PredictionIntervalLevel": { @@ -3813,7 +3960,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a group when you specify a group by criteria or in the response to a\n query with a specific grouping.

" + "smithy.api#documentation": "

Represents a group when you specify a group by criteria or in the response to a query\n with a specific grouping.

" } }, "com.amazonaws.costexplorer#GroupDefinitionKey": { @@ -3823,7 +3970,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "[\\S\\s]*" + "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.costexplorer#GroupDefinitionType": { @@ -3863,19 +4010,19 @@ "MaxImpact": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { - "smithy.api#documentation": "

\n The maximum dollar value observed for an anomaly.\n

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

The maximum dollar value that's observed for an anomaly.

", "smithy.api#required": {} } }, "TotalImpact": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { - "smithy.api#documentation": "

\n The cumulative dollar value observed for an anomaly.\n

" + "smithy.api#documentation": "

The cumulative dollar value that's observed for an anomaly.

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

\n The anomaly's dollar value.\n

" + "smithy.api#documentation": "

The dollar value of the anomaly.

" } }, "com.amazonaws.costexplorer#InstanceDetails": { @@ -3884,36 +4031,36 @@ "EC2InstanceDetails": { "target": "com.amazonaws.costexplorer#EC2InstanceDetails", "traits": { - "smithy.api#documentation": "

The Amazon EC2 instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

The Amazon EC2 instances that Amazon Web Services recommends that you purchase.

" } }, "RDSInstanceDetails": { "target": "com.amazonaws.costexplorer#RDSInstanceDetails", "traits": { - "smithy.api#documentation": "

The Amazon RDS instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

The Amazon RDS instances that Amazon Web Services recommends that you purchase.

" } }, "RedshiftInstanceDetails": { "target": "com.amazonaws.costexplorer#RedshiftInstanceDetails", "traits": { - "smithy.api#documentation": "

The Amazon Redshift instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

The Amazon Redshift instances that Amazon Web Services recommends that you\n purchase.

" } }, "ElastiCacheInstanceDetails": { "target": "com.amazonaws.costexplorer#ElastiCacheInstanceDetails", "traits": { - "smithy.api#documentation": "

The ElastiCache instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

The ElastiCache instances that Amazon Web Services recommends that you purchase.

" } }, "ESInstanceDetails": { "target": "com.amazonaws.costexplorer#ESInstanceDetails", "traits": { - "smithy.api#documentation": "

The Amazon ES instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

The Amazon ES instances that Amazon Web Services recommends that you purchase.

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

Details about the instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

Details about the instances that Amazon Web Services recommends that you\n purchase.

" } }, "com.amazonaws.costexplorer#InvalidNextTokenException": { @@ -4125,7 +4272,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "[\\S\\s]*" + "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.costexplorer#MetricNames": { @@ -4172,7 +4319,7 @@ "TargetInstances": { "target": "com.amazonaws.costexplorer#TargetInstancesList", "traits": { - "smithy.api#documentation": "

Identifies whether this instance type is the AWS default recommendation.

" + "smithy.api#documentation": "

Determines whether this instance type is the Amazon Web Services default\n recommendation.

" } } }, @@ -4221,30 +4368,30 @@ "NetworkInBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The network ingress throughput utilization measured in Bytes per second.\n

" + "smithy.api#documentation": "

The network inbound throughput utilization measured in Bytes per second.

" } }, "NetworkOutBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The network outgress throughput utilization measured in Bytes per second.\n

" + "smithy.api#documentation": "

The network outbound throughput utilization measured in Bytes per second.

" } }, "NetworkPacketsInPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The network ingress packets measured in packets per second.\n

" + "smithy.api#documentation": "

The network ingress packets that are measured in packets per second.

" } }, "NetworkPacketsOutPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The network outgress packets measured in packets per second.\n

" + "smithy.api#documentation": "

The network outgress packets that are measured in packets per second.

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

\n The network field that contains a list of network metrics associated with the current instance.\n

" + "smithy.api#documentation": "

The network field that contains a list of network metrics that are associated with\n the current instance.

" } }, "com.amazonaws.costexplorer#NextPageToken": { @@ -4254,7 +4401,7 @@ "min": 0, "max": 8192 }, - "smithy.api#pattern": "[\\S\\s]*" + "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.costexplorer#NonNegativeInteger": { @@ -4435,7 +4582,7 @@ "AnomalyId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n A cost anomaly ID.\n

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

A cost anomaly ID.

", "smithy.api#required": {} } }, @@ -4454,7 +4601,7 @@ "AnomalyId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The ID of the modified cost anomaly.\n

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

The ID of the modified cost anomaly.

", "smithy.api#required": {} } } @@ -4478,13 +4625,13 @@ "InstanceType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The type of instance that AWS recommends.

" + "smithy.api#documentation": "

The type of instance that Amazon Web Services recommends.

" } }, "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the recommended reservation.

" } }, "DatabaseEngine": { @@ -4502,7 +4649,7 @@ "DeploymentOption": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a reservation in a single Availability Zone or a\n reservation with a backup in a second Availability Zone.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a reservation in a single Availability\n Zone or a reservation with a backup in a second Availability Zone.

" } }, "LicenseModel": { @@ -4514,18 +4661,18 @@ "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current-generation instance.

" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + "smithy.api#documentation": "

Determines whether the recommended reservation is size flexible.

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

Details about the Amazon RDS instances that AWS recommends that you\n purchase.

" + "smithy.api#documentation": "

Details about the Amazon RDS instances that Amazon Web Services recommends that you\n purchase.

" } }, "com.amazonaws.costexplorer#RICostForUnusedHours": { @@ -4561,30 +4708,30 @@ "NodeType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The type of node that AWS recommends.

" + "smithy.api#documentation": "

The type of node that Amazon Web Services recommends.

" } }, "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The AWS Region of the recommended reservation.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the recommended reservation.

" } }, "CurrentGeneration": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommendation is for a current-generation instance.

" + "smithy.api#documentation": "

Determines whether the recommendation is for a current-generation instance.

" } }, "SizeFlexEligible": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Whether the recommended reservation is size flexible.

" + "smithy.api#documentation": "

Determines whether the recommended reservation is size flexible.

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

Details about the Amazon Redshift instances that AWS recommends that you\n purchase.

" + "smithy.api#documentation": "

Details about the Amazon Redshift instances that Amazon Web Services recommends that\n you purchase.

" } }, "com.amazonaws.costexplorer#RequestChangedException": { @@ -4611,7 +4758,7 @@ "UtilizationPercentageInUnits": { "target": "com.amazonaws.costexplorer#UtilizationPercentageInUnits", "traits": { - "smithy.api#documentation": "

The percentage of Amazon EC2 reservation time that you used, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" + "smithy.api#documentation": "

The percentage of Amazon EC2 reservation time that you used. It's converted to\n normalized units. Normalized units are available only for Amazon EC2 usage after\n November 11, 2017.

" } }, "PurchasedHours": { @@ -4623,7 +4770,7 @@ "PurchasedUnits": { "target": "com.amazonaws.costexplorer#PurchasedUnits", "traits": { - "smithy.api#documentation": "

How many Amazon EC2 reservation hours that you purchased, converted to normalized units.\n Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" + "smithy.api#documentation": "

The number of Amazon EC2 reservation hours that you purchased. It's converted to\n normalized units. Normalized units are available only for Amazon EC2 usage after\n November 11, 2017.

" } }, "TotalActualHours": { @@ -4635,7 +4782,7 @@ "TotalActualUnits": { "target": "com.amazonaws.costexplorer#TotalActualUnits", "traits": { - "smithy.api#documentation": "

The total number of Amazon EC2 reservation hours that you used, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" + "smithy.api#documentation": "

The total number of Amazon EC2 reservation hours that you used. It's converted to\n normalized units. Normalized units are available only for Amazon EC2 usage after\n November 11, 2017.

" } }, "UnusedHours": { @@ -4647,43 +4794,43 @@ "UnusedUnits": { "target": "com.amazonaws.costexplorer#UnusedUnits", "traits": { - "smithy.api#documentation": "

The number of Amazon EC2 reservation hours that you didn't use, converted to normalized\n units. Normalized units are available only for Amazon EC2 usage after November 11,\n 2017.

" + "smithy.api#documentation": "

The number of Amazon EC2 reservation hours that you didn't use. It's converted to\n normalized units. Normalized units are available only for Amazon EC2 usage after\n November 11, 2017.

" } }, "OnDemandCostOfRIHoursUsed": { "target": "com.amazonaws.costexplorer#OnDemandCostOfRIHoursUsed", "traits": { - "smithy.api#documentation": "

How much your reservation would cost if charged On-Demand rates.

" + "smithy.api#documentation": "

How much your reservation costs if charged On-Demand rates.

" } }, "NetRISavings": { "target": "com.amazonaws.costexplorer#NetRISavings", "traits": { - "smithy.api#documentation": "

How much you saved due to purchasing and utilizing reservation. AWS calculates this\n by subtracting TotalAmortizedFee from\n OnDemandCostOfRIHoursUsed.

" + "smithy.api#documentation": "

How much you saved due to purchasing and utilizing reservation. Amazon Web Services\n calculates this by subtracting TotalAmortizedFee from\n OnDemandCostOfRIHoursUsed.

" } }, "TotalPotentialRISavings": { "target": "com.amazonaws.costexplorer#TotalPotentialRISavings", "traits": { - "smithy.api#documentation": "

How much you could save if you use your entire reservation.

" + "smithy.api#documentation": "

How much you might save if you use your entire reservation.

" } }, "AmortizedUpfrontFee": { "target": "com.amazonaws.costexplorer#AmortizedUpfrontFee", "traits": { - "smithy.api#documentation": "

The upfront cost of your reservation, amortized over the reservation\n period.

" + "smithy.api#documentation": "

The upfront cost of your reservation. It's amortized over the reservation\n period.

" } }, "AmortizedRecurringFee": { "target": "com.amazonaws.costexplorer#AmortizedRecurringFee", "traits": { - "smithy.api#documentation": "

The monthly cost of your reservation, amortized over the reservation\n period.

" + "smithy.api#documentation": "

The monthly cost of your reservation. It's amortized over the reservation\n period.

" } }, "TotalAmortizedFee": { "target": "com.amazonaws.costexplorer#TotalAmortizedFee", "traits": { - "smithy.api#documentation": "

The total cost of your reservation, amortized over the reservation\n period.

" + "smithy.api#documentation": "

The total cost of your reservation. It's amortized over the reservation period.

" } }, "RICostForUnusedHours": { @@ -4695,13 +4842,13 @@ "RealizedSavings": { "target": "com.amazonaws.costexplorer#RealizedSavings", "traits": { - "smithy.api#documentation": "

The realized savings due to purchasing and using a reservation.

" + "smithy.api#documentation": "

The realized savings because of purchasing and using a reservation.

" } }, "UnrealizedSavings": { "target": "com.amazonaws.costexplorer#UnrealizedSavings", "traits": { - "smithy.api#documentation": "

The unrealized savings due to purchasing and using a reservation.

" + "smithy.api#documentation": "

The unrealized savings because of purchasing and using a reservation.

" } } }, @@ -4726,7 +4873,7 @@ } }, "traits": { - "smithy.api#documentation": "

A\n group of reservations that share a set of attributes.

" + "smithy.api#documentation": "

A group of reservations that share a set of attributes.

" } }, "com.amazonaws.costexplorer#ReservationCoverageGroups": { @@ -4747,13 +4894,13 @@ "AccountScope": { "target": "com.amazonaws.costexplorer#AccountScope", "traits": { - "smithy.api#documentation": "

The account scope that AWS recommends that you purchase this instance for. For\n example, you can purchase this reservation for an entire organization in AWS\n Organizations.

" + "smithy.api#documentation": "

The account scope that Amazon Web Services recommends that you purchase this instance\n for. For example, you can purchase this reservation for an entire organization in\n Amazon Web Services Organizations.

" } }, "LookbackPeriodInDays": { "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

How many days of previous usage that AWS considers when making this\n recommendation.

" + "smithy.api#documentation": "

How many days of previous usage that Amazon Web Services considers when making this\n recommendation.

" } }, "TermInYears": { @@ -4765,13 +4912,13 @@ "PaymentOption": { "target": "com.amazonaws.costexplorer#PaymentOption", "traits": { - "smithy.api#documentation": "

The payment option for the reservation. For example, AllUpfront or\n NoUpfront.

" + "smithy.api#documentation": "

The payment option for the reservation (for example, AllUpfront or\n NoUpfront).

" } }, "ServiceSpecification": { "target": "com.amazonaws.costexplorer#ServiceSpecification", "traits": { - "smithy.api#documentation": "

Hardware specifications for the service that you want recommendations\n for.

" + "smithy.api#documentation": "

Hardware specifications for the service that you want recommendations for.

" } }, "RecommendationDetails": { @@ -4788,7 +4935,7 @@ } }, "traits": { - "smithy.api#documentation": "

A specific reservation that AWS recommends for purchase.

" + "smithy.api#documentation": "

A specific reservation that Amazon Web Services recommends for purchase.

" } }, "com.amazonaws.costexplorer#ReservationPurchaseRecommendationDetail": { @@ -4803,97 +4950,97 @@ "InstanceDetails": { "target": "com.amazonaws.costexplorer#InstanceDetails", "traits": { - "smithy.api#documentation": "

Details about the instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

Details about the instances that Amazon Web Services recommends that you\n purchase.

" } }, "RecommendedNumberOfInstancesToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The number of instances that AWS recommends that you purchase.

" + "smithy.api#documentation": "

The number of instances that Amazon Web Services recommends that you purchase.

" } }, "RecommendedNormalizedUnitsToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The number of normalized units that AWS recommends that you purchase.

" + "smithy.api#documentation": "

The number of normalized units that Amazon Web Services recommends that you\n purchase.

" } }, "MinimumNumberOfInstancesUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The minimum number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" + "smithy.api#documentation": "

The minimum number of instances that you used in an hour during the historical period.\n Amazon Web Services uses this to calculate your recommended reservation\n purchases.

" } }, "MinimumNormalizedUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The minimum number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" + "smithy.api#documentation": "

The minimum number of normalized units that you used in an hour during the historical\n period. Amazon Web Services uses this to calculate your recommended reservation\n purchases.

" } }, "MaximumNumberOfInstancesUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" + "smithy.api#documentation": "

The maximum number of instances that you used in an hour during the historical period.\n Amazon Web Services uses this to calculate your recommended reservation\n purchases.

" } }, "MaximumNormalizedUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" + "smithy.api#documentation": "

The maximum number of normalized units that you used in an hour during the historical\n period. Amazon Web Services uses this to calculate your recommended reservation\n purchases.

" } }, "AverageNumberOfInstancesUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average number of instances that you used in an hour during the historical\n period. AWS uses this to calculate your recommended reservation purchases.

" + "smithy.api#documentation": "

The average number of instances that you used in an hour during the historical period.\n Amazon Web Services uses this to calculate your recommended reservation\n purchases.

" } }, "AverageNormalizedUnitsUsedPerHour": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average number of normalized units that you used in an hour during the\n historical period. AWS uses this to calculate your recommended reservation\n purchases.

" + "smithy.api#documentation": "

The average number of normalized units that you used in an hour during the historical\n period. Amazon Web Services uses this to calculate your recommended reservation\n purchases.

" } }, "AverageUtilization": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average utilization of your instances. AWS uses this to calculate your\n recommended reservation purchases.

" + "smithy.api#documentation": "

The average utilization of your instances. Amazon Web Services uses this to calculate\n your recommended reservation purchases.

" } }, "EstimatedBreakEvenInMonths": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How long AWS estimates that it takes for this instance to start saving you money,\n in months.

" + "smithy.api#documentation": "

How long Amazon Web Services estimates that it takes for this instance to start saving\n you money, in months.

" } }, "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this\n instance.

" } }, "EstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much AWS estimates that this specific recommendation could save you in a\n month.

" + "smithy.api#documentation": "

How much Amazon Web Services estimates that this specific recommendation could save you\n in a month.

" } }, "EstimatedMonthlySavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much AWS estimates that this specific recommendation could save you in a month,\n as a percentage of your overall costs.

" + "smithy.api#documentation": "

How much Amazon Web Services estimates that this specific recommendation could save you\n in a month, as a percentage of your overall costs.

" } }, "EstimatedMonthlyOnDemandCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much AWS estimates that you spend on On-Demand Instances in a month.

" + "smithy.api#documentation": "

How much Amazon Web Services estimates that you spend on On-Demand Instances in a\n month.

" } }, "EstimatedReservationCostForLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much AWS estimates that you would have spent for all usage during the specified\n historical period if you had\n a\n reservation.

" + "smithy.api#documentation": "

How much Amazon Web Services estimates that you would have spent for all usage during\n the specified historical period if you had a reservation.

" } }, "UpfrontCost": { @@ -4931,12 +5078,12 @@ "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The timestamp for when AWS made this recommendation.

" + "smithy.api#documentation": "

The timestamp for when Amazon Web Services made this recommendation.

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

Information about this specific recommendation, such as the timestamp for when AWS\n made a specific recommendation.

" + "smithy.api#documentation": "

Information about this specific recommendation, such as the timestamp for when Amazon Web Services made a specific recommendation.

" } }, "com.amazonaws.costexplorer#ReservationPurchaseRecommendationSummary": { @@ -4945,13 +5092,13 @@ "TotalEstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total amount that AWS estimates that this recommendation could save you in a\n month.

" + "smithy.api#documentation": "

The total amount that Amazon Web Services estimates that this recommendation could save\n you in a month.

" } }, "TotalEstimatedMonthlySavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total amount that AWS estimates that this recommendation could save you in a\n month, as a percentage of your costs.

" + "smithy.api#documentation": "

The total amount that Amazon Web Services estimates that this recommendation could save\n you in a month, as a percentage of your costs.

" } }, "CurrencyCode": { @@ -4962,7 +5109,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary about this recommendation, such as the currency code, the amount that AWS\n estimates that you could save, and the total amount of reservation to\n purchase.

" + "smithy.api#documentation": "

A summary about this recommendation, such as the currency code, the amount that\n Amazon Web Services estimates that you could save, and the total amount of\n reservation to purchase.

" } }, "com.amazonaws.costexplorer#ReservationPurchaseRecommendations": { @@ -5048,12 +5195,12 @@ "EC2ResourceUtilization": { "target": "com.amazonaws.costexplorer#EC2ResourceUtilization", "traits": { - "smithy.api#documentation": "

Utilization of current Amazon EC2 instance.

" + "smithy.api#documentation": "

The utilization of current Amazon EC2 instance.

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

Resource utilization of current resource.

" + "smithy.api#documentation": "

Resource utilization of current resource.

" } }, "com.amazonaws.costexplorer#ResultByTime": { @@ -5080,12 +5227,12 @@ "Estimated": { "target": "com.amazonaws.costexplorer#Estimated", "traits": { - "smithy.api#documentation": "

Whether\n the result is estimated.

" + "smithy.api#documentation": "

Determines whether the result is estimated.

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

The result that is associated with a time period.

" + "smithy.api#documentation": "

The result that's associated with a time period.

" } }, "com.amazonaws.costexplorer#ResultsByTime": { @@ -5106,31 +5253,31 @@ "CurrentInstance": { "target": "com.amazonaws.costexplorer#CurrentInstance", "traits": { - "smithy.api#documentation": "

Context regarding the current instance.

" + "smithy.api#documentation": "

Context regarding the current instance.

" } }, "RightsizingType": { "target": "com.amazonaws.costexplorer#RightsizingType", "traits": { - "smithy.api#documentation": "

Recommendation to either terminate or modify the resource.

" + "smithy.api#documentation": "

A recommendation to either terminate or modify the resource.

" } }, "ModifyRecommendationDetail": { "target": "com.amazonaws.costexplorer#ModifyRecommendationDetail", "traits": { - "smithy.api#documentation": "

Details for modification recommendations.

" + "smithy.api#documentation": "

The details for the modification recommendations.

" } }, "TerminateRecommendationDetail": { "target": "com.amazonaws.costexplorer#TerminateRecommendationDetail", "traits": { - "smithy.api#documentation": "

Details for termination recommendations.

" + "smithy.api#documentation": "

The details for termination recommendations.

" } }, "FindingReasonCodes": { "target": "com.amazonaws.costexplorer#FindingReasonCodes", "traits": { - "smithy.api#documentation": "

\n The list of possible reasons why the recommendation is generated such as under or over utilization of specific metrics (for example, CPU, Memory, Network).\n

" + "smithy.api#documentation": "

The list of possible reasons why the recommendation is generated such as under or\n over utilization of specific metrics (for example, CPU, Memory, Network).

" } } }, @@ -5144,20 +5291,20 @@ "RecommendationTarget": { "target": "com.amazonaws.costexplorer#RecommendationTarget", "traits": { - "smithy.api#documentation": "

\n The option to see recommendations within the same instance family, or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY.\n

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

The option to see recommendations within the same instance family or recommendations\n for instances across other families. The default value is\n SAME_INSTANCE_FAMILY.

", "smithy.api#required": {} } }, "BenefitsConsidered": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

\n The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE.\n

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

The option to consider RI or Savings Plans discount benefits in your savings\n calculation. The default value is TRUE.

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

Enables you to customize recommendations across two attributes. You can choose to view\n recommendations for instances within the same instance families or across different instance\n families. You can also choose to view your estimated savings associated with recommendations\n with consideration of existing Savings Plans or RI benefits, or\n neither.

" + "smithy.api#documentation": "

You can use RightsizingRecommendationConfiguration to customize\n recommendations across two attributes. You can choose to view recommendations for\n instances within the same instance families or across different instance families. You\n can also choose to view your estimated savings that are associated with recommendations\n with consideration of existing Savings Plans or RI benefits, or neither.

" } }, "com.amazonaws.costexplorer#RightsizingRecommendationList": { @@ -5172,25 +5319,25 @@ "RecommendationId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The ID for this specific recommendation.

" + "smithy.api#documentation": "

The ID for this specific recommendation.

" } }, "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The timestamp for when AWS made this recommendation.

" + "smithy.api#documentation": "

The timestamp for when Amazon Web Services made this recommendation.

" } }, "LookbackPeriodInDays": { "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

How many days of previous usage that AWS considers when making this\n recommendation.

" + "smithy.api#documentation": "

The number of days of previous usage that Amazon Web Services considers when making\n this recommendation.

" } }, "AdditionalMetadata": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Additional metadata that may be applicable to the recommendation.

" + "smithy.api#documentation": "

Additional metadata that might be applicable to the recommendation.

" } } }, @@ -5204,30 +5351,30 @@ "TotalRecommendationCount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Total number of instance recommendations.

" + "smithy.api#documentation": "

The total number of instance recommendations.

" } }, "EstimatedTotalMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Estimated total savings resulting from modifications, on a monthly basis.

" + "smithy.api#documentation": "

The estimated total savings resulting from modifications, on a monthly basis.

" } }, "SavingsCurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that AWS used to calculate the savings.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the savings.

" } }, "SavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Savings percentage based on the recommended modifications, relative to the total\n On-Demand\n costs associated with these instances.

" + "smithy.api#documentation": "

The savings percentage based on the recommended modifications. It's relative to the\n total On-Demand costs that are associated with these instances.

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

Summary of rightsizing recommendations

" + "smithy.api#documentation": "

The summary of rightsizing recommendations

" } }, "com.amazonaws.costexplorer#RightsizingType": { @@ -5251,30 +5398,30 @@ "Service": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The AWS service name associated with the cost anomaly.\n

" + "smithy.api#documentation": "

The Amazon Web Services service name that's associated with the cost anomaly.

" } }, "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The AWS Region associated with the cost anomaly.\n

" + "smithy.api#documentation": "

The Amazon Web Services Region that's associated with the cost anomaly.

" } }, "LinkedAccount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The linked account value associated with the cost anomaly.\n

" + "smithy.api#documentation": "

The member account value that's associated with the cost anomaly.

" } }, "UsageType": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The UsageType value associated with the cost anomaly.\n

" + "smithy.api#documentation": "

The UsageType value that's associated with the cost anomaly.

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

\n The combination of AWS service, linked account, Region, and usage type where a cost anomaly is observed.\n

" + "smithy.api#documentation": "

The combination of Amazon Web Services service, linked account, Region, and usage type\n where a cost anomaly is observed.

" } }, "com.amazonaws.costexplorer#RootCauses": { @@ -5292,24 +5439,24 @@ "AmortizedRecurringCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront.

" + "smithy.api#documentation": "

The amortized amount of your Savings Plans commitment that was purchased with either a\n Partial or a NoUpfront.

" } }, "AmortizedUpfrontCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.

" + "smithy.api#documentation": "

The amortized amount of your Savings Plans commitment that was purchased with an\n Upfront or PartialUpfront Savings Plans.

" } }, "TotalAmortizedCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.

" + "smithy.api#documentation": "

The total amortized amount of your Savings Plans commitment, regardless of your\n Savings Plans purchase method.

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

The amortized amount of Savings Plans purchased in a specific account during a specific time interval.

" + "smithy.api#documentation": "

The amortized amount of Savings Plans purchased in a specific account during a\n specific time interval.

" } }, "com.amazonaws.costexplorer#SavingsPlansCoverage": { @@ -5332,7 +5479,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of Savings Plans eligible usage that is covered by Savings Plans. All calculations consider the On-Demand equivalent of your Savings Plans usage.

" + "smithy.api#documentation": "

The amount of Savings Plans eligible usage that is covered by Savings Plans. All\n calculations consider the On-Demand equivalent of your Savings Plans usage.

" } }, "com.amazonaws.costexplorer#SavingsPlansCoverageData": { @@ -5341,30 +5488,30 @@ "SpendCoveredBySavingsPlans": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amount of your AWS usage that is covered by a Savings Plans.

" + "smithy.api#documentation": "

The amount of your Amazon Web Services usage that is covered by a Savings Plans.

" } }, "OnDemandCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The cost of your AWS usage at the public On-Demand rate.

" + "smithy.api#documentation": "

The cost of your Amazon Web Services usage at the public On-Demand rate.

" } }, "TotalCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total cost of your AWS usage, regardless of your purchase option.

" + "smithy.api#documentation": "

The total cost of your Amazon Web Services usage, regardless of your purchase\n option.

" } }, "CoveragePercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The percentage of your existing Savings Plans covered usage, divided by all of your\n eligible Savings Plans usage in an account(or set of accounts).

" + "smithy.api#documentation": "

The percentage of your existing Savings Plans covered usage, divided by all of your\n eligible Savings Plans usage in an account (or set of accounts).

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

Specific coverage percentage, On-Demand costs, and spend covered by Savings Plans, and total Savings Plans costs for an account.

" + "smithy.api#documentation": "

Specific coverage percentage, On-Demand costs, and spend covered by Savings Plans, and\n total Savings Plans costs for an account.

" } }, "com.amazonaws.costexplorer#SavingsPlansCoverages": { @@ -5408,7 +5555,7 @@ "Region": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

A collection of AWS resources in a geographic area. Each AWS Region is isolated and independent of the other Regions.

" + "smithy.api#documentation": "

A collection of Amazon Web Services resources in a geographic area. Each Amazon Web Services Region is isolated and independent of the other Regions.

" } }, "InstanceFamily": { @@ -5420,12 +5567,12 @@ "OfferingId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The unique ID used to distinguish Savings Plans from one another.

" + "smithy.api#documentation": "

The unique ID that's used to distinguish Savings Plans from one another.

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

Attribute details on a specific Savings Plan.

" + "smithy.api#documentation": "

The attribute details on a specific Savings Plan.

" } }, "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendation": { @@ -5434,7 +5581,7 @@ "AccountScope": { "target": "com.amazonaws.costexplorer#AccountScope", "traits": { - "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.

" + "smithy.api#documentation": "

The account scope that you want your recommendations for. Amazon Web Services\n calculates recommendations that include the management account and member accounts if\n the value is set to PAYER. If the value is LINKED,\n recommendations are calculated for individual member accounts only.

" } }, "SavingsPlansType": { @@ -5446,7 +5593,7 @@ "TermInYears": { "target": "com.amazonaws.costexplorer#TermInYears", "traits": { - "smithy.api#documentation": "

The Savings Plans recommendation term in years, used to generate the recommendation.

" + "smithy.api#documentation": "

The Savings Plans recommendation term in years. It's used to generate the\n recommendation.

" } }, "PaymentOption": { @@ -5475,7 +5622,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains your request parameters, Savings Plan Recommendations Summary, and Details.

" + "smithy.api#documentation": "

Contains your request parameters, Savings Plan Recommendations Summary, and\n Details.

" } }, "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationDetail": { @@ -5496,55 +5643,55 @@ "UpfrontCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The upfront cost of the recommended Savings Plans, based on the selected payment option.

" + "smithy.api#documentation": "

The upfront cost of the recommended Savings Plans, based on the selected payment\n option.

" } }, "EstimatedROI": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated return on investment based on the recommended Savings Plans purchased. This is calculated as estimatedSavingsAmount/ estimatedSPCost*100.

" + "smithy.api#documentation": "

The estimated return on investment that's based on the recommended Savings Plans that\n you purchased. This is calculated as estimatedSavingsAmount/\n estimatedSPCost*100.

" } }, "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code AWS used to generate the recommendations and present potential\n savings.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to generate the recommendations and\n present potential savings.

" } }, "EstimatedSPCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The cost of the recommended Savings Plans over the length of the lookback period.

" + "smithy.api#documentation": "

The cost of the recommended Savings Plans over the length of the lookback\n period.

" } }, "EstimatedOnDemandCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the lookback period.

" + "smithy.api#documentation": "

The remaining On-Demand cost estimated to not be covered by the recommended Savings\n Plans, over the length of the lookback period.

" } }, "EstimatedOnDemandCostWithCurrentCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.\n

" + "smithy.api#documentation": "

The estimated On-Demand costs you would expect with no additional commitment, based\n on your usage of the selected time period and the Savings Plans you own.

" } }, "EstimatedSavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated savings amount based on the recommended Savings Plans over the length of the lookback period.

" + "smithy.api#documentation": "

The estimated savings amount that's based on the recommended Savings Plans over the\n length of the lookback period.

" } }, "EstimatedSavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

" + "smithy.api#documentation": "

The estimated savings percentage relative to the total cost of applicable On-Demand\n usage over the lookback period.

" } }, "HourlyCommitmentToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The recommended hourly commitment level for the Savings Plans type, and configuration based on the usage during the lookback period.

" + "smithy.api#documentation": "

The recommended hourly commitment level for the Savings Plans type and the\n configuration that's based on the usage during the lookback period.

" } }, "EstimatedAverageUtilization": { @@ -5556,25 +5703,25 @@ "EstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated monthly savings amount, based on the recommended Savings Plans.

" + "smithy.api#documentation": "

The estimated monthly savings amount based on the recommended Savings Plans.

" } }, "CurrentMinimumHourlyOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + "smithy.api#documentation": "

The lowest value of hourly On-Demand spend over the lookback period of the applicable\n usage type.

" } }, "CurrentMaximumHourlyOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + "smithy.api#documentation": "

The highest value of hourly On-Demand spend over the lookback period of the applicable\n usage type.

" } }, "CurrentAverageHourlyOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + "smithy.api#documentation": "

The average value of hourly On-Demand spend over the lookback period of the applicable\n usage type.

" } } }, @@ -5606,7 +5753,7 @@ "AdditionalMetadata": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Additional metadata that may be applicable to the recommendation.

" + "smithy.api#documentation": "

Additional metadata that might be applicable to the recommendation.

" } } }, @@ -5620,37 +5767,37 @@ "EstimatedROI": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated return on investment based on the recommended Savings Plans and estimated savings.

" + "smithy.api#documentation": "

The estimated return on investment that's based on the recommended Savings Plans and\n estimated savings.

" } }, "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code AWS used to generate the recommendations and present potential\n savings.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to generate the recommendations and\n present potential savings.

" } }, "EstimatedTotalCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand usage.

" + "smithy.api#documentation": "

The estimated total cost of the usage after purchasing the recommended Savings Plans.\n This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand\n usage.

" } }, "CurrentOnDemandSpend": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The current total on demand spend of the applicable usage types over the lookback period.

" + "smithy.api#documentation": "

The current total on demand spend of the applicable usage types over the lookback\n period.

" } }, "EstimatedSavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.

" + "smithy.api#documentation": "

The estimated total savings over the lookback period, based on the purchase of the\n recommended Savings Plans.

" } }, "TotalRecommendationCount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The aggregate number of Savings Plans recommendations that exist for your account.

" + "smithy.api#documentation": "

The aggregate number of Savings Plans recommendations that exist for your\n account.

" } }, "DailyCommitmentToPurchase": { @@ -5662,25 +5809,25 @@ "HourlyCommitmentToPurchase": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The recommended hourly commitment based on the recommendation parameters.

" + "smithy.api#documentation": "

The recommended hourly commitment that's based on the recommendation\n parameters.

" } }, "EstimatedSavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated as estimatedSavingsAmount/ CurrentOnDemandSpend*100.

" + "smithy.api#documentation": "

The estimated savings relative to the total cost of On-Demand usage, over the lookback\n period. This is calculated as estimatedSavingsAmount/\n CurrentOnDemandSpend*100.

" } }, "EstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated monthly savings amount, based on the recommended Savings Plans purchase.

" + "smithy.api#documentation": "

The estimated monthly savings amount that's based on the recommended Savings Plans\n purchase.

" } }, "EstimatedOnDemandCostWithCurrentCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own.\n

" + "smithy.api#documentation": "

The estimated On-Demand costs you would expect with no additional commitment. It's\n based on your usage of the selected time period and the Savings Plans you own.

" } } }, @@ -5694,18 +5841,18 @@ "NetSavings": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The savings amount that you are accumulating for the usage that is covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

" + "smithy.api#documentation": "

The savings amount that you're accumulating for the usage that's covered by a Savings\n Plans, when compared to the On-Demand equivalent of the same usage.

" } }, "OnDemandCostEquivalent": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much the amount that the usage would have cost if it was\n accrued\n at the On-Demand rate.

" + "smithy.api#documentation": "

How much the amount that the usage would have cost if it was accrued at the On-Demand\n rate.

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

The amount of savings you're accumulating, against the public On-Demand rate of the usage accrued in an account.

" + "smithy.api#documentation": "

The amount of savings that you're accumulating, against the public On-Demand rate of\n the usage accrued in an account.

" } }, "com.amazonaws.costexplorer#SavingsPlansUtilization": { @@ -5714,30 +5861,30 @@ "TotalCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

" + "smithy.api#documentation": "

The total amount of Savings Plans commitment that's been purchased in an account (or\n set of accounts).

" } }, "UsedCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.

" + "smithy.api#documentation": "

The amount of your Savings Plans commitment that was consumed from Savings Plans\n eligible usage in a specific period.

" } }, "UnusedCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amount of your Savings Plans commitment that was not consumed from Savings Plans eligible usage in a specific period.

" + "smithy.api#documentation": "

The amount of your Savings Plans commitment that wasn't consumed from Savings Plans\n eligible usage in a specific period.

" } }, "UtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.

" + "smithy.api#documentation": "

The amount of UsedCommitment divided by the TotalCommitment\n for your Savings Plans.

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

The measurement of how well you are using your existing Savings Plans.

" + "smithy.api#documentation": "

The measurement of how well you're using your existing Savings Plans.

" } }, "com.amazonaws.costexplorer#SavingsPlansUtilizationAggregates": { @@ -5746,20 +5893,20 @@ "Utilization": { "target": "com.amazonaws.costexplorer#SavingsPlansUtilization", "traits": { - "smithy.api#documentation": "

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

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

A ratio of your effectiveness of using existing Savings Plans to apply to workloads\n that are Savings Plans eligible.

", "smithy.api#required": {} } }, "Savings": { "target": "com.amazonaws.costexplorer#SavingsPlansSavings", "traits": { - "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" + "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings\n from Savings Plans, as well as the onDemandCostEquivalent of the Savings\n Plans when considering the utilization rate.

" } }, "AmortizedCommitment": { "target": "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment", "traits": { - "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" + "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. This includes the sum of the\n upfront and recurring Savings Plans fees.

" } } }, @@ -5779,20 +5926,20 @@ "Utilization": { "target": "com.amazonaws.costexplorer#SavingsPlansUtilization", "traits": { - "smithy.api#documentation": "

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

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

A ratio of your effectiveness of using existing Savings Plans to apply to workloads\n that are Savings Plans eligible.

", "smithy.api#required": {} } }, "Savings": { "target": "com.amazonaws.costexplorer#SavingsPlansSavings", "traits": { - "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" + "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings\n from Savings Plans as well as the onDemandCostEquivalent of the Savings\n Plans when considering the utilization rate.

" } }, "AmortizedCommitment": { "target": "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment", "traits": { - "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" + "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. This includes the sum of the\n upfront and recurring Savings Plans fees.

" } } }, @@ -5818,24 +5965,24 @@ "Utilization": { "target": "com.amazonaws.costexplorer#SavingsPlansUtilization", "traits": { - "smithy.api#documentation": "

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

" + "smithy.api#documentation": "

A ratio of your effectiveness of using existing Savings Plans to apply to workloads\n that are Savings Plans eligible.

" } }, "Savings": { "target": "com.amazonaws.costexplorer#SavingsPlansSavings", "traits": { - "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" + "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings\n from savings plans as well as the onDemandCostEquivalent of the Savings\n Plans when considering the utilization rate.

" } }, "AmortizedCommitment": { "target": "com.amazonaws.costexplorer#SavingsPlansAmortizedCommitment", "traits": { - "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans fees.

" + "smithy.api#documentation": "

The total amortized commitment for a Savings Plans. Includes the sum of the upfront\n and recurring Savings Plans fees.

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

A single daily or monthly Savings Plans utilization rate, and details for your account. A management account in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.

" + "smithy.api#documentation": "

A single daily or monthly Savings Plans utilization rate, and details for your\n account. A management account in an organization have access to member accounts. You can\n use GetDimensionValues to determine the possible dimension values.

" } }, "com.amazonaws.costexplorer#SavingsPlansUtilizationDetails": { @@ -5857,7 +6004,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "[\\S\\s]*" + "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.costexplorer#ServiceQuotaExceededException": { @@ -5879,12 +6026,12 @@ "EC2Specification": { "target": "com.amazonaws.costexplorer#EC2Specification", "traits": { - "smithy.api#documentation": "

The Amazon EC2 hardware specifications that you want AWS to provide recommendations\n for.

" + "smithy.api#documentation": "

The Amazon EC2 hardware specifications that you want Amazon Web Services to provide\n recommendations for.

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

Hardware specifications for the service that you want recommendations\n for.

" + "smithy.api#documentation": "

Hardware specifications for the service that you want recommendations for.

" } }, "com.amazonaws.costexplorer#SortDefinition": { @@ -5893,14 +6040,14 @@ "Key": { "target": "com.amazonaws.costexplorer#SortDefinitionKey", "traits": { - "smithy.api#documentation": "

The key by which to sort the data.

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

The key that's used to sort the data.

", "smithy.api#required": {} } }, "SortOrder": { "target": "com.amazonaws.costexplorer#SortOrder", "traits": { - "smithy.api#documentation": "

The order in which to sort the data.

" + "smithy.api#documentation": "

The order that's used to sort the data.

" } } }, @@ -5915,7 +6062,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "[\\S\\s]*" + "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.costexplorer#SortDefinitions": { @@ -5945,24 +6092,24 @@ "Address": { "target": "com.amazonaws.costexplorer#SubscriberAddress", "traits": { - "smithy.api#documentation": "

The email address or SNS Amazon Resource Name (ARN), depending on the Type.

" + "smithy.api#documentation": "

The email address or SNS Amazon Resource Name (ARN). This depends on the\n Type.

" } }, "Type": { "target": "com.amazonaws.costexplorer#SubscriberType", "traits": { - "smithy.api#documentation": "

\n The notification delivery channel.\n

" + "smithy.api#documentation": "

The notification delivery channel.

" } }, "Status": { "target": "com.amazonaws.costexplorer#SubscriberStatus", "traits": { - "smithy.api#documentation": "

Indicates if the subscriber accepts the notifications.

" + "smithy.api#documentation": "

Indicates if the subscriber accepts the notifications.

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

\n The recipient of AnomalySubscription notifications.\n

" + "smithy.api#documentation": "

The recipient of AnomalySubscription notifications.

" } }, "com.amazonaws.costexplorer#SubscriberAddress": { @@ -5972,7 +6119,7 @@ "min": 6, "max": 302 }, - "smithy.api#pattern": "(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+$)" + "smithy.api#pattern": "^(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+$)$" } }, "com.amazonaws.costexplorer#SubscriberStatus": { @@ -6037,7 +6184,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "[\\S\\s]*" + "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.costexplorer#TagList": { @@ -6064,12 +6211,12 @@ "MatchOptions": { "target": "com.amazonaws.costexplorer#MatchOptions", "traits": { - "smithy.api#documentation": "

The match options that you can use to filter your results.\n MatchOptions is only applicable for actions related to Cost Category.\n The default values for MatchOptions are EQUALS and\n CASE_SENSITIVE.

" + "smithy.api#documentation": "

The match options that you can use to filter your results. MatchOptions\n is only applicable for actions related to Cost Category. The default values for\n MatchOptions are EQUALS and\n CASE_SENSITIVE.

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

The values that are available for a tag.

\n\t\t

If Values and Key are not specified, the ABSENT \n MatchOption is applied to all tags. That is, filtering on resources with no tags.

\n

If Values is provided and Key is not specified, the ABSENT \n MatchOption is applied to the tag Key only. That is, filtering on resources without the given tag key.

" + "smithy.api#documentation": "

The values that are available for a tag.

\n

If Values and Key aren't specified, the ABSENT\n MatchOption is applied to all tags. That is, it's filtered on resources\n with no tags.

\n

If Values is provided and Key isn't specified, the\n ABSENT\n MatchOption is applied to the tag Key only. That is, it's\n filtered on resources without the given tag key.

" } }, "com.amazonaws.costexplorer#TagValuesList": { @@ -6084,48 +6231,48 @@ "EstimatedMonthlyCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Expected cost to operate this instance type on a monthly basis.

" + "smithy.api#documentation": "

The expected cost to operate this instance type on a monthly basis.

" } }, "EstimatedMonthlySavings": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Estimated savings resulting from modification, on a monthly basis.

" + "smithy.api#documentation": "

The estimated savings that result from modification, on a monthly basis.

" } }, "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this\n instance.

" } }, "DefaultTargetInstance": { "target": "com.amazonaws.costexplorer#GenericBoolean", "traits": { - "smithy.api#documentation": "

Indicates whether this recommendation is the defaulted AWS recommendation.

" + "smithy.api#documentation": "

Determines whether this recommendation is the defaulted Amazon Web Services\n recommendation.

" } }, "ResourceDetails": { "target": "com.amazonaws.costexplorer#ResourceDetails", "traits": { - "smithy.api#documentation": "

Details on the target instance type.

" + "smithy.api#documentation": "

Details on the target instance type.

" } }, "ExpectedResourceUtilization": { "target": "com.amazonaws.costexplorer#ResourceUtilization", "traits": { - "smithy.api#documentation": "

Expected utilization metrics for target instance type.

" + "smithy.api#documentation": "

The expected utilization metrics for target instance type.

" } }, "PlatformDifferences": { "target": "com.amazonaws.costexplorer#PlatformDifferences", "traits": { - "smithy.api#documentation": "

\n Explains the actions you might need to take in order to successfully migrate your workloads from the current instance type to the recommended instance type.\n

" + "smithy.api#documentation": "

Explains the actions you might need to take in order to successfully migrate your\n workloads from the current instance type to the recommended instance type.

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

Details on recommended instance.

" + "smithy.api#documentation": "

Details on recommended instance.

" } }, "com.amazonaws.costexplorer#TargetInstancesList": { @@ -6155,18 +6302,18 @@ "EstimatedMonthlySavings": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Estimated savings resulting from modification, on a monthly basis.

" + "smithy.api#documentation": "

The estimated savings that result from modification, on a monthly basis.

" } }, "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that AWS used to calculate the costs for this instance.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this\n instance.

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

Details on termination recommendation.

" + "smithy.api#documentation": "

Details on termination recommendation.

" } }, "com.amazonaws.costexplorer#TotalActualHours": { @@ -6184,26 +6331,26 @@ "NumericOperator": { "target": "com.amazonaws.costexplorer#NumericOperator", "traits": { - "smithy.api#documentation": "

\n The comparing value used in the filter.\n

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

The comparing value that's used in the filter.

", "smithy.api#required": {} } }, "StartValue": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { - "smithy.api#documentation": "

\n The lower bound dollar value used in the filter.\n

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

The lower bound dollar value that's used in the filter.

", "smithy.api#required": {} } }, "EndValue": { "target": "com.amazonaws.costexplorer#GenericDouble", "traits": { - "smithy.api#documentation": "

The upper bound dollar value used in the filter.

" + "smithy.api#documentation": "

The upper bound dollar value that's used in the filter.

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

Filters cost anomalies based on the total impact.

" + "smithy.api#documentation": "

Filters cost anomalies based on the total impact.

" } }, "com.amazonaws.costexplorer#TotalPotentialRISavings": { @@ -6279,7 +6426,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing cost anomaly monitor. The changes made are applied going forward, and\n does not change anomalies detected in the past.

" + "smithy.api#documentation": "

Updates an existing cost anomaly monitor. The changes made are applied going forward, and\n doesn'tt change anomalies detected in the past.

" } }, "com.amazonaws.costexplorer#UpdateAnomalyMonitorRequest": { @@ -6288,14 +6435,14 @@ "MonitorArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

Cost anomaly monitor Amazon Resource Names (ARNs).

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

Cost anomaly monitor Amazon Resource Names (ARNs).

", "smithy.api#required": {} } }, "MonitorName": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The new name for the cost anomaly monitor.\n

" + "smithy.api#documentation": "

The new name for the cost anomaly monitor.

" } } } @@ -6306,7 +6453,7 @@ "MonitorArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n A cost anomaly monitor ARN.\n

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

A cost anomaly monitor ARN.

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

Updates an existing cost anomaly monitor subscription.

" + "smithy.api#documentation": "

Updates an existing cost anomaly monitor subscription.

" } }, "com.amazonaws.costexplorer#UpdateAnomalySubscriptionRequest": { @@ -6341,38 +6488,38 @@ "SubscriptionArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

A cost anomaly subscription Amazon Resource Name (ARN).

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

A cost anomaly subscription Amazon Resource Name (ARN).

", "smithy.api#required": {} } }, "Threshold": { "target": "com.amazonaws.costexplorer#NullableNonNegativeDouble", "traits": { - "smithy.api#documentation": "

\n The update to the threshold value for receiving notifications.\n

" + "smithy.api#documentation": "

The update to the threshold value for receiving notifications.

" } }, "Frequency": { "target": "com.amazonaws.costexplorer#AnomalySubscriptionFrequency", "traits": { - "smithy.api#documentation": "

\n The update to the frequency value at which subscribers will receive notifications.\n

" + "smithy.api#documentation": "

The update to the frequency value that subscribers receive notifications.

" } }, "MonitorArnList": { "target": "com.amazonaws.costexplorer#MonitorArnList", "traits": { - "smithy.api#documentation": "

\n A list of cost anomaly monitor ARNs.\n

" + "smithy.api#documentation": "

A list of cost anomaly monitor ARNs.

" } }, "Subscribers": { "target": "com.amazonaws.costexplorer#Subscribers", "traits": { - "smithy.api#documentation": "

\n The update to the subscriber list.\n

" + "smithy.api#documentation": "

The update to the subscriber list.

" } }, "SubscriptionName": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n The subscription's new name.\n

" + "smithy.api#documentation": "

The new name of the subscription.

" } } } @@ -6383,7 +6530,7 @@ "SubscriptionArn": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

\n A cost anomaly subscription ARN.\n

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

A cost anomaly subscription ARN.

", "smithy.api#required": {} } } @@ -6437,6 +6584,12 @@ }, "DefaultValue": { "target": "com.amazonaws.costexplorer#CostCategoryValue" + }, + "SplitChargeRules": { + "target": "com.amazonaws.costexplorer#CostCategorySplitChargeRulesList", + "traits": { + "smithy.api#documentation": "

\n The split charge rules used to allocate your charges between your Cost Category values.\n

" + } } } }, @@ -6502,7 +6655,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "[\\S\\s]*" + "smithy.api#pattern": "^[\\S\\s]*$" } }, "com.amazonaws.costexplorer#Values": { @@ -6518,7 +6671,7 @@ "min": 0, "max": 40 }, - "smithy.api#pattern": "(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?" + "smithy.api#pattern": "^(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?$" } }, "com.amazonaws.costexplorer#ZonedDateTime": { diff --git a/aws/sdk/aws-models/chime-sdk-identity.json b/aws/sdk/aws-models/chime-sdk-identity.json new file mode 100644 index 0000000000..93ac161500 --- /dev/null +++ b/aws/sdk/aws-models/chime-sdk-identity.json @@ -0,0 +1,1884 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.chimesdkidentity#AppInstance": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the messaging instance.

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

The name of an AppInstance.

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

The time at which an AppInstance was created. In epoch milliseconds.

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

The time an AppInstance was last updated. In epoch milliseconds.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkidentity#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata of an AppInstance.

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

The details of an AppInstance, an instance of an Amazon Chime SDK messaging\n application.

" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceAdmin": { + "type": "structure", + "members": { + "Admin": { + "target": "com.amazonaws.chimesdkidentity#Identity", + "traits": { + "smithy.api#documentation": "

The AppInstanceAdmin data.

" + } + }, + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance for which the user is an administrator.

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

The time at which an administrator was created.

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

The details of an AppInstanceAdmin.

" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceAdminList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceAdminSummary" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceAdminSummary": { + "type": "structure", + "members": { + "Admin": { + "target": "com.amazonaws.chimesdkidentity#Identity", + "traits": { + "smithy.api#documentation": "

The details of the AppInstanceAdmin.

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

Summary of the details of an AppInstanceAdmin.

" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceSummary" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceRetentionSettings": { + "type": "structure", + "members": { + "ChannelRetentionSettings": { + "target": "com.amazonaws.chimesdkidentity#ChannelRetentionSettings", + "traits": { + "smithy.api#documentation": "

The length of time in days to retain the messages in a channel.

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

The details of the data-retention settings for an AppInstance.

" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceSummary": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstance ARN.

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

The name of the AppInstance.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkidentity#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata of the AppInstance.

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

Summary of the data for an AppInstance.

" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceUser": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceUser.

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

The name of the AppInstanceUser.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkidentity#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata of the AppInstanceUser.

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

The time at which the AppInstanceUser was created.

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

The time at which the AppInstanceUser was last updated.

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

The details of an AppInstanceUser.

" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceUserSummary" + } + }, + "com.amazonaws.chimesdkidentity#AppInstanceUserSummary": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceUser.

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

The name of an AppInstanceUser.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkidentity#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata of the AppInstanceUser.

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

Summary of the details of an AppInstanceUser.

" + } + }, + "com.amazonaws.chimesdkidentity#BadRequestException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkidentity#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkidentity#String" + } + }, + "traits": { + "smithy.api#documentation": "

The input parameters don't match the service's restrictions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chimesdkidentity#ChannelRetentionSettings": { + "type": "structure", + "members": { + "RetentionDays": { + "target": "com.amazonaws.chimesdkidentity#RetentionDays", + "traits": { + "smithy.api#documentation": "

The time in days to retain the messages in a channel.

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

The details of the retention settings for a channel.

" + } + }, + "com.amazonaws.chimesdkidentity#ChimeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 1600 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.chimesdkidentity#ChimeIdentityService": { + "type": "service", + "version": "2021-04-20", + "operations": [ + { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstance" + }, + { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceAdmin" + }, + { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceUser" + }, + { + "target": "com.amazonaws.chimesdkidentity#DeleteAppInstance" + }, + { + "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceAdmin" + }, + { + "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceUser" + }, + { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstance" + }, + { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceAdmin" + }, + { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceUser" + }, + { + "target": "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettings" + }, + { + "target": "com.amazonaws.chimesdkidentity#ListAppInstanceAdmins" + }, + { + "target": "com.amazonaws.chimesdkidentity#ListAppInstances" + }, + { + "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUsers" + }, + { + "target": "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettings" + }, + { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstance" + }, + { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUser" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Chime SDK Identity", + "arnNamespace": "chime", + "cloudFormationName": "ChimeSDKIdentity", + "cloudTrailEventSource": "chimesdkidentity.amazonaws.com", + "endpointPrefix": "identity-chime" + }, + "aws.auth#sigv4": { + "name": "chime" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

The Amazon Chime SDK Identity APIs in this section allow software developers to create\n and manage unique instances of their messaging applications. These APIs provide the\n overarching framework for creating and sending messages. For more information about the\n identity APIs, refer to .

", + "smithy.api#title": "Amazon Chime SDK Identity" + } + }, + "com.amazonaws.chimesdkidentity#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[-_a-zA-Z0-9]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkidentity#ConflictException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkidentity#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkidentity#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Chime SDK messaging AppInstance under an AWS account.\n Only SDK messaging customers use this API. CreateAppInstance supports\n idempotency behavior as described in the AWS API Standard.

\n

identity

", + "smithy.api#http": { + "method": "POST", + "uri": "/app-instances", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstanceAdmin": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceAdminRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceAdminResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Promotes an AppInstanceUser to an AppInstanceAdmin. The\n promoted user can perform the following actions.

\n\n
    \n
  • \n

    \n ChannelModerator actions across all channels in the\n AppInstance.

    \n
    • \n
  • \n

    \n DeleteChannelMessage actions.

    \n
    • \n
\n\n

Only an AppInstanceUser can be promoted to an AppInstanceAdmin\n role.

", + "smithy.api#http": { + "method": "POST", + "uri": "/app-instances/{AppInstanceArn}/admins", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstanceAdminRequest": { + "type": "structure", + "members": { + "AppInstanceAdminArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the administrator of the current AppInstance.

", + "smithy.api#required": {} + } + }, + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstanceAdminResponse": { + "type": "structure", + "members": { + "AppInstanceAdmin": { + "target": "com.amazonaws.chimesdkidentity#Identity", + "traits": { + "smithy.api#documentation": "

The name and ARN of the admin for the AppInstance.

" + } + }, + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the of the admin for the AppInstance.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstanceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.chimesdkidentity#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "

The name of the AppInstance.

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

The metadata of the AppInstance. Limited to a 1KB string in UTF-8.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkidentity#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

The ClientRequestToken of the AppInstance.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.chimesdkidentity#TagList", + "traits": { + "smithy.api#documentation": "

Tags assigned to the AppInstanceUser.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstanceResponse": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the AppInstance.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstanceUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceUserRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#CreateAppInstanceUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a user under an Amazon Chime AppInstance. The request consists of a\n unique appInstanceUserId and Name for that user.

", + "smithy.api#http": { + "method": "POST", + "uri": "/app-instance-users", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstanceUserRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance request.

", + "smithy.api#required": {} + } + }, + "AppInstanceUserId": { + "target": "com.amazonaws.chimesdkidentity#UserId", + "traits": { + "smithy.api#documentation": "

The user ID of the AppInstance.

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

The user's name.

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

The request's metadata. Limited to a 1KB string in UTF-8.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkidentity#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

The token assigned to the user requesting an AppInstance.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.chimesdkidentity#TagList", + "traits": { + "smithy.api#documentation": "

Tags assigned to the AppInstanceUser.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#CreateAppInstanceUserResponse": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The user's ARN.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#DeleteAppInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an AppInstance and all associated data asynchronously.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/app-instances/{AppInstanceArn}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkidentity#DeleteAppInstanceAdmin": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceAdminRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Demotes an AppInstanceAdmin to an AppInstanceUser. This action\n does not delete the user.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/app-instances/{AppInstanceArn}/admins/{AppInstanceAdminArn}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkidentity#DeleteAppInstanceAdminRequest": { + "type": "structure", + "members": { + "AppInstanceAdminArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance's administrator.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#DeleteAppInstanceRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#DeleteAppInstanceUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceUserRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an AppInstanceUser.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/app-instance-users/{AppInstanceUserArn}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkidentity#DeleteAppInstanceUserRequest": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the user request being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the full details of an AppInstance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app-instances/{AppInstanceArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstanceAdmin": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceAdminRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceAdminResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the full details of an AppInstanceAdmin.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app-instances/{AppInstanceArn}/admins/{AppInstanceAdminArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstanceAdminRequest": { + "type": "structure", + "members": { + "AppInstanceAdminArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceAdmin.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstanceAdminResponse": { + "type": "structure", + "members": { + "AppInstanceAdmin": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceAdmin", + "traits": { + "smithy.api#documentation": "

The ARN and name of the AppInstanceUser, the ARN of the\n AppInstance, and the created and last-updated timestamps. All timestamps\n use epoch milliseconds.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstanceRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstanceResponse": { + "type": "structure", + "members": { + "AppInstance": { + "target": "com.amazonaws.chimesdkidentity#AppInstance", + "traits": { + "smithy.api#documentation": "

The ARN, metadata, created and last-updated timestamps, and the name of the\n AppInstance. All timestamps use epoch milliseconds.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstanceUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceUserRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the full details of an AppInstanceUser.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app-instance-users/{AppInstanceUserArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstanceUserRequest": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceUser.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#DescribeAppInstanceUserResponse": { + "type": "structure", + "members": { + "AppInstanceUser": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceUser", + "traits": { + "smithy.api#documentation": "

The name of the AppInstanceUser.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BadRequest", + "name": "BadRequest" + }, + { + "value": "Conflict", + "name": "Conflict" + }, + { + "value": "Forbidden", + "name": "Forbidden" + }, + { + "value": "NotFound", + "name": "NotFound" + }, + { + "value": "PreconditionFailed", + "name": "PreconditionFailed" + }, + { + "value": "ResourceLimitExceeded", + "name": "ResourceLimitExceeded" + }, + { + "value": "ServiceFailure", + "name": "ServiceFailure" + }, + { + "value": "AccessDenied", + "name": "AccessDenied" + }, + { + "value": "ServiceUnavailable", + "name": "ServiceUnavailable" + }, + { + "value": "Throttled", + "name": "Throttled" + }, + { + "value": "Throttling", + "name": "Throttling" + }, + { + "value": "Unauthorized", + "name": "Unauthorized" + }, + { + "value": "Unprocessable", + "name": "Unprocessable" + }, + { + "value": "VoiceConnectorGroupAssociationsExist", + "name": "VoiceConnectorGroupAssociationsExist" + }, + { + "value": "PhoneNumberAssociationsExist", + "name": "PhoneNumberAssociationsExist" + } + ] + } + }, + "com.amazonaws.chimesdkidentity#ForbiddenException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkidentity#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkidentity#String" + } + }, + "traits": { + "smithy.api#documentation": "

The client is permanently forbidden from making the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettingsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the retention settings for an AppInstance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app-instances/{AppInstanceArn}/retention-settings", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettingsRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettingsResponse": { + "type": "structure", + "members": { + "AppInstanceRetentionSettings": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceRetentionSettings", + "traits": { + "smithy.api#documentation": "

The retention settings for the AppInstance.

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

The timestamp representing the time at which the specified items are retained, in Epoch\n Seconds.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#Identity": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN in an Identity.

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

The name in an Identity.

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

The details of a user.

" + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstanceAdmins": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#ListAppInstanceAdminsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#ListAppInstanceAdminsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the administrators in the AppInstance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app-instances/{AppInstanceArn}/admins", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstanceAdminsRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkidentity#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of administrators that you want to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkidentity#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from previous API requests until the number of administrators is\n reached.

", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstanceAdminsResponse": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

" + } + }, + "AppInstanceAdmins": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceAdminList", + "traits": { + "smithy.api#documentation": "

The information for each administrator.

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

The token returned from previous API requests until the number of administrators is\n reached.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstanceUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUsersRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

List all AppInstanceUsers created under a single\n AppInstance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app-instance-users", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstanceUsersRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpQuery": "app-instance-arn", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkidentity#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of requests that you want returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkidentity#NextToken", + "traits": { + "smithy.api#documentation": "

The token passed by previous API calls until all requested users are returned.

", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstanceUsersResponse": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

" + } + }, + "AppInstanceUsers": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceUserList", + "traits": { + "smithy.api#documentation": "

The information for each requested AppInstanceUser.

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

The token passed by previous API calls until all requested users are returned.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#ListAppInstancesRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#ListAppInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Amazon Chime AppInstances created under a single AWS\n account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/app-instances", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstancesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.chimesdkidentity#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of AppInstances that you want to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkidentity#NextToken", + "traits": { + "smithy.api#documentation": "

The token passed by previous API requests until you reach the maximum number of\n AppInstances.

", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstancesResponse": { + "type": "structure", + "members": { + "AppInstances": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceList", + "traits": { + "smithy.api#documentation": "

The information for each AppInstance.

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

The token passed by previous API requests until the maximum number of\n AppInstances is reached.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.chimesdkidentity#Metadata": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkidentity#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkidentity#NonEmptyResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettingsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Sets the amount of time in days that a given AppInstance retains\n data.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/app-instances/{AppInstanceArn}/retention-settings", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettingsRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AppInstanceRetentionSettings": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceRetentionSettings", + "traits": { + "smithy.api#documentation": "

The time in days to retain data. Data type: number.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettingsResponse": { + "type": "structure", + "members": { + "AppInstanceRetentionSettings": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceRetentionSettings", + "traits": { + "smithy.api#documentation": "

The time in days to retain data. Data type: number.

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

The time at which the API deletes data.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#ResourceLimitExceededException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkidentity#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkidentity#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request exceeds the resource limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chimesdkidentity#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkidentity#RetentionDays": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 5475 + } + } + }, + "com.amazonaws.chimesdkidentity#ServiceFailureException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkidentity#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkidentity#String" + } + }, + "traits": { + "smithy.api#documentation": "

The service encountered an unexpected error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chimesdkidentity#ServiceUnavailableException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkidentity#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkidentity#String" + } + }, + "traits": { + "smithy.api#documentation": "

The service is currently unavailable.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.chimesdkidentity#String": { + "type": "string" + }, + "com.amazonaws.chimesdkidentity#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.chimesdkidentity#TagKey", + "traits": { + "smithy.api#documentation": "

The key of the tag.

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

The value of the tag.

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

Describes a tag applied to a resource.

" + } + }, + "com.amazonaws.chimesdkidentity#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkidentity#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkidentity#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.chimesdkidentity#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkidentity#ThrottledClientException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkidentity#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkidentity#String" + } + }, + "traits": { + "smithy.api#documentation": "

The client exceeded its request rate limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.chimesdkidentity#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.chimesdkidentity#UnauthorizedClientException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkidentity#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkidentity#String" + } + }, + "traits": { + "smithy.api#documentation": "

The client is not currently authorized to make the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.chimesdkidentity#UpdateAppInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates AppInstance metadata.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/app-instances/{AppInstanceArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkidentity#UpdateAppInstanceRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.chimesdkidentity#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "

The name that you want to change.

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

The metadata that you want to change.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#UpdateAppInstanceResponse": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#UpdateAppInstanceUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the details of an AppInstanceUser. You can update names and\n metadata.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/app-instance-users/{AppInstanceUserArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserRequest": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceUser.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.chimesdkidentity#UserName", + "traits": { + "smithy.api#documentation": "

The name of the AppInstanceUser.

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

The metadata of the AppInstanceUser.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserResponse": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceUser.

" + } + } + } + }, + "com.amazonaws.chimesdkidentity#UserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9]([A-Za-z0-9\\:\\-\\_\\.\\@]{0,62}[A-Za-z0-9])?$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkidentity#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "\\S", + "smithy.api#sensitive": {} + } + } + } +} diff --git a/aws/sdk/aws-models/chime-sdk-messaging.json b/aws/sdk/aws-models/chime-sdk-messaging.json new file mode 100644 index 0000000000..0877d8ea9c --- /dev/null +++ b/aws/sdk/aws-models/chime-sdk-messaging.json @@ -0,0 +1,3774 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.chimesdkmessaging#AppInstanceUserMembershipSummary": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipType", + "traits": { + "smithy.api#documentation": "

The type of ChannelMembership.

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

The time at which a message was last read.

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

Summary of the membership details of an AppInstanceUser.

" + } + }, + "com.amazonaws.chimesdkmessaging#BadRequestException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

The input parameters don't match the service's restrictions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chimesdkmessaging#BatchChannelMemberships": { + "type": "structure", + "members": { + "InvitedBy": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The identifier of the member who invited another member.

" + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipType", + "traits": { + "smithy.api#documentation": "

The membership types set for the channel users.

" + } + }, + "Members": { + "target": "com.amazonaws.chimesdkmessaging#Members", + "traits": { + "smithy.api#documentation": "

The users successfully added to the request.

" + } + }, + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel to which you're adding users.

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

The membership information, including member ARNs, the channel ARN, and membership\n types.

" + } + }, + "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembershipRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a specified number of users to a channel.

", + "smithy.api#http": { + "method": "POST", + "uri": "/channels/{ChannelArn}/memberships?operation=batch-create", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembershipError": { + "type": "structure", + "members": { + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the member that the service couldn't add.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code.

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

The error message.

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

A list of failed member ARNs, error codes, and error messages.

" + } + }, + "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembershipErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembershipError" + } + }, + "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembershipRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel to which you're adding users.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipType", + "traits": { + "smithy.api#documentation": "

The membership type of a user, DEFAULT or HIDDEN. Default\n members are always returned as part of ListChannelMemberships. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN. Otherwise hidden members are not returned. This is only supported\n by moderators.

" + } + }, + "MemberArns": { + "target": "com.amazonaws.chimesdkmessaging#MemberArns", + "traits": { + "smithy.api#documentation": "

The ARNs of the members you want to add to the channel.

", + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembershipResponse": { + "type": "structure", + "members": { + "BatchChannelMemberships": { + "target": "com.amazonaws.chimesdkmessaging#BatchChannelMemberships", + "traits": { + "smithy.api#documentation": "

The list of channel memberships in the response.

" + } + }, + "Errors": { + "target": "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembershipErrors", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#Channel": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "

The name of a channel.

" + } + }, + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of a channel.

" + } + }, + "Mode": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMode", + "traits": { + "smithy.api#documentation": "

The mode of the channel.

" + } + }, + "Privacy": { + "target": "com.amazonaws.chimesdkmessaging#ChannelPrivacy", + "traits": { + "smithy.api#documentation": "

The channel's privacy setting.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkmessaging#Metadata", + "traits": { + "smithy.api#documentation": "

The channel's metadata.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The AppInstanceUser who created the channel.

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

The time at which the AppInstanceUser created the channel.

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

The time at which a member sent the last message in the channel.

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

The time at which a channel was last updated.

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

The details of a channel.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelBan": { + "type": "structure", + "members": { + "Member": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The member being banned from the channel.

" + } + }, + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel from which a member is being banned.

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

The time at which the ban was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The AppInstanceUser who created the ban.

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

The details of a channel ban.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelBanSummary": { + "type": "structure", + "members": { + "Member": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The member being banned from a channel.

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

Summary of the details of a ChannelBan.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelBanSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelBanSummary" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMembership": { + "type": "structure", + "members": { + "InvitedBy": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The identifier of the member who invited another member.

" + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipType", + "traits": { + "smithy.api#documentation": "

The membership type set for the channel member.

" + } + }, + "Member": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The data of the channel member.

" + } + }, + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the member's channel.

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

The time at which the channel membership was created.

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

The time at which a channel membership was last updated.

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

The details of a channel member.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMembershipForAppInstanceUserSummary": { + "type": "structure", + "members": { + "ChannelSummary": { + "target": "com.amazonaws.chimesdkmessaging#ChannelSummary", + "traits": { + "smithy.api#documentation": "

Returns the channel data for an AppInstance.

" + } + }, + "AppInstanceUserMembershipSummary": { + "target": "com.amazonaws.chimesdkmessaging#AppInstanceUserMembershipSummary", + "traits": { + "smithy.api#documentation": "

Returns the channel membership data for an AppInstance.

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

Summary of the channel membership details of an AppInstanceUser.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMembershipForAppInstanceUserSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipForAppInstanceUserSummary" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMembershipSummary": { + "type": "structure", + "members": { + "Member": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

A member's summary data.

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

Summary of the details of a ChannelMembership.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMembershipSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipSummary" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMembershipType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEFAULT", + "name": "DEFAULT" + }, + { + "value": "HIDDEN", + "name": "HIDDEN" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMessage": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID of a message.

" + } + }, + "Content": { + "target": "com.amazonaws.chimesdkmessaging#Content", + "traits": { + "smithy.api#documentation": "

The message content.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkmessaging#Metadata", + "traits": { + "smithy.api#documentation": "

The message metadata.

" + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageType", + "traits": { + "smithy.api#documentation": "

The message type.

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

The time at which the message was created.

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

The time at which a message was edited.

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

The time at which a message was updated.

" + } + }, + "Sender": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The message sender.

" + } + }, + "Redacted": { + "target": "com.amazonaws.chimesdkmessaging#NonNullableBoolean", + "traits": { + "smithy.api#documentation": "

Hides the content of a message.

" + } + }, + "Persistence": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessagePersistenceType", + "traits": { + "smithy.api#documentation": "

The persistence setting for a channel message.

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

The details of a message in a channel.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMessagePersistenceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PERSISTENT", + "name": "PERSISTENT" + }, + { + "value": "NON_PERSISTENT", + "name": "NON_PERSISTENT" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMessageSummary": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID of the message.

" + } + }, + "Content": { + "target": "com.amazonaws.chimesdkmessaging#Content", + "traits": { + "smithy.api#documentation": "

The content of the message.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkmessaging#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata of the message.

" + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageType", + "traits": { + "smithy.api#documentation": "

The type of message.

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

The time at which the message summary was created.

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

The time at which a message was last updated.

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

The time at which a message was last edited.

" + } + }, + "Sender": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The message sender.

" + } + }, + "Redacted": { + "target": "com.amazonaws.chimesdkmessaging#NonNullableBoolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a message was redacted.

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

Summary of the messages in a Channel.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMessageSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageSummary" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMessageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STANDARD", + "name": "STANDARD" + }, + { + "value": "CONTROL", + "name": "CONTROL" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNRESTRICTED", + "name": "UNRESTRICTED" + }, + { + "value": "RESTRICTED", + "name": "RESTRICTED" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#ChannelModeratedByAppInstanceUserSummary": { + "type": "structure", + "members": { + "ChannelSummary": { + "target": "com.amazonaws.chimesdkmessaging#ChannelSummary", + "traits": { + "smithy.api#documentation": "

Summary of the details of a Channel.

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

Summary of the details of a moderated channel.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelModeratedByAppInstanceUserSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelModeratedByAppInstanceUserSummary" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelModerator": { + "type": "structure", + "members": { + "Moderator": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The moderator's data.

" + } + }, + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the moderator's channel.

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

The time at which the moderator was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The AppInstanceUser who created the moderator.

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

The details of a channel moderator.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelModeratorSummary": { + "type": "structure", + "members": { + "Moderator": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The data for a moderator.

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

Summary of the details of a ChannelModerator.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelModeratorSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelModeratorSummary" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelPrivacy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PUBLIC", + "name": "PUBLIC" + }, + { + "value": "PRIVATE", + "name": "PRIVATE" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#ChannelSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel.

" + } + }, + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + }, + "Mode": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMode", + "traits": { + "smithy.api#documentation": "

The mode of the channel.

" + } + }, + "Privacy": { + "target": "com.amazonaws.chimesdkmessaging#ChannelPrivacy", + "traits": { + "smithy.api#documentation": "

The privacy setting of the channel.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkmessaging#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata of the channel.

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

The time at which the last message in a channel was sent.

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

Summary of the details of a Channel.

" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelSummary" + } + }, + "com.amazonaws.chimesdkmessaging#ChimeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 1600 + }, + "smithy.api#pattern": "^arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}$" + } + }, + "com.amazonaws.chimesdkmessaging#ChimeMessagingService": { + "type": "service", + "version": "2021-05-15", + "operations": [ + { + "target": "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembership" + }, + { + "target": "com.amazonaws.chimesdkmessaging#CreateChannel" + }, + { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelBan" + }, + { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelMembership" + }, + { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelModerator" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannel" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelBan" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelMembership" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelMessage" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelModerator" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannel" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelBan" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembership" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipForAppInstanceUser" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelModeratedByAppInstanceUser" + }, + { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelModerator" + }, + { + "target": "com.amazonaws.chimesdkmessaging#GetChannelMessage" + }, + { + "target": "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpoint" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannelBans" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMemberships" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMembershipsForAppInstanceUser" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMessages" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannelModerators" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannels" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannelsModeratedByAppInstanceUser" + }, + { + "target": "com.amazonaws.chimesdkmessaging#RedactChannelMessage" + }, + { + "target": "com.amazonaws.chimesdkmessaging#SendChannelMessage" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannel" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelMessage" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelReadMarker" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Chime SDK Messaging", + "arnNamespace": "chime", + "cloudFormationName": "ChimeSDKMessaging", + "cloudTrailEventSource": "chimesdkmessaging.amazonaws.com", + "endpointPrefix": "messaging-chime" + }, + "aws.auth#sigv4": { + "name": "chime" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

The Amazon Chime SDK Messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK Identity APIs. For more information about the messaging\n APIs, see .

", + "smithy.api#title": "Amazon Chime SDK Messaging" + } + }, + "com.amazonaws.chimesdkmessaging#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[-_a-zA-Z0-9]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#ConflictException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.chimesdkmessaging#Content": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a channel to which you can add users and send messages.

\n\n

\n Restriction: You can't change a channel's\n privacy.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/channels", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelBan": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelBanRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelBanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

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 DeleteChannelBan, and then\n CreateChannelMembership. Bans are cleaned up when you delete users or\n channels.

\n

If you ban a user who is already part of a channel, that user is automatically kicked\n from the channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/channels/{ChannelArn}/bans", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelBanRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the ban request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the member being banned.

", + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelBanResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the response to the ban request.

" + } + }, + "Member": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The ChannelArn and BannedIdentity of the member in the ban\n response.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelMembershipRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a user to a channel. The InvitedBy response field is derived from the\n request header. A channel member can:

\n\n
    \n
  • \n

    List messages

    \n
    • \n
  • \n

    Send messages

    \n
    • \n
  • \n

    Receive messages

    \n
    • \n
  • \n

    Edit their own messages

    \n
    • \n
  • \n

    Leave the channel

    \n
    • \n
\n\n

Privacy settings impact this action as follows:

\n\n
    \n
  • \n

    Public Channels: You do not need to be a member to list messages, but you must be\n a member to send messages.

    \n
    • \n
  • \n

    Private Channels: You must be a member to list or send messages.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/channels/{ChannelArn}/memberships", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelMembershipRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel to which you're adding users.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the member you want to add to the channel.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipType", + "traits": { + "smithy.api#documentation": "

The membership type of a user, DEFAULT or HIDDEN. Default\n members are always returned as part of ListChannelMemberships. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN. Otherwise hidden members are not returned. This is only supported\n by moderators.

", + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelMembershipResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + }, + "Member": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The ARN and metadata of the member being added.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelModerator": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelModeratorRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelModeratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new ChannelModerator. A channel moderator can:

\n\n
    \n
  • \n

    Add and remove other members of the channel.

    \n
    • \n
  • \n

    Add and remove other moderators of the channel.

    \n
    • \n
  • \n

    Add and remove user bans for the channel.

    \n
    • \n
  • \n

    Redact messages in the channel.

    \n
    • \n
  • \n

    List messages in the channel.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/channels/{ChannelArn}/moderators", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelModeratorRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelModeratorArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the moderator.

", + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelModeratorResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + }, + "ChannelModerator": { + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The ARNs of the channel and the moderator.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel request.

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

The name of the channel.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMode", + "traits": { + "smithy.api#documentation": "

The channel mode: UNRESTRICTED or RESTRICTED. 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.

" + } + }, + "Privacy": { + "target": "com.amazonaws.chimesdkmessaging#ChannelPrivacy", + "traits": { + "smithy.api#documentation": "

The channel's privacy level: PUBLIC or PRIVATE. Private\n channels aren't discoverable by users outside the channel. Public channels are discoverable\n by anyone in the AppInstance.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkmessaging#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata of the creation request. Limited to 1KB and UTF-8.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkmessaging#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

The client token for the request. An Idempotency token.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.chimesdkmessaging#TagList", + "traits": { + "smithy.api#documentation": "

The tags for the creation request.

" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Immediately makes a channel and its memberships inaccessible and marks them for\n deletion. This is an irreversible process.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/channels/{ChannelArn}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelBan": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelBanRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a user from a channel's ban list.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/channels/{ChannelArn}/bans/{MemberArn}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelBanRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel from which the AppInstanceUser was banned.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceUser that you want to reinstate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelMembershipRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a member from a channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/channels/{ChannelArn}/memberships/{MemberArn}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelMembershipRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel from which you want to remove the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the member that you're removing from the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelMessageRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

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 UpdateChannelMessage.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/channels/{ChannelArn}/messages/{MessageId}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelMessageRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID of the message being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelModerator": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelModeratorRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a channel moderator.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "DELETE", + "uri": "/channels/{ChannelArn}/moderators/{ChannelModeratorArn}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelModeratorRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelModeratorArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the moderator being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DeleteChannelRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the full details of a channel in an Amazon Chime\n AppInstance.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelBan": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelBanRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelBanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the full details of a channel ban.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/bans/{MemberArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelBanRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel from which the user is banned.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the member being banned.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelBanResponse": { + "type": "structure", + "members": { + "ChannelBan": { + "target": "com.amazonaws.chimesdkmessaging#ChannelBan", + "traits": { + "smithy.api#documentation": "

The details of the ban.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the full details of a user's channel membership.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/memberships/{MemberArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipForAppInstanceUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipForAppInstanceUserRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipForAppInstanceUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the details of a channel based on the membership of the specified\n AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}?scope=app-instance-user-membership", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipForAppInstanceUserRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel to which the user belongs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the user in a channel.

", + "smithy.api#httpQuery": "app-instance-user-arn", + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipForAppInstanceUserResponse": { + "type": "structure", + "members": { + "ChannelMembership": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipForAppInstanceUserSummary", + "traits": { + "smithy.api#documentation": "

The channel to which a user belongs.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the member.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipResponse": { + "type": "structure", + "members": { + "ChannelMembership": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembership", + "traits": { + "smithy.api#documentation": "

The details of the membership.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelModeratedByAppInstanceUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelModeratedByAppInstanceUserRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelModeratedByAppInstanceUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the full details of a channel moderated by the specified\n AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}?scope=app-instance-user-moderated-channel", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelModeratedByAppInstanceUserRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the moderated channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceUser in the moderated channel.

", + "smithy.api#httpQuery": "app-instance-user-arn", + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelModeratedByAppInstanceUserResponse": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.chimesdkmessaging#ChannelModeratedByAppInstanceUserSummary", + "traits": { + "smithy.api#documentation": "

The moderated channel.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelModerator": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelModeratorRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelModeratorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the full details of a single ChannelModerator.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/moderators/{ChannelModeratorArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelModeratorRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelModeratorArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel moderator.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelModeratorResponse": { + "type": "structure", + "members": { + "ChannelModerator": { + "target": "com.amazonaws.chimesdkmessaging#ChannelModerator", + "traits": { + "smithy.api#documentation": "

The details of the channel moderator.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelResponse": { + "type": "structure", + "members": { + "Channel": { + "target": "com.amazonaws.chimesdkmessaging#Channel", + "traits": { + "smithy.api#documentation": "

The channel details.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BadRequest", + "name": "BadRequest" + }, + { + "value": "Conflict", + "name": "Conflict" + }, + { + "value": "Forbidden", + "name": "Forbidden" + }, + { + "value": "NotFound", + "name": "NotFound" + }, + { + "value": "PreconditionFailed", + "name": "PreconditionFailed" + }, + { + "value": "ResourceLimitExceeded", + "name": "ResourceLimitExceeded" + }, + { + "value": "ServiceFailure", + "name": "ServiceFailure" + }, + { + "value": "AccessDenied", + "name": "AccessDenied" + }, + { + "value": "ServiceUnavailable", + "name": "ServiceUnavailable" + }, + { + "value": "Throttled", + "name": "Throttled" + }, + { + "value": "Throttling", + "name": "Throttling" + }, + { + "value": "Unauthorized", + "name": "Unauthorized" + }, + { + "value": "Unprocessable", + "name": "Unprocessable" + }, + { + "value": "VoiceConnectorGroupAssociationsExist", + "name": "VoiceConnectorGroupAssociationsExist" + }, + { + "value": "PhoneNumberAssociationsExist", + "name": "PhoneNumberAssociationsExist" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#ForbiddenException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

The client is permanently forbidden from making the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.chimesdkmessaging#GetChannelMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#GetChannelMessageRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#GetChannelMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the full details of a channel message.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/messages/{MessageId}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#GetChannelMessageRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID of the message.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#GetChannelMessageResponse": { + "type": "structure", + "members": { + "ChannelMessage": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessage", + "traits": { + "smithy.api#documentation": "

The details of and content in the message.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

The details of the endpoint for the messaging session.

", + "smithy.api#http": { + "method": "GET", + "uri": "/endpoints/messaging-session", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointResponse": { + "type": "structure", + "members": { + "Endpoint": { + "target": "com.amazonaws.chimesdkmessaging#MessagingSessionEndpoint", + "traits": { + "smithy.api#documentation": "

The endpoint returned in the response.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#Identity": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN in an Identity.

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

The name in an Identity.

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

The details of a user.

" + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelBans": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelBansRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelBansResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the users banned from a particular channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/bans", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelBansRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of bans that you want returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token passed by previous API calls until all requested bans are returned.

", + "smithy.api#httpQuery": "next-token" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelBansResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

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

The token passed by previous API calls until all requested bans are returned.

" + } + }, + "ChannelBans": { + "target": "com.amazonaws.chimesdkmessaging#ChannelBanSummaryList", + "traits": { + "smithy.api#documentation": "

The information for each requested ban.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMemberships": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMembershipsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMembershipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all channel memberships in a channel.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/memberships", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMembershipsForAppInstanceUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMembershipsForAppInstanceUserRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMembershipsForAppInstanceUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all channels that a particular AppInstanceUser is a part of. Only an\n AppInstanceAdmin can call the API with a user ARN that is not their own.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels?scope=app-instance-user-memberships", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMembershipsForAppInstanceUserRequest": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstanceUsers

", + "smithy.api#httpQuery": "app-instance-user-arn" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of users that you want returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from previous API requests until the number of channel memberships is\n reached.

", + "smithy.api#httpQuery": "next-token" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMembershipsForAppInstanceUserResponse": { + "type": "structure", + "members": { + "ChannelMemberships": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipForAppInstanceUserSummaryList", + "traits": { + "smithy.api#documentation": "

The token passed by previous API calls until all requested users are returned.

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

The token passed by previous API calls until all requested users are returned.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMembershipsRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The maximum number of channel memberships that you want returned.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipType", + "traits": { + "smithy.api#documentation": "

The membership type of a user, DEFAULT or HIDDEN. Default\n members are always returned as part of ListChannelMemberships. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN. Otherwise hidden members are not returned.

", + "smithy.api#httpQuery": "type" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of channel memberships that you want returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token passed by previous API calls until all requested channel memberships are\n returned.

", + "smithy.api#httpQuery": "next-token" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMembershipsResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + }, + "ChannelMemberships": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipSummaryList", + "traits": { + "smithy.api#documentation": "

The information for the requested channel memberships.

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

The token passed by previous API calls until all requested channel memberships are\n returned.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMessages": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMessagesRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelMessagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

List all the messages in a channel. Returns a paginated list of\n ChannelMessages. By default, sorted by creation timestamp in descending\n order.

\n \n

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.

\n

Also, the x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/messages", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMessagesRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SortOrder": { + "target": "com.amazonaws.chimesdkmessaging#SortOrder", + "traits": { + "smithy.api#documentation": "

The order in which you want messages sorted. Default is Descending, based on time\n created.

", + "smithy.api#httpQuery": "sort-order" + } + }, + "NotBefore": { + "target": "com.amazonaws.chimesdkmessaging#Timestamp", + "traits": { + "smithy.api#documentation": "

The initial or starting time stamp for your requested messages.

", + "smithy.api#httpQuery": "not-before" + } + }, + "NotAfter": { + "target": "com.amazonaws.chimesdkmessaging#Timestamp", + "traits": { + "smithy.api#documentation": "

The final or ending time stamp for your requested messages.

", + "smithy.api#httpQuery": "not-after" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of messages that you want returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token passed by previous API calls until all requested messages are returned.

", + "smithy.api#httpQuery": "next-token" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMessagesResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel containing the requested messages.

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

The token passed by previous API calls until all requested messages are returned.

" + } + }, + "ChannelMessages": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageSummaryList", + "traits": { + "smithy.api#documentation": "

The information about, and content of, each requested message.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelModerators": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelModeratorsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelModeratorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the moderators for a channel.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels/{ChannelArn}/moderators", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelModeratorsRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of moderators that you want returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token passed by previous API calls until all requested moderators are\n returned.

", + "smithy.api#httpQuery": "next-token" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelModeratorsResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

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

The token passed by previous API calls until all requested moderators are\n returned.

" + } + }, + "ChannelModerators": { + "target": "com.amazonaws.chimesdkmessaging#ChannelModeratorSummaryList", + "traits": { + "smithy.api#documentation": "

The information about and names of each moderator.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all Channels created under a single Chime App as a paginated list. You can specify\n filters to narrow results.

\n\n

\n Functionality & restrictions\n

\n
    \n
  • \n

    Use privacy = PUBLIC to retrieve all public channels in the\n account.

    \n
    • \n
  • \n

    Only an AppInstanceAdmin can set privacy = PRIVATE to\n list the private channels in an account.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelsModeratedByAppInstanceUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelsModeratedByAppInstanceUserRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelsModeratedByAppInstanceUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

A list of the channels moderated by an AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/channels?scope=app-instance-user-moderated-channels", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelsModeratedByAppInstanceUserRequest": { + "type": "structure", + "members": { + "AppInstanceUserArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the user in the moderated channel.

", + "smithy.api#httpQuery": "app-instance-user-arn" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of channels in the request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from previous API requests until the number of channels moderated by\n the user is reached.

", + "smithy.api#httpQuery": "next-token" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelsModeratedByAppInstanceUserResponse": { + "type": "structure", + "members": { + "Channels": { + "target": "com.amazonaws.chimesdkmessaging#ChannelModeratedByAppInstanceUserSummaryList", + "traits": { + "smithy.api#documentation": "

The moderated channels in the request.

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

The token returned from previous API requests until the number of channels moderated by\n the user is reached.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelsRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the AppInstance.

", + "smithy.api#httpQuery": "app-instance-arn", + "smithy.api#required": {} + } + }, + "Privacy": { + "target": "com.amazonaws.chimesdkmessaging#ChannelPrivacy", + "traits": { + "smithy.api#documentation": "

The privacy setting. PUBLIC retrieves all the public channels.\n PRIVATE retrieves private channels. Only an AppInstanceAdmin\n can retrieve private channels.

", + "smithy.api#httpQuery": "privacy" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of channels that you want to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token passed by previous API calls until all requested channels are returned.

", + "smithy.api#httpQuery": "next-token" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "target": "com.amazonaws.chimesdkmessaging#ChannelSummaryList", + "traits": { + "smithy.api#documentation": "

The information about each channel.

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

The token returned from previous API requests until the number of channels is\n reached.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.chimesdkmessaging#MemberArns": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.chimesdkmessaging#Members": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#Identity" + } + }, + "com.amazonaws.chimesdkmessaging#MessageId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[-_a-zA-Z0-9]*$" + } + }, + "com.amazonaws.chimesdkmessaging#MessagingSessionEndpoint": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.chimesdkmessaging#UrlType", + "traits": { + "smithy.api#documentation": "

The endpoint to which you establish a websocket connection.

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

The websocket endpoint used to connect to Amazon Chime SDK messaging.

" + } + }, + "com.amazonaws.chimesdkmessaging#Metadata": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#NonEmptyContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#NonEmptyResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#NonNullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.chimesdkmessaging#NotFoundException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

One or more of the resources in the request does not exist in the system.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.chimesdkmessaging#RedactChannelMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#RedactChannelMessageRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#RedactChannelMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

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.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/channels/{ChannelArn}/messages/{MessageId}?operation=redact", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#RedactChannelMessageRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel containing the messages that you want to redact.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID of the message being redacted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#RedactChannelMessageResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel containing the messages that you want to redact.

" + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID of the message being redacted.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ResourceLimitExceededException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request exceeds the resource limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chimesdkmessaging#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#SendChannelMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#SendChannelMessageRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#SendChannelMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends a message to a particular channel that the member is a part of.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n\n

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata.\n CONTROL messages can contain 30 bytes of data and no metadata.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/channels/{ChannelArn}/messages", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmessaging#SendChannelMessageRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyContent", + "traits": { + "smithy.api#documentation": "

The content of the message.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageType", + "traits": { + "smithy.api#documentation": "

The type of message, STANDARD or CONTROL.

", + "smithy.api#required": {} + } + }, + "Persistence": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessagePersistenceType", + "traits": { + "smithy.api#documentation": "

Boolean that controls whether the message is persisted on the back end. Required.

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

The optional metadata for each message.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkmessaging#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

The Idempotency token for each client request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#SendChannelMessageResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID string assigned to each message.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ServiceFailureException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

The service encountered an unexpected error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chimesdkmessaging#ServiceUnavailableException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

The service is currently unavailable.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.chimesdkmessaging#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASCENDING", + "name": "ASCENDING" + }, + { + "value": "DESCENDING", + "name": "DESCENDING" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#String": { + "type": "string" + }, + "com.amazonaws.chimesdkmessaging#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.chimesdkmessaging#TagKey", + "traits": { + "smithy.api#documentation": "

The key of the tag.

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

The value of the tag.

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

Describes a tag applied to a resource.

" + } + }, + "com.amazonaws.chimesdkmessaging#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.chimesdkmessaging#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#ThrottledClientException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

The client exceeded its request rate limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.chimesdkmessaging#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.chimesdkmessaging#UnauthorizedClientException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "

The client is not currently authorized to make the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a channel's attributes.

\n

\n Restriction: You can't change a channel's privacy.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/channels/{ChannelArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelMessageRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the content of a message.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/channels/{ChannelArn}/messages/{MessageId}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelMessageRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID string of the message being updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.chimesdkmessaging#Content", + "traits": { + "smithy.api#documentation": "

The content of the message being updated.

" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkmessaging#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata of the message being updated.

" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelMessageResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "

The ID string of the message being updated.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelReadMarker": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelReadMarkerRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelReadMarkerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

The details of the time when a user last read messages in a channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/channels/{ChannelArn}/readMarker", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelReadMarkerRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelReadMarkerResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelRequest": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMode", + "traits": { + "smithy.api#documentation": "

The mode of the update request.

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

The metadata for the update request.

" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user that makes the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The ARN of the channel.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#UrlType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + } + } +} diff --git a/aws/sdk/aws-models/chime.json b/aws/sdk/aws-models/chime.json index d4e3e5869e..78f89d7e40 100644 --- a/aws/sdk/aws-models/chime.json +++ b/aws/sdk/aws-models/chime.json @@ -871,7 +871,10 @@ "type": "structure", "members": { "InvitedBy": { - "target": "com.amazonaws.chime#Identity" + "target": "com.amazonaws.chime#Identity", + "traits": { + "smithy.api#documentation": "

The identifier of the member who invited another member.

" + } }, "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", @@ -893,7 +896,7 @@ } }, "traits": { - "smithy.api#documentation": "

The membership information, including member ARNs, the channel ARN, and membership types.

" + "smithy.api#documentation": "

The membership information, including member ARNs, the channel ARN, and membership\n types.

" } }, "com.amazonaws.chime#BatchCreateAttendee": { @@ -1011,7 +1014,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a specified number of users to a channel.

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

Adds a specified number of users to a channel.

", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -1068,7 +1071,7 @@ "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", "traits": { - "smithy.api#documentation": "

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of \n ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals \n HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

" + "smithy.api#documentation": "

The membership type of a user, DEFAULT or HIDDEN. Default\n members are always returned as part of ListChannelMemberships. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN. Otherwise hidden members are not returned. This is only supported\n by moderators.

" } }, "MemberArns": { @@ -1099,7 +1102,7 @@ "Errors": { "target": "com.amazonaws.chime#BatchCreateChannelMembershipErrors", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } } @@ -1846,10 +1849,7 @@ "target": "com.amazonaws.chime#ChannelSummary" }, "AppInstanceUserMembershipSummary": { - "target": "com.amazonaws.chime#AppInstanceUserMembershipSummary", - "traits": { - "smithy.api#documentation": "

Returns the channel membership data for an AppInstance.

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

Summary of the details of a Channel.

" + } } }, "traits": { @@ -2264,7 +2267,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource.

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

The request could not be processed because of conflict in the current state of the\n resource.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2907,7 +2910,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a channel to which you can add users and send messages.

\n\n

\n Restriction: You can't change a channel's privacy.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Creates a channel to which you can add users and send messages.

\n\n

\n Restriction: You can't change a channel's\n privacy.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -2953,7 +2956,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 DeleteChannelBan, and then\n CreateChannelMembership. Bans are cleaned up when you delete users or\n channels.

\n

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

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 DeleteChannelBan, and then\n CreateChannelMembership. Bans are cleaned up when you delete users or\n channels.

\n

If you ban a user who is already part of a channel, that user is automatically kicked\n from the channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -3003,7 +3006,7 @@ "Member": { "target": "com.amazonaws.chime#Identity", "traits": { - "smithy.api#documentation": "

The ChannelArn and BannedIdentity of the member in the ban response.

" + "smithy.api#documentation": "

The ChannelArn and BannedIdentity of the member in the ban\n response.

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

Adds a user to a channel. The InvitedBy response field is derived from the\n request header. A channel member can:

\n\n
    \n
  • \n

    List messages

    \n
    • \n
  • \n

    Send messages

    \n
    • \n
  • \n

    Receive messages

    \n
    • \n
  • \n

    Edit their own messages

    \n
    • \n
  • \n

    Leave the channel

    \n
    • \n
\n\n

Privacy settings impact this action as follows:

\n\n
    \n
  • \n

    Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

    \n
    • \n
  • \n

    Private Channels: You must be a member to list or send messages.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Adds a user to a channel. The InvitedBy response field is derived from the\n request header. A channel member can:

\n\n
    \n
  • \n

    List messages

    \n
    • \n
  • \n

    Send messages

    \n
    • \n
  • \n

    Receive messages

    \n
    • \n
  • \n

    Edit their own messages

    \n
    • \n
  • \n

    Leave the channel

    \n
    • \n
\n\n

Privacy settings impact this action as follows:

\n\n
    \n
  • \n

    Public Channels: You do not need to be a member to list messages, but you must be\n a member to send messages.

    \n
    • \n
  • \n

    Private Channels: You must be a member to list or send messages.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -3075,7 +3078,7 @@ "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", "traits": { - "smithy.api#documentation": "

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of \nListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals \nHIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

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

The membership type of a user, DEFAULT or HIDDEN. Default\n members are always returned as part of ListChannelMemberships. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN. Otherwise hidden members are not returned. This is only supported\n by moderators.

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

Creates a new ChannelModerator. A channel moderator can:

\n\n
    \n
  • \n

    Add and remove other members of the channel.

    \n
    • \n
  • \n

    Add and remove other moderators of the channel.

    \n
    • \n
  • \n

    Add and remove user bans for the channel.

    \n
    • \n
  • \n

    Redact messages in the channel.

    \n
    • \n
  • \n

    List messages in the channel.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Creates a new ChannelModerator. A channel moderator can:

\n\n
    \n
  • \n

    Add and remove other members of the channel.

    \n
    • \n
  • \n

    Add and remove other moderators of the channel.

    \n
    • \n
  • \n

    Add and remove user bans for the channel.

    \n
    • \n
  • \n

    Redact messages in the channel.

    \n
    • \n
  • \n

    List messages in the channel.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -3215,13 +3218,13 @@ "Mode": { "target": "com.amazonaws.chime#ChannelMode", "traits": { - "smithy.api#documentation": "

The channel mode: UNRESTRICTED or RESTRICTED. 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.

" + "smithy.api#documentation": "

The channel mode: UNRESTRICTED or RESTRICTED. 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.

" } }, "Privacy": { "target": "com.amazonaws.chime#ChannelPrivacy", "traits": { - "smithy.api#documentation": "

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. \n Public channels are discoverable by anyone in the AppInstance.

" + "smithy.api#documentation": "

The channel's privacy level: PUBLIC or PRIVATE. Private\n channels aren't discoverable by users outside the channel. Public channels are discoverable\n by anyone in the AppInstance.

" } }, "Metadata": { @@ -4919,7 +4922,7 @@ } ], "traits": { - "smithy.api#documentation": "

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Immediately makes a channel and its memberships inaccessible and marks them for\n deletion. This is an irreversible process.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -4956,7 +4959,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a user from a channel's ban list.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Removes a user from a channel's ban list.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -5024,7 +5027,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes a member from a channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Removes a member from a channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -5089,7 +5092,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 UpdateChannelMessage.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

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 UpdateChannelMessage.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -5154,7 +5157,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a channel moderator.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Deletes a channel moderator.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -6284,7 +6287,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nReturns the full details of an \nAppInstanceUser\n.\n

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

Returns the full details of an AppInstanceUser.

", "smithy.api#endpoint": { "hostPrefix": "identity-" }, @@ -6348,7 +6351,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the full details of a channel in an Amazon Chime AppInstance.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Returns the full details of a channel in an Amazon Chime\n AppInstance.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -6391,7 +6394,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the full details of a channel ban.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Returns the full details of a channel ban.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -6473,7 +6476,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the full details of a user's channel membership.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Returns the full details of a user's channel membership.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -6513,7 +6516,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nReturns the details of a channel based on the membership of the specified AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Returns the details of a channel based on the membership of the specified\n AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -6631,7 +6634,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the full details of a channel moderated by the specified AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Returns the full details of a channel moderated by the specified\n AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -6713,7 +6716,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the full details of a single ChannelModerator.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Returns the full details of a single ChannelModerator.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -7151,7 +7154,7 @@ "Region": { "target": "com.amazonaws.chime#TranscribeMedicalRegion", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.

" } } }, @@ -7190,7 +7193,7 @@ "Region": { "target": "com.amazonaws.chime#TranscribeRegion", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

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

Gets the full details of a channel message.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the \n value in the header.

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

Gets the full details of a channel message.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -9905,7 +9908,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nList all \nAppInstanceUsers\ncreated under a single AppInstance.\n

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

List all AppInstanceUsers\n created under a single AppInstance.\n

", "smithy.api#endpoint": { "hostPrefix": "identity-" }, @@ -10331,7 +10334,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the users banned from a particular channel.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Lists all the users banned from a particular channel.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -10433,7 +10436,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all channel memberships in a channel.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Lists all channel memberships in a channel.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -10478,7 +10481,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all channels that a particular AppInstanceUser is a part of. Only an\n AppInstanceAdmin can call the API with a user ARN that is not their\n own.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Lists all channels that a particular AppInstanceUser is a part of. Only an\n AppInstanceAdmin can call the API with a user ARN that is not their own.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -10558,7 +10561,7 @@ "Type": { "target": "com.amazonaws.chime#ChannelMembershipType", "traits": { - "smithy.api#documentation": "

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of \n ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals \n HIDDEN. Otherwise hidden members are not returned.

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

The membership type of a user, DEFAULT or HIDDEN. Default\n members are always returned as part of ListChannelMemberships. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN. Otherwise hidden members are not returned.

", "smithy.api#httpQuery": "type" } }, @@ -10572,7 +10575,7 @@ "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { - "smithy.api#documentation": "

The token passed by previous API calls until all requested channel memberships are returned.

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

The token passed by previous API calls until all requested channel memberships are\n returned.

", "smithy.api#httpQuery": "next-token" } }, @@ -10603,7 +10606,7 @@ "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { - "smithy.api#documentation": "

The token passed by previous API calls until all requested channel memberships are returned.

" + "smithy.api#documentation": "

The token passed by previous API calls until all requested channel memberships are\n returned.

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

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

\n \n

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.

\n

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the \n value in the header.

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

List all the messages in a channel. Returns a paginated list of\n ChannelMessages. By default, sorted by creation timestamp in descending\n order.

\n \n

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.

\n

Also, the x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -10667,7 +10670,7 @@ "SortOrder": { "target": "com.amazonaws.chime#SortOrder", "traits": { - "smithy.api#documentation": "

The order in which you want messages sorted. Default is Descending, based on time created.

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

The order in which you want messages sorted. Default is Descending, based on time\n created.

", "smithy.api#httpQuery": "sort-order" } }, @@ -10760,7 +10763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the moderators for a channel.

\n\n \n\n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Lists all the moderators for a channel.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -10797,7 +10800,7 @@ "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { - "smithy.api#documentation": "

The token passed by previous API calls until all requested moderators are returned.

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

The token passed by previous API calls until all requested moderators are\n returned.

", "smithy.api#httpQuery": "next-token" } }, @@ -10822,7 +10825,7 @@ "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { - "smithy.api#documentation": "

The token passed by previous API calls until all requested moderators are returned.

" + "smithy.api#documentation": "

The token passed by previous API calls until all requested moderators are\n returned.

" } }, "ChannelModerators": { @@ -10862,7 +10865,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

\n\n

\n Functionality & restrictions\n

\n
    \n
  • \n

    Use privacy = PUBLIC to retrieve all public channels in the account.

    \n
    • \n
  • \n

    Only an AppInstanceAdmin can set privacy = PRIVATE to list the\n private channels in an account.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Lists all Channels created under a single Chime App as a paginated list. You can specify\n filters to narrow results.

\n\n

\n Functionality & restrictions\n

\n
    \n
  • \n

    Use privacy = PUBLIC to retrieve all public channels in the\n account.

    \n
    • \n
  • \n

    Only an AppInstanceAdmin can set privacy = PRIVATE to\n list the private channels in an account.

    \n
    • \n
\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -10907,7 +10910,7 @@ } ], "traits": { - "smithy.api#documentation": "

A list of the channels moderated by an AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

A list of the channels moderated by an AppInstanceUser.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -10943,7 +10946,7 @@ "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { - "smithy.api#documentation": "

The token returned from previous API requests until the number of channels moderated by the user is reached.

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

The token returned from previous API requests until the number of channels moderated by\n the user is reached.

", "smithy.api#httpQuery": "next-token" } }, @@ -10968,7 +10971,7 @@ "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { - "smithy.api#documentation": "

The token returned from previous API requests until the number of channels moderated by the user is reached.

" + "smithy.api#documentation": "

The token returned from previous API requests until the number of channels moderated by\n the user is reached.

" } } } @@ -10987,7 +10990,7 @@ "Privacy": { "target": "com.amazonaws.chime#ChannelPrivacy", "traits": { - "smithy.api#documentation": "

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an \n AppInstanceAdmin can retrieve private channels.\n

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

The privacy setting. PUBLIC retrieves all the public channels.\n PRIVATE retrieves private channels. Only an AppInstanceAdmin\n can retrieve private channels.

", "smithy.api#httpQuery": "privacy" } }, @@ -11026,7 +11029,7 @@ "NextToken": { "target": "com.amazonaws.chime#NextToken", "traits": { - "smithy.api#documentation": "

The token returned from previous API requests until the number of channels is reached.

" + "smithy.api#documentation": "

The token returned from previous API requests until the number of channels is\n reached.

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

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.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

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.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -15457,7 +15460,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a message to a particular channel that the member is a part of.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

\n\n

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of \n data and no metadata.

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

Sends a message to a particular channel that the member is a part of.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n\n

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata.\n CONTROL messages can contain 30 bytes of data and no metadata.

\n ", "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": "

The ARN of the AppInstance.

" + "smithy.api#documentation": "

The ARN of the AppInstance.

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

Update a channel's attributes.

\n

\n Restriction: You can't change a channel's privacy.\n

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Update a channel's attributes.

\n

\n Restriction: You can't change a channel's privacy.

\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -17917,7 +17928,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the content of a message.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

Updates the content of a message.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, @@ -18017,7 +18028,7 @@ } ], "traits": { - "smithy.api#documentation": "

The details of the time when a user last read messages in a channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes \n the API call as the value in the header.

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

The details of the time when a user last read messages in a channel.

\n\n \n

The x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.

\n ", "smithy.api#endpoint": { "hostPrefix": "messaging-" }, diff --git a/aws/sdk/aws-models/cloud9.json b/aws/sdk/aws-models/cloud9.json index 0c85dbf66d..069e0d2d89 100644 --- a/aws/sdk/aws-models/cloud9.json +++ b/aws/sdk/aws-models/cloud9.json @@ -285,6 +285,12 @@ "traits": { "smithy.api#documentation": "

The connection type used for connecting to an Amazon EC2 environment. Valid values are\n CONNECT_SSH (default) and CONNECT_SSM (connected through\n Amazon EC2 Systems Manager).

\n

For more information, see Accessing no-ingress EC2 instances with\n Amazon EC2 Systems Manager in the Cloud9 User Guide.

" } + }, + "dryRun": { + "target": "com.amazonaws.cloud9#NullableBoolean", + "traits": { + "smithy.api#documentation": "

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

Any new or replacement description for the environment.

" } + }, + "managedCredentialsAction": { + "target": "com.amazonaws.cloud9#ManagedCredentialsAction", + "traits": { + "smithy.api#documentation": "

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:

\n
    \n
  • \n

    \n ENABLE\n

    \n
    • \n
  • \n

    \n DISABLE\n

    \n
    • \n
\n \n

Only the environment owner can change the status of managed temporary credentials. An AccessDeniedException 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.

\n " + } } } }, diff --git a/aws/sdk/aws-models/clouddirectory.json b/aws/sdk/aws-models/clouddirectory.json index 5d61cca396..351dbafe88 100644 --- a/aws/sdk/aws-models/clouddirectory.json +++ b/aws/sdk/aws-models/clouddirectory.json @@ -37,7 +37,7 @@ } }, "traits": { - "smithy.api#documentation": "

Access denied. Check your permissions.

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

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

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

The pagination token.

" + } }, "MaxResults": { - "target": "com.amazonaws.clouddirectory#NumberResults" + "target": "com.amazonaws.clouddirectory#NumberResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to be retrieved in a single call. This is an approximate\n number.

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

Lists parent objects that are associated with a given object in pagination\n fashion.

" } }, "com.amazonaws.clouddirectory#BatchListObjectParentsResponse": { "type": "structure", "members": { "ParentLinks": { - "target": "com.amazonaws.clouddirectory#ObjectIdentifierAndLinkNameList" + "target": "com.amazonaws.clouddirectory#ObjectIdentifierAndLinkNameList", + "traits": { + "smithy.api#documentation": "

Returns a list of parent reference and LinkName Tuples.

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

The pagination token.

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

Represents the output of a ListObjectParents response operation.

" } }, "com.amazonaws.clouddirectory#BatchListObjectPolicies": { @@ -2174,7 +2192,10 @@ } }, "ListObjectParents": { - "target": "com.amazonaws.clouddirectory#BatchListObjectParents" + "target": "com.amazonaws.clouddirectory#BatchListObjectParents", + "traits": { + "smithy.api#documentation": "

Lists parent objects that are associated with a given object in pagination\n fashion.

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

The list of parent objects to retrieve.

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

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 Access Objects. You can identify an object in one of the following ways:

\n
    \n
  • \n

    \n $ObjectIdentifier - 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

    \n
    • \n
  • \n

    \n /some/path - Identifies the object based on path

    \n
    • \n
  • \n

    \n #SomeBatchReference - Identifies the object in a batch call

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

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 Access Objects. You can identify an object in one of the following ways:

\n
    \n
  • \n

    \n $ObjectIdentifier - 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.

    \n
    • \n
  • \n

    \n /some/path - Identifies the object based on path

    \n
    • \n
  • \n

    \n #SomeBatchReference - Identifies the object in a batch call

    \n
    • \n
" } } }, @@ -8334,13 +8358,13 @@ "SchemaArn": { "target": "com.amazonaws.clouddirectory#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions.

" + "smithy.api#documentation": "

The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions.\n If this value is set, FacetName must also be set.

" } }, "FacetName": { "target": "com.amazonaws.clouddirectory#FacetName", "traits": { - "smithy.api#documentation": "

The name of the facet.

" + "smithy.api#documentation": "

The name of the facet. If this value is set, SchemaArn must also be set.

" } } }, diff --git a/aws/sdk/aws-models/codebuild.json b/aws/sdk/aws-models/codebuild.json index e514a8e41b..4374ff59b7 100644 --- a/aws/sdk/aws-models/codebuild.json +++ b/aws/sdk/aws-models/codebuild.json @@ -37,7 +37,7 @@ } }, "traits": { - "smithy.api#documentation": "

An AWS service limit was exceeded for the calling AWS account.

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

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

", "smithy.api#error": "client" } }, @@ -270,7 +270,7 @@ "names": { "target": "com.amazonaws.codebuild#ProjectNames", "traits": { - "smithy.api#documentation": "

The names or ARNs of the build projects. To get information about a project shared\n with your AWS account, its ARN must be specified. You cannot specify a shared project\n using its name.

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

The names or ARNs of the build projects. To get information about a project shared\n with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project\n using its name.

", "smithy.api#required": {} } } @@ -397,7 +397,7 @@ "computeTypesAllowed": { "target": "com.amazonaws.codebuild#ComputeTypesAllowed", "traits": { - "smithy.api#documentation": "

An array of strings that specify the compute types that are allowed for the batch\n build. See Build environment\n compute types in the AWS CodeBuild User Guide for these values.\n

" + "smithy.api#documentation": "

An array of strings that specify the compute types that are allowed for the batch\n build. See Build environment\n compute types in the CodeBuild User Guide for these values.\n

" } } }, @@ -411,7 +411,7 @@ "com.amazonaws.codebuild#BucketOwnerAccess": { "type": "string", "traits": { - "smithy.api#documentation": "

Specifies the access for objects that are uploaded to an Amazon S3 bucket that is owned by\n another account.

\n

By default, only the account that uploads the objects to the bucket has access to\n these objects. This property allows you to give the bucket owner access to these\n objects.

\n
\n
NONE
\n
\n

The bucket owner does not have access to the objects. This is the\n default.

\n
\n
READ_ONLY
\n
\n

The bucket owner has read only access to the objects. The uploading account\n retains ownership of the objects.

\n
\n
FULL
\n
\n

The bucket owner has full access to the objects. Object ownership is determined\n by the following criteria:

\n
    \n
  • \n

    If the bucket is configured with the Bucket\n owner preferred setting, the bucket owner owns the\n objects. The uploading account will have object access as specified\n by the bucket's policy.

    \n
    • \n
  • \n

    Otherwise, the uploading account retains ownership of the\n objects.

    \n
    • \n
\n

For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3\n Object Ownership in the Amazon Simple Storage Service User\n Guide.

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

Specifies the bucket owner's access for objects that another account uploads to their\n Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has\n access to these objects. This property allows you to give the bucket owner access to\n these objects.

\n \n

To use this property, your CodeBuild service role must have the\n s3:PutBucketAcl permission. This permission allows CodeBuild to modify\n the access control list for the bucket.

\n \n

This property can be one of the following values:

\n
\n
NONE
\n
\n

The bucket owner does not have access to the objects. This is the\n default.

\n
\n
READ_ONLY
\n
\n

The bucket owner has read-only access to the objects. The uploading account\n retains ownership of the objects.

\n
\n
FULL
\n
\n

The bucket owner has full access to the objects. Object ownership is determined\n by the following criteria:

\n
    \n
  • \n

    If the bucket is configured with the Bucket\n owner preferred setting, the bucket owner owns the\n objects. The uploading account will have object access as specified\n by the bucket's policy.

    \n
    • \n
  • \n

    Otherwise, the uploading account retains ownership of the\n objects.

    \n
    • \n
\n

For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3\n Object Ownership in the Amazon Simple Storage Service User\n Guide.

\n
\n
", "smithy.api#enum": [ { "value": "NONE", @@ -476,19 +476,19 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

Any version identifier for the version of the source code to be built. If\n sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

Any version identifier for the version of the source code to be built. If\n sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide.

" } }, "resolvedSourceVersion": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

An identifier for the version of this build's source code.

\n
    \n
  • \n

    For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

    \n
    • \n
  • \n

    For AWS CodePipeline, the source revision provided by AWS CodePipeline.

    \n
    • \n
  • \n

    For Amazon S3, this does not apply.

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

An identifier for the version of this build's source code.

\n
    \n
  • \n

    For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

    \n
    • \n
  • \n

    For CodePipeline, the source revision provided by CodePipeline.

    \n
    • \n
  • \n

    For Amazon S3, this does not apply.

    \n
    • \n
" } }, "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

" + "smithy.api#documentation": "

The name of the CodeBuild project.

" } }, "phases": { @@ -512,7 +512,7 @@ "secondarySourceVersions": { "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n
    \n
  • \n

    For AWS CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example, pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

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

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n
    \n
  • \n

    For CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example, pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
" } }, "artifacts": { @@ -548,13 +548,13 @@ "logs": { "target": "com.amazonaws.codebuild#LogsLocation", "traits": { - "smithy.api#documentation": "

Information about the build's logs in Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

Information about the build's logs in CloudWatch Logs.

" } }, "timeoutInMinutes": { "target": "com.amazonaws.codebuild#WrapperInt", "traits": { - "smithy.api#documentation": "

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not\n get marked as completed.

" + "smithy.api#documentation": "

How long, in minutes, for CodeBuild to wait before timing out this build if it does not\n get marked as completed.

" } }, "queuedTimeoutInMinutes": { @@ -572,13 +572,13 @@ "initiator": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The entity that started the build. Valid values include:

\n
    \n
  • \n

    If AWS CodePipeline started the build, the pipeline's name (for example,\n codepipeline/my-demo-pipeline).

    \n
    • \n
  • \n

    If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example,\n MyUserName).

    \n
    • \n
  • \n

    If the Jenkins plugin for AWS CodeBuild started the build, the string\n CodeBuild-Jenkins-Plugin.

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

The entity that started the build. Valid values include:

\n
    \n
  • \n

    If CodePipeline started the build, the pipeline's name (for example,\n codepipeline/my-demo-pipeline).

    \n
    • \n
  • \n

    If an IAM user started the build, the user's name (for example,\n MyUserName).

    \n
    • \n
  • \n

    If the Jenkins plugin for CodeBuild started the build, the string\n CodeBuild-Jenkins-Plugin.

    \n
    • \n
" } }, "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter\n that identifies the VPC ID and the list of security group IDs and subnet IDs. The\n security groups and subnets must belong to the same VPC. You must provide at least one\n security group and one subnet ID.

" + "smithy.api#documentation": "

If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter\n that identifies the VPC ID and the list of security group IDs and subnet IDs. The\n security groups and subnets must belong to the same VPC. You must provide at least one\n security group and one subnet ID.

" } }, "networkInterface": { @@ -590,13 +590,13 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, "exportedEnvironmentVariables": { "target": "com.amazonaws.codebuild#ExportedEnvironmentVariables", "traits": { - "smithy.api#documentation": "

A list of exported environment variables for this build.

\n

Exported environment variables are used in conjunction with AWS CodePipeline to export\n environment variables from the current build stage to subsequent stages in the pipeline.\n For more information, see Working with variables in the AWS CodePipeline User Guide.

" + "smithy.api#documentation": "

A list of exported environment variables for this build.

\n

Exported environment variables are used in conjunction with CodePipeline to export\n environment variables from the current build stage to subsequent stages in the pipeline.\n For more information, see Working with variables in the CodePipeline User Guide.

" } }, "reportArns": { @@ -735,7 +735,7 @@ "resolvedSourceVersion": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The identifier of the resolved version of this batch build's source code.

\n
    \n
  • \n

    For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

    \n
    • \n
  • \n

    For AWS CodePipeline, the source revision provided by AWS CodePipeline.

    \n
    • \n
  • \n

    For Amazon S3, this does not apply.

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

The identifier of the resolved version of this batch build's source code.

\n
    \n
  • \n

    For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

    \n
    • \n
  • \n

    For CodePipeline, the source revision provided by CodePipeline.

    \n
    • \n
  • \n

    For Amazon S3, this does not apply.

    \n
    • \n
" } }, "projectName": { @@ -762,7 +762,7 @@ "secondarySourceVersions": { "target": "com.amazonaws.codebuild#ProjectSecondarySourceVersions", "traits": { - "smithy.api#documentation": "

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n
    \n
  • \n

    For AWS CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example, pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

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

An array of ProjectSourceVersion objects. Each\n ProjectSourceVersion must be one of:

\n
    \n
  • \n

    For CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example, pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
" } }, "artifacts": { @@ -813,7 +813,7 @@ "initiator": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The entity that started the batch build. Valid values include:

\n
    \n
  • \n

    If AWS CodePipeline started the build, the pipeline's name (for example,\n codepipeline/my-demo-pipeline).

    \n
    • \n
  • \n

    If an AWS Identity and Access Management (IAM) user started the build, the user's name.

    \n
    • \n
  • \n

    If the Jenkins plugin for AWS CodeBuild started the build, the string\n CodeBuild-Jenkins-Plugin.

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

The entity that started the batch build. Valid values include:

\n
    \n
  • \n

    If CodePipeline started the build, the pipeline's name (for example,\n codepipeline/my-demo-pipeline).

    \n
    • \n
  • \n

    If an IAM user started the build, the user's name.

    \n
    • \n
  • \n

    If the Jenkins plugin for CodeBuild started the build, the string\n CodeBuild-Jenkins-Plugin.

    \n
    • \n
" } }, "vpcConfig": { @@ -822,7 +822,7 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the batch build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" } }, "buildBatchNumber": { @@ -1180,7 +1180,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information that defines how the AWS CodeBuild build project reports the build status\n to the source provider.

" + "smithy.api#documentation": "

Contains information that defines how the CodeBuild build project reports the build status\n to the source provider.

" } }, "com.amazonaws.codebuild#BuildSummaries": { @@ -1283,25 +1283,25 @@ "status": { "target": "com.amazonaws.codebuild#LogsConfigStatusType", "traits": { - "smithy.api#documentation": "

The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:

\n
    \n
  • \n

    \n ENABLED: Amazon CloudWatch Logs are enabled for this build project.

    \n
    • \n
  • \n

    \n DISABLED: Amazon CloudWatch Logs are not enabled for this build project.

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

The current status of the logs in CloudWatch Logs for a build project. Valid values are:

\n
    \n
  • \n

    \n ENABLED: CloudWatch Logs are enabled for this build project.

    \n
    • \n
  • \n

    \n DISABLED: CloudWatch Logs are not enabled for this build project.

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

The group name of the logs in Amazon CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

" + "smithy.api#documentation": "

The group name of the logs in CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

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

The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

" + "smithy.api#documentation": "

The prefix of the stream name of the CloudWatch Logs. For more information, see Working\n with Log Groups and Log Streams.

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

Information about Amazon CloudWatch Logs for a build project.

" + "smithy.api#documentation": "

Information about CloudWatch Logs for a build project.

" } }, "com.amazonaws.codebuild#CodeBuild_20161006": { @@ -1434,6 +1434,9 @@ { "target": "com.amazonaws.codebuild#UpdateProject" }, + { + "target": "com.amazonaws.codebuild#UpdateProjectVisibility" + }, { "target": "com.amazonaws.codebuild#UpdateReportGroup" }, @@ -1453,7 +1456,7 @@ "name": "codebuild" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS CodeBuild\n

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code,\n runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the\n need to provision, manage, and scale your own build servers. It provides prepackaged\n build environments for the most popular programming languages and build tools, such as\n Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild\n to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You\n pay only for the build time you consume. For more information about AWS CodeBuild, see the \n AWS CodeBuild User\n Guide.\n

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

CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code,\n runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the\n need to provision, manage, and scale your own build servers. It provides prepackaged\n build environments for the most popular programming languages and build tools, such as\n Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild\n to use your own build tools. CodeBuild scales automatically to meet peak build requests. You\n pay only for the build time you consume. For more information about CodeBuild, see the \n CodeBuild User\n Guide.\n

", "smithy.api#title": "AWS CodeBuild" } }, @@ -1659,7 +1662,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the latest\n version is used. If specified, it must be one of:

\n
    \n
  • \n

    For AWS CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
\n

If sourceVersion is specified at the build level, then that version takes\n precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide. \n

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the latest\n version is used. If specified, it must be one of:

\n
    \n
  • \n

    For CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
\n

If sourceVersion is specified at the build level, then that version takes\n precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide. \n

" } }, "secondarySourceVersions": { @@ -1697,14 +1700,14 @@ "serviceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services\n on behalf of the AWS account.

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

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services\n on behalf of the Amazon Web Services account.

", "smithy.api#required": {} } }, "timeoutInMinutes": { "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out\n any build that has not been marked as completed. The default is 60 minutes.

" + "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out\n any build that has not been marked as completed. The default is 60 minutes.

" } }, "queuedTimeoutInMinutes": { @@ -1716,19 +1719,19 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" } }, "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by Amazon Web Services services that support CodeBuild build project\n tags.

" } }, "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" + "smithy.api#documentation": "

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

" } }, "badgeEnabled": { @@ -1740,7 +1743,7 @@ "logsConfig": { "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs\n uploaded to a specified S3 bucket, or both.

" + "smithy.api#documentation": "

Information about logs for the build project. These can be logs in CloudWatch Logs, logs\n uploaded to a specified S3 bucket, or both.

" } }, "fileSystemLocations": { @@ -1824,7 +1827,7 @@ "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

\n A list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" + "smithy.api#documentation": "

\n A list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by Amazon Web Services services that support CodeBuild report group\n tags.

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

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or\n Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a\n code change is pushed to the repository.

\n \n

If you enable webhooks for an AWS CodeBuild project, and the project is used as a build\n step in AWS CodePipeline, then two identical builds are created for each commit. One build is\n triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build\n basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we\n recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the\n Webhook box. For more information, see step 5 in Change a Build Project's Settings.

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

For an existing CodeBuild build project that has its source code stored in a GitHub or\n Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a\n code change is pushed to the repository.

\n \n

If you enable webhooks for an CodeBuild project, and the project is used as a build\n step in CodePipeline, then two identical builds are created for each commit. One build is\n triggered through webhooks, and one through CodePipeline. Because billing is on a per-build\n basis, you are billed for both builds. Therefore, if you are using CodePipeline, we\n recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the\n Webhook box. For more information, see step 5 in Change a Build Project's Settings.

\n " } }, "com.amazonaws.codebuild#CreateWebhookInput": { @@ -1872,7 +1875,7 @@ "projectName": { "target": "com.amazonaws.codebuild#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

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

The name of the CodeBuild project.

", "smithy.api#required": {} } }, @@ -1902,7 +1905,7 @@ "webhook": { "target": "com.amazonaws.codebuild#Webhook", "traits": { - "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n CodeBuild.

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

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or\n Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code\n change is pushed to the repository.

" + "smithy.api#documentation": "

For an existing CodeBuild build project that has its source code stored in a GitHub or\n Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code\n change is pushed to the repository.

" } }, "com.amazonaws.codebuild#DeleteWebhookInput": { @@ -2200,7 +2203,7 @@ "projectName": { "target": "com.amazonaws.codebuild#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

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

The name of the CodeBuild project.

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

Information about a Docker image that is managed by AWS CodeBuild.

" + "smithy.api#documentation": "

Information about a Docker image that is managed by CodeBuild.

" } }, "com.amazonaws.codebuild#EnvironmentImages": { @@ -2420,7 +2423,7 @@ } }, "traits": { - "smithy.api#documentation": "

A set of Docker images that are related by programming language and are managed by\n AWS CodeBuild.

" + "smithy.api#documentation": "

A set of Docker images that are related by programming language and are managed by\n CodeBuild.

" } }, "com.amazonaws.codebuild#EnvironmentLanguages": { @@ -2446,7 +2449,7 @@ } }, "traits": { - "smithy.api#documentation": "

A set of Docker images that are related by platform and are managed by AWS CodeBuild.

" + "smithy.api#documentation": "

A set of Docker images that are related by platform and are managed by CodeBuild.

" } }, "com.amazonaws.codebuild#EnvironmentPlatforms": { @@ -2495,14 +2498,14 @@ "value": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The value of the environment variable.

\n \n

We strongly discourage the use of PLAINTEXT environment variables to\n store sensitive values, especially AWS secret key IDs and secret access keys.\n PLAINTEXT environment variables can be displayed in plain text\n using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For sensitive values, we recommend you use an\n environment variable of type PARAMETER_STORE or\n SECRETS_MANAGER.

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

The value of the environment variable.

\n \n

We strongly discourage the use of PLAINTEXT environment variables to\n store sensitive values, especially Amazon Web Services secret key IDs and secret access keys.\n PLAINTEXT environment variables can be displayed in plain text\n using the CodeBuild console and the CLI. For sensitive values, we recommend you use an\n environment variable of type PARAMETER_STORE or\n SECRETS_MANAGER.

\n ", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.codebuild#EnvironmentVariableType", "traits": { - "smithy.api#documentation": "

The type of environment variable. Valid values include:

\n
    \n
  • \n

    \n PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager\n Parameter Store. To learn how to specify a parameter store environment variable,\n see env/parameter-store in the\n AWS CodeBuild User Guide.

    \n
    • \n
  • \n

    \n PLAINTEXT: An environment variable in plain text format. This is\n the default value.

    \n
    • \n
  • \n

    \n SECRETS_MANAGER: An environment variable stored in AWS Secrets\n Manager. To learn how to specify a secrets manager environment variable, see\n env/secrets-manager in the\n AWS CodeBuild User Guide.

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

The type of environment variable. Valid values include:

\n
    \n
  • \n

    \n PARAMETER_STORE: An environment variable stored in Systems Manager\n Parameter Store. To learn how to specify a parameter store environment variable,\n see env/parameter-store in the\n CodeBuild User Guide.

    \n
    • \n
  • \n

    \n PLAINTEXT: An environment variable in plain text format. This is\n the default value.

    \n
    • \n
  • \n

    \n SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see\n env/secrets-manager in the\n CodeBuild User Guide.

    \n
    • \n
" } } }, @@ -2552,7 +2555,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about an exported environment variable.

\n

Exported environment variables are used in conjunction with AWS CodePipeline to export\n environment variables from the current build stage to subsequent stages in the pipeline.\n For more information, see Working with variables in the AWS CodePipeline User Guide.

\n \n

During a build, the value of a variable is available starting with the\n install phase. It can be updated between the start of the\n install phase and the end of the post_build phase.\n After the post_build phase ends, the value of exported variables cannot\n change.

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

Contains information about an exported environment variable.

\n

Exported environment variables are used in conjunction with CodePipeline to export\n environment variables from the current build stage to subsequent stages in the pipeline.\n For more information, see Working with variables in the CodePipeline User Guide.

\n \n

During a build, the value of a variable is available starting with the\n install phase. It can be updated between the start of the\n install phase and the end of the post_build phase.\n After the post_build phase ends, the value of exported variables cannot\n change.

\n " } }, "com.amazonaws.codebuild#ExportedEnvironmentVariables": { @@ -2704,13 +2707,13 @@ "fetchSubmodules": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Set to true to fetch Git submodules for your AWS CodeBuild build project.

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

Set to true to fetch Git submodules for your CodeBuild build project.

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

Information about the Git submodules configuration for an AWS CodeBuild build project.\n

" + "smithy.api#documentation": "

Information about the Git submodules configuration for an CodeBuild build project.\n

" } }, "com.amazonaws.codebuild#Identifiers": { @@ -2760,7 +2763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports the source repository credentials for an AWS CodeBuild project that has its\n source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

" + "smithy.api#documentation": "

Imports the source repository credentials for an CodeBuild project that has its\n source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

" } }, "com.amazonaws.codebuild#ImportSourceCredentialsInput": { @@ -2789,7 +2792,7 @@ "authType": { "target": "com.amazonaws.codebuild#AuthType", "traits": { - "smithy.api#documentation": "

The type of authentication used to connect to a GitHub, GitHub Enterprise, or\n Bitbucket repository. An OAUTH connection is not supported by the API and must be\n created using the AWS CodeBuild console.

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

The type of authentication used to connect to a GitHub, GitHub Enterprise, or\n Bitbucket repository. An OAUTH connection is not supported by the API and must be\n created using the CodeBuild console.

", "smithy.api#required": {} } }, @@ -2850,7 +2853,7 @@ "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild build project that the cache is reset for.

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

The name of the CodeBuild build project that the cache is reset for.

", "smithy.api#required": {} } } @@ -3117,7 +3120,7 @@ "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

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

The name of the CodeBuild project.

", "smithy.api#required": {} } }, @@ -3195,7 +3198,7 @@ "target": "com.amazonaws.codebuild#ListCuratedEnvironmentImagesOutput" }, "traits": { - "smithy.api#documentation": "

Gets information about Docker images that are managed by AWS CodeBuild.

" + "smithy.api#documentation": "

Gets information about Docker images that are managed by CodeBuild.

" } }, "com.amazonaws.codebuild#ListCuratedEnvironmentImagesInput": { @@ -3208,7 +3211,7 @@ "platforms": { "target": "com.amazonaws.codebuild#EnvironmentPlatforms", "traits": { - "smithy.api#documentation": "

Information about supported platforms for Docker images that are managed by\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about supported platforms for Docker images that are managed by\n CodeBuild.

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

\n Gets a list ARNs for the report groups in the current AWS account.\n

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

\n Gets a list ARNs for the report groups in the current Amazon Web Services account.\n

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3339,7 +3342,7 @@ "reportGroups": { "target": "com.amazonaws.codebuild#ReportGroupArns", "traits": { - "smithy.api#documentation": "

\n The list of ARNs for the report groups in the current AWS account.\n

" + "smithy.api#documentation": "

\n The list of ARNs for the report groups in the current Amazon Web Services account.\n

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

\n Returns a list of ARNs for the reports in the current AWS account.\n

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

\n Returns a list of ARNs for the reports in the current Amazon Web Services account.\n

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3487,7 +3490,7 @@ "reports": { "target": "com.amazonaws.codebuild#ReportArns", "traits": { - "smithy.api#documentation": "

\n The list of returned ARNs for the reports in the current AWS account.\n

" + "smithy.api#documentation": "

\n The list of returned ARNs for the reports in the current Amazon Web Services account.\n

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

Gets a list of projects that are shared with other AWS accounts or users.

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

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3521,7 +3524,7 @@ "sortBy": { "target": "com.amazonaws.codebuild#SharedResourceSortByType", "traits": { - "smithy.api#documentation": "

The criterion to be used to list build projects shared with the current AWS account\n or user. Valid values include:

\n
    \n
  • \n

    \n ARN: List based on the ARN.

    \n
    • \n
  • \n

    \n MODIFIED_TIME: List based on when information about the shared\n project was last changed.

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

The criterion to be used to list build projects shared with the current Amazon Web Services account\n or user. Valid values include:

\n
    \n
  • \n

    \n ARN: List based on the ARN.

    \n
    • \n
  • \n

    \n MODIFIED_TIME: List based on when information about the shared\n project was last changed.

    \n
    • \n
" } }, "sortOrder": { @@ -3556,7 +3559,7 @@ "projects": { "target": "com.amazonaws.codebuild#ProjectArns", "traits": { - "smithy.api#documentation": "

The list of ARNs for the build projects shared with the current AWS account or user.\n

" + "smithy.api#documentation": "

The list of ARNs for the build projects shared with the current Amazon Web Services account or user.\n

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

Gets a list of report groups that are shared with other AWS accounts or users.\n

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

Gets a list of report groups that are shared with other Amazon Web Services accounts or users.\n

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3596,7 +3599,7 @@ "sortBy": { "target": "com.amazonaws.codebuild#SharedResourceSortByType", "traits": { - "smithy.api#documentation": "

The criterion to be used to list report groups shared with the current AWS account or\n user. Valid values include:

\n
    \n
  • \n

    \n ARN: List based on the ARN.

    \n
    • \n
  • \n

    \n MODIFIED_TIME: List based on when information about the shared\n report group was last changed.

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

The criterion to be used to list report groups shared with the current Amazon Web Services account or\n user. Valid values include:

\n
    \n
  • \n

    \n ARN: List based on the ARN.

    \n
    • \n
  • \n

    \n MODIFIED_TIME: List based on when information about the shared\n report group was last changed.

    \n
    • \n
" } }, "nextToken": { @@ -3625,7 +3628,7 @@ "reportGroups": { "target": "com.amazonaws.codebuild#ReportGroupArns", "traits": { - "smithy.api#documentation": "

The list of ARNs for the report groups shared with the current AWS account or user.\n

" + "smithy.api#documentation": "

The list of ARNs for the report groups shared with the current Amazon Web Services account or user.\n

" } } } @@ -3668,7 +3671,7 @@ "cloudWatchLogs": { "target": "com.amazonaws.codebuild#CloudWatchLogsConfig", "traits": { - "smithy.api#documentation": "

Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.

" + "smithy.api#documentation": "

Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.

" } }, "s3Logs": { @@ -3679,7 +3682,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a\n specified S3 bucket, or both.

" + "smithy.api#documentation": "

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a\n specified S3 bucket, or both.

" } }, "com.amazonaws.codebuild#LogsConfigStatusType": { @@ -3703,19 +3706,19 @@ "groupName": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs group for the build logs.

" + "smithy.api#documentation": "

The name of the CloudWatch Logs group for the build logs.

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

The name of the Amazon CloudWatch Logs stream for the build logs.

" + "smithy.api#documentation": "

The name of the CloudWatch Logs stream for the build logs.

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

The URL to an individual build log in Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

The URL to an individual build log in CloudWatch Logs.

" } }, "s3DeepLink": { @@ -3727,7 +3730,7 @@ "cloudWatchLogsArn": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The ARN of Amazon CloudWatch Logs for a build project. Its format is\n arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.\n For more information, see Resources Defined by Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

The ARN of CloudWatch Logs for a build project. Its format is\n arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.\n For more information, see Resources Defined by CloudWatch Logs.

" } }, "s3LogsArn": { @@ -3739,7 +3742,7 @@ "cloudWatchLogs": { "target": "com.amazonaws.codebuild#CloudWatchLogsConfig", "traits": { - "smithy.api#documentation": "

Information about Amazon CloudWatch Logs for a build project.

" + "smithy.api#documentation": "

Information about CloudWatch Logs for a build project.

" } }, "s3Logs": { @@ -3750,7 +3753,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about build logs in Amazon CloudWatch Logs.

" + "smithy.api#documentation": "

Information about build logs in CloudWatch Logs.

" } }, "com.amazonaws.codebuild#NetworkInterface": { @@ -3907,7 +3910,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n
    \n
  • \n

    For AWS CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
\n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide. \n

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n
    \n
  • \n

    For CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
\n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide. \n

" } }, "secondarySourceVersions": { @@ -3943,13 +3946,13 @@ "serviceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services\n on behalf of the AWS account.

" + "smithy.api#documentation": "

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services\n on behalf of the Amazon Web Services account.

" } }, "timeoutInMinutes": { "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any\n related build that did not get marked as completed. The default is 60 minutes.

" + "smithy.api#documentation": "

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any\n related build that did not get marked as completed. The default is 60 minutes.

" } }, "queuedTimeoutInMinutes": { @@ -3961,13 +3964,13 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/). If you don't specify a \n value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).\n

" } }, "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this build project.

\n

These tags are available for use by Amazon Web Services services that support CodeBuild build project\n tags.

" } }, "created": { @@ -3985,13 +3988,13 @@ "webhook": { "target": "com.amazonaws.codebuild#Webhook", "traits": { - "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n CodeBuild.

" } }, "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

Information about the VPC configuration that AWS CodeBuild accesses.

" + "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" } }, "badge": { @@ -4003,7 +4006,7 @@ "logsConfig": { "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an\n S3 bucket, or both.

" + "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in CloudWatch Logs, an\n S3 bucket, or both.

" } }, "fileSystemLocations": { @@ -4023,6 +4026,21 @@ "traits": { "smithy.api#documentation": "

The maximum number of concurrent builds that are allowed for this project.

\n

New builds are only started if the current number of builds is less than or equal to this limit. \n If the current build count meets this limit, new builds are throttled and are not run.

" } + }, + "projectVisibility": { + "target": "com.amazonaws.codebuild#ProjectVisibilityType" + }, + "publicProjectAlias": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Contains the project identifier used with the public build APIs.

" + } + }, + "resourceAccessRole": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for\n the project's builds.

" + } } }, "traits": { @@ -4047,38 +4065,38 @@ "type": { "target": "com.amazonaws.codebuild#ArtifactsType", "traits": { - "smithy.api#documentation": "

The type of build output artifact. Valid values include:

\n
    \n
  • \n

    \n CODEPIPELINE: The build project has build output generated\n through AWS CodePipeline.

    \n \n

    The CODEPIPELINE type is not supported for\n secondaryArtifacts.

    \n     \n
    • \n
  • \n

    \n NO_ARTIFACTS: The build project does not produce any build\n output.

    \n
    • \n
  • \n

    \n S3: The build project stores build output in Amazon S3.

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

The type of build output artifact. Valid values include:

\n
    \n
  • \n

    \n CODEPIPELINE: The build project has build output generated\n through CodePipeline.

    \n \n

    The CODEPIPELINE type is not supported for\n secondaryArtifacts.

    \n     \n
    • \n
  • \n

    \n NO_ARTIFACTS: The build project does not produce any build\n output.

    \n
    • \n
  • \n

    \n S3: The build project stores build output in Amazon S3.

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

Information about the build output artifact location:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, AWS CodePipeline ignores this\n value if specified. This is because AWS CodePipeline manages its build output locations\n instead of AWS CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, this is the name of the output\n bucket.

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

Information about the build output artifact location:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, CodePipeline ignores this\n value if specified. This is because CodePipeline manages its build output locations\n instead of CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, this is the name of the output\n bucket.

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

Along with namespaceType and name, the pattern that AWS CodeBuild\n uses to name and store the output artifact:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, AWS CodePipeline ignores this\n value if specified. This is because AWS CodePipeline manages its build output names instead\n of AWS CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, this is the path to the output\n artifact. If path is not specified, path is not\n used.

    \n
    • \n
\n

For example, if path is set to MyArtifacts,\n namespaceType is set to NONE, and name is set\n to MyArtifact.zip, the output artifact is stored in the output bucket at\n MyArtifacts/MyArtifact.zip.

" + "smithy.api#documentation": "

Along with namespaceType and name, the pattern that CodeBuild\n uses to name and store the output artifact:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, CodePipeline ignores this\n value if specified. This is because CodePipeline manages its build output names instead\n of CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, this is the path to the output\n artifact. If path is not specified, path is not\n used.

    \n
    • \n
\n

For example, if path is set to MyArtifacts,\n namespaceType is set to NONE, and name is set\n to MyArtifact.zip, the output artifact is stored in the output bucket at\n MyArtifacts/MyArtifact.zip.

" } }, "namespaceType": { "target": "com.amazonaws.codebuild#ArtifactNamespace", "traits": { - "smithy.api#documentation": "

Along with path and name, the pattern that AWS CodeBuild uses to\n determine the name and location to store the output artifact:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, AWS CodePipeline ignores this\n value if specified. This is because AWS CodePipeline manages its build output names instead\n of AWS CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, valid values include:

    \n
      \n
    • \n

      \n BUILD_ID: Include the build ID in the location of the\n build output artifact.

      \n
      • \n
    • \n

      \n NONE: Do not include the build ID. This is the default if\n namespaceType is not specified.

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

For example, if path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and name is\n set to MyArtifact.zip, the output artifact is stored in\n MyArtifacts//MyArtifact.zip.

" + "smithy.api#documentation": "

Along with path and name, the pattern that CodeBuild uses to\n determine the name and location to store the output artifact:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, CodePipeline ignores this\n value if specified. This is because CodePipeline manages its build output names instead\n of CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, valid values include:

    \n
      \n
    • \n

      \n BUILD_ID: Include the build ID in the location of the\n build output artifact.

      \n
      • \n
    • \n

      \n NONE: Do not include the build ID. This is the default if\n namespaceType is not specified.

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

For example, if path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and name is\n set to MyArtifact.zip, the output artifact is stored in\n MyArtifacts//MyArtifact.zip.

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

Along with path and namespaceType, the pattern that AWS CodeBuild\n uses to name and store the output artifact:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, AWS CodePipeline ignores this\n value if specified. This is because AWS CodePipeline manages its build output names instead\n of AWS CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, this is the name of the output\n artifact object. If you set the name to be a forward slash (\"/\"), the artifact\n is stored in the root of the output bucket.

    \n
    • \n
\n

For example:

\n
    \n
  • \n

    If path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and\n name is set to MyArtifact.zip, then the output\n artifact is stored in MyArtifacts//MyArtifact.zip.

    \n
    • \n
  • \n

    If path is empty, namespaceType is set to\n NONE, and name is set to \"/\", the\n output artifact is stored in the root of the output bucket.

    \n
    • \n
  • \n

    If path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and\n name is set to \"/\", the output artifact is stored\n in MyArtifacts/.

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

Along with path and namespaceType, the pattern that CodeBuild\n uses to name and store the output artifact:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, CodePipeline ignores this\n value if specified. This is because CodePipeline manages its build output names instead\n of CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, this is the name of the output\n artifact object. If you set the name to be a forward slash (\"/\"), the artifact\n is stored in the root of the output bucket.

    \n
    • \n
\n

For example:

\n
    \n
  • \n

    If path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and\n name is set to MyArtifact.zip, then the output\n artifact is stored in MyArtifacts//MyArtifact.zip.

    \n
    • \n
  • \n

    If path is empty, namespaceType is set to\n NONE, and name is set to \"/\", the\n output artifact is stored in the root of the output bucket.

    \n
    • \n
  • \n

    If path is set to MyArtifacts,\n namespaceType is set to BUILD_ID, and\n name is set to \"/\", the output artifact is stored\n in MyArtifacts/.

    \n
    • \n
" } }, "packaging": { "target": "com.amazonaws.codebuild#ArtifactPackaging", "traits": { - "smithy.api#documentation": "

The type of build output artifact to create:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, AWS CodePipeline ignores this\n value if specified. This is because AWS CodePipeline manages its build output artifacts\n instead of AWS CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, valid values include:

    \n
      \n
    • \n

      \n NONE: AWS CodeBuild creates in the output bucket a folder that\n contains the build output. This is the default if packaging\n is not specified.

      \n
      • \n
    • \n

      \n ZIP: AWS CodeBuild creates in the output bucket a ZIP file that\n contains the build output.

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

The type of build output artifact to create:

\n
    \n
  • \n

    If type is set to CODEPIPELINE, CodePipeline ignores this\n value if specified. This is because CodePipeline manages its build output artifacts\n instead of CodeBuild.

    \n
    • \n
  • \n

    If type is set to NO_ARTIFACTS, this value is\n ignored if specified, because no build output is produced.

    \n
    • \n
  • \n

    If type is set to S3, valid values include:

    \n
      \n
    • \n

      \n NONE: CodeBuild creates in the output bucket a folder that\n contains the build output. This is the default if packaging\n is not specified.

      \n
      • \n
    • \n

      \n ZIP: CodeBuild creates in the output bucket a ZIP file that\n contains the build output.

      \n
      • \n
    \n
    • \n
" } }, "overrideArtifactName": { @@ -4219,21 +4237,21 @@ "type": { "target": "com.amazonaws.codebuild#EnvironmentType", "traits": { - "smithy.api#documentation": "

The type of build environment to use for related builds.

\n
    \n
  • \n

    The environment type ARM_CONTAINER is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland),\n Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and\n EU (Frankfurt).

    \n
    • \n
  • \n

    The environment type LINUX_CONTAINER with compute type\n build.general1.2xlarge is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon),\n Canada (Central), EU (Ireland), EU (London),\n EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and\n China (Ningxia).

    \n
    • \n
  • \n

    The environment type LINUX_GPU_CONTAINER is available only in\n regions US East (N. Virginia), US East (Ohio), US West (Oregon),\n Canada (Central), EU (Ireland), EU (London),\n EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and\n China (Ningxia).

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

The type of build environment to use for related builds.

\n
    \n
  • \n

    The environment type ARM_CONTAINER is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland),\n Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and\n EU (Frankfurt).

    \n
    • \n
  • \n

    The environment type LINUX_CONTAINER with compute type\n build.general1.2xlarge is available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon),\n Canada (Central), EU (Ireland), EU (London),\n EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and\n China (Ningxia).

    \n
    • \n
  • \n

    The environment type LINUX_GPU_CONTAINER is available only in\n regions US East (N. Virginia), US East (Ohio), US West (Oregon),\n Canada (Central), EU (Ireland), EU (London),\n EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul),\n Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and\n China (Ningxia).

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

    The environment types WINDOWS_CONTAINER and\n WINDOWS_SERVER_2019_CONTAINER are available only in regions\n US East (N. Virginia), US East (Ohio), US West (Oregon), and\n EU (Ireland).

    \n
    • \n
\n

For more information, see Build environment compute types in the CodeBuild\n user guide.

", "smithy.api#required": {} } }, "image": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The image tag or image digest that identifies the Docker image to use for this build\n project. Use the following formats:

\n
    \n
  • \n

    For an image tag: /:. For\n example, in the Docker repository that CodeBuild uses to manage its Docker\n images, this would be aws/codebuild/standard:4.0.

    \n
    • \n
  • \n

    For an image digest: /@.\n For example, to specify an image with the digest\n \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use\n /@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

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

The image tag or image digest that identifies the Docker image to use for this build\n project. Use the following formats:

\n
    \n
  • \n

    For an image tag: /:. For\n example, in the Docker repository that CodeBuild uses to manage its Docker\n images, this would be aws/codebuild/standard:4.0.

    \n
    • \n
  • \n

    For an image digest: /@.\n For example, to specify an image with the digest\n \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use\n /@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

    \n
    • \n
\n

For more information, see Docker images provided by CodeBuild in the CodeBuild user\n guide.

", "smithy.api#required": {} } }, "computeType": { "target": "com.amazonaws.codebuild#ComputeType", "traits": { - "smithy.api#documentation": "

Information about the compute resources the build project uses. Available values\n include:

\n
    \n
  • \n

    \n BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for\n builds.

    \n
    • \n
  • \n

    \n BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for\n builds.

    \n
    • \n
  • \n

    \n BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for\n builds, depending on your environment type.

    \n
    • \n
  • \n

    \n BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.

    \n
    • \n
\n

If you use BUILD_GENERAL1_LARGE:

\n
    \n
  • \n

    For environment type LINUX_CONTAINER, you can use up to 15 GB\n memory and 8 vCPUs for builds.

    \n
    • \n
  • \n

    For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

    \n
    • \n
  • \n

    For environment type ARM_CONTAINER, you can use up to 16 GB\n memory and 8 vCPUs on ARM-based processors for builds.

    \n
    • \n
\n

For more information, see Build Environment\n Compute Types in the AWS CodeBuild User Guide.\n

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

Information about the compute resources the build project uses. Available values\n include:

\n
    \n
  • \n

    \n BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for\n builds.

    \n
    • \n
  • \n

    \n BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for\n builds.

    \n
    • \n
  • \n

    \n BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for\n builds, depending on your environment type.

    \n
    • \n
  • \n

    \n BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and\n 824 GB of SSD storage for builds. This compute type supports Docker images up to\n 100 GB uncompressed.

    \n
    • \n
\n

If you use BUILD_GENERAL1_LARGE:

\n
    \n
  • \n

    For environment type LINUX_CONTAINER, you can use up to 15 GB\n memory and 8 vCPUs for builds.

    \n
    • \n
  • \n

    For environment type LINUX_GPU_CONTAINER, you can use up to 255\n GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

    \n
    • \n
  • \n

    For environment type ARM_CONTAINER, you can use up to 16 GB\n memory and 8 vCPUs on ARM-based processors for builds.

    \n
    • \n
\n

For more information, see Build Environment\n Compute Types in the CodeBuild User Guide.\n

", "smithy.api#required": {} } }, @@ -4252,7 +4270,7 @@ "certificate": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded\n certificate for the build project. For more information, see certificate in the\n AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded\n certificate for the build project. For more information, see certificate in the\n CodeBuild User Guide.

" } }, "registryCredential": { @@ -4264,7 +4282,7 @@ "imagePullCredentialsType": { "target": "com.amazonaws.codebuild#ImagePullCredentialsType", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\n values:

\n
    \n
  • \n

    \n CODEBUILD specifies that AWS CodeBuild uses its own credentials.\n This requires that you modify your ECR repository policy to trust AWS\n CodeBuild's service principal.

    \n
    • \n
  • \n

    \n SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service\n role.

    \n
    • \n
\n

When you use a cross-account or private registry image, you must use SERVICE_ROLE\n credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.\n

" + "smithy.api#documentation": "

The type of credentials CodeBuild uses to pull images in your build. There are two valid\n values:

\n
    \n
  • \n

    \n CODEBUILD specifies that CodeBuild uses its own credentials.\n This requires that you modify your ECR repository policy to trust CodeBuild service principal.

    \n
    • \n
  • \n

    \n SERVICE_ROLE specifies that CodeBuild uses your build project's service\n role.

    \n
    • \n
\n

When you use a cross-account or private registry image, you must use SERVICE_ROLE\n credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.\n

" } } }, @@ -4284,7 +4302,7 @@ "location": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A string that specifies the location of the file system created by Amazon EFS. Its\n format is efs-dns-name:/directory-path. You can find the DNS name of file\n system when you view it in the AWS EFS console. The directory path is a path to a\n directory in the file system that CodeBuild mounts. For example, if the DNS name of a\n file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount\n directory is my-efs-mount-directory, then the location is\n fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

\n

The directory path in the format efs-dns-name:/directory-path is\n optional. If you do not specify a directory path, the location is only the DNS name and\n CodeBuild mounts the entire file system.

" + "smithy.api#documentation": "

A string that specifies the location of the file system created by Amazon EFS. Its\n format is efs-dns-name:/directory-path. You can find the DNS name of file\n system when you view it in the Amazon EFS console. The directory path is a path to a\n directory in the file system that CodeBuild mounts. For example, if the DNS name of a\n file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount\n directory is my-efs-mount-directory, then the location is\n fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

\n

The directory path in the format efs-dns-name:/directory-path is\n optional. If you do not specify a directory path, the location is only the DNS name and\n CodeBuild mounts the entire file system.

" } }, "mountPoint": { @@ -4302,7 +4320,7 @@ "mountOptions": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The mount options for a file system created by AWS EFS. The default mount options\n used by CodeBuild are\n nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For\n more information, see Recommended NFS Mount\n Options.

" + "smithy.api#documentation": "

The mount options for a file system created by Amazon EFS. The default mount options\n used by CodeBuild are\n nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For\n more information, see Recommended NFS Mount\n Options.

" } } }, @@ -4375,14 +4393,14 @@ "type": { "target": "com.amazonaws.codebuild#SourceType", "traits": { - "smithy.api#documentation": "

The type of repository that contains the source code to be built. Valid values\n include:

\n
    \n
  • \n

    \n BITBUCKET: The source code is in a Bitbucket repository.

    \n
    • \n
  • \n

    \n CODECOMMIT: The source code is in an AWS CodeCommit repository.

    \n
    • \n
  • \n

    \n CODEPIPELINE: The source code settings are specified in the\n source action of a pipeline in AWS CodePipeline.

    \n
    • \n
  • \n

    \n GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud\n repository.

    \n
    • \n
  • \n

    \n GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise\n Server repository.

    \n
    • \n
  • \n

    \n NO_SOURCE: The project does not have input source code.

    \n
    • \n
  • \n

    \n S3: The source code is in an Amazon S3 bucket.

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

The type of repository that contains the source code to be built. Valid values\n include:

\n
    \n
  • \n

    \n BITBUCKET: The source code is in a Bitbucket repository.

    \n
    • \n
  • \n

    \n CODECOMMIT: The source code is in an CodeCommit repository.

    \n
    • \n
  • \n

    \n CODEPIPELINE: The source code settings are specified in the\n source action of a pipeline in CodePipeline.

    \n
    • \n
  • \n

    \n GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud\n repository.

    \n
    • \n
  • \n

    \n GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise\n Server repository.

    \n
    • \n
  • \n

    \n NO_SOURCE: The project does not have input source code.

    \n
    • \n
  • \n

    \n S3: The source code is in an Amazon S3 bucket.

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

Information about the location of the source code to be built. Valid values\n include:

\n
    \n
  • \n

    For source code settings that are specified in the source action of a pipeline\n in AWS CodePipeline, location should not be specified. If it is specified,\n AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source\n action instead of this value.

    \n
    • \n
  • \n

    For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository\n that contains the source code and the buildspec file (for example,\n https://git-codecommit..amazonaws.com/v1/repos/).

    \n
    • \n
  • \n

    For source code in an Amazon S3 input bucket, one of the following.

    \n
      \n
    • \n

      The path to the ZIP file that contains the source code (for example,\n //.zip).

      \n
      • \n
    • \n

      The path to the folder that contains the source code (for example,\n ///).

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

    For source code in a GitHub repository, the HTTPS clone URL to the repository\n that contains the source and the buildspec file. You must connect your AWS\n account to your GitHub account. Use the AWS CodeBuild console to start creating a build\n project. When you use the console to connect (or reconnect) with GitHub, on the\n GitHub Authorize application page, for\n Organization access, choose Request access next to each repository you want to\n allow AWS CodeBuild to have access to, and then choose Authorize\n application. (After you have connected to your GitHub account,\n you do not need to finish creating the build project. You can leave the AWS CodeBuild\n console.) To instruct AWS CodeBuild to use this connection, in the source\n object, set the auth object's type value to\n OAUTH.

    \n
    • \n
  • \n

    For source code in a Bitbucket repository, the HTTPS clone URL to the\n repository that contains the source and the buildspec file. You must connect\n your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start\n creating a build project. When you use the console to connect (or reconnect)\n with Bitbucket, on the Bitbucket Confirm access to your\n account page, choose Grant\n access. (After you have connected to your Bitbucket account, you\n do not need to finish creating the build project. You can leave the AWS CodeBuild\n console.) To instruct AWS CodeBuild to use this connection, in the source\n object, set the auth object's type value to\n OAUTH.

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

Information about the location of the source code to be built. Valid values\n include:

\n
    \n
  • \n

    For source code settings that are specified in the source action of a pipeline\n in CodePipeline, location should not be specified. If it is specified,\n CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source\n action instead of this value.

    \n
    • \n
  • \n

    For source code in an CodeCommit repository, the HTTPS clone URL to the repository\n that contains the source code and the buildspec file (for example,\n https://git-codecommit..amazonaws.com/v1/repos/).

    \n
    • \n
  • \n

    For source code in an Amazon S3 input bucket, one of the following.

    \n
      \n
    • \n

      The path to the ZIP file that contains the source code (for example,\n //.zip).

      \n
      • \n
    • \n

      The path to the folder that contains the source code (for example,\n ///).

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

    For source code in a GitHub repository, the HTTPS clone URL to the repository\n that contains the source and the buildspec file. You must connect your Amazon Web Services account \n to your GitHub account. Use the CodeBuild console to start creating a build\n project. When you use the console to connect (or reconnect) with GitHub, on the\n GitHub Authorize application page, for\n Organization access, choose Request access next to each repository you want to\n allow CodeBuild to have access to, and then choose Authorize\n application. (After you have connected to your GitHub account,\n you do not need to finish creating the build project. You can leave the CodeBuild\n console.) To instruct CodeBuild to use this connection, in the source\n object, set the auth object's type value to\n OAUTH.

    \n
    • \n
  • \n

    For source code in a Bitbucket repository, the HTTPS clone URL to the\n repository that contains the source and the buildspec file. You must connect\n your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start\n creating a build project. When you use the console to connect (or reconnect)\n with Bitbucket, on the Bitbucket Confirm access to your\n account page, choose Grant\n access. (After you have connected to your Bitbucket account, you\n do not need to finish creating the build project. You can leave the CodeBuild\n console.) To instruct CodeBuild to use this connection, in the source\n object, set the auth object's type value to\n OAUTH.

    \n
    • \n
\n

\n If you specify CODEPIPELINE for the Type property, don't specify this \n property. For all of the other types, you must specify Location.\n

" } }, "gitCloneDepth": { @@ -4400,19 +4418,19 @@ "buildspec": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The buildspec file declaration to use for the builds in this build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

The buildspec file declaration to use for the builds in this build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, "auth": { "target": "com.amazonaws.codebuild#SourceAuth", "traits": { - "smithy.api#documentation": "

Information about the authorization settings for AWS CodeBuild to access the source code to be\n built.

\n

This information is for the AWS CodeBuild console's use only. Your code should not get or set\n this information directly.

" + "smithy.api#documentation": "

Information about the authorization settings for CodeBuild to access the source code to be\n built.

\n

This information is for the CodeBuild console's use only. Your code should not get or set\n this information directly.

" } }, "reportBuildStatus": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Set to true to report the status of a build's start and finish to your source\n provider. This option is valid only when your source provider is GitHub, GitHub\n Enterprise, or Bitbucket. If this is set and you use a different source provider, an\n invalidInputException is thrown.

\n

To be able to report the build status to the source provider, the user associated with the source provider must\nhave write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the AWS CodeBuild User Guide.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

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

Set to true to report the status of a build's start and finish to your source\n provider. This option is valid only when your source provider is GitHub, GitHub\n Enterprise, or Bitbucket. If this is set and you use a different source provider, an\n invalidInputException is thrown.

\n

To be able to report the build status to the source provider, the user associated with the source provider must\nhave write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

\n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n

If your project's builds are triggered by a webhook, you must push a\n new commit to the repo for a change to this property to take\n effect.

" } }, "buildStatusConfig": { @@ -4451,7 +4469,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The source version for the corresponding source identifier. If specified, must be one\n of:

\n
    \n
  • \n

    For AWS CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example, pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

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

The source version for the corresponding source identifier. If specified, must be one\n of:

\n
    \n
  • \n

    For CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example, pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide.

", "smithy.api#required": {} } } @@ -4472,6 +4490,22 @@ } } }, + "com.amazonaws.codebuild#ProjectVisibilityType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Specifies the visibility of the project's builds. Possible values are:

\n\n
\n
PUBLIC_READ
\n
\n

The project builds are visible to the public.

\n
\n
PRIVATE
\n
\n

The project builds are not visible to the public.

\n
\n
", + "smithy.api#enum": [ + { + "value": "PUBLIC_READ", + "name": "PUBLIC_READ" + }, + { + "value": "PRIVATE", + "name": "PRIVATE" + } + ] + } + }, "com.amazonaws.codebuild#Projects": { "type": "list", "member": { @@ -4504,7 +4538,7 @@ "policy": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

A JSON-formatted resource policy. For more information, see Sharing\n a Project and Sharing a Report Group in the AWS CodeBuild User Guide.\n

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

A JSON-formatted resource policy. For more information, see Sharing\n a Project and Sharing a Report Group in the CodeBuild User Guide.\n

", "smithy.api#required": {} } }, @@ -4534,20 +4568,20 @@ "credential": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.

\n \n

The credential can use the name of the credentials only if they\n exist in your current AWS Region.

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

The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.

\n \n

The credential can use the name of the credentials only if they\n exist in your current Amazon Web Services Region.

\n ", "smithy.api#required": {} } }, "credentialProvider": { "target": "com.amazonaws.codebuild#CredentialProviderType", "traits": { - "smithy.api#documentation": "

The service that created the credentials to access a private Docker registry. The\n valid value, SECRETS_MANAGER, is for AWS Secrets Manager.

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

The service that created the credentials to access a private Docker registry. The\n valid value, SECRETS_MANAGER, is for Secrets Manager.

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

Information about credentials that provide access to a private Docker registry. When\n this is set:

\n
    \n
  • \n

    \n imagePullCredentialsType must be set to SERVICE_ROLE.\n

    \n
    • \n
  • \n

    images cannot be curated or an Amazon ECR image.

    \n
    • \n
\n

For more information, see Private Registry with\n AWS Secrets Manager Sample for AWS CodeBuild.

" + "smithy.api#documentation": "

Information about credentials that provide access to a private Docker registry. When\n this is set:

\n
    \n
  • \n

    \n imagePullCredentialsType must be set to SERVICE_ROLE.\n

    \n
    • \n
  • \n

    images cannot be curated or an Amazon ECR image.

    \n
    • \n
\n

For more information, see Private Registry with\n Secrets Manager Sample for CodeBuild.

" } }, "com.amazonaws.codebuild#Report": { @@ -4748,7 +4782,7 @@ "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

A list of tag key and value pairs associated with this report group.

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" + "smithy.api#documentation": "

A list of tag key and value pairs associated with this report group.

\n

These tags are available for use by Amazon Web Services services that support CodeBuild report group\n tags.

" } }, "status": { @@ -5025,7 +5059,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a resolved build artifact. A resolve artifact is an artifact that is built and\n deployed to the destination, such as Amazon S3.

" + "smithy.api#documentation": "

Represents a resolved build artifact. A resolved artifact is an artifact that is built and\n deployed to the destination, such as Amazon S3.

" } }, "com.amazonaws.codebuild#ResolvedSecondaryArtifacts": { @@ -5042,7 +5076,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified AWS resource cannot be created, because an AWS resource with the same\n settings already exists.

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

The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same\n settings already exists.

", "smithy.api#error": "client" } }, @@ -5054,7 +5088,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified AWS resource cannot be found.

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

The specified Amazon Web Services resource cannot be found.

", "smithy.api#error": "client" } }, @@ -5113,7 +5147,7 @@ "idempotencyToken": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuildBatch request. The token is included in the\n RetryBuildBatch request and is valid for five minutes. If you repeat\n the RetryBuildBatch request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuildBatch request. The token is included in the\n RetryBuildBatch request and is valid for five minutes. If you repeat\n the RetryBuildBatch request with the same token, but change a parameter,\n CodeBuild returns a parameter mismatch error.

" } }, "retryType": { @@ -5159,7 +5193,7 @@ "idempotencyToken": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuild request. The token is included in the\n RetryBuild request and is valid for five minutes. If you repeat\n the RetryBuild request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n RetryBuild request. The token is included in the\n RetryBuild request and is valid for five minutes. If you repeat\n the RetryBuild request with the same token, but change a parameter,\n CodeBuild returns a parameter mismatch error.

" } } } @@ -5214,7 +5248,7 @@ "bucketOwner": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The AWS account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket\n that is owned by an account other than the account running the build.

" + "smithy.api#documentation": "

The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket\n that is owned by an account other than the account running the build.

" } }, "path": { @@ -5226,7 +5260,7 @@ "packaging": { "target": "com.amazonaws.codebuild#ReportPackagingType", "traits": { - "smithy.api#documentation": "

The type of build output artifact to create. Valid values include:

\n
    \n
  • \n

    \n NONE: AWS CodeBuild creates the raw data in the output bucket. This\n is the default if packaging is not specified.

    \n
    • \n
  • \n

    \n ZIP: AWS CodeBuild creates a ZIP file with the raw data in the\n output bucket.

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

The type of build output artifact to create. Valid values include:

\n
    \n
  • \n

    \n NONE: CodeBuild creates the raw data in the output bucket. This\n is the default if packaging is not specified.

    \n
    • \n
  • \n

    \n ZIP: CodeBuild creates a ZIP file with the raw data in the\n output bucket.

    \n
    • \n
" } }, "encryptionKey": { @@ -5334,7 +5368,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the authorization settings for AWS CodeBuild to access the source code to be\n built.

\n

This information is for the AWS CodeBuild console's use only. Your code should not get or set\n this information directly.

" + "smithy.api#documentation": "

Information about the authorization settings for CodeBuild to access the source code to be\n built.

\n

This information is for the CodeBuild console's use only. Your code should not get or set\n this information directly.

" } }, "com.amazonaws.codebuild#SourceAuthType": { @@ -5483,7 +5517,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The version of the batch build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
AWS CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon S3
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The version of the batch build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon S3
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide.

" } }, "artifactsOverride": { @@ -5537,7 +5571,7 @@ "buildspecOverride": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, "insecureSslOverride": { @@ -5609,13 +5643,13 @@ "encryptionKeyOverride": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) that overrides the one specified in the batch build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

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

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuildBatch request. The token is included in the\n StartBuildBatch request and is valid for five minutes. If you repeat\n the StartBuildBatch request with the same token, but change a parameter,\n AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuildBatch request. The token is included in the\n StartBuildBatch request and is valid for five minutes. If you repeat\n the StartBuildBatch request with the same token, but change a parameter,\n CodeBuild returns a parameter mismatch error.

" } }, "logsConfigOverride": { @@ -5633,7 +5667,7 @@ "imagePullCredentialsTypeOverride": { "target": "com.amazonaws.codebuild#ImagePullCredentialsType", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that AWS CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust AWS CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that AWS CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an AWS CodeBuild curated image,\n you must use CODEBUILD credentials.

" + "smithy.api#documentation": "

The type of credentials CodeBuild uses to pull images in your batch build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an CodeBuild curated image,\n you must use CODEBUILD credentials.

" } }, "buildBatchConfigOverride": { @@ -5667,7 +5701,7 @@ "projectName": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild build project to start running a build.

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

The name of the CodeBuild build project to start running a build.

", "smithy.api#required": {} } }, @@ -5686,7 +5720,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

The version of the build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
AWS CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon S3
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide.

" + "smithy.api#documentation": "

The version of the build input to be built, for this build only. If not specified,\n the latest version is used. If specified, the contents depends on the source\n provider:

\n
\n
CodeCommit
\n
\n

The commit ID, branch, or Git tag to use.

\n
\n
GitHub
\n
\n

The commit ID, pull request ID, branch name, or tag name that corresponds\n to the version of the source code you want to build. If a pull request ID is\n specified, it must use the format pr/pull-request-ID (for\n example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit\n ID is used.

\n
\n
Bitbucket
\n
\n

The commit ID, branch name, or tag name that corresponds to the version of\n the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

\n
\n
Amazon S3
\n
\n

The version ID of the object that represents the build input ZIP file to\n use.

\n
\n
\n

If sourceVersion is specified at the project level, then this\n sourceVersion (at the build level) takes precedence.

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide.

" } }, "artifactsOverride": { @@ -5734,13 +5768,13 @@ "gitSubmodulesConfigOverride": { "target": "com.amazonaws.codebuild#GitSubmodulesConfig", "traits": { - "smithy.api#documentation": "

Information about the Git submodules configuration for this build of an AWS CodeBuild build\n project.

" + "smithy.api#documentation": "

Information about the Git submodules configuration for this build of an CodeBuild build\n project.

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

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same AWS Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" + "smithy.api#documentation": "

A buildspec file declaration that overrides, for this build only, the latest one\n already defined in the build project.

\n

If this value is set, it can be either an inline buildspec definition, the path to an\n alternate buildspec file relative to the value of the built-in\n CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket.\n The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec\n file using its ARN (for example,\n arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not\n provided or is set to an empty string, the source code must contain a buildspec file in\n its root directory. For more information, see Buildspec File Name and Storage Location.

" } }, "insecureSslOverride": { @@ -5752,7 +5786,7 @@ "reportBuildStatusOverride": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

Set to true to report to your source provider the status of a build's start and\n completion. If you use this option with a source provider other than GitHub, GitHub\n Enterprise, or Bitbucket, an invalidInputException is thrown.

\n

To be able to report the build status to the source provider, the user associated with the source provider must\nhave write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the AWS CodeBuild User Guide.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

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

Set to true to report to your source provider the status of a build's start and\n completion. If you use this option with a source provider other than GitHub, GitHub\n Enterprise, or Bitbucket, an invalidInputException is thrown.

\n

To be able to report the build status to the source provider, the user associated with the source provider must\nhave write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

\n \n

The status of a build triggered by a webhook is always reported to your source\n provider.

\n " } }, "buildStatusConfigOverride": { @@ -5818,13 +5852,13 @@ "encryptionKeyOverride": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) that overrides the one specified in the build\n project. The CMK key encrypts the build output artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).

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

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuild request. The token is included in the StartBuild request and is valid for 5\n minutes. If you repeat the StartBuild request with the same token, but change a\n parameter, AWS CodeBuild returns a parameter mismatch error.

" + "smithy.api#documentation": "

A unique, case sensitive identifier you provide to ensure the idempotency of the\n StartBuild request. The token is included in the StartBuild request and is valid for 5\n minutes. If you repeat the StartBuild request with the same token, but change a\n parameter, CodeBuild returns a parameter mismatch error.

" } }, "logsConfigOverride": { @@ -5842,7 +5876,7 @@ "imagePullCredentialsTypeOverride": { "target": "com.amazonaws.codebuild#ImagePullCredentialsType", "traits": { - "smithy.api#documentation": "

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that AWS CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust AWS CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that AWS CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an AWS CodeBuild curated image,\n you must use CODEBUILD credentials.

" + "smithy.api#documentation": "

The type of credentials CodeBuild uses to pull images in your build. There are two valid\n values:

\n
\n
CODEBUILD
\n
\n

Specifies that CodeBuild uses its own credentials. This requires that you\n modify your ECR repository policy to trust CodeBuild's service principal.

\n
\n
SERVICE_ROLE
\n
\n

Specifies that CodeBuild uses your build project's service role.

\n
\n
\n

When using a cross-account or private registry image, you must use\n SERVICE_ROLE credentials. When using an CodeBuild curated image,\n you must use CODEBUILD credentials.

" } }, "debugSessionEnabled": { @@ -6010,7 +6044,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tag, consisting of a key and a value.

\n

This tag is available for use by AWS services that support tags in AWS CodeBuild.

" + "smithy.api#documentation": "

A tag, consisting of a key and a value.

\n

This tag is available for use by Amazon Web Services services that support tags in CodeBuild.

" } }, "com.amazonaws.codebuild#TagList": { @@ -6200,7 +6234,7 @@ "sourceVersion": { "target": "com.amazonaws.codebuild#String", "traits": { - "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n
    \n
  • \n

    For AWS CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
\n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the AWS CodeBuild User Guide. \n

" + "smithy.api#documentation": "

A version of the build input to be built for this project. If not specified, the\n latest version is used. If specified, it must be one of:

\n
    \n
  • \n

    For CodeCommit: the commit ID, branch, or Git tag to use.

    \n
    • \n
  • \n

    For GitHub: the commit ID, pull request ID, branch name, or tag name that\n corresponds to the version of the source code you want to build. If a pull\n request ID is specified, it must use the format pr/pull-request-ID\n (for example pr/25). If a branch name is specified, the branch's\n HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is\n used.

    \n
    • \n
  • \n

    For Bitbucket: the commit ID, branch name, or tag name that corresponds to the\n version of the source code you want to build. If a branch name is specified, the\n branch's HEAD commit ID is used. If not specified, the default branch's HEAD\n commit ID is used.

    \n
    • \n
  • \n

    For Amazon S3: the version ID of the object that represents the build input ZIP\n file to use.

    \n
    • \n
\n

If sourceVersion is specified at the build level, then that version\n takes precedence over this sourceVersion (at the project level).

\n

For more information, see Source Version Sample\n with CodeBuild in the CodeBuild User Guide. \n

" } }, "secondarySourceVersions": { @@ -6236,13 +6270,13 @@ "serviceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent\n AWS services on behalf of the AWS account.

" + "smithy.api#documentation": "

The replacement ARN of the IAM role that enables CodeBuild to interact with dependent\n Amazon Web Services services on behalf of the Amazon Web Services account.

" } }, "timeoutInMinutes": { "target": "com.amazonaws.codebuild#TimeOut", "traits": { - "smithy.api#documentation": "

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before\n timing out any related build that did not get marked as completed.

" + "smithy.api#documentation": "

The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before\n timing out any related build that did not get marked as completed.

" } }, "queuedTimeoutInMinutes": { @@ -6254,19 +6288,19 @@ "encryptionKey": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" + "smithy.api#documentation": "

The Key Management Service customer master key (CMK) to be used for encrypting the build output\n artifacts.

\n \n

You can use a cross-account KMS key to encrypt the build output artifacts if your\n service role has permission to that key.

\n \n

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using\n the format alias/).\n

" } }, "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

An updated list of tag key and value pairs associated with this build project.

\n

These tags are available for use by AWS services that support AWS CodeBuild build project\n tags.

" + "smithy.api#documentation": "

An updated list of tag key and value pairs associated with this build project.

\n

These tags are available for use by Amazon Web Services services that support CodeBuild build project\n tags.

" } }, "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig", "traits": { - "smithy.api#documentation": "

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" + "smithy.api#documentation": "

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

" } }, "badgeEnabled": { @@ -6278,7 +6312,7 @@ "logsConfig": { "target": "com.amazonaws.codebuild#LogsConfig", "traits": { - "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs,\n logs in an S3 bucket, or both.

" + "smithy.api#documentation": "

Information about logs for the build project. A project can create logs in CloudWatch Logs,\n logs in an S3 bucket, or both.

" } }, "fileSystemLocations": { @@ -6309,6 +6343,70 @@ } } }, + "com.amazonaws.codebuild#UpdateProjectVisibility": { + "type": "operation", + "input": { + "target": "com.amazonaws.codebuild#UpdateProjectVisibilityInput" + }, + "output": { + "target": "com.amazonaws.codebuild#UpdateProjectVisibilityOutput" + }, + "errors": [ + { + "target": "com.amazonaws.codebuild#InvalidInputException" + }, + { + "target": "com.amazonaws.codebuild#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the public visibility for a project. The project's build results, logs, and\n artifacts are available to the general public. For more information, see Public build\n projects in the CodeBuild User Guide.

\n \n

The following should be kept in mind when making your projects public:

\n
    \n
  • \n

    All of a project's build results, logs, and artifacts, including builds that were run\n when the project was private, are available to the general public.

    \n
    • \n
  • \n

    All build logs and artifacts are available to the public. Environment variables, source\n code, and other sensitive information may have been output to the build logs and artifacts.\n You must be careful about what information is output to the build logs. Some best practice\n are:

    \n
      \n
    • \n

      Do not store sensitive values, especially Amazon Web Services access key IDs and secret access\n keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store\n or Secrets Manager to store sensitive values.

      \n
      • \n
    • \n

      Follow Best\n practices for using webhooks in the CodeBuild User\n Guide to limit which entities can trigger a build, and do\n not store the buildspec in the project itself, to ensure that your webhooks are as\n secure as possible.

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

    A malicious user can use public builds to distribute malicious artifacts. We recommend\n that you review all pull requests to verify that the pull request is a legitimate change. We\n also recommend that you validate any artifacts with their checksums to make sure that the\n correct artifacts are being downloaded.

    \n
    • \n
\n " + } + }, + "com.amazonaws.codebuild#UpdateProjectVisibilityInput": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build project.

", + "smithy.api#required": {} + } + }, + "projectVisibility": { + "target": "com.amazonaws.codebuild#ProjectVisibilityType", + "traits": { + "smithy.api#required": {} + } + }, + "resourceAccessRole": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for\n the project's builds.

" + } + } + } + }, + "com.amazonaws.codebuild#UpdateProjectVisibilityOutput": { + "type": "structure", + "members": { + "projectArn": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the build project.

" + } + }, + "publicProjectAlias": { + "target": "com.amazonaws.codebuild#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Contains the project identifier used with the public build APIs.

" + } + }, + "projectVisibility": { + "target": "com.amazonaws.codebuild#ProjectVisibilityType" + } + } + }, "com.amazonaws.codebuild#UpdateReportGroup": { "type": "operation", "input": { @@ -6348,7 +6446,7 @@ "tags": { "target": "com.amazonaws.codebuild#TagList", "traits": { - "smithy.api#documentation": "

\n An updated list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by AWS services that support AWS CodeBuild report group\n tags.

" + "smithy.api#documentation": "

\n An updated list of tag key and value pairs associated with this report group.\n

\n

These tags are available for use by Amazon Web Services services that support CodeBuild report group\n tags.

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

Updates the webhook associated with an AWS CodeBuild build project.

\n \n

If you use Bitbucket for your repository, rotateSecret is ignored.\n

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

Updates the webhook associated with an CodeBuild build project.

\n \n

If you use Bitbucket for your repository, rotateSecret is ignored.\n

\n " } }, "com.amazonaws.codebuild#UpdateWebhookInput": { @@ -6393,7 +6491,7 @@ "projectName": { "target": "com.amazonaws.codebuild#ProjectName", "traits": { - "smithy.api#documentation": "

The name of the AWS CodeBuild project.

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

The name of the CodeBuild project.

", "smithy.api#required": {} } }, @@ -6429,7 +6527,7 @@ "webhook": { "target": "com.amazonaws.codebuild#Webhook", "traits": { - "smithy.api#documentation": "

Information about a repository's webhook that is associated with a project in AWS CodeBuild.\n

" + "smithy.api#documentation": "

Information about a repository's webhook that is associated with a project in CodeBuild.\n

" } } } @@ -6467,7 +6565,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the VPC configuration that AWS CodeBuild accesses.

" + "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" } }, "com.amazonaws.codebuild#Webhook": { @@ -6482,7 +6580,7 @@ "payloadUrl": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The AWS CodeBuild endpoint where webhook events are sent.

" + "smithy.api#documentation": "

The CodeBuild endpoint where webhook events are sent.

" } }, "secret": { @@ -6517,7 +6615,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n AWS CodeBuild.

" + "smithy.api#documentation": "

Information about a webhook that connects repository events to a build project in\n CodeBuild.

" } }, "com.amazonaws.codebuild#WebhookBuildType": { diff --git a/aws/sdk/aws-models/config.json b/aws/sdk/aws-models/config.json index e614d20ebb..48cfffc737 100644 --- a/aws/sdk/aws-models/config.json +++ b/aws/sdk/aws-models/config.json @@ -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": { diff --git a/aws/sdk/aws-models/connect.json b/aws/sdk/aws-models/connect.json index ac0199f7a2..1730e2c0df 100644 --- a/aws/sdk/aws-models/connect.json +++ b/aws/sdk/aws-models/connect.json @@ -58,6 +58,177 @@ } } }, + "com.amazonaws.connect#AgentStatus": { + "type": "structure", + "members": { + "AgentStatusARN": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent status.

" + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

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

The name of the agent status.

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

The description of the agent status.

" + } + }, + "Type": { + "target": "com.amazonaws.connect#AgentStatusType", + "traits": { + "smithy.api#documentation": "

The type of agent status.

" + } + }, + "DisplayOrder": { + "target": "com.amazonaws.connect#AgentStatusOrderNumber", + "traits": { + "smithy.api#documentation": "

The display order of the agent status.

" + } + }, + "State": { + "target": "com.amazonaws.connect#AgentStatusState", + "traits": { + "smithy.api#documentation": "

The state of the agent status.

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

One or more tags.

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

Contains information about an agent status.

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

The identifier for an agent status.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the agent status.

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

The name of the agent status.

" + } + }, + "Type": { + "target": "com.amazonaws.connect#AgentStatusType", + "traits": { + "smithy.api#documentation": "

The type of the agent status.

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

Summary information for an agent status.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates an agent status for the specified Amazon Connect instance.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#AgentStatusName", + "traits": { + "smithy.api#documentation": "

The name of the status.

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

The description of the status.

" + } + }, + "State": { + "target": "com.amazonaws.connect#AgentStatusState", + "traits": { + "smithy.api#documentation": "

The state of the status.

", + "smithy.api#required": {} + } + }, + "DisplayOrder": { + "target": "com.amazonaws.connect#AgentStatusOrderNumber", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The display order of the status.

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

One or more tags.

" + } + } + } + }, + "com.amazonaws.connect#CreateAgentStatusResponse": { + "type": "structure", + "members": { + "AgentStatusARN": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent status.

" + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates hours of operation.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonNameLength127", + "traits": { + "smithy.api#documentation": "

The name of the hours of operation.

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

The description of the hours of operation.

" + } + }, + "TimeZone": { + "target": "com.amazonaws.connect#TimeZone", + "traits": { + "smithy.api#documentation": "

The time zone of the hours of operation.

", + "smithy.api#required": {} + } + }, + "Config": { + "target": "com.amazonaws.connect#HoursOfOperationConfigList", + "traits": { + "smithy.api#documentation": "

Configuration information for the hours of operation: day, start time, and end time.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

One or more tags.

" + } + } + } + }, + "com.amazonaws.connect#CreateHoursOfOperationResponse": { + "type": "structure", + "members": { + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

" + } + }, + "HoursOfOperationArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the hours of operation.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes an hours of operation.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier for the hours of operation.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes an agent status.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier for the agent status.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeAgentStatusResponse": { + "type": "structure", + "members": { + "AgentStatus": { + "target": "com.amazonaws.connect#AgentStatus", + "traits": { + "smithy.api#documentation": "

The agent status.

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

The description for the hours of operation.

" } @@ -4950,19 +5460,22 @@ "Day": { "target": "com.amazonaws.connect#HoursOfOperationDays", "traits": { - "smithy.api#documentation": "

The day that the hours of operation applies to.

" + "smithy.api#documentation": "

The day that the hours of operation applies to.

", + "smithy.api#required": {} } }, "StartTime": { "target": "com.amazonaws.connect#HoursOfOperationTimeSlice", "traits": { - "smithy.api#documentation": "

The start time that your contact center is open.

" + "smithy.api#documentation": "

The start time that your contact center is open.

", + "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.connect#HoursOfOperationTimeSlice", "traits": { - "smithy.api#documentation": "

The end time that your contact center is closes.

" + "smithy.api#documentation": "

The end time that your contact center is closes.

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

The hours.

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

The hours.

", + "smithy.api#required": {} } }, "Minutes": { "target": "com.amazonaws.connect#MinutesLimit60", "traits": { - "smithy.api#documentation": "

The minutes.

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

The minutes.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "AgentStatusTypes": { + "target": "com.amazonaws.connect#AgentStatusTypes", + "traits": { + "smithy.api#documentation": "

Available agent status types.

", + "smithy.api#httpQuery": "AgentStatusTypes" + } + } + } + }, + "com.amazonaws.connect#ListAgentStatusResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" + } + }, + "AgentStatusSummaryList": { + "target": "com.amazonaws.connect#AgentStatusSummaryList", + "traits": { + "smithy.api#documentation": "

A summary of agent statuses.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists agent statuses.

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

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, queues, quick connects, and\n contact flows.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

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

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, queues, quick connects, \n contact flows, agent status, and hours of operation.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

", "smithy.api#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": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates agent status.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AgentStatusId": { + "target": "com.amazonaws.connect#AgentStatusId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent status.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#AgentStatusName", + "traits": { + "smithy.api#documentation": "

The name of the agent status.

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

The description of the agent status.

" + } + }, + "State": { + "target": "com.amazonaws.connect#AgentStatusState", + "traits": { + "smithy.api#documentation": "

The state of the agent status.

" + } + }, + "DisplayOrder": { + "target": "com.amazonaws.connect#AgentStatusOrderNumber", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The display order of the agent status.

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

A number indicating the reset order of the agent status.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates the hours of operation.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HoursOfOperationId": { + "target": "com.amazonaws.connect#HoursOfOperationId", + "traits": { + "smithy.api#documentation": "

The identifier of the hours of operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#CommonNameLength127", + "traits": { + "smithy.api#documentation": "

The name of the hours of operation.

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

The description of the hours of operation.

" + } + }, + "TimeZone": { + "target": "com.amazonaws.connect#TimeZone", + "traits": { + "smithy.api#documentation": "

The time zone of the hours of operation.

" + } + }, + "Config": { + "target": "com.amazonaws.connect#HoursOfOperationConfigList", + "traits": { + "smithy.api#documentation": "

Configuration information of the hours of operation.

" + } + } + } + }, "com.amazonaws.connect#UpdateInstanceAttribute": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/customer-profiles.json b/aws/sdk/aws-models/customer-profiles.json index 0efb35024e..95673a4477 100644 --- a/aws/sdk/aws-models/customer-profiles.json +++ b/aws/sdk/aws-models/customer-profiles.json @@ -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": "

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.

\n

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can\n be associated with one domain.

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

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.

\n

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can\n be associated with one domain.

\n

Use this API or UpdateDomain to\n enable identity\n resolution: set Matching to true.

", "smithy.api#http": { "method": "POST", "uri": "/domains/{DomainName}", @@ -361,7 +361,7 @@ "Matching": { "target": "com.amazonaws.customerprofiles#MatchingRequest", "traits": { - "smithy.api#documentation": "

The process of matching duplicate profiles. This process runs every Saturday at 12AM.

" + "smithy.api#documentation": "

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 \nGetMatches\nAPI to return and review the results.

" } }, "Tags": { @@ -404,7 +404,7 @@ "Matching": { "target": "com.amazonaws.customerprofiles#MatchingResponse", "traits": { - "smithy.api#documentation": "

The process of matching duplicate profiles. This process runs every Saturday at 12AM.

" + "smithy.api#documentation": "

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 \nGetMatches\nAPI to return and review the results.

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

The process of matching duplicate profiles. This process runs every Saturday at 12AM.

" + "smithy.api#documentation": "

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 \nGetMatches\nAPI to return and review the results.

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

This API is in preview release for Amazon Connect and subject to change.

\n

Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.

\n

GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.

\n \n

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.

\n \n\n

Amazon Connect uses the following profile attributes to identify matches:

\n
    \n
  • \n

    PhoneNumber

    \n
    • \n
  • \n

    HomePhoneNumber

    \n
    • \n
  • \n

    BusinessPhoneNumber

    \n
    • \n
  • \n

    MobilePhoneNumber

    \n
    • \n
  • \n

    EmailAddress

    \n
    • \n
  • \n

    PersonalEmailAddress

    \n
    • \n
  • \n

    BusinessEmailAddress

    \n
    • \n
  • \n

    FullName

    \n
    • \n
  • \n

    BusinessName

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

This API is in preview release for Amazon Connect and subject to change.

\n

Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.

\n

GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.

\n \n

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.

\n \n\n

Amazon Connect uses the following profile attributes to identify matches:

\n
    \n
  • \n

    PhoneNumber

    \n
    • \n
  • \n

    HomePhoneNumber

    \n
    • \n
  • \n

    BusinessPhoneNumber

    \n
    • \n
  • \n

    MobilePhoneNumber

    \n
    • \n
  • \n

    EmailAddress

    \n
    • \n
  • \n

    PersonalEmailAddress

    \n
    • \n
  • \n

    BusinessEmailAddress

    \n
    • \n
  • \n

    FullName

    \n
    • \n
  • \n

    BusinessName

    \n
    • \n
\n

For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

", "smithy.api#http": { "method": "GET", "uri": "/domains/{DomainName}/matches", @@ -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": "

The unique identifier of a customer profile.

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

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.

" + } } } }, @@ -2940,7 +2946,7 @@ "FieldSourceProfileIds": { "target": "com.amazonaws.customerprofiles#FieldSourceProfileIds", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } } } @@ -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": "

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.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.customerprofiles#requestValueList", + "traits": { + "smithy.api#documentation": "

A list of key values.

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

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.

" } }, "com.amazonaws.customerprofiles#ObjectTypeField": { @@ -2998,7 +3026,7 @@ "StandardIdentifiers": { "target": "com.amazonaws.customerprofiles#StandardIdentifierList", "traits": { - "smithy.api#documentation": "

The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE 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.

" + "smithy.api#documentation": "

The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be 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.

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

Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.

\n

After a domain is created, the name can’t be changed.

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

Updates the properties of a domain, including creating or selecting a dead letter queue\n or an encryption key.

\n

After a domain is created, the name can’t be changed.

\n

Use this API or CreateDomain to\n enable identity\n resolution: set Matching to true.

", "smithy.api#http": { "method": "PUT", "uri": "/domains/{DomainName}", @@ -4776,7 +4812,7 @@ "Matching": { "target": "com.amazonaws.customerprofiles#MatchingRequest", "traits": { - "smithy.api#documentation": "

The process of matching duplicate profiles. This process runs every Saturday at 12AM.

" + "smithy.api#documentation": "

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 \nGetMatches\nAPI to return and review the results.

" } }, "Tags": { @@ -4818,7 +4854,7 @@ "Matching": { "target": "com.amazonaws.customerprofiles#MatchingResponse", "traits": { - "smithy.api#documentation": "

The process of matching duplicate profiles. This process runs every Saturday at 12AM.

" + "smithy.api#documentation": "

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 \nGetMatches\nAPI to return and review the results.

" } }, "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}$" } } } diff --git a/aws/sdk/aws-models/databrew.json b/aws/sdk/aws-models/databrew.json index 65356fd3c3..6c2d803237 100644 --- a/aws/sdk/aws-models/databrew.json +++ b/aws/sdk/aws-models/databrew.json @@ -3989,6 +3989,10 @@ { "value": "XML", "name": "XML" + }, + { + "value": "TABLEAUHYPER", + "name": "TABLEAUHYPER" } ] } diff --git a/aws/sdk/aws-models/ds.json b/aws/sdk/aws-models/ds.json index ac22439b94..49f84c048f 100644 --- a/aws/sdk/aws-models/ds.json +++ b/aws/sdk/aws-models/ds.json @@ -137,7 +137,7 @@ } ], "traits": { - "smithy.api#documentation": "

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

\n

Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" + "smithy.api#documentation": "

If the DNS server for your self-managed domain uses a publicly addressable IP address,\n you must add a CIDR address block to correctly route traffic to and from your Microsoft AD\n on Amazon Web Services. AddIpRoutes adds this address block. You can\n also use AddIpRoutes to facilitate routing traffic that uses public IP\n ranges from your Microsoft AD on Amazon Web Services to a peer VPC.

\n

Before you call AddIpRoutes, ensure that all of the required\n permissions have been explicitly granted through a policy. For details about what\n permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" } }, "com.amazonaws.directoryservice#AddIpRoutesRequest": { @@ -153,14 +153,14 @@ "IpRoutes": { "target": "com.amazonaws.directoryservice#IpRoutes", "traits": { - "smithy.api#documentation": "

IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

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

IP address blocks, using CIDR format, of the traffic to route. This is often the IP\n address block of the DNS server used for your self-managed domain.

", "smithy.api#required": {} } }, "UpdateSecurityGroupForDirectoryControllers": { "target": "com.amazonaws.directoryservice#UpdateSecurityGroupForDirectoryControllers", "traits": { - "smithy.api#documentation": "

If set to true, updates the inbound and outbound rules of the security group that has the description: \"AWS created security group for directory ID directory controllers.\"\n Following are the new rules:\n

\n

Inbound:

\n
    \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

    \n
    • \n
\n \n

\n

Outbound:

\n
    \n
  • \n

    Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

    \n
    • \n
\n

These security rules impact an internal network interface that is not exposed publicly.

" + "smithy.api#documentation": "

If set to true, updates the inbound and outbound rules of the security group that has\n the description: \"Amazon Web Services created security group for directory ID\n directory controllers.\" Following are the new rules:

\n

Inbound:

\n
    \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source:\n 0.0.0.0/0

    \n
    • \n
  • \n

    Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source:\n 0.0.0.0/0

    \n
    • \n
  • \n

    Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0

    \n
    • \n
  • \n

    Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

    \n
    • \n
\n\n

\n

Outbound:

\n
    \n
  • \n

    Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

    \n
    • \n
\n

These security rules impact an internal network interface that is not exposed\n publicly.

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

Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.

" + "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified directory. Each directory can\n have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be\n unique to each resource.

" } }, "com.amazonaws.directoryservice#AddTagsToResourceRequest": { @@ -310,7 +310,7 @@ "min": 1, "max": 62 }, - "smithy.api#pattern": "^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*" + "smithy.api#pattern": "^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$" } }, "com.amazonaws.directoryservice#Attribute": { @@ -400,7 +400,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.

" + "smithy.api#documentation": "

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema\n extension has started replicating to all domain controllers, the task can no longer be\n canceled. A schema extension can be canceled during any of the following states;\n Initializing, CreatingSnapshot, and\n UpdatingSchema.

" } }, "com.amazonaws.directoryservice#CancelSchemaExtensionRequest": { @@ -671,6 +671,53 @@ "target": "com.amazonaws.directoryservice#CidrIp" } }, + "com.amazonaws.directoryservice#ClientAuthenticationSettingInfo": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.directoryservice#ClientAuthenticationType", + "traits": { + "smithy.api#documentation": "

The type of client authentication for the specified directory. If no type is specified, a list of all client authentication types that are supported for the directory is retrieved.

" + } + }, + "Status": { + "target": "com.amazonaws.directoryservice#ClientAuthenticationStatus", + "traits": { + "smithy.api#documentation": "

Whether the client authentication type is enabled or disabled for the specified directory.

" + } + }, + "LastUpdatedDateTime": { + "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the status of the client authentication type was last updated.

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

Contains information about a client authentication method for a directory.

" + } + }, + "com.amazonaws.directoryservice#ClientAuthenticationSettingsInfo": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#ClientAuthenticationSettingInfo" + } + }, + "com.amazonaws.directoryservice#ClientAuthenticationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "ENABLED" + }, + { + "value": "Disabled", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.directoryservice#ClientAuthenticationType": { "type": "string", "traits": { @@ -756,7 +803,7 @@ "min": 8, "max": 64 }, - "smithy.api#pattern": "[\\u0020-\\u00FF]+", + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$", "smithy.api#sensitive": {} } }, @@ -766,24 +813,24 @@ "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.

" + "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domains pointed to by the\n conditional forwarder.

" } }, "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.

" + "smithy.api#documentation": "

The IP addresses of the remote DNS server associated with RemoteDomainName. This is the\n IP address of the DNS server that your conditional forwarder points to.

" } }, "ReplicationScope": { "target": "com.amazonaws.directoryservice#ReplicationScope", "traits": { - "smithy.api#documentation": "

The replication scope of the conditional forwarder. The only allowed value is\n Domain, which will replicate the conditional forwarder to all of the\n domain controllers for your AWS directory.

" + "smithy.api#documentation": "

The replication scope of the conditional forwarder. The only allowed value is\n Domain, which will replicate the conditional forwarder to all of the domain\n controllers for your Amazon Web Services directory.

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

Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.

" + "smithy.api#documentation": "

Points to a remote domain with which you are setting up a trust relationship.\n Conditional forwarders are required in order to set up a trust relationship with another\n domain.

" } }, "com.amazonaws.directoryservice#ConditionalForwarders": { @@ -815,7 +862,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an AD Connector to connect to an on-premises directory.

\n

Before you call ConnectDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.

" + "smithy.api#documentation": "

Creates an AD Connector to connect to a self-managed directory.

\n

Before you call ConnectDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.

" } }, "com.amazonaws.directoryservice#ConnectDirectoryRequest": { @@ -824,20 +871,20 @@ "Name": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { - "smithy.api#documentation": "

The fully qualified name of the on-premises directory, such as\n corp.example.com.

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

The fully qualified name of your self-managed directory, such as\n corp.example.com.

", "smithy.api#required": {} } }, "ShortName": { "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { - "smithy.api#documentation": "

The NetBIOS name of the on-premises directory, such as CORP.

" + "smithy.api#documentation": "

The NetBIOS name of your self-managed directory, such as CORP.

" } }, "Password": { "target": "com.amazonaws.directoryservice#ConnectPassword", "traits": { - "smithy.api#documentation": "

The password for the on-premises user account.

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

The password for your self-managed user account.

", "smithy.api#required": {} } }, @@ -941,7 +988,7 @@ "Alias": { "target": "com.amazonaws.directoryservice#AliasName", "traits": { - "smithy.api#documentation": "

The requested alias.

\n

The alias must be unique amongst all aliases in AWS. This operation throws an\n EntityAlreadyExistsException error if the alias already exists.

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

The requested alias.

\n

The alias must be unique amongst all aliases in Amazon Web Services. This operation throws an\n EntityAlreadyExistsException error if the alias already exists.

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

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

" + "smithy.api#documentation": "

Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional\n forwarders are required in order to set up a trust relationship with another domain. The\n conditional forwarder points to the trusted domain.

" } }, "com.amazonaws.directoryservice#CreateConditionalForwarderRequest": { @@ -1104,14 +1151,14 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The directory ID of the AWS directory for which you are creating the conditional forwarder.

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

The directory ID of the Amazon Web Services directory for which you are creating the conditional\n forwarder.

", "smithy.api#required": {} } }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

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

The fully qualified domain name (FQDN) of the remote domain with which you will set up\n a trust relationship.

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

Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.

" + "smithy.api#documentation": "

Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active\n Directory. Conditional forwarders are required in order to set up a trust relationship with\n another domain.

" } }, "com.amazonaws.directoryservice#CreateConditionalForwarderResult": { @@ -1157,7 +1204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Simple AD directory. For more information, see Simple Active Directory in the AWS Directory Service Admin\n Guide.

\n

Before you call CreateDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.

" + "smithy.api#documentation": "

Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin\n Guide.

\n

Before you call CreateDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.

" } }, "com.amazonaws.directoryservice#CreateDirectoryRequest": { @@ -1256,7 +1303,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a subscription to forward real-time Directory Service domain controller security\n logs to the specified Amazon CloudWatch log group in your AWS account.

" + "smithy.api#documentation": "

Creates a subscription to forward real-time Directory Service domain controller security\n logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.

" } }, "com.amazonaws.directoryservice#CreateLogSubscriptionRequest": { @@ -1308,7 +1355,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide.

\n

Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" + "smithy.api#documentation": "

Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.

\n

Before you call CreateMicrosoftAD, ensure that all of the required\n permissions have been explicitly granted through a policy. For details about what permissions\n are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" } }, "com.amazonaws.directoryservice#CreateMicrosoftADRequest": { @@ -1317,14 +1364,14 @@ "Name": { "target": "com.amazonaws.directoryservice#DirectoryName", "traits": { - "smithy.api#documentation": "

The fully qualified domain name for the AWS Managed Microsoft AD directory, such as\n corp.example.com. This name will resolve inside your VPC only. It does not need\n to be publicly resolvable.

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

The fully qualified domain name for the Managed Microsoft AD directory, such as\n corp.example.com. This name will resolve inside your VPC only. It does not need\n to be publicly resolvable.

", "smithy.api#required": {} } }, "ShortName": { "target": "com.amazonaws.directoryservice#DirectoryShortName", "traits": { - "smithy.api#documentation": "

The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

" + "smithy.api#documentation": "

The NetBIOS name for your domain, such as CORP. If you don't specify a\n NetBIOS name, it will default to the first part of your directory DNS. For example,\n CORP for the directory DNS corp.example.com.

" } }, "Password": { @@ -1337,7 +1384,7 @@ "Description": { "target": "com.amazonaws.directoryservice#Description", "traits": { - "smithy.api#documentation": "

A description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.

" + "smithy.api#documentation": "

A description for the directory. This label will appear on the Amazon Web Services console\n Directory Details page after the directory is created.

" } }, "VpcSettings": { @@ -1350,18 +1397,18 @@ "Edition": { "target": "com.amazonaws.directoryservice#DirectoryEdition", "traits": { - "smithy.api#documentation": "

AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

" + "smithy.api#documentation": "

Managed Microsoft AD is available in two editions: Standard and\n Enterprise. Enterprise is the default.

" } }, "Tags": { "target": "com.amazonaws.directoryservice#Tags", "traits": { - "smithy.api#documentation": "

The tags to be assigned to the AWS Managed Microsoft AD directory.

" + "smithy.api#documentation": "

The tags to be assigned to the Managed Microsoft AD directory.

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

Creates an AWS Managed Microsoft AD directory.

" + "smithy.api#documentation": "

Creates an Managed Microsoft AD directory.

" } }, "com.amazonaws.directoryservice#CreateMicrosoftADResult": { @@ -1404,7 +1451,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

\n \n

You cannot take snapshots of AD Connector directories.

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

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

\n \n

You cannot take snapshots of AD Connector directories.

\n " } }, "com.amazonaws.directoryservice#CreateSnapshotBeforeSchemaExtension": { @@ -1474,7 +1521,7 @@ } ], "traits": { - "smithy.api#documentation": "

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

\n

This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

" + "smithy.api#documentation": "

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For\n example, you can establish a trust between your Managed Microsoft AD directory, and your existing\n self-managed Microsoft Active Directory. This would allow you to provide users and groups\n access to resources in either domain, with a single set of credentials.

\n

This action initiates the creation of the Amazon Web Services side of a trust relationship between an\n Managed Microsoft AD directory and an external domain. You can create either a forest trust or an\n external trust.

" } }, "com.amazonaws.directoryservice#CreateTrustRequest": { @@ -1483,21 +1530,21 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.

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

The Directory ID of the Managed Microsoft AD directory for which to establish the trust\n relationship.

", "smithy.api#required": {} } }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

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

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the\n trust relationship.

", "smithy.api#required": {} } }, "TrustPassword": { "target": "com.amazonaws.directoryservice#TrustPassword", "traits": { - "smithy.api#documentation": "

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

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

The trust password. The must be the same password that was used when creating the trust\n relationship on the external domain.

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

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

\n

This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain.

" + "smithy.api#documentation": "

Directory Service for Microsoft Active Directory allows you to configure trust relationships. For\n example, you can establish a trust between your Managed Microsoft AD directory, and your existing\n self-managed Microsoft Active Directory. This would allow you to provide users and groups\n access to resources in either domain, with a single set of credentials.

\n

This action initiates the creation of the Amazon Web Services side of a trust relationship between an\n Managed Microsoft AD directory and an external domain.

" } }, "com.amazonaws.directoryservice#CreateTrustResult": { @@ -1596,7 +1643,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a conditional forwarder that has been set up for your AWS directory.

" + "smithy.api#documentation": "

Deletes a conditional forwarder that has been set up for your Amazon Web Services\n directory.

" } }, "com.amazonaws.directoryservice#DeleteConditionalForwarderRequest": { @@ -1612,7 +1659,7 @@ "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

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

The fully qualified domain name (FQDN) of the remote domain with which you are deleting\n the conditional forwarder.

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

Deletes an AWS Directory Service directory.

\n

Before you call DeleteDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.

" + "smithy.api#documentation": "

Deletes an Directory Service directory.

\n

Before you call DeleteDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.

" } }, "com.amazonaws.directoryservice#DeleteDirectoryRequest": { @@ -1803,7 +1850,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.

" + "smithy.api#documentation": "

Deletes an existing trust relationship between your Managed Microsoft AD directory and an external\n domain.

" } }, "com.amazonaws.directoryservice#DeleteTrustRequest": { @@ -1824,7 +1871,7 @@ } }, "traits": { - "smithy.api#documentation": "

Deletes the local side of an existing trust relationship between the AWS Managed Microsoft AD directory and the external domain.

" + "smithy.api#documentation": "

Deletes the local side of an existing trust relationship between the Managed Microsoft AD\n directory and the external domain.

" } }, "com.amazonaws.directoryservice#DeleteTrustResult": { @@ -1925,7 +1972,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified directory as a publisher to the specified SNS topic.

" + "smithy.api#documentation": "

Removes the specified directory as a publisher to the specified Amazon SNS topic.

" } }, "com.amazonaws.directoryservice#DeregisterEventTopicRequest": { @@ -1934,20 +1981,20 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.

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

The Directory ID to remove as a publisher. This directory will no longer send messages\n to the specified Amazon SNS topic.

", "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.directoryservice#TopicName", "traits": { - "smithy.api#documentation": "

The name of the SNS topic from which to remove the directory as a publisher.

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

The name of the Amazon SNS topic from which to remove the directory as a\n publisher.

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

Removes the specified directory as a publisher to the specified SNS topic.

" + "smithy.api#documentation": "

Removes the specified directory as a publisher to the specified Amazon SNS topic.

" } }, "com.amazonaws.directoryservice#DeregisterEventTopicResult": { @@ -2019,6 +2066,85 @@ } } }, + "com.amazonaws.directoryservice#DescribeClientAuthenticationSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#DescribeClientAuthenticationSettingsRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#DescribeClientAuthenticationSettingsResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#AccessDeniedException" + }, + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.\n

" + } + }, + "com.amazonaws.directoryservice#DescribeClientAuthenticationSettingsRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to retrieve information.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.directoryservice#ClientAuthenticationType", + "traits": { + "smithy.api#documentation": "

The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.

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

The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.

" + } + }, + "Limit": { + "target": "com.amazonaws.directoryservice#PageLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

" + } + } + } + }, + "com.amazonaws.directoryservice#DescribeClientAuthenticationSettingsResult": { + "type": "structure", + "members": { + "ClientAuthenticationSettingsInfo": { + "target": "com.amazonaws.directoryservice#ClientAuthenticationSettingsInfo", + "traits": { + "smithy.api#documentation": "

Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.

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

The next token used to retrieve the client authentication settings if the number of setting types exceeds\n page limit and there is another page.

" + } + } + } + }, "com.amazonaws.directoryservice#DescribeConditionalForwarders": { "type": "operation", "input": { @@ -2048,7 +2174,7 @@ } ], "traits": { - "smithy.api#documentation": "

Obtains information about the conditional forwarders for this account.

\n

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

" + "smithy.api#documentation": "

Obtains information about the conditional forwarders for this account.

\n

If no input parameters are provided for RemoteDomainNames, this request describes all\n conditional forwarders for the specified directory ID.

" } }, "com.amazonaws.directoryservice#DescribeConditionalForwardersRequest": { @@ -2057,14 +2183,14 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The directory ID for which to get the list of associated conditional forwarders.

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

The directory ID for which to get the list of associated conditional\n forwarders.

", "smithy.api#required": {} } }, "RemoteDomainNames": { "target": "com.amazonaws.directoryservice#RemoteDomainNames", "traits": { - "smithy.api#documentation": "

The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

" + "smithy.api#documentation": "

The fully qualified domain names (FQDN) of the remote domains for which to get the list\n of associated conditional forwarders. If this member is null, all conditional forwarders are\n returned.

" } } }, @@ -2204,20 +2330,20 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier of the directory for which to retrieve the domain controller information.

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

Identifier of the directory for which to retrieve the domain controller\n information.

", "smithy.api#required": {} } }, "DomainControllerIds": { "target": "com.amazonaws.directoryservice#DomainControllerIds", "traits": { - "smithy.api#documentation": "

A list of identifiers for the domain controllers whose information will be provided.

" + "smithy.api#documentation": "

A list of identifiers for the domain controllers whose information will be\n provided.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.

" + "smithy.api#documentation": "

The DescribeDomainControllers.NextToken value from a previous call\n to DescribeDomainControllers. Pass null if this is the first call.\n

" } }, "Limit": { @@ -2240,7 +2366,7 @@ "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.

" + "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken\n parameter in a subsequent call to DescribeDomainControllers retrieve the\n next set of items.

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

Obtains information about which SNS topics receive status messages from the specified directory.

\n

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

" + "smithy.api#documentation": "

Obtains information about which Amazon SNS topics receive status messages from the specified\n directory.

\n

If no input parameters are provided, such as DirectoryId or TopicName, this request\n describes all of the associations in the account.

" } }, "com.amazonaws.directoryservice#DescribeEventTopicsRequest": { @@ -2277,13 +2403,13 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

" + "smithy.api#documentation": "

The Directory ID for which to get the list of associated Amazon SNS topics. If this member\n is null, associations for all Directory IDs are returned.

" } }, "TopicNames": { "target": "com.amazonaws.directoryservice#TopicNames", "traits": { - "smithy.api#documentation": "

A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

\n

An empty list results in an InvalidParameterException being thrown.

" + "smithy.api#documentation": "

A list of Amazon SNS topic names for which to obtain the information. If this member is\n null, all associations for the specified Directory ID are returned.

\n

An empty list results in an InvalidParameterException being\n thrown.

" } } }, @@ -2297,7 +2423,7 @@ "EventTopics": { "target": "com.amazonaws.directoryservice#EventTopics", "traits": { - "smithy.api#documentation": "

A list of SNS topic names that receive status messages from the specified Directory ID.

" + "smithy.api#documentation": "

A list of Amazon SNS topic names that receive status messages from the specified Directory\n ID.

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

Obtains information about the trust relationships for this account.

\n

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

" + "smithy.api#documentation": "

Obtains information about the trust relationships for this account.

\n

If no input parameters are provided, such as DirectoryId or TrustIds, this request\n describes all the trust relationships belonging to the account.

" } }, "com.amazonaws.directoryservice#DescribeTrustsRequest": { @@ -2658,19 +2784,19 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The Directory ID of the AWS directory that is a part of the requested trust relationship.

" + "smithy.api#documentation": "

The Directory ID of the Amazon Web Services directory that is a part of the requested trust\n relationship.

" } }, "TrustIds": { "target": "com.amazonaws.directoryservice#TrustIds", "traits": { - "smithy.api#documentation": "

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

\n

An empty list results in an InvalidParameterException being thrown.

" + "smithy.api#documentation": "

A list of identifiers of the trust relationships for which to obtain the information. If\n this member is null, all trust relationships that belong to the current account are\n returned.

\n

An empty list results in an InvalidParameterException being thrown.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

The DescribeTrustsResult.NextToken value from a previous call to\n DescribeTrusts. Pass null if this is the first call.

" + "smithy.api#documentation": "

The DescribeTrustsResult.NextToken value from a previous call to\n DescribeTrusts. Pass null if this is the first call.

" } }, "Limit": { @@ -2681,7 +2807,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the trust relationships for a particular AWS Managed Microsoft AD directory. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.

" + "smithy.api#documentation": "

Describes the trust relationships for a particular Managed Microsoft AD directory. If no input\n parameters are provided, such as directory ID or trust ID, this request describes all the\n trust relationships.

" } }, "com.amazonaws.directoryservice#DescribeTrustsResult": { @@ -2690,13 +2816,13 @@ "Trusts": { "target": "com.amazonaws.directoryservice#Trusts", "traits": { - "smithy.api#documentation": "

The list of Trust objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" + "smithy.api#documentation": "

The list of Trust objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the\n requested number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter\n in a subsequent call to DescribeTrusts to retrieve the next set of items.

" + "smithy.api#documentation": "

If not null, more results are available. Pass this value for the\n NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.

" } } }, @@ -2733,7 +2859,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Region you specified is the same Region where the AWS Managed Microsoft AD directory\n was created. Specify a different Region and try again.

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

The Region you specified is the same Region where the Managed Microsoft AD directory\n was created. Specify a different Region and try again.

", "smithy.api#error": "client" } }, @@ -2748,7 +2874,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified directory has already been shared with this AWS account.

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

The specified directory has already been shared with this Amazon Web Services account.

", "smithy.api#error": "client" } }, @@ -2772,14 +2898,14 @@ "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

A list of one or more IP addresses of DNS servers or domain controllers in the on-premises\n directory.

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

A list of one or more IP addresses of DNS servers or domain controllers in your self-managed\n directory.

", "smithy.api#required": {} } }, "CustomerUserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { - "smithy.api#documentation": "

The user name of an account in the on-premises directory that is used to connect to the\n directory. This account must have the following permissions:

\n
    \n
  • \n

    Read users and groups

    \n
    • \n
  • \n

    Create computer objects

    \n
    • \n
  • \n

    Join computers to the domain

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

The user name of an account in your self-managed directory that is used to connect to the\n directory. This account must have the following permissions:

\n
    \n
  • \n

    Read users and groups

    \n
    • \n
  • \n

    Create computer objects

    \n
    • \n
  • \n

    Join computers to the domain

    \n
    • \n
", "smithy.api#required": {} } } @@ -2806,7 +2932,7 @@ "CustomerUserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { - "smithy.api#documentation": "

The user name of the service account in the on-premises directory.

" + "smithy.api#documentation": "

The user name of the service account in your self-managed directory.

" } }, "SecurityGroupId": { @@ -2886,7 +3012,7 @@ "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For\n an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers\n in the on-premises directory to which the AD Connector is connected.

" + "smithy.api#documentation": "

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For\n an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers\n in your self-managed directory to which the AD Connector is connected.

" } }, "Stage": { @@ -2898,13 +3024,13 @@ "ShareStatus": { "target": "com.amazonaws.directoryservice#ShareStatus", "traits": { - "smithy.api#documentation": "

Current directory status of the shared AWS Managed Microsoft AD directory.

" + "smithy.api#documentation": "

Current directory status of the shared Managed Microsoft AD directory.

" } }, "ShareMethod": { "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { - "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a shared directory request (HANDSHAKE).

" + "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by\n sending a shared directory request (HANDSHAKE).

" } }, "ShareNotes": { @@ -2934,7 +3060,7 @@ "VpcSettings": { "target": "com.amazonaws.directoryservice#DirectoryVpcSettingsDescription", "traits": { - "smithy.api#documentation": "

A DirectoryVpcSettingsDescription object that contains additional\n information about a directory. This member is only present if the directory is a Simple AD or\n Managed AD directory.

" + "smithy.api#documentation": "

A DirectoryVpcSettingsDescription object that contains additional\n information about a directory. This member is only present if the directory is a Simple AD or\n Managed Microsoft AD directory.

" } }, "ConnectSettings": { @@ -2970,13 +3096,13 @@ "DesiredNumberOfDomainControllers": { "target": "com.amazonaws.directoryservice#DesiredNumberOfDomainControllers", "traits": { - "smithy.api#documentation": "

The desired number of domain controllers in the directory if the directory is Microsoft AD.

" + "smithy.api#documentation": "

The desired number of domain controllers in the directory if the directory is Microsoft\n AD.

" } }, "OwnerDirectoryDescription": { "target": "com.amazonaws.directoryservice#OwnerDirectoryDescription", "traits": { - "smithy.api#documentation": "

Describes the AWS Managed Microsoft AD directory in the directory owner account.

" + "smithy.api#documentation": "

Describes the Managed Microsoft AD directory in the directory owner account.

" } }, "RegionsInfo": { @@ -2987,7 +3113,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about an AWS Directory Service directory.

" + "smithy.api#documentation": "

Contains information about an Directory Service directory.

" } }, "com.amazonaws.directoryservice#DirectoryDescriptions": { @@ -3055,7 +3181,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of directories in the region has been reached. You can use the\n GetDirectoryLimits operation to determine your directory limits in the\n region.

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

The maximum number of directories in the region has been reached. You can use the\n GetDirectoryLimits operation to determine your directory limits in\n the region.

", "smithy.api#error": "client" } }, @@ -3083,19 +3209,19 @@ "CloudOnlyMicrosoftADLimit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

The maximum number of AWS Managed Microsoft AD directories allowed in the region.

" + "smithy.api#documentation": "

The maximum number of Managed Microsoft AD directories allowed in the region.

" } }, "CloudOnlyMicrosoftADCurrentCount": { "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

The current number of AWS Managed Microsoft AD directories in the region.

" + "smithy.api#documentation": "

The current number of Managed Microsoft AD directories in the region.

" } }, "CloudOnlyMicrosoftADLimitReached": { "target": "com.amazonaws.directoryservice#CloudOnlyDirectoriesLimitReached", "traits": { - "smithy.api#documentation": "

Indicates if the AWS Managed Microsoft AD directory limit has been reached.

" + "smithy.api#documentation": "

Indicates if the Managed Microsoft AD directory limit has been reached.

" } }, "ConnectedDirectoriesLimit": { @@ -3138,7 +3264,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified directory has not been shared with this AWS account.

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

The specified directory has not been shared with this Amazon Web Services account.

", "smithy.api#error": "client" } }, @@ -3212,6 +3338,9 @@ { "target": "com.amazonaws.directoryservice#DescribeCertificate" }, + { + "target": "com.amazonaws.directoryservice#DescribeClientAuthenticationSettings" + }, { "target": "com.amazonaws.directoryservice#DescribeConditionalForwarders" }, @@ -3345,7 +3474,7 @@ "name": "ds" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Directory Service\n

AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

\n \n

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web\n Services.

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

Directory Service is a web service that makes it easy for you to setup and run directories in the\n Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active\n Directory. This guide provides detailed information about Directory Service operations, data types,\n parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service\n Administration Guide.

\n \n

Amazon Web Services provides SDKs that consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs\n provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services\n services. For more information about the Amazon Web Services SDKs, including how to download and\n install them, see Tools for Amazon Web\n Services.

\n ", "smithy.api#title": "AWS Directory Service", "smithy.api#xmlNamespace": { "uri": "http://directoryservice.amazonaws.com/doc/2015-04-16/" @@ -3475,7 +3604,7 @@ "SubnetIds": { "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { - "smithy.api#documentation": "

The identifiers of the subnets for the directory servers. The two subnets must be in\n different Availability Zones. AWS Directory Service creates a directory server and a DNS\n server in each of these subnets.

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

The identifiers of the subnets for the directory servers. The two subnets must be in\n different Availability Zones. Directory Service creates a directory server and a DNS\n server in each of these subnets.

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

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

" + "smithy.api#documentation": "

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In\n User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

" } }, "com.amazonaws.directoryservice#DisableRadiusRequest": { @@ -3716,13 +3845,13 @@ "UserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { - "smithy.api#documentation": "

The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.

\n

If the AD Connector service account does not have privileges to remove a service principal\n name, you can specify an alternate account with the UserName and Password\n parameters. These credentials are only used to disable single sign-on and are not stored by\n the service. The AD Connector service account is not changed.

" + "smithy.api#documentation": "

The username of an alternate account to use to disable single-sign on. This is only used\n for AD Connector directories. This account must have privileges to remove a service\n principal name.

\n

If the AD Connector service account does not have privileges to remove a service\n principal name, you can specify an alternate account with the UserName\n and Password parameters. These credentials are only used to disable\n single sign-on and are not stored by the service. The AD Connector service account is not\n changed.

" } }, "Password": { "target": "com.amazonaws.directoryservice#ConnectPassword", "traits": { - "smithy.api#documentation": "

The password of an alternate account to use to disable single-sign on. This is only used\n for AD Connector directories. For more information, see the UserName parameter.

" + "smithy.api#documentation": "

The password of an alternate account to use to disable single-sign on. This is only used\n for AD Connector directories. For more information, see the UserName\n parameter.

" } } }, @@ -3834,7 +3963,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.

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

The maximum allowed number of domain controllers per directory was exceeded. The\n default limit per directory is 20 domain controllers.

", "smithy.api#error": "client" } }, @@ -3930,7 +4059,7 @@ "Type": { "target": "com.amazonaws.directoryservice#ClientAuthenticationType", "traits": { - "smithy.api#documentation": "

The type of client authentication to enable. Currently only the value SmartCard is\n supported. Smart card authentication in AD Connector requires that you enable Kerberos\n Constrained Delegation for the Service User to the LDAP service in the on-premises AD.\n

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

The type of client authentication to enable. Currently only the value SmartCard is\n supported. Smart card authentication in AD Connector requires that you enable Kerberos\n Constrained Delegation for the Service User to the LDAP service in your self-managed AD.\n

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

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

" + "smithy.api#documentation": "

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User\n Service (RADIUS) server for an AD Connector or Microsoft AD directory.

" } }, "com.amazonaws.directoryservice#EnableRadiusRequest": { @@ -4043,7 +4172,7 @@ "RadiusSettings": { "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { - "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS server.

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

A RadiusSettings object that contains information about the RADIUS\n server.

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

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.

" + "smithy.api#documentation": "

Enables single sign-on for a directory. Single sign-on allows users in your directory to\n access certain Amazon Web Services services from a computer joined to the directory without having to enter\n their credentials separately.

" } }, "com.amazonaws.directoryservice#EnableSsoRequest": { @@ -4101,13 +4230,13 @@ "UserName": { "target": "com.amazonaws.directoryservice#UserName", "traits": { - "smithy.api#documentation": "

The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

\n

If the AD Connector service account does not have privileges to add a service principal\n name, you can specify an alternate account with the UserName and Password\n parameters. These credentials are only used to enable single sign-on and are not stored by\n the service. The AD Connector service account is not changed.

" + "smithy.api#documentation": "

The username of an alternate account to use to enable single-sign on. This is only used\n for AD Connector directories. This account must have privileges to add a service principal\n name.

\n

If the AD Connector service account does not have privileges to add a service principal\n name, you can specify an alternate account with the UserName and\n Password parameters. These credentials are only used to enable single\n sign-on and are not stored by the service. The AD Connector service account is not\n changed.

" } }, "Password": { "target": "com.amazonaws.directoryservice#ConnectPassword", "traits": { - "smithy.api#documentation": "

The password of an alternate account to use to enable single-sign on. This is only used for\n AD Connector directories. For more information, see the UserName parameter.

" + "smithy.api#documentation": "

The password of an alternate account to use to enable single-sign on. This is only used\n for AD Connector directories. For more information, see the UserName\n parameter.

" } } }, @@ -4161,25 +4290,25 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.

" + "smithy.api#documentation": "

The Directory ID of an Directory Service directory that will publish status messages to an Amazon SNS\n topic.

" } }, "TopicName": { "target": "com.amazonaws.directoryservice#TopicName", "traits": { - "smithy.api#documentation": "

The name of an AWS SNS topic the receives status messages from the directory.

" + "smithy.api#documentation": "

The name of an Amazon SNS topic the receives status messages from the directory.

" } }, "TopicArn": { "target": "com.amazonaws.directoryservice#TopicArn", "traits": { - "smithy.api#documentation": "

The SNS topic ARN (Amazon Resource Name).

" + "smithy.api#documentation": "

The Amazon SNS topic ARN (Amazon Resource Name).

" } }, "CreatedDateTime": { "target": "com.amazonaws.directoryservice#CreatedDateTime", "traits": { - "smithy.api#documentation": "

The date and time of when you associated your directory with the SNS topic.

" + "smithy.api#documentation": "

The date and time of when you associated your directory with the Amazon SNS topic.

" } }, "Status": { @@ -4190,7 +4319,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about SNS topic and AWS Directory Service directory associations.

" + "smithy.api#documentation": "

Information about Amazon SNS topic and Directory Service directory associations.

" } }, "com.amazonaws.directoryservice#EventTopics": { @@ -4241,7 +4370,7 @@ "DirectoryLimits": { "target": "com.amazonaws.directoryservice#DirectoryLimits", "traits": { - "smithy.api#documentation": "

A DirectoryLimits object that contains the directory limits for the\n current rRegion.

" + "smithy.api#documentation": "

A DirectoryLimits object that contains the directory limits for the\n current Region.

" } } }, @@ -4402,7 +4531,7 @@ } }, "traits": { - "smithy.api#documentation": "

The new password provided by the user does not meet the password complexity requirements defined in your directory.

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

The new password provided by the user does not meet the password complexity\n requirements defined in your directory.

", "smithy.api#error": "client" } }, @@ -4439,7 +4568,7 @@ "CidrIp": { "target": "com.amazonaws.directoryservice#CidrIp", "traits": { - "smithy.api#documentation": "

IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.

" + "smithy.api#documentation": "

IP address block using CIDR format, for example 10.0.0.0/24. This is often the\n address block of the DNS server used for your self-managed domain. For a single IP address\n use a CIDR address block with /32. For example 10.0.0.0/32.

" } }, "Description": { @@ -4450,7 +4579,7 @@ } }, "traits": { - "smithy.api#documentation": "

IP address block. This is often the address block of the DNS server used for your on-premises domain.

" + "smithy.api#documentation": "

IP address block. This is often the address block of the DNS server used for your\n self-managed domain.

" } }, "com.amazonaws.directoryservice#IpRouteInfo": { @@ -4508,7 +4637,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.

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

The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP\n address blocks.

", "smithy.api#error": "client" } }, @@ -4759,20 +4888,20 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

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

Identifier (ID) of the directory for which you want to retrieve the IP\n addresses.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

The ListIpRoutes.NextToken value from a previous call to\n ListIpRoutes. Pass null if this is the first call.

" + "smithy.api#documentation": "

The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.

" } }, "Limit": { "target": "com.amazonaws.directoryservice#Limit", "traits": { - "smithy.api#documentation": "

Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

" + "smithy.api#documentation": "

Maximum number of items to return. If this value is zero, the maximum number of items\n is specified by the limitations of the operation.

" } } } @@ -4789,7 +4918,7 @@ "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter\n in a subsequent call to ListIpRoutes to retrieve the next set of items.

" + "smithy.api#documentation": "

If not null, more results are available. Pass this value for the\n NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.

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

Lists the active log subscriptions for the AWS account.

" + "smithy.api#documentation": "

Lists the active log subscriptions for the Amazon Web Services account.

" } }, "com.amazonaws.directoryservice#ListLogSubscriptionsRequest": { @@ -4826,7 +4955,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

If a DirectoryID is provided, lists only the log subscription\n associated with that directory. If no DirectoryId is provided, lists all\n log subscriptions associated with your AWS account. If there are no log subscriptions for the\n AWS account or the directory, an empty list will be returned.

" + "smithy.api#documentation": "

If a DirectoryID is provided, lists only the log subscription\n associated with that directory. If no DirectoryId is provided, lists all\n log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the\n Amazon Web Services account or the directory, an empty list will be returned.

" } }, "NextToken": { @@ -4849,7 +4978,7 @@ "LogSubscriptions": { "target": "com.amazonaws.directoryservice#LogSubscriptions", "traits": { - "smithy.api#documentation": "

A list of active LogSubscription objects for calling the AWS\n account.

" + "smithy.api#documentation": "

A list of active LogSubscription objects for calling the Amazon Web Services account.

" } }, "NextToken": { @@ -4892,14 +5021,14 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the directory from which to retrieve the schema extension information.

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

The identifier of the directory from which to retrieve the schema extension\n information.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.

" + "smithy.api#documentation": "

The ListSchemaExtensions.NextToken value from a previous call to\n ListSchemaExtensions. Pass null if this is the first call.

" } }, "Limit": { @@ -4922,7 +5051,7 @@ "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.

" + "smithy.api#documentation": "

If not null, more results are available. Pass this value for the NextToken\n parameter in a subsequent call to ListSchemaExtensions to retrieve the next set\n of items.

" } } } @@ -5004,7 +5133,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "[-._/#A-Za-z0-9]+" + "smithy.api#pattern": "^[-._/#A-Za-z0-9]+$" } }, "com.amazonaws.directoryservice#LogSubscription": { @@ -5077,7 +5206,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "^(https?|ftp|file|ldaps?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;()]*[-a-zA-Z0-9+&@#/%=~_|()]" + "smithy.api#pattern": "^(https?|ftp|file|ldaps?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;()]*[-a-zA-Z0-9+&@#/%=~_|()]$" } }, "com.amazonaws.directoryservice#OrganizationalUnitDN": { @@ -5100,7 +5229,7 @@ } }, "traits": { - "smithy.api#documentation": "

Exception encountered while trying to access your AWS organization.

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

Exception encountered while trying to access your Amazon Web Services organization.

", "smithy.api#error": "client" } }, @@ -5110,7 +5239,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier of the AWS Managed Microsoft AD directory in the directory owner\n account.

" + "smithy.api#documentation": "

Identifier of the Managed Microsoft AD directory in the directory owner\n account.

" } }, "AccountId": { @@ -5161,7 +5290,7 @@ "com.amazonaws.directoryservice#Password": { "type": "string", "traits": { - "smithy.api#pattern": "(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*", + "smithy.api#pattern": "^(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^", "smithy.api#sensitive": {} } }, @@ -5221,13 +5350,13 @@ "RadiusServers": { "target": "com.amazonaws.directoryservice#Servers", "traits": { - "smithy.api#documentation": "

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

" + "smithy.api#documentation": "

An array of strings that contains the fully qualified domain name (FQDN) or IP\n addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server\n load balancer.

" } }, "RadiusPort": { "target": "com.amazonaws.directoryservice#PortNumber", "traits": { - "smithy.api#documentation": "

The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.

" + "smithy.api#documentation": "

The port that your RADIUS server is using for communications. Your self-managed\n network must allow inbound traffic over this port from the Directory Service servers.

" } }, "RadiusTimeout": { @@ -5239,7 +5368,7 @@ "RadiusRetries": { "target": "com.amazonaws.directoryservice#RadiusRetries", "traits": { - "smithy.api#documentation": "

The maximum number of times that communication with the RADIUS server is attempted.

" + "smithy.api#documentation": "

The maximum number of times that communication with the RADIUS server is\n attempted.

" } }, "SharedSecret": { @@ -5268,7 +5397,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about a Remote Authentication Dial In User Service (RADIUS) server.

" + "smithy.api#documentation": "

Contains information about a Remote Authentication Dial In User Service (RADIUS)\n server.

" } }, "com.amazonaws.directoryservice#RadiusSharedSecret": { @@ -5278,6 +5407,7 @@ "min": 8, "max": 512 }, + "smithy.api#pattern": "^(\\p{LD}|\\p{Punct}| )+$", "smithy.api#sensitive": {} } }, @@ -5419,7 +5549,7 @@ "PrimaryRegion": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { - "smithy.api#documentation": "

The Region where the AWS Managed Microsoft AD directory was originally created.

" + "smithy.api#documentation": "

The Region where the Managed Microsoft AD directory was originally created.

" } }, "AdditionalRegions": { @@ -5539,7 +5669,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

" + "smithy.api#documentation": "

Associates a directory with an Amazon SNS topic. This establishes the directory as a\n publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when\n the status of your directory changes. You get notified if your directory goes from an Active\n status to an Impaired or Inoperable status. You also receive a notification when the directory\n returns to an Active status.

" } }, "com.amazonaws.directoryservice#RegisterEventTopicRequest": { @@ -5548,14 +5678,14 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The Directory ID that will publish status messages to the SNS topic.

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

The Directory ID that will publish status messages to the Amazon SNS topic.

", "smithy.api#required": {} } }, "TopicName": { "target": "com.amazonaws.directoryservice#TopicName", "traits": { - "smithy.api#documentation": "

The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.

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

The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS\n topic must be in the same region as the specified Directory ID.

", "smithy.api#required": {} } } @@ -5670,7 +5800,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier (ID) of the directory from which you want to remove the IP addresses.

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

Identifier (ID) of the directory from which you want to remove the IP\n addresses.

", "smithy.api#required": {} } }, @@ -5798,7 +5928,7 @@ "com.amazonaws.directoryservice#RequestId": { "type": "string", "traits": { - "smithy.api#documentation": "

The AWS request identifier.

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

The Amazon Web Services request identifier.

", "smithy.api#pattern": "^([A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12})$" } }, @@ -5834,7 +5964,7 @@ } ], "traits": { - "smithy.api#documentation": "

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD\n directory.

\n

You can reset the password for any user in your directory with the following\n exceptions:

\n
    \n
  • \n

    For Simple AD, you cannot reset the password for any user that is a member of either\n the Domain Admins or Enterprise\n Admins group except for the administrator user.

    \n
    • \n
  • \n

    For AWS Managed Microsoft AD, you can only reset the password for a user that is in an\n OU based off of the NetBIOS name that you typed when you created your directory. For\n example, you cannot reset the password for a user in the AWS\n Reserved OU. For more information about the OU structure for an AWS Managed\n Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration\n Guide.

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

Resets the password for any user in your Managed Microsoft AD or Simple AD\n directory.

\n

You can reset the password for any user in your directory with the following\n exceptions:

\n
    \n
  • \n

    For Simple AD, you cannot reset the password for any user that is a member of either\n the Domain Admins or Enterprise\n Admins group except for the administrator user.

    \n
    • \n
  • \n

    For Managed Microsoft AD, you can only reset the password for a user that is in an\n OU based off of the NetBIOS name that you typed when you created your directory. For\n example, you cannot reset the password for a user in the Amazon Web Services\n Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration\n Guide.

    \n
    • \n
" } }, "com.amazonaws.directoryservice#ResetUserPasswordRequest": { @@ -5843,7 +5973,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user\n resides.

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

Identifier of the Managed Microsoft AD or Simple AD directory in which the user\n resides.

", "smithy.api#required": {} } }, @@ -5928,7 +6058,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[&\\w+-.@]+" + "smithy.api#pattern": "^[&\\w+-.@]+$" } }, "com.amazonaws.directoryservice#SchemaExtensionId": { @@ -5973,7 +6103,7 @@ "StartDateTime": { "target": "com.amazonaws.directoryservice#StartDateTime", "traits": { - "smithy.api#documentation": "

The date and time that the schema extension started being applied to the directory.

" + "smithy.api#documentation": "

The date and time that the schema extension started being applied to the\n directory.

" } }, "EndDateTime": { @@ -6086,7 +6216,7 @@ } }, "traits": { - "smithy.api#documentation": "

An exception has occurred in AWS Directory Service.

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

An exception has occurred in Directory Service.

", "smithy.api#error": "server" } }, @@ -6131,7 +6261,7 @@ } ], "traits": { - "smithy.api#documentation": "

Shares a specified directory (DirectoryId) in your AWS account (directory\n owner) with another AWS account (directory consumer). With this operation you can use your\n directory from any AWS account and from any Amazon VPC within an AWS Region.

\n

When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a\n shared directory in the directory consumer account. This shared directory contains the\n metadata to provide access to the directory within the directory owner account. The shared\n directory is visible in all VPCs in the directory consumer account.

\n

The ShareMethod parameter determines whether the specified directory can be\n shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It\n also determines whether you can share the directory with any other AWS account either inside\n or outside of the organization (HANDSHAKE).

\n

The ShareNotes parameter is only used when HANDSHAKE is called,\n which sends a directory sharing request to the directory consumer.

" + "smithy.api#documentation": "

Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory\n owner) with another Amazon Web Services account (directory consumer). With this operation you can use your\n directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.

\n

When you share your Managed Microsoft AD directory, Directory Service creates a\n shared directory in the directory consumer account. This shared directory contains the\n metadata to provide access to the directory within the directory owner account. The shared\n directory is visible in all VPCs in the directory consumer account.

\n

The ShareMethod parameter determines whether the specified directory can be\n shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It\n also determines whether you can share the directory with any other Amazon Web Services account either inside\n or outside of the organization (HANDSHAKE).

\n

The ShareNotes parameter is only used when HANDSHAKE is called,\n which sends a directory sharing request to the directory consumer.

" } }, "com.amazonaws.directoryservice#ShareDirectoryRequest": { @@ -6140,7 +6270,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS\n accounts.

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

Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts.

", "smithy.api#required": {} } }, @@ -6160,7 +6290,7 @@ "ShareMethod": { "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { - "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a directory sharing request (HANDSHAKE).

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

The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by\n sending a directory sharing request (HANDSHAKE).

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

The maximum number of AWS accounts that you can share with this directory has been reached.

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

The maximum number of Amazon Web Services accounts that you can share with this directory has been\n reached.

", "smithy.api#error": "client" } }, @@ -6296,7 +6426,7 @@ "ShareMethod": { "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { - "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your AWS organization (ORGANIZATIONS) or with any AWS account by\n sending a shared directory request (HANDSHAKE).

" + "smithy.api#documentation": "

The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by\n sending a shared directory request (HANDSHAKE).

" } }, "SharedAccountId": { @@ -6314,7 +6444,7 @@ "ShareStatus": { "target": "com.amazonaws.directoryservice#ShareStatus", "traits": { - "smithy.api#documentation": "

Current directory status of the shared AWS Managed Microsoft AD directory.

" + "smithy.api#documentation": "

Current directory status of the shared Managed Microsoft AD directory.

" } }, "ShareNotes": { @@ -6410,7 +6540,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of manual snapshots for the directory has been reached. You can\n use the GetSnapshotLimits operation to determine the snapshot limits for a\n directory.

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

The maximum number of manual snapshots for the directory has been reached. You can\n use the GetSnapshotLimits operation to determine the snapshot limits\n for a directory.

", "smithy.api#error": "client" } }, @@ -6540,21 +6670,21 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the directory for which the schema extension will be applied to.

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

The identifier of the directory for which the schema extension will be applied\n to.

", "smithy.api#required": {} } }, "CreateSnapshotBeforeSchemaExtension": { "target": "com.amazonaws.directoryservice#CreateSnapshotBeforeSchemaExtension", "traits": { - "smithy.api#documentation": "

If true, creates a snapshot of the directory before applying the schema extension.

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

If true, creates a snapshot of the directory before applying the schema\n extension.

", "smithy.api#required": {} } }, "LdifContent": { "target": "com.amazonaws.directoryservice#LdifContent", "traits": { - "smithy.api#documentation": "

The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \\n. See the example request below for more details. The file size can be no larger than 1MB.

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

The LDIF file represented as a string. To construct the LdifContent string, precede\n each line as it would be formatted in an ldif file with \\n. See the example request below for\n more details. The file size can be no larger than 1MB.

", "smithy.api#required": {} } }, @@ -6605,14 +6735,14 @@ "Key": { "target": "com.amazonaws.directoryservice#TagKey", "traits": { - "smithy.api#documentation": "

Required name of the tag. The string value can be Unicode characters and cannot be prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

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

Required name of the tag. The string value can be Unicode characters and cannot be\n prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits,\n white-space, '_', '.', '/', '=', '+', '-' (Java regex:\n \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.directoryservice#TagValue", "traits": { - "smithy.api#documentation": "

The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

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

The optional value of the tag. The string value can be Unicode characters. The string\n can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-'\n (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

", "smithy.api#required": {} } } @@ -6698,7 +6828,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[a-zA-Z0-9_-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, "com.amazonaws.directoryservice#TopicNames": { @@ -6736,7 +6866,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The Directory ID of the AWS directory involved in the trust relationship.

" + "smithy.api#documentation": "

The Directory ID of the Amazon Web Services directory involved in the trust relationship.

" } }, "TrustId": { @@ -6748,7 +6878,7 @@ "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.

" + "smithy.api#documentation": "

The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust\n relationship.

" } }, "TrustType": { @@ -6801,7 +6931,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a trust relationship between an AWS Managed Microsoft AD directory and an external domain.

" + "smithy.api#documentation": "

Describes a trust relationship between an Managed Microsoft AD directory and an external\n domain.

" } }, "com.amazonaws.directoryservice#TrustDirection": { @@ -6842,7 +6972,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "(.|\\s)*\\S(.|\\s)*", + "smithy.api#pattern": "^(.|\\s)*\\S(.|\\s)*$", "smithy.api#sensitive": {} } }, @@ -6956,7 +7086,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the AWS Managed Microsoft AD directory that you want to stop\n sharing.

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

The identifier of the Managed Microsoft AD directory that you want to stop\n sharing.

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

Updates a conditional forwarder that has been set up for your AWS directory.

" + "smithy.api#documentation": "

Updates a conditional forwarder that has been set up for your Amazon Web Services\n directory.

" } }, "com.amazonaws.directoryservice#UpdateConditionalForwarderRequest": { @@ -7055,21 +7185,21 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The directory ID of the AWS directory for which to update the conditional forwarder.

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

The directory ID of the Amazon Web Services directory for which to update the conditional\n forwarder.

", "smithy.api#required": {} } }, "RemoteDomainName": { "target": "com.amazonaws.directoryservice#RemoteDomainName", "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

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

The fully qualified domain name (FQDN) of the remote domain with which you will set up\n a trust relationship.

", "smithy.api#required": {} } }, "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "

The updated IP addresses of the remote DNS server associated with the conditional forwarder.

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

The updated IP addresses of the remote DNS server associated with the conditional\n forwarder.

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

Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

" + "smithy.api#documentation": "

Adds or removes domain controllers to or from the directory. Based on the difference\n between current value and new value (provided through this API call), domain controllers will\n be added or removed. It may take up to 45 minutes for any new domain controllers to become\n fully active once the requested number of domain controllers is updated. During this time, you\n cannot make another update request.

" } }, "com.amazonaws.directoryservice#UpdateNumberOfDomainControllersRequest": { @@ -7126,7 +7256,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

Identifier of the directory to which the domain controllers will be added or removed.

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

Identifier of the directory to which the domain controllers will be added or\n removed.

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

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

" + "smithy.api#documentation": "

Updates the Remote Authentication Dial In User Service (RADIUS) server information\n for an AD Connector or Microsoft AD directory.

" } }, "com.amazonaws.directoryservice#UpdateRadiusRequest": { @@ -7175,14 +7305,14 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "

The identifier of the directory for which to update the RADIUS server information.

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

The identifier of the directory for which to update the RADIUS server\n information.

", "smithy.api#required": {} } }, "RadiusSettings": { "target": "com.amazonaws.directoryservice#RadiusSettings", "traits": { - "smithy.api#documentation": "

A RadiusSettings object that contains information about the RADIUS server.

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

A RadiusSettings object that contains information about the RADIUS\n server.

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

Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.

" + "smithy.api#documentation": "

Updates the trust that has been set up between your Managed Microsoft AD directory and an\n self-managed Active Directory.

" } }, "com.amazonaws.directoryservice#UpdateTrustRequest": { @@ -7283,7 +7413,7 @@ "smithy.api#length": { "min": 1 }, - "smithy.api#pattern": "[a-zA-Z0-9._-]+" + "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" } }, "com.amazonaws.directoryservice#UserPassword": { @@ -7322,7 +7452,7 @@ } ], "traits": { - "smithy.api#documentation": "

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

\n

This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.

" + "smithy.api#documentation": "

Directory Service for Microsoft Active Directory allows you to configure and verify trust\n relationships.

\n

This action verifies a trust relationship between your Managed Microsoft AD directory and an\n external domain.

" } }, "com.amazonaws.directoryservice#VerifyTrustRequest": { @@ -7337,7 +7467,7 @@ } }, "traits": { - "smithy.api#documentation": "

Initiates the verification of an existing trust relationship between an AWS Managed Microsoft AD directory and an external domain.

" + "smithy.api#documentation": "

Initiates the verification of an existing trust relationship between an Managed Microsoft AD\n directory and an external domain.

" } }, "com.amazonaws.directoryservice#VerifyTrustResult": { diff --git a/aws/sdk/aws-models/ebs.json b/aws/sdk/aws-models/ebs.json index d1c93bbc9f..83b661268e 100644 --- a/aws/sdk/aws-models/ebs.json +++ b/aws/sdk/aws-models/ebs.json @@ -382,7 +382,7 @@ "name": "ebs" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

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.

\n \t\t\n \t

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.

\n\n\n

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 Accessing the Contents of an EBS Snapshot in the Amazon Elastic Compute Cloud User\n Guide. For more information about the supported AWS Regions, endpoints,\n and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in\n the AWS General Reference.

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

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.

\n \t\t\n \t

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.

\n\n\n

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 Accessing the Contents of an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User\n Guide. For more information about the supported Amazon Web Services Regions, endpoints,\n and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in\n the Amazon Web Services General Reference.

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

The size of the block.

" + "smithy.api#documentation": "

The size of the blocks in the snapshot, in bytes.

" } }, "NextToken": { @@ -746,7 +746,7 @@ "BlockSize": { "target": "com.amazonaws.ebs#BlockSize", "traits": { - "smithy.api#documentation": "

The size of the block.

" + "smithy.api#documentation": "

The size of the blocks in the snapshot, in bytes.

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

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 pending state.

\t\n \t

Data written to a snapshot must be aligned with 512-byte sectors.

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

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 pending state.

\t\n \t

Data written to a snapshot must be aligned with 512-KiB sectors.

", "smithy.api#http": { "method": "PUT", "uri": "/snapshots/{SnapshotId}/blocks/{BlockIndex}", @@ -868,7 +868,7 @@ "DataLength": { "target": "com.amazonaws.ebs#DataLength", "traits": { - "smithy.api#documentation": "

The size of the data to write to the block, in bytes. Currently, the only supported\n size is 524288.

\n

Valid values: 524288\n

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

The size of the data to write to the block, in bytes. Currently, the only supported\n size is 524288 bytes.

\n

Valid values: 524288\n

", "smithy.api#httpHeader": "x-amz-Data-Length", "smithy.api#required": {} } @@ -1099,20 +1099,20 @@ "ClientToken": { "target": "com.amazonaws.ebs#IdempotencyToken", "traits": { - "smithy.api#documentation": "

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.

\n

If you do not specify a client token, one is automatically generated by the AWS SDK.

\n

For more information, see \n \t\tIdempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

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

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.

\n

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

\n

For more information, see \n \t\tIdempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

", "smithy.api#idempotencyToken": {} } }, "Encrypted": { "target": "com.amazonaws.ebs#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify\n true. To create an unencrypted snapshot, omit this parameter.

\n

If you specify a value for ParentSnapshotId, omit\n this parameter.

\n

If you specify true, the snapshot is encrypted using the CMK specified\n using the KmsKeyArn parameter. If no value is specified\n for KmsKeyArn, 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 \n \t\tModifyEbsDefaultKmsKeyId.

\n

If your account is enabled for encryption by default, you cannot set this parameter to\n false. In this case, you can omit this parameter.

\n\n

For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify\n true. To create an unencrypted snapshot, omit this parameter.

\n

If you specify a value for ParentSnapshotId, omit\n this parameter.

\n

If you specify true, the snapshot is encrypted using the KMS key specified\n using the KmsKeyArn parameter. If no value is specified\n for KmsKeyArn, 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 \n \t\tModifyEbsDefaultKmsKeyId.

\n

If your account is enabled for encryption by default, you cannot set this parameter to\n false. In this case, you can omit this parameter.

\n\n

For more information, see \n Using encryption in the Amazon Elastic Compute Cloud User Guide.

" } }, "KmsKeyArn": { "target": "com.amazonaws.ebs#KmsKeyArn", "traits": { - "smithy.api#documentation": "

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.

\n

If you specify a ParentSnapshotId, omit this\n parameter; the snapshot will be encrypted using the same CMK that was used to encrypt\n the parent snapshot.

\n

If Encrypted is set to true, \n \tyou must specify a CMK ARN.

" + "smithy.api#documentation": "

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.

\n

If you specify a ParentSnapshotId, omit this\n parameter; the snapshot will be encrypted using the same KMS key that was used to encrypt\n the parent snapshot.

\n

If Encrypted is set to true, \n you must specify a KMS key ARN.

" } }, "Timeout": { @@ -1141,7 +1141,7 @@ "OwnerId": { "target": "com.amazonaws.ebs#OwnerId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the snapshot owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the snapshot owner.

" } }, "Status": { @@ -1183,7 +1183,7 @@ "KmsKeyArn": { "target": "com.amazonaws.ebs#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer\n master key (CMK) used to encrypt the snapshot.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.

" } } } diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index 2b7ddf961d..4bf490c93c 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -10080,7 +10080,7 @@ "target": "com.amazonaws.ec2#KeyPair" }, "traits": { - "smithy.api#documentation": "

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.

\n

You can have up to five thousand key pairs per Region.

\n\t\t

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 ImportKeyPair.

\n

For more information, see Key Pairs in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Creates an ED25519 or 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public\n key and displays the private key for you to save to a file. The private key is returned\n as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name\n already exists, Amazon EC2 returns an error.

\n\t\t

The key pair returned to you is available only in the Amazon Web Services Region in which you create it.\n If you prefer, you can create your own key pair using a third-party tool and upload it\n to any Region using ImportKeyPair.

\n

You can have up to 5,000 key pairs per Amazon Web Services Region.

\n

For more information, see Amazon EC2 key pairs in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#CreateKeyPairRequest": { @@ -10101,6 +10101,12 @@ "smithy.api#xmlName": "dryRun" } }, + "KeyType": { + "target": "com.amazonaws.ec2#KeyType", + "traits": { + "smithy.api#documentation": "

The type of key pair. Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.

\n

Default: rsa\n

" + } + }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -11477,7 +11483,7 @@ "target": "com.amazonaws.ec2#CreateSecurityGroupResult" }, "traits": { - "smithy.api#documentation": "

Creates a security group.

\n

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\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n

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.

\n

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.

\n

You can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.

\n

For more information about VPC security group limits, see Amazon VPC Limits.

" + "smithy.api#documentation": "

Creates a security group.

\n

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\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

\n

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.

\n

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.

\n

You can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.

\n

For more information about VPC security group limits, see Amazon VPC Limits.

" } }, "com.amazonaws.ec2#CreateSecurityGroupRequest": { @@ -21062,7 +21068,7 @@ "target": "com.amazonaws.ec2#DescribeKeyPairsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified key pairs or all of your key pairs.

\n

For more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

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

Describes the specified key pairs or all of your key pairs.

\n

For more information about key pairs, see Amazon EC2 key pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -23856,7 +23862,7 @@ "target": "com.amazonaws.ec2#DescribeSecurityGroupsResult" }, "traits": { - "smithy.api#documentation": "

Describes the specified security groups or all of your security groups.

\n

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\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

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

Describes the specified security groups or all of your security groups.

\n

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\tAmazon EC2 security groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity groups for your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -37092,7 +37098,7 @@ "target": "com.amazonaws.ec2#ImportKeyPairResult" }, "traits": { - "smithy.api#documentation": "

Imports the public key from an RSA key pair that you created with a third-party tool. \n Compare this with CreateKeyPair, 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.

\n

For more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. \n Compare this with CreateKeyPair, 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.

\n

For more information about key pairs, see Amazon EC2 key pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#ImportKeyPairRequest": { @@ -42547,7 +42553,7 @@ "target": "com.amazonaws.ec2#SensitiveUserData", "traits": { "aws.protocols#ec2QueryName": "KeyMaterial", - "smithy.api#documentation": "

An unencrypted PEM encoded RSA private key.

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

An unencrypted PEM encoded RSA or ED25519 private key.

", "smithy.api#xmlName": "keyMaterial" } }, @@ -42607,7 +42613,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. \n If you used ImportKeyPair to provide Amazon Web Services the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

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

If you used CreateKeyPair to create the key pair:

\n
    \n
  • \n

    For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. \n

    \n
    • \n
  • \n

    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which \n is the default for OpenSSH, starting with OpenSSH 6.8.

    \n
    • \n
\n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n
    \n
  • \n

    For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

    \n
    • \n
  • \n

    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256\n digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

    \n
    • \n
", "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": "

The type of key pair.

", + "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" }, diff --git a/aws/sdk/aws-models/ecs.json b/aws/sdk/aws-models/ecs.json index 7fd0b1b2a8..a1a78a1223 100644 --- a/aws/sdk/aws-models/ecs.json +++ b/aws/sdk/aws-models/ecs.json @@ -603,7 +603,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n\t\t

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n\t\t

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 CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT 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.

" + "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n\t\t

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n\t\t

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 CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT 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.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "com.amazonaws.ecs#CapacityProviderStrategyItemBase": { @@ -679,7 +679,7 @@ "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the Amazon Web Services account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

" } }, "clusterName": { @@ -1364,7 +1364,7 @@ "containerInstanceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" } }, "ec2InstanceId": { @@ -1766,7 +1766,7 @@ "defaultCapacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

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 RunTask or CreateService 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.

\n\t\t

If a default capacity provider strategy is not defined for a cluster during creation,\n\t\t\tit can be defined later with the PutClusterCapacityProviders API\n\t\t\toperation.

" + "smithy.api#documentation": "

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 RunTask or CreateService 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.

\n\t\t

If a default capacity provider strategy is not defined for a cluster during creation,\n\t\t\tit can be defined later with the PutClusterCapacityProviders API\n\t\t\toperation.

" } } } @@ -1875,7 +1875,7 @@ "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the service.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the service.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n\t\t

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "platformVersion": { @@ -1899,13 +1899,13 @@ "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

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).

" + "smithy.api#documentation": "

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).

" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "networkConfiguration": { @@ -2712,7 +2712,7 @@ "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container instance ID or full ARN of the container instance to deregister.\n\t\t\tThe ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

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

The container instance ID or full ARN of the container instance to deregister.\n\t\t\tThe ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

", "smithy.api#required": {} } }, @@ -2891,7 +2891,7 @@ "include": { "target": "com.amazonaws.ecs#ClusterFieldList", "traits": { - "smithy.api#documentation": "

Whether to include additional information about the clusters in the response. If this\n\t\t\tfield is omitted, this information isn't included.

\n\t\t

If ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.

\n\t\t

If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.

\n\t\t

If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.

\n\t\t

If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.

" + "smithy.api#documentation": "

Whether to include additional information about the clusters in the response. If this\n\t\t\tfield is omitted, this information isn't included.

\n\t\t

If ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.

\n\t\t

If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.

\n\t\t

If CONFIGURATIONS is specified, the configuration for the cluster is\n\t\t\tincluded.

\n\t\t

If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.

\n\t\t

If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.

" } } } @@ -3440,7 +3440,7 @@ "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container instance ID or full ARN of the container instance.\n\t\t\tThe ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" + "smithy.api#documentation": "

The container instance ID or full ARN of the container instance.\n\t\t\tThe ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" } }, "cluster": { @@ -4001,7 +4001,7 @@ "command": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

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 CMD to execute the command\n\t\t\targuments directly, or CMD-SHELL to run the command with the container's\n\t\t\tdefault shell. For example:

\n\t\t

\n\t\t\t [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n\t\t

\n\t\t

An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the Create a container\n\t\t\tsection of the Docker Remote API.

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

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 CMD to execute the command\n\t\t\targuments directly, or CMD-SHELL to run the command with the container's\n\t\t\tdefault shell.

\n\t\t

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.

\n\t\t

\n\t\t\t [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n\t\t

\n\t\t

You do not need to include the brackets when you use the Amazon Web Services Management Consoleas shown below.

\n\t\t

\n\t\t\t \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" \n\t\t

\n\t\t

An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the Create a container\n\t\t\tsection of the Docker Remote API.

", "smithy.api#required": {} } }, @@ -5517,7 +5517,7 @@ "expression": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an\n\t\t\texpression if the constraint type is distinctInstance. For more\n\t\t\tinformation, see Cluster Query Language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

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 distinctInstance. For more information, see Cluster query language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" } } }, @@ -6402,7 +6402,7 @@ "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n\t\t

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n\t\t

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

\n\t\t

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "cluster": { @@ -6432,7 +6432,7 @@ "group": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

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).

" + "smithy.api#documentation": "

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).

" } }, "launchType": { @@ -6444,13 +6444,13 @@ "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc 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 Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc 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 Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "overrides": { "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "

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 command 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 environment override.

\n\t\t \n\t\t\t

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.

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

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 command 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 environment override.

\n\t\t

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.

" } }, "placementConstraints": { @@ -6462,13 +6462,13 @@ "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of five\n\t\t\tstrategy rules per task.

" + "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of 5\n\t\t\tstrategy rules per task.

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

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\tLATEST platform version is used by default. For more information, see\n\t\t\t\tFargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

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 LATEST\n\t\t\tplatform version is used by default. For more information, see Fargate platform versions in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "propagateTags": { @@ -6480,7 +6480,7 @@ "referenceId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The reference ID to use for the task.

" + "smithy.api#documentation": "

The reference ID to use for the task. The reference ID can have a maximum length of\n\t\t\t1024 characters.

" } }, "startedBy": { @@ -6634,7 +6634,7 @@ "serviceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

" + "smithy.api#documentation": "

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the Amazon Web Services account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

" } }, "serviceName": { diff --git a/aws/sdk/aws-models/elasticache.json b/aws/sdk/aws-models/elasticache.json index 4370369d29..e37ffd0d5e 100644 --- a/aws/sdk/aws-models/elasticache.json +++ b/aws/sdk/aws-models/elasticache.json @@ -114,7 +114,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 Resource-level permissions.

\n

\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.

\n

For more information, \n see Using Cost Allocation Tags in Amazon ElastiCache \n in the ElastiCache User Guide.

" + "smithy.api#documentation": "

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 Resource-level permissions.

\n

\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.

\n

For more information, \n see Using Cost Allocation Tags in Amazon ElastiCache \n in the ElastiCache User Guide.

" } }, "com.amazonaws.elasticache#AddTagsToResourceMessage": { @@ -123,7 +123,7 @@ "ResourceName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.\n ElastiCache resources are cluster and snapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.\n ElastiCache resources are cluster and snapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

", "smithy.api#required": {} } }, @@ -540,7 +540,7 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

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

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.

", "smithy.api#required": {} } } @@ -1036,7 +1036,7 @@ "CacheNodeId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "CacheNodeStatus": { @@ -1459,7 +1459,7 @@ "OwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The AWS account ID of the cache security group owner.

" + "smithy.api#documentation": "

The Amazon account ID of the cache security group owner.

" } }, "CacheSecurityGroupName": { @@ -2467,7 +2467,7 @@ "GlobalReplicationGroupIdSuffix": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

\n

For a full list of AWS Regions and their respective Global datastore iD prefixes, see Using the AWS CLI with Global datastores .

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

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.

\n

For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .

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

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

\n

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

\n

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.

\n

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

\n

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 Creating a Subnet Group. For versions below 5.0.6, \n the limit is 250 per cluster.

\n

To request a limit increase, see \n AWS Service Limits \n and choose the limit type Nodes per cluster per instance type.

\n

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 Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.

\n \n \n \n

This operation is valid for Redis only.

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

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

\n

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

\n

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.

\n

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

\n

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 Creating a Subnet Group. For versions below 5.0.6, \n the limit is 250 per cluster.

\n

To request a limit increase, see \n Amazon Service Limits \n and choose the limit type Nodes per cluster per instance type.

\n

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 Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.

\n \n \n \n

This operation is valid for Redis only.

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

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.elasticache#DisassociateGlobalReplicationGroupMessage": { @@ -5037,7 +5122,7 @@ "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The AWS region of secondary cluster you wish to remove from the Global datastore

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

The Amazon region of secondary cluster you wish to remove from the Global datastore

", "smithy.api#required": {} } } @@ -5089,7 +5174,7 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The AWS account ID of the Amazon EC2 security group owner.

" + "smithy.api#documentation": "

The Amazon account ID of the Amazon EC2 security group owner.

" } } }, @@ -5267,7 +5352,7 @@ "PrimaryRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The AWS region of the primary cluster of the Global datastore

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

The Amazon region of the primary cluster of the Global datastore

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

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.

\n \n \n
    \n
  • \n

    The GlobalReplicationGroupIdSuffix represents the name of the Global datastore,\n which is what you use to associate a secondary cluster.

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

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.

\n \n \n
    \n
  • \n

    The GlobalReplicationGroupIdSuffix represents the name of the Global datastore,\n which is what you use to associate a secondary cluster.

    \n
    • \n
" } }, "com.amazonaws.elasticache#GlobalReplicationGroupAlreadyExistsFault": { @@ -5521,7 +5606,7 @@ "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The AWS region of the Global datastore member.

" + "smithy.api#documentation": "

The Amazon region of the Global datastore member.

" } }, "Role": { @@ -5544,7 +5629,7 @@ } }, "traits": { - "smithy.api#documentation": "

A member of a Global datastore. It contains the Replication Group Id, the AWS region and the role of the replication group.

" + "smithy.api#documentation": "

A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.

" } }, "com.amazonaws.elasticache#GlobalReplicationGroupMemberList": { @@ -5616,7 +5701,7 @@ "RegionalConfigurations": { "target": "com.amazonaws.elasticache#RegionalConfigurationList", "traits": { - "smithy.api#documentation": "

Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global datastore

" + "smithy.api#documentation": "

Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

" } }, "ApplyImmediately": { @@ -6114,7 +6199,7 @@ "ResourceName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want the list of tags, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the resource for which you want the list of tags, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

", "smithy.api#required": {} } } @@ -6754,7 +6839,7 @@ "MultiAZEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

A flag to indicate MultiAZ is enabled.

" } }, "NodeGroupId": { @@ -8125,7 +8210,7 @@ "ReplicationGroupRegion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The AWS region where the cluster is stored

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

The Amazon region where the cluster is stored

", "smithy.api#required": {} } }, @@ -8212,7 +8297,7 @@ "ResourceName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, \n for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster \n or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

", "smithy.api#required": {} } }, @@ -8383,6 +8468,12 @@ "traits": { "smithy.api#documentation": "

Returns the destination, format and type of the logs.

" } + }, + "ReplicationGroupCreateTime": { + "target": "com.amazonaws.elasticache#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the cluster was created.

" + } } }, "traits": { @@ -8967,7 +9058,7 @@ "EC2SecurityGroupOwnerId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

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.

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

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.

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

Represents the input of a TestFailover 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).

\n \n

\n Note the following\n

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

    \n

    \n
    • \n
  • \n

    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.

    \n
    • \n
  • \n

    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:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node group \n

      \n
      2. \n
    2. \n

      Cache cluster message: Failover from primary node to replica node completed\n

      \n
      3. \n
    3. \n

      Replication group message: Failover from primary node to replica node completed\n

      \n
      4. \n
    4. \n

      Cache cluster message: Recovering cache nodes \n

      \n
      5. \n
    5. \n

      Cache cluster message: Finished recovery for cache nodes \n

      \n
      6. \n
    \n \n

    For more information see:

    \n \n
    • \n
\n \n

Also see, Testing Multi-AZ in the ElastiCache User Guide.

" + "smithy.api#documentation": "

Represents the input of a TestFailover 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).

\n \n

\n Note the following\n

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

    \n

    \n
    • \n
  • \n

    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.

    \n
    • \n
  • \n

    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:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node group \n

      \n
      2. \n
    2. \n

      Cache cluster message: Failover from primary node to replica node completed\n

      \n
      3. \n
    3. \n

      Replication group message: Failover from primary node to replica node completed\n

      \n
      4. \n
    4. \n

      Cache cluster message: Recovering cache nodes \n

      \n
      5. \n
    5. \n

      Cache cluster message: Finished recovery for cache nodes \n

      \n
      6. \n
    \n \n

    For more information see:

    \n \n
    • \n
\n \n

Also see, Testing Multi-AZ in the ElastiCache User Guide.

" } }, "com.amazonaws.elasticache#TestFailoverMessage": { diff --git a/aws/sdk/aws-models/elasticmapreduce.json b/aws/sdk/aws-models/elasticmapreduce.json index 0e15e9615a..d63257dc40 100644 --- a/aws/sdk/aws-models/elasticmapreduce.json +++ b/aws/sdk/aws-models/elasticmapreduce.json @@ -871,7 +871,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When true, IAM principals in the\n account can perform EMR cluster actions on the cluster that their IAM policies allow. When false, 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.

\n

The default value is false if a value is not provided when creating a cluster using the EMR API RunJobFlow command or the CLI create-cluster command. The default value is true when a cluster is created using the Management Console. IAM principals that are allowed to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.

" + "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When true, IAM principals in the\n account can perform EMR cluster actions on the cluster that their IAM policies allow. When false, 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.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Management Console. IAM principals that are\n allowed to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" } }, "Applications": { @@ -1538,13 +1538,13 @@ "IdentityId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity\n Store. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified.

" + "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity\n Store. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified, but not both.

" } }, "IdentityName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified.

" + "smithy.api#documentation": "

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified, but not both.

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

Provides cluster-level details including status, hardware and software configuration,\n VPC settings, and so on.

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

Provides cluster-level details including status, hardware and software configuration,\n VPC settings, and so on.

", "smithy.waiters#waitable": { "ClusterRunning": { "acceptors": [ @@ -2524,7 +2524,7 @@ }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "

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.

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

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.

" } + }, + "CustomAmiId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The custom AMI ID to use for the provisioned instance group.

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

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.

" } + }, + "CustomAmiId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The custom AMI ID to use for the provisioned instance group.

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

The date/time the instance group was terminated.

" } + }, + "CustomAmiId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The custom AMI ID to use for the provisioned instance group.

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

A configuration classification that applies when provisioning cluster instances, which\n can include configurations for applications and software that run on the cluster.

" } + }, + "CustomAmiId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The custom AMI ID to use for the instance type.

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

Evaluates to TRUE when the specified InstanceType is\n EBS-optimized.

" } + }, + "CustomAmiId": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

The custom AMI ID to use for the instance type.

" + } } }, "traits": { @@ -4190,7 +4220,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When true, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When false, 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.

\n

The default value is false if a value is not provided when creating a cluster using the EMR API RunJobFlow command or the CLI create-cluster command. The default value is true when a cluster is created using the Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.

" + "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When true, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When false, 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.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" } }, "JobFlowRole": { @@ -5064,7 +5094,7 @@ "NextToken": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

Specifies the next page of results. If NextToken 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 ListReleaseLabels request fails if the identity (AWS AccountID) and all filtering parameters are different from the original request, or if the NextToken is expired or tampered with.

" + "smithy.api#documentation": "

Specifies the next page of results. If NextToken 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 ListReleaseLabels request fails if the identity (account ID) and all filtering parameters are different from the original request, or if the NextToken is expired or tampered with.

" } }, "MaxResults": { @@ -6320,7 +6350,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Set this value to true 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 false for clusters created using the EMR API or the CLI create-cluster command.

\n

When set to false, 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 Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.

" + "smithy.api#documentation": "

Set this value to true 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 true for clusters created using the EMR API or the CLI create-cluster command.

\n

When set to false, 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 Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" } }, "JobFlowRole": { @@ -6740,7 +6770,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When false, 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.

\n

This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

\n

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMR Management Guide.

" + "smithy.api#documentation": "

Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When false, 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.

\n

This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

\n

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" } }, "com.amazonaws.emr#SetVisibleToAllUsersInput": { diff --git a/aws/sdk/aws-models/eventbridge.json b/aws/sdk/aws-models/eventbridge.json index eff10d113a..ce4b8e76bb 100644 --- a/aws/sdk/aws-models/eventbridge.json +++ b/aws/sdk/aws-models/eventbridge.json @@ -199,7 +199,7 @@ "name": "events" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon EventBridge helps you to respond to state changes in your AWS resources. When your\n resources change state, they automatically send events into an event stream. You can create\n rules that match selected events in the stream and route them to targets to take action. You\n can also use rules to take action on a predetermined schedule. For example, you can configure\n rules to:

\n
    \n
  • \n

    Automatically invoke an AWS Lambda function to update DNS entries when an event\n notifies you that Amazon EC2 instance enters the running state.

    \n
    • \n
  • \n

    Direct specific API records from AWS CloudTrail to an Amazon Kinesis data stream for\n detailed analysis of potential security or availability risks.

    \n
    • \n
  • \n

    Periodically invoke a built-in target to create a snapshot of an Amazon EBS\n volume.

    \n
    • \n
\n

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User\n Guide.

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

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your\n resources change state, they automatically send events to an event stream. You can create\n rules that match selected events in the stream and route them to targets to take action. You\n can also use rules to take action on a predetermined schedule. For example, you can configure\n rules to:

\n
    \n
  • \n

    Automatically invoke an Lambda function to update DNS entries when an event\n notifies you that Amazon EC2 instance enters the running state.

    \n
    • \n
  • \n

    Direct specific API records from CloudTrail to an Amazon Kinesis data stream for\n detailed analysis of potential security or availability risks.

    \n
    • \n
  • \n

    Periodically invoke a built-in target to create a snapshot of an Amazon EBS\n volume.

    \n
    • \n
\n

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User\n Guide.

", "smithy.api#title": "Amazon EventBridge", "smithy.api#xmlNamespace": { "uri": "http://events.amazonaws.com/doc/2015-10-07" @@ -626,7 +626,7 @@ } }, "traits": { - "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an AWS Batch job.

" + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an Batch job.

" } }, "com.amazonaws.eventbridge#BatchParameters": { @@ -635,32 +635,32 @@ "JobDefinition": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The ARN or name of the job definition to use if the event target is an AWS Batch job. This\n job definition must already exist.

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

The ARN or name of the job definition to use if the event target is an Batch job. This\n job definition must already exist.

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

The name to use for this execution of the job, if the target is an AWS Batch job.

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

The name to use for this execution of the job, if the target is an Batch job.

", "smithy.api#required": {} } }, "ArrayProperties": { "target": "com.amazonaws.eventbridge#BatchArrayProperties", "traits": { - "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an AWS Batch job.

" + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an Batch job.

" } }, "RetryStrategy": { "target": "com.amazonaws.eventbridge#BatchRetryStrategy", "traits": { - "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry\n strategy is the number of times to retry the failed job execution. Valid values are 1–10. When\n you specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

" + "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an Batch job. The retry\n strategy is the number of times to retry the failed job execution. Valid values are 1–10. When\n you specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

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

The custom parameters to be used when the target is an AWS Batch job.

" + "smithy.api#documentation": "

The custom parameters to be used when the target is an Batch job.

" } }, "com.amazonaws.eventbridge#BatchRetryStrategy": { @@ -674,7 +674,7 @@ } }, "traits": { - "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you\n specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

" + "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an Batch job. If you\n specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

" } }, "com.amazonaws.eventbridge#Boolean": { @@ -845,7 +845,7 @@ } }, "traits": { - "smithy.api#documentation": "

A JSON string which you can use to limit the event bus permissions you are granting to\n only accounts that fulfill the condition. Currently, the only supported condition is\n membership in a certain AWS organization. The string must contain Type,\n Key, and Value fields. The Value field specifies the\n ID of the AWS organization. Following is an example value for Condition:

\n

\n '{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\":\n \"o-1234567890\"}'\n

" + "smithy.api#documentation": "

A JSON string which you can use to limit the event bus permissions you are granting to\n only accounts that fulfill the condition. Currently, the only supported condition is\n membership in a certain Amazon Web Services organization. The string must contain Type,\n Key, and Value fields. The Value field specifies the\n ID of the Amazon Web Services organization. Following is an example value for Condition:

\n

\n '{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\":\n \"o-1234567890\"}'\n

" } }, "com.amazonaws.eventbridge#Connection": { @@ -1414,7 +1414,7 @@ "EventSourceArn": { "target": "com.amazonaws.eventbridge#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the event source associated with the archive.

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

The ARN of the event bus that sends events to the archive.

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

Called by an SaaS partner to create a partner event source. This operation is not used by\n AWS customers.

\n

Each partner event source can be used by one AWS account to create a matching partner\n event bus in that AWS account. A SaaS partner must create one partner event source for each\n AWS account that wants to receive those event types.

\n

A partner event source creates events based on resources within the SaaS partner's service\n or application.

\n

An AWS account that creates a partner event bus that matches the partner event source can\n use that event bus to receive events from the partner, and then process them using AWS Events\n rules and targets.

\n

Partner event source names follow this format:

\n

\n \n partner_name/event_namespace/event_name\n \n

\n

\n partner_name is determined during partner registration and identifies\n the partner to AWS customers. event_namespace is determined by the\n partner and is a way for the partner to categorize their events.\n event_name is determined by the partner, and should uniquely identify\n an event-generating resource within the partner system. The combination of\n event_namespace and event_name should help AWS\n customers decide whether to create an event bus to receive these events.

" + "smithy.api#documentation": "

Called by an SaaS partner to create a partner event source. This operation is not used by\n Amazon Web Services customers.

\n

Each partner event source can be used by one Amazon Web Services account to create a matching partner\n event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each\n Amazon Web Services account that wants to receive those event types.

\n

A partner event source creates events based on resources within the SaaS partner's service\n or application.

\n

An Amazon Web Services account that creates a partner event bus that matches the partner event source can\n use that event bus to receive events from the partner, and then process them using Amazon Web Services Events\n rules and targets.

\n

Partner event source names follow this format:

\n

\n \n partner_name/event_namespace/event_name\n \n

\n

\n partner_name is determined during partner registration and identifies\n the partner to Amazon Web Services customers. event_namespace is determined by the\n partner and is a way for the partner to categorize their events.\n event_name is determined by the partner, and should uniquely identify\n an event-generating resource within the partner system. The combination of\n event_namespace and event_name should help Amazon Web Services\n customers decide whether to create an event bus to receive these events.

" } }, "com.amazonaws.eventbridge#CreatePartnerEventSourceRequest": { @@ -1789,14 +1789,14 @@ "Name": { "target": "com.amazonaws.eventbridge#EventSourceName", "traits": { - "smithy.api#documentation": "

The name of the partner event source. This name must be unique and must be in the format\n \n partner_name/event_namespace/event_name\n .\n The AWS account that wants to use this partner event source must create a partner event bus\n with a name that matches the name of the partner event source.

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

The name of the partner event source. This name must be unique and must be in the format\n \n partner_name/event_namespace/event_name\n .\n The Amazon Web Services account that wants to use this partner event source must create a partner event bus\n with a name that matches the name of the partner event source.

", "smithy.api#required": {} } }, "Account": { "target": "com.amazonaws.eventbridge#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID that is permitted to create a matching partner event bus for this\n partner event source.

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

The Amazon Web Services account ID that is permitted to create a matching partner event bus for this\n partner event source.

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

You can use this operation to temporarily stop receiving events from the specified partner\n event source. The matching event bus is not deleted.

\n

When you deactivate a partner event source, the source goes into PENDING state. If it\n remains in PENDING state for more than two weeks, it is deleted.

\n

To activate a deactivated partner event source, use ActivateEventSource.

" + "smithy.api#documentation": "

You can use this operation to temporarily stop receiving events from the specified partner\n event source. The matching event bus is not deleted.

\n

When you deactivate a partner event source, the source goes into PENDING state. If it\n remains in PENDING state for more than two weeks, it is deleted.

\n

To activate a deactivated partner event source, use ActivateEventSource.

" } }, "com.amazonaws.eventbridge#DeactivateEventSourceRequest": { @@ -2156,7 +2156,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation is used by SaaS partners to delete a partner event source. This operation\n is not used by AWS customers.

\n

When you delete an event source, the status of the corresponding partner event bus in the\n AWS customer account becomes DELETED.

\n

" + "smithy.api#documentation": "

This operation is used by SaaS partners to delete a partner event source. This operation\n is not used by Amazon Web Services customers.

\n

When you delete an event source, the status of the corresponding partner event bus in the\n Amazon Web Services customer account becomes DELETED.

\n

" } }, "com.amazonaws.eventbridge#DeletePartnerEventSourceRequest": { @@ -2172,7 +2172,7 @@ "Account": { "target": "com.amazonaws.eventbridge#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the AWS customer that the event source was created for.

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

The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.

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

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n\n

If you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.

\n\n

Managed rules are rules created and managed by another AWS service on your behalf. These\n rules are created by those other AWS services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.

" + "smithy.api#documentation": "

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n\n

If you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.

\n\n

Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These\n rules are created by those other Amazon Web Services services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.

" } }, "com.amazonaws.eventbridge#DeleteRuleRequest": { @@ -2220,7 +2220,7 @@ "Force": { "target": "com.amazonaws.eventbridge#Boolean", "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to delete the rule. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.

" + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify\n Force as True to delete the rule. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.

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

Displays details about an event bus in your account. This can include the external AWS\n accounts that are permitted to write events to your default event bus, and the associated\n policy. For custom event buses and partner event buses, it displays the name, ARN, policy,\n state, and creation time.

\n

To enable your account to receive events from other accounts on its default event bus,\n use PutPermission.

\n

For more information about partner event buses, see CreateEventBus.

" + "smithy.api#documentation": "

Displays details about an event bus in your account. This can include the external Amazon Web Services\n accounts that are permitted to write events to your default event bus, and the associated\n policy. For custom event buses and partner event buses, it displays the name, ARN, policy,\n state, and creation time.

\n

To enable your account to receive events from other accounts on its default event bus,\n use PutPermission.

\n

For more information about partner event buses, see CreateEventBus.

" } }, "com.amazonaws.eventbridge#DescribeEventBusRequest": { @@ -2681,7 +2681,7 @@ } ], "traits": { - "smithy.api#documentation": "

An SaaS partner can use this operation to list details about a partner event source that\n they have created. AWS customers do not use this operation. Instead, AWS customers can use\n DescribeEventSource to see details about a partner event source that is\n shared with them.

" + "smithy.api#documentation": "

An SaaS partner can use this operation to list details about a partner event source that\n they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource\n to see details about a partner event source that is\n shared with them.

" } }, "com.amazonaws.eventbridge#DescribePartnerEventSourceRequest": { @@ -2839,7 +2839,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified rule.

\n

DescribeRule does not list the targets of a rule. To see the targets associated with a\n rule, use ListTargetsByRule.

" + "smithy.api#documentation": "

Describes the specified rule.

\n

DescribeRule does not list the targets of a rule. To see the targets associated with a\n rule, use ListTargetsByRule.

" } }, "com.amazonaws.eventbridge#DescribeRuleRequest": { @@ -2908,7 +2908,7 @@ "ManagedBy": { "target": "com.amazonaws.eventbridge#ManagedBy", "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, this field displays\n the principal name of the AWS service that created the rule.

" + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays\n the principal name of the Amazon Web Services service that created the rule.

" } }, "EventBusName": { @@ -2985,19 +2985,19 @@ "LaunchType": { "target": "com.amazonaws.eventbridge#LaunchType", "traits": { - "smithy.api#documentation": "

Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where AWS Fargate with Amazon\n ECS is supported. For more information, see AWS Fargate on Amazon ECS in\n the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where Fargate witt Amazon ECS\n is supported. For more information, see Fargate on Amazon ECS in\n the Amazon Elastic Container Service Developer Guide.

" } }, "NetworkConfiguration": { "target": "com.amazonaws.eventbridge#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

Use this structure if the ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and whether\n a public IP address is to be used. This structure is required if LaunchType is\n FARGATE because the awsvpc mode is required for Fargate\n tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.

" + "smithy.api#documentation": "

Use this structure if the Amazon ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and whether\n a public IP address is to be used. This structure is required if LaunchType is\n FARGATE because the awsvpc mode is required for Fargate\n tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.

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

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.

" + "smithy.api#documentation": "

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.

" } }, "Group": { @@ -3124,12 +3124,12 @@ "Policy": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The permissions policy of the event bus, describing which other AWS accounts can write\n events to this event bus.

" + "smithy.api#documentation": "

The permissions policy of the event bus, describing which other Amazon Web Services accounts can write\n events to this event bus.

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

An event bus receives events from a source and routes them to rules associated with that\n event bus. Your account's default event bus receives events from AWS services. A custom event\n bus can receive events from your custom applications and services. A partner event bus\n receives events from an event source created by an SaaS partner. These events come from the\n partners services or applications.

" + "smithy.api#documentation": "

An event bus receives events from a source and routes them to rules associated with that\n event bus. Your account's default event bus receives events from Amazon Web Services services. A custom event\n bus can receive events from your custom applications and services. A partner event bus\n receives events from an event source created by an SaaS partner. These events come from the\n partners services or applications.

" } }, "com.amazonaws.eventbridge#EventBusList": { @@ -3197,7 +3197,7 @@ "ExpirationTime": { "target": "com.amazonaws.eventbridge#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create a\n matching event bus for it.

" + "smithy.api#documentation": "

The date and time that the event source will expire, if the Amazon Web Services account doesn't create a\n matching event bus for it.

" } }, "Name": { @@ -3214,7 +3214,7 @@ } }, "traits": { - "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that AWS account can receive events from the\n partner's applications or services.

" + "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events from the\n partner's applications or services.

" } }, "com.amazonaws.eventbridge#EventSourceList": { @@ -3312,7 +3312,7 @@ "QueryStringParameters": { "target": "com.amazonaws.eventbridge#QueryStringParametersMap", "traits": { - "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API\n Gateway REST API or EventBridge ApiDestination.

" + "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API Gateway \n REST API or EventBridge ApiDestination.

" } } }, @@ -3348,7 +3348,7 @@ "InputPathsMap": { "target": "com.amazonaws.eventbridge#TransformerPaths", "traits": { - "smithy.api#documentation": "

Map of JSON paths to be extracted from the event. You can then insert these in the\n template in InputTemplate to produce the output you want to be sent to the\n target.

\n

\n InputPathsMap is an array key-value pairs, where each value is a valid JSON\n path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket\n notation.

\n

The keys cannot start with \"AWS.\"

" + "smithy.api#documentation": "

Map of JSON paths to be extracted from the event. You can then insert these in the\n template in InputTemplate to produce the output you want to be sent to the\n target.

\n

\n InputPathsMap is an array key-value pairs, where each value is a valid JSON\n path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket\n notation.

\n

The keys cannot start with \"Amazon Web Services.\"

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

You can use this to see all the partner event sources that have been shared with your AWS\n account. For more information about partner event sources, see CreateEventBus.

" + "smithy.api#documentation": "

You can use this to see all the partner event sources that have been shared with your Amazon Web Services\n account. For more information about partner event sources, see CreateEventBus.

" } }, "com.amazonaws.eventbridge#ListEventSourcesRequest": { @@ -3808,7 +3808,7 @@ } ], "traits": { - "smithy.api#documentation": "

An SaaS partner can use this operation to display the AWS account ID that a particular\n partner event source name is associated with. This operation is not used by AWS\n customers.

" + "smithy.api#documentation": "

An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular\n partner event source name is associated with. This operation is not used by Amazon Web Services\n customers.

" } }, "com.amazonaws.eventbridge#ListPartnerEventSourceAccountsRequest": { @@ -3869,7 +3869,7 @@ } ], "traits": { - "smithy.api#documentation": "

An SaaS partner can use this operation to list all the partner event source names that\n they have created. This operation is not used by AWS customers.

" + "smithy.api#documentation": "

An SaaS partner can use this operation to list all the partner event source names that\n they have created. This operation is not used by Amazon Web Services customers.

" } }, "com.amazonaws.eventbridge#ListPartnerEventSourcesRequest": { @@ -3948,7 +3948,7 @@ "EventSourceArn": { "target": "com.amazonaws.eventbridge#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the event source associated with the replay.

" + "smithy.api#documentation": "

The ARN of the archive from which the events are replayed.

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

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.

\n\n

ListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.

" + "smithy.api#documentation": "

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.

\n\n

ListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.

" } }, "com.amazonaws.eventbridge#ListRulesRequest": { @@ -4245,7 +4245,7 @@ } }, "traits": { - "smithy.api#documentation": "

This rule was created by an AWS service on behalf of your account. It is managed by that\n service. If you see this error in response to DeleteRule or\n RemoveTargets, you can use the Force parameter in those calls to\n delete the rule or remove targets from the rule. You cannot modify these managed rules by\n using DisableRule, EnableRule, PutTargets,\n PutRule, TagResource, or UntagResource.

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

This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that\n service. If you see this error in response to DeleteRule or\n RemoveTargets, you can use the Force parameter in those calls to\n delete the rule or remove targets from the rule. You cannot modify these managed rules by\n using DisableRule, EnableRule, PutTargets,\n PutRule, TagResource, or UntagResource.

", "smithy.api#error": "client" } }, @@ -4344,7 +4344,7 @@ } }, "traits": { - "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that AWS account can receive events from the\n partner's applications or services.

" + "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events from the\n partner's applications or services.

" } }, "com.amazonaws.eventbridge#PartnerEventSourceAccount": { @@ -4353,7 +4353,7 @@ "Account": { "target": "com.amazonaws.eventbridge#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID that the partner event source was offered to.

" + "smithy.api#documentation": "

The Amazon Web Services account ID that the partner event source was offered to.

" } }, "CreationTime": { @@ -4365,7 +4365,7 @@ "ExpirationTime": { "target": "com.amazonaws.eventbridge#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create a\n matching event bus for it.

" + "smithy.api#documentation": "

The date and time that the event source will expire, if the Amazon Web Services account doesn't create a\n matching event bus for it.

" } }, "State": { @@ -4376,7 +4376,7 @@ } }, "traits": { - "smithy.api#documentation": "

The AWS account that a partner event source has been offered to.

" + "smithy.api#documentation": "

The Amazon Web Services account that a partner event source has been offered to.

" } }, "com.amazonaws.eventbridge#PartnerEventSourceAccountList": { @@ -4498,7 +4498,7 @@ } }, "traits": { - "smithy.api#documentation": "

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Developer\n Guide.

" + "smithy.api#documentation": "

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer\n Guide.

" } }, "com.amazonaws.eventbridge#PlacementStrategyField": { @@ -4597,7 +4597,7 @@ "Time": { "target": "com.amazonaws.eventbridge#EventTime", "traits": { - "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

" + "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

" } }, "Source": { @@ -4609,7 +4609,7 @@ "Resources": { "target": "com.amazonaws.eventbridge#EventResourceList", "traits": { - "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" } }, "DetailType": { @@ -4633,7 +4633,7 @@ "TraceHeader": { "target": "com.amazonaws.eventbridge#TraceHeader", "traits": { - "smithy.api#documentation": "

An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the\n trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer Guide.

" + "smithy.api#documentation": "

An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the\n trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.

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

This is used by SaaS partners to write events to a customer's partner event bus. AWS\n customers do not use this operation.

" + "smithy.api#documentation": "

This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services\n customers do not use this operation.

" } }, "com.amazonaws.eventbridge#PutPartnerEventsRequest": { @@ -4746,13 +4746,13 @@ "Source": { "target": "com.amazonaws.eventbridge#EventSourceName", "traits": { - "smithy.api#documentation": "

The event source that is generating the evntry.

" + "smithy.api#documentation": "

The event source that is generating the entry.

" } }, "Resources": { "target": "com.amazonaws.eventbridge#EventResourceList", "traits": { - "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

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

Running PutPermission permits the specified AWS account or AWS organization\n to put events to the specified event bus. Amazon EventBridge (CloudWatch\n Events) rules in your account are triggered by these events arriving to an event bus in your\n account.

\n

For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.

\n\n

To enable multiple AWS accounts to put events to your event bus, run\n PutPermission once for each of these accounts. Or, if all the accounts are\n members of the same AWS organization, you can run PutPermission once specifying\n Principal as \"*\" and specifying the AWS organization ID in\n Condition, to grant permissions to all accounts in that organization.

\n\n

If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn with proper permissions when they use PutTarget to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

\n\n

The permission policy on the default event bus cannot exceed 10 KB in size.

" + "smithy.api#documentation": "

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization\n to put events to the specified event bus. Amazon EventBridge (CloudWatch\n Events) rules in your account are triggered by these events arriving to an event bus in your\n account.

\n

For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.

\n\n

To enable multiple Amazon Web Services accounts to put events to your event bus, run\n PutPermission once for each of these accounts. Or, if all the accounts are\n members of the same Amazon Web Services organization, you can run PutPermission once specifying\n Principal as \"*\" and specifying the Amazon Web Services organization ID in\n Condition, to grant permissions to all accounts in that organization.

\n\n

If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn with proper permissions when they use PutTarget to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n\n

The permission policy on the event bus cannot exceed 10 KB in size.

" } }, "com.amazonaws.eventbridge#PutPermissionRequest": { @@ -4871,25 +4871,25 @@ "Action": { "target": "com.amazonaws.eventbridge#Action", "traits": { - "smithy.api#documentation": "

The action that you are enabling the other account to perform. Currently, this must be\n events:PutEvents.

" + "smithy.api#documentation": "

The action that you are enabling the other account to perform.

" } }, "Principal": { "target": "com.amazonaws.eventbridge#Principal", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account ID that you are permitting to put events to your default event\n bus. Specify \"*\" to permit any account to put events to your default event bus.

\n\n

If you specify \"*\" without specifying Condition, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.

" + "smithy.api#documentation": "

The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event\n bus. Specify \"*\" to permit any account to put events to your default event bus.

\n\n

If you specify \"*\" without specifying Condition, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.

" } }, "StatementId": { "target": "com.amazonaws.eventbridge#StatementId", "traits": { - "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to. If you\n later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

" + "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to. If you\n later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

" } }, "Condition": { "target": "com.amazonaws.eventbridge#Condition", "traits": { - "smithy.api#documentation": "

This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain AWS organization. For more information about\n AWS Organizations, see What Is AWS\n Organizations in the AWS Organizations User Guide.

\n

If you specify Condition with an AWS organization ID, and specify \"*\" as the\n value for Principal, you grant permission to all the accounts in the named\n organization.

\n\n

The Condition is a JSON string which must contain Type,\n Key, and Value fields.

" + "smithy.api#documentation": "

This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain Amazon Web Services organization. For more information about\n Amazon Web Services Organizations, see What Is Amazon Web Services \n Organizations in the Amazon Web Services Organizations User Guide.

\n

If you specify Condition with an Amazon Web Services organization ID, and specify \"*\" as the\n value for Principal, you grant permission to all the accounts in the named\n organization.

\n\n

The Condition is a JSON string which must contain Type,\n Key, and Value fields.

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

Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.

\n\n

A single rule watches for events from a single event bus. Events generated by AWS services\n go to your account's default event bus. Events generated by SaaS partner services or\n applications go to the matching partner event bus. If you have custom applications or\n services, you can specify whether their events go to your default event bus or a custom event\n bus that you have created. For more information, see CreateEventBus.

\n\n

If you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule command. If you omit arguments in PutRule, the old values\n for those arguments are not kept. Instead, they are replaced with null values.

\n\n

When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.

\n\n

A rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.

\n\n

When you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule operation and assign tags, you must have both the\n events:PutRule and events:TagResource permissions.

\n

If you are updating an existing rule, any tags you specify in the PutRule\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

\n\n

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.

\n\n

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.

\n

To prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.

\n

An infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.

" + "smithy.api#documentation": "

Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.

\n\n

A single rule watches for events from a single event bus. Events generated by Amazon Web Services services\n go to your account's default event bus. Events generated by SaaS partner services or\n applications go to the matching partner event bus. If you have custom applications or\n services, you can specify whether their events go to your default event bus or a custom event\n bus that you have created. For more information, see CreateEventBus.

\n\n

If you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule command. If you omit arguments in PutRule, the old values\n for those arguments are not kept. Instead, they are replaced with null values.

\n\n

When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.

\n\n

A rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.

\n\n

When you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule operation and assign tags, you must have both the\n events:PutRule and events:TagResource permissions.

\n

If you are updating an existing rule, any tags you specify in the PutRule\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

\n\n

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.

\n\n

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.

\n

To prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.

\n

An infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.

" } }, "com.amazonaws.eventbridge#PutRuleRequest": { @@ -4969,7 +4969,7 @@ "RoleArn": { "target": "com.amazonaws.eventbridge#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

\n

If you're setting an event bus in another account as the target and that account granted\n permission to your account through an organization instead of directly by the account ID, you\n must specify a RoleArn with proper permissions in the Target\n structure, instead of here in this parameter.

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

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n
    \n
  • \n

    \n API\n destination\n

    \n
    • \n
  • \n

    Amazon API Gateway REST API endpoints

    \n
    • \n
  • \n

    API Gateway

    \n
    • \n
  • \n

    AWS Batch job queue

    \n
    • \n
  • \n

    CloudWatch Logs group

    \n
    • \n
  • \n

    CodeBuild project

    \n
    • \n
  • \n

    CodePineline

    \n
    • \n
  • \n

    Amazon EC2 CreateSnapshot API call

    \n
    • \n
  • \n

    Amazon EC2 RebootInstances API call

    \n
    • \n
  • \n

    Amazon EC2 StopInstances API call

    \n
    • \n
  • \n

    Amazon EC2 TerminateInstances API call

    \n
    • \n
  • \n

    Amazon ECS tasks

    \n
    • \n
  • \n

    Event bus in a different AWS account or Region.

    \n

    You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon)\n us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

    \n
    • \n
  • \n

    Firehose delivery stream (Kinesis Data Firehose)

    \n
    • \n
  • \n

    Inspector assessment template (Amazon Inspector)

    \n
    • \n
  • \n

    Kinesis stream (Kinesis Data Stream)

    \n
    • \n
  • \n

    AWS Lambda function

    \n
    • \n
  • \n

    Redshift clusters (Data API statement execution)

    \n
    • \n
  • \n

    Amazon SNS topic

    \n
    • \n
  • \n

    Amazon SQS queues (includes FIFO queues

    \n
    • \n
  • \n

    SSM Automation

    \n
    • \n
  • \n

    SSM OpsItem

    \n
    • \n
  • \n

    SSM Run Command

    \n
    • \n
  • \n

    Step Functions state machines

    \n
    • \n
\n\n

Creating rules with built-in targets is supported only in the AWS Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different AWS\n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n
    \n
  • \n

    If none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).

    \n
    • \n
  • \n

    If Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.

    \n
    • \n
  • \n

    If InputPath is specified in the form of JSONPath\n (for example, $.detail), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).

    \n
    • \n
  • \n

    If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.

    \n
    • \n
\n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n
    \n
  • \n

    \n API\n destination\n

    \n
    • \n
  • \n

    Amazon API Gateway REST API endpoints

    \n
    • \n
  • \n

    API Gateway

    \n
    • \n
  • \n

    Batch job queue

    \n
    • \n
  • \n

    CloudWatch Logs group

    \n
    • \n
  • \n

    CodeBuild project

    \n
    • \n
  • \n

    CodePipeline

    \n
    • \n
  • \n

    Amazon EC2 CreateSnapshot API call

    \n
    • \n
  • \n

    EC2 Image Builder

    \n
    • \n
  • \n

    Amazon EC2 RebootInstances API call

    \n
    • \n
  • \n

    Amazon EC2 StopInstances API call

    \n
    • \n
  • \n

    Amazon EC2 TerminateInstances API call

    \n
    • \n
  • \n

    Amazon ECS tasks

    \n
    • \n
  • \n

    Event bus in a different Amazon Web Services account or Region.

    \n

    You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon)\n us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

    \n
    • \n
  • \n

    Firehose delivery stream (Kinesis Data Firehose)

    \n
    • \n
  • \n

    Inspector assessment template (Amazon Inspector)

    \n
    • \n
  • \n

    Kinesis stream (Kinesis Data Stream)

    \n
    • \n
  • \n

    Lambda function

    \n
    • \n
  • \n

    Redshift clusters (Data API statement execution)

    \n
    • \n
  • \n

    Amazon SNS topic

    \n
    • \n
  • \n

    Amazon SQS queues (includes FIFO queues

    \n
    • \n
  • \n

    SSM Automation

    \n
    • \n
  • \n

    SSM OpsItem

    \n
    • \n
  • \n

    SSM Run Command

    \n
    • \n
  • \n

    Step Functions state machines

    \n
    • \n
\n\n

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n
    \n
  • \n

    If none of the following arguments are specified for a target, then the entire event\n is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or\n Amazon ECS task, in which case nothing from the event is passed to the target).

    \n
    • \n
  • \n

    If Input is specified in the form of valid JSON, then\n the matched event is overridden with this constant.

    \n
    • \n
  • \n

    If InputPath is specified in the form of JSONPath\n (for example, $.detail), then only the part of the event specified in the\n path is passed to the target (for example, only the detail part of the event is\n passed).

    \n
    • \n
  • \n

    If InputTransformer is specified, then one or more\n specified JSONPaths are extracted from the event and used as values in a template that you\n specify as the input to the target.

    \n
    • \n
\n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" } }, "com.amazonaws.eventbridge#PutTargetsRequest": { @@ -5135,7 +5135,7 @@ "SecretManagerArn": { "target": "com.amazonaws.eventbridge#RedshiftSecretManagerArn", "traits": { - "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using AWS Secrets Manager.

" + "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using Amazon Web Services Secrets Manager.

" } }, "Database": { @@ -5172,7 +5172,7 @@ } }, "traits": { - "smithy.api#documentation": "

These are custom parameters to be used when the target is a Redshift cluster to invoke the\n Redshift Data API ExecuteStatement based on EventBridge events.

" + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement based on EventBridge events.

" } }, "com.amazonaws.eventbridge#RedshiftSecretManagerArn": { @@ -5214,7 +5214,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes the permission of another AWS account to be able to put events to the specified\n event bus. Specify the account to revoke by the StatementId value that you\n associated with the account when you granted it permission with PutPermission.\n You can find the StatementId by using DescribeEventBus.

" + "smithy.api#documentation": "

Revokes the permission of another Amazon Web Services account to be able to put events to the specified\n event bus. Specify the account to revoke by the StatementId value that you\n associated with the account when you granted it permission with PutPermission.\n You can find the StatementId by using DescribeEventBus.

" } }, "com.amazonaws.eventbridge#RemovePermissionRequest": { @@ -5292,7 +5292,7 @@ "Force": { "target": "com.amazonaws.eventbridge#Boolean", "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.

" + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.

" } } } @@ -5619,19 +5619,19 @@ "ScheduleExpression": { "target": "com.amazonaws.eventbridge#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

" } }, "RoleArn": { "target": "com.amazonaws.eventbridge#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target invocation.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target invocation.

\n

If you're setting an event bus in another account as the target and that account granted\n permission to your account through an organization instead of directly by the account ID, you\n must specify a RoleArn with proper permissions in the Target\n structure, instead of here in this parameter.

" } }, "ManagedBy": { "target": "com.amazonaws.eventbridge#ManagedBy", "traits": { - "smithy.api#documentation": "

If the rule was created on behalf of your account by an AWS service, this field displays\n the principal name of the service that created the rule.

" + "smithy.api#documentation": "

If the rule was created on behalf of your account by an Amazon Web Services service, this field displays\n the principal name of the service that created the rule.

" } }, "EventBusName": { @@ -6040,7 +6040,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key-value pair associated with an AWS resource. In EventBridge, rules and event buses\n support tagging.

" + "smithy.api#documentation": "

A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses\n support tagging.

" } }, "com.amazonaws.eventbridge#TagKey": { @@ -6087,7 +6087,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values. In EventBridge, rules and event buses can be tagged.

\n

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of\n characters.

\n

You can use the TagResource action with a resource that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n resource. If you specify a tag key that is already associated with the resource, the new tag\n value that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource.

" + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values. In EventBridge, rules and event buses can be tagged.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of\n characters.

\n

You can use the TagResource action with a resource that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n resource. If you specify a tag key that is already associated with the resource, the new tag\n value that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource.

" } }, "com.amazonaws.eventbridge#TagResourceRequest": { @@ -6128,7 +6128,7 @@ "Id": { "target": "com.amazonaws.eventbridge#TargetId", "traits": { - "smithy.api#documentation": "

The ID of the target.

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

The ID of the target. We recommend using a memorable and unique string.

", "smithy.api#required": {} } }, @@ -6184,7 +6184,7 @@ "BatchParameters": { "target": "com.amazonaws.eventbridge#BatchParameters", "traits": { - "smithy.api#documentation": "

If the event target is an AWS Batch job, this contains the job definition, job name, and\n other parameters. For more information, see Jobs in the AWS Batch User\n Guide.

" + "smithy.api#documentation": "

If the event target is an Batch job, this contains the job definition, job name, and\n other parameters. For more information, see Jobs in the Batch User\n Guide.

" } }, "SqsParameters": { @@ -6202,7 +6202,7 @@ "RedshiftDataParameters": { "target": "com.amazonaws.eventbridge#RedshiftDataParameters", "traits": { - "smithy.api#documentation": "

Contains the Redshift Data API parameters to use when the target is a Redshift\n cluster.

\n

If you specify a Redshift Cluster as a Target, you can use this to specify parameters to\n invoke the Redshift Data API ExecuteStatement based on EventBridge events.

" + "smithy.api#documentation": "

Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift\n cluster.

\n

If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to\n invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

" } }, "SageMakerPipelineParameters": { @@ -6225,7 +6225,7 @@ } }, "traits": { - "smithy.api#documentation": "

Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.

\n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

" + "smithy.api#documentation": "

Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.

\n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

" } }, "com.amazonaws.eventbridge#TargetArn": { @@ -6315,7 +6315,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tests whether the specified event pattern matches the provided event.

\n

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.

" + "smithy.api#documentation": "

Tests whether the specified event pattern matches the provided event.

\n

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.

" } }, "com.amazonaws.eventbridge#TestEventPatternRequest": { @@ -6331,7 +6331,7 @@ "Event": { "target": "com.amazonaws.eventbridge#String", "traits": { - "smithy.api#documentation": "

The event, in JSON format, to test against the event pattern. The JSON must follow the\n format specified in AWS Events, and the following\n fields are mandatory:

\n
    \n
  • \n

    \n id\n

    \n
    • \n
  • \n

    \n account\n

    \n
    • \n
  • \n

    \n source\n

    \n
    • \n
  • \n

    \n time\n

    \n
    • \n
  • \n

    \n region\n

    \n
    • \n
  • \n

    \n resources\n

    \n
    • \n
  • \n

    \n detail-type\n

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

The event, in JSON format, to test against the event pattern. The JSON must follow the\n format specified in Amazon Web Services Events, and the following\n fields are mandatory:

\n
    \n
  • \n

    \n id\n

    \n
    • \n
  • \n

    \n account\n

    \n
    • \n
  • \n

    \n source\n

    \n
    • \n
  • \n

    \n time\n

    \n
    • \n
  • \n

    \n region\n

    \n
    • \n
  • \n

    \n resources\n

    \n
    • \n
  • \n

    \n detail-type\n

    \n
    • \n
", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/imagebuilder.json b/aws/sdk/aws-models/imagebuilder.json index 53e8a186d7..118cd67989 100644 --- a/aws/sdk/aws-models/imagebuilder.json +++ b/aws/sdk/aws-models/imagebuilder.json @@ -73,7 +73,7 @@ "region": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "

The Region of the Amazon EC2 AMI.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the Amazon EC2 AMI.

" } }, "image": { @@ -144,7 +144,7 @@ "launchPermission": { "target": "com.amazonaws.imagebuilder#LaunchPermissionConfiguration", "traits": { - "smithy.api#documentation": "

Launch permissions can be used to configure which accounts can use the AMI to launch\n\t\t\tinstances.

" + "smithy.api#documentation": "

Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch\n\t\t\tinstances.

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

The defining characteristics of a specific version of an TOE component.

" + "smithy.api#documentation": "

The defining characteristics of a specific version of an Amazon Web Services TOE component.

" } }, "com.amazonaws.imagebuilder#ComponentVersionArn": { @@ -4844,7 +4844,7 @@ "userIds": { "target": "com.amazonaws.imagebuilder#AccountList", "traits": { - "smithy.api#documentation": "

The account ID.

" + "smithy.api#documentation": "

The Amazon Web Services account ID.

" } }, "userGroups": { @@ -5071,7 +5071,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

Use the following filters to streamline results:

\n\t\t
    \n
  • \n

    \n description\n

    \n
    • \n
  • \n

    \n name\n

    \n
    • \n
  • \n

    \n platform\n

    \n
    • \n
  • \n

    \n supportedOsVersion\n

    \n
    • \n
  • \n

    \n type\n

    \n
    • \n
  • \n

    \n version\n

    \n
    • \n
" } }, "byName": { @@ -5175,7 +5175,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

Request filters that are used to narrow the list of container images that are returned.

" + "smithy.api#documentation": "

Use the following filters to streamline results:

\n\t\t
    \n
  • \n

    \n containerType\n

    \n
    • \n
  • \n

    \n name\n

    \n
    • \n
  • \n

    \n parentImage\n

    \n
    • \n
  • \n

    \n platform\n

    \n
    • \n
" } }, "maxResults": { @@ -5267,7 +5267,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n\t\t
    \n
  • \n\t\t\t\t

    \n\t\t\t\t\t name - The name of this distribution configuration.

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

You can filter on name to streamline results.

" } }, "maxResults": { @@ -5366,7 +5366,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

Use the following filters to streamline results:

\n\t\t
    \n
  • \n

    \n name\n

    \n
    • \n
  • \n

    \n osVersion\n

    \n
    • \n
  • \n

    \n platform\n

    \n
    • \n
  • \n

    \n type\n

    \n
    • \n
  • \n

    \n version\n

    \n
    • \n
" } }, "maxResults": { @@ -5564,7 +5564,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

Use the following filters to streamline results:

\n\t\t
    \n
  • \n

    \n name\n

    \n
    • \n
  • \n

    \n version\n

    \n
    • \n
" } }, "maxResults": { @@ -5656,7 +5656,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

Use the following filters to streamline results:

\n\t\t
    \n
  • \n

    \n description\n

    \n
    • \n
  • \n

    \n distributionConfigurationArn\n

    \n
    • \n
  • \n

    \n imageRecipeArn\n

    \n
    • \n
  • \n

    \n infrastructureConfigurationArn\n

    \n
    • \n
  • \n

    \n name\n

    \n
    • \n
  • \n

    \n status\n

    \n
    • \n
" } }, "maxResults": { @@ -5754,7 +5754,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

Use the following filters to streamline results:

\n\t\t
    \n
  • \n

    \n name\n

    \n
    • \n
  • \n

    \n parentImage\n

    \n
    • \n
  • \n

    \n platform\n

    \n
    • \n
" } }, "maxResults": { @@ -5852,7 +5852,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

Use the following filters to streamline results:

\n\t\t
    \n
  • \n

    \n name\n

    \n
    • \n
  • \n

    \n osVersion\n

    \n
    • \n
  • \n

    \n platform\n

    \n
    • \n
  • \n

    \n type\n

    \n
    • \n
  • \n

    \n version\n

    \n
    • \n
" } }, "byName": { @@ -5956,7 +5956,7 @@ "filters": { "target": "com.amazonaws.imagebuilder#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

" + "smithy.api#documentation": "

You can filter on name to streamline results.

" } }, "maxResults": { diff --git a/aws/sdk/aws-models/iotsitewise.json b/aws/sdk/aws-models/iotsitewise.json index c88ac18933..a5e62d6c04 100644 --- a/aws/sdk/aws-models/iotsitewise.json +++ b/aws/sdk/aws-models/iotsitewise.json @@ -5283,10 +5283,17 @@ "type": { "target": "com.amazonaws.iotsitewise#InterpolationType", "traits": { - "smithy.api#documentation": "

The interpolation type.

\n

Valid values: LINEAR_INTERPOLATION\n

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

The interpolation type.

\n

Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION\n

\n

For the LOCF_INTERPOLATION 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.

\n

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 LOCF_INTERPOLATION 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.

", "smithy.api#httpQuery": "type", "smithy.api#required": {} } + }, + "intervalWindowInSeconds": { + "target": "com.amazonaws.iotsitewise#IntervalWindowInSeconds", + "traits": { + "smithy.api#documentation": "

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.

\n \n
    \n
  • \n

    If you specify a value for the intervalWindowInSeconds parameter, \n the type parameter must be LINEAR_INTERPOLATION.

    \n
    • \n
  • \n

    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.

    \n
    • \n
\n \n

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.

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

The offset for the tumbling window. The offset parameter accepts the following:

\n
    \n
  • \n

    The offset time.

    \n

    For example, if you specify 18h for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    \n
      \n
    • \n

      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.

      \n
      • \n
    • \n

      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.

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

    The ISO 8601 format.

    \n

    For example, if you specify PT18H for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    \n
      \n
    • \n

      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.

      \n
      • \n
    • \n

      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.

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

    The 24-hour clock.

    \n

    For example, if you specify 00:03:00 for offset \n and 5m for interval, 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).

    \n
    • \n
  • \n

    The offset time zone.

    \n

    For example, if you specify 2021-07-23T18:00-08 for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    \n
      \n
    • \n

      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.

      \n
      • \n
    • \n

      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.

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

The offset for the tumbling window. The offset parameter accepts the following:

\n
    \n
  • \n

    The offset time.

    \n

    For example, if you specify 18h for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    \n
      \n
    • \n

      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.

      \n
      • \n
    • \n

      If you create the metric after 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) the next day.

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

    The ISO 8601 format.

    \n

    For example, if you specify PT18H for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    \n
      \n
    • \n

      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.

      \n
      • \n
    • \n

      If you create the metric after 6:00 PM (UTC), \n you get the first aggregation result at 6 PM (UTC) the next day.

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

    The 24-hour clock.

    \n

    For example, if you specify 00:03:00 for offset \n and 5m for interval, 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).

    \n
    • \n
  • \n

    The offset time zone.

    \n

    For example, if you specify 2021-07-23T18:00-08 for offset \n and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

    \n
      \n
    • \n

      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.

      \n
      • \n
    • \n

      If you create the metric after 6:00 PM (PST), \n you get the first aggregation result at 6 PM (PST) the next day.

      \n
      • \n
    \n
    • \n
" } } }, diff --git a/aws/sdk/aws-models/lambda.json b/aws/sdk/aws-models/lambda.json index 8513f09920..0caa022c59 100644 --- a/aws/sdk/aws-models/lambda.json +++ b/aws/sdk/aws-models/lambda.json @@ -4918,7 +4918,7 @@ "MasterRegion": { "target": "com.amazonaws.lambda#MasterRegion", "traits": { - "smithy.api#documentation": "

For Lambda@Edge functions, the Region of the master function. For example, us-east-1 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 FunctionVersion to ALL.

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

For Lambda@Edge functions, the Amazon Web Services Region of the master function. For example, us-east-1 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 FunctionVersion to ALL.

", "smithy.api#httpQuery": "MasterRegion" } }, @@ -6562,6 +6562,10 @@ "value": "python3.8", "name": "python38" }, + { + "value": "python3.9", + "name": "python39" + }, { "value": "dotnetcore1.0", "name": "dotnetcore10" diff --git a/aws/sdk/aws-models/license-manager.json b/aws/sdk/aws-models/license-manager.json index f3c9100ce0..ea451520a3 100644 --- a/aws/sdk/aws-models/license-manager.json +++ b/aws/sdk/aws-models/license-manager.json @@ -767,6 +767,10 @@ { "value": "PROVISIONAL", "name": "PROVISIONAL" + }, + { + "value": "PERPETUAL", + "name": "PERPETUAL" } ] } diff --git a/aws/sdk/aws-models/lightsail.json b/aws/sdk/aws-models/lightsail.json index add83b69ff..fd23927b32 100644 --- a/aws/sdk/aws-models/lightsail.json +++ b/aws/sdk/aws-models/lightsail.json @@ -92,12 +92,44 @@ "traits": { "smithy.api#documentation": "

The timestamp when the access key was created.

" } + }, + "lastUsed": { + "target": "com.amazonaws.lightsail#AccessKeyLastUsed", + "traits": { + "smithy.api#documentation": "

An object that describes the last time the access key was used.

\n\n \n

This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the\n region and serviceName values are N/A, and the\n lastUsedDate value is null.

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

Describes an access key for an Amazon Lightsail bucket.

\n\n

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 CreateBucketAccessKey action to create an access key for a specific bucket. For\n more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

\n\n \n

The secretAccessKey value is returned only in response to the\n CreateBucketAccessKey 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.

\n " } }, + "com.amazonaws.lightsail#AccessKeyLastUsed": { + "type": "structure", + "members": { + "lastUsedDate": { + "target": "com.amazonaws.lightsail#IsoDate", + "traits": { + "smithy.api#documentation": "

The date and time when the access key was most recently used.

\n

This value is null if the access key has not been used.

" + } + }, + "region": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The AWS Region where this access key was most recently used.

\n

This value is N/A if the access key has not been used.

" + } + }, + "serviceName": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

The name of the AWS service with which this access key was most recently used.

\n

This value is N/A if the access key has not been used.

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

Describes the last time an access key was used.

\n\n \n

This object does not include data in the response of a CreateBucketAccessKey action.

\n " + } + }, "com.amazonaws.lightsail#AccessKeyList": { "type": "list", "member": { @@ -2924,7 +2956,7 @@ "enableObjectVersioning": { "target": "com.amazonaws.lightsail#boolean", "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether to enable versioning of objects in the\n bucket.

\n\n

For more information about versioning, see Enabling and suspending bucket object versioning in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" + "smithy.api#documentation": "

A Boolean value that indicates whether to enable versioning of objects in the\n bucket.

\n\n

For more information about versioning, see Enabling and suspending object versioning in a bucket in Amazon Lightsail in the\n Amazon Lightsail Developer Guide.

" } } } diff --git a/aws/sdk/aws-models/logs.json b/aws/sdk/aws-models/logs.json index d2b860cc77..7eac2d48c1 100644 --- a/aws/sdk/aws-models/logs.json +++ b/aws/sdk/aws-models/logs.json @@ -60,7 +60,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

\n

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.

\n \n

CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK\n with your log group. For more information, see Using Symmetric and Asymmetric\n Keys.

\n \n

It can take up to 5 minutes for this operation to take effect.

\n

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 InvalidParameterException error.

" + "smithy.api#documentation": "

Associates the specified Key Management Service customer master key (CMK) with the specified log group.

\n

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.

\n \n

CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK\n with your log group. For more information, see Using Symmetric and Asymmetric\n Keys.

\n \n

It can take up to 5 minutes for this operation to take effect.

\n

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 InvalidParameterException error.

" } }, "com.amazonaws.cloudwatchlogs#AssociateKmsKeyRequest": { @@ -76,7 +76,7 @@ "kmsKeyId": { "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", "traits": { - "smithy.api#documentation": "

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 Amazon Resource Names - AWS Key Management Service (AWS KMS) and Using Symmetric and Asymmetric Keys.

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

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 Amazon Resource Names - Key Management Service and Using Symmetric and Asymmetric Keys.

", "smithy.api#required": {} } } @@ -188,7 +188,7 @@ "destination": { "target": "com.amazonaws.cloudwatchlogs#ExportDestinationBucket", "traits": { - "smithy.api#documentation": "

The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.

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

The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services region.

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

Creates a log group with the specified name. You can create up to 20,000 log groups per account.

\n

You must use the following guidelines when naming a log group:

\n
    \n
  • \n

    Log group names must be unique within a region for an AWS account.

    \n
    • \n
  • \n

    Log group names can be between 1 and 512 characters long.

    \n
    • \n
  • \n

    Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)

    \n
    • \n
\n

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 PutRetentionPolicy.

\n

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.

\n

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 InvalidParameterException error.

\n \n

CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with\n your log group. For more information, see Using Symmetric and Asymmetric\n Keys.

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

Creates a log group with the specified name. You can create up to 20,000 log groups per account.

\n

You must use the following guidelines when naming a log group:

\n
    \n
  • \n

    Log group names must be unique within a region for an Amazon Web Services account.

    \n
    • \n
  • \n

    Log group names can be between 1 and 512 characters long.

    \n
    • \n
  • \n

    Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)

    \n
    • \n
\n

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 PutRetentionPolicy.

\n

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.

\n

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 InvalidParameterException error.

\n \n

CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with\n your log group. For more information, see Using Symmetric and Asymmetric\n Keys.

\n " } }, "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": { @@ -250,13 +250,13 @@ "kmsKeyId": { "target": "com.amazonaws.cloudwatchlogs#KmsKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. \n For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. \n For more information, see Amazon Resource Names - Key Management Service.

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

The key-value pairs to use for the tags.

" + "smithy.api#documentation": "

The key-value pairs to use for the tags.

\n

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.

" } } } @@ -322,7 +322,7 @@ "type": "integer", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

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.

\n

If you omit retentionInDays in a PutRetentionPolicy operation, \n the events in the log group are always retained and never expire.

" + "smithy.api#documentation": "

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.

\n

To set a log group to never have log events expire, use\n DeleteRetentionPolicy.\n

" } }, "com.amazonaws.cloudwatchlogs#DefaultValue": { @@ -798,7 +798,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

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

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.

\n

CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the \n aws:ResourceTag/key-name\n condition key. Other CloudWatch Logs actions\n do support the use of the aws:ResourceTag/key-name\n condition key to control access.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -1285,7 +1285,7 @@ "accessPolicy": { "target": "com.amazonaws.cloudwatchlogs#AccessPolicy", "traits": { - "smithy.api#documentation": "

An IAM policy document that governs which AWS accounts can create subscription filters\n against this destination.

" + "smithy.api#documentation": "

An IAM policy document that governs which Amazon Web Services accounts can create subscription filters\n against this destination.

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

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

\n

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.

\n

Note that it can take up to 5 minutes for this operation to take effect.

" + "smithy.api#documentation": "

Disassociates the associated Key Management Service customer master key (CMK) from the specified log group.

\n

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.

\n

Note that it can take up to 5 minutes for this operation to take effect.

" } }, "com.amazonaws.cloudwatchlogs#DisassociateKmsKeyRequest": { @@ -1860,7 +1860,7 @@ "nextToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

\n

Using this token works only when you specify true for startFromHead.

" + "smithy.api#documentation": "

The token for the next set of items to return. (You received this token from a previous call.)

" } }, "limit": { @@ -1872,7 +1872,7 @@ "startFromHead": { "target": "com.amazonaws.cloudwatchlogs#StartFromHead", "traits": { - "smithy.api#documentation": "

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.

\n

If you are using nextToken in this operation, you must specify true for startFromHead.

" + "smithy.api#documentation": "

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.

\n

If you are using a previous nextForwardToken value as the nextToken in this operation, \n you must specify true for startFromHead.

" } } } @@ -2554,7 +2554,7 @@ "name": "logs" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

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.

\n

You can use CloudWatch Logs to:

\n
    \n
  • \n

    \n Monitor logs from EC2 instances in real-time: 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.

    \n
    • \n
  • \n

    \n Monitor AWS CloudTrail logged events: 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.

    \n
    • \n
  • \n

    \n Archive log data: 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.

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

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.

\n

You can use CloudWatch Logs to:

\n
    \n
  • \n

    \n Monitor logs from EC2 instances in real-time: 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.

    \n
    • \n
  • \n

    \n Monitor CloudTrail logged events: 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.

    \n
    • \n
  • \n

    \n Archive log data: 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.

    \n
    • \n
", "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": "

The fields to use as dimensions for the metric. One metric filter can include\n as many as three dimensions.

\n \n

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 IPAddress or requestID 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

\n

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.

\n

You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated AWS Charges.\n

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

The fields to use as dimensions for the metric. One metric filter can include\n as many as three dimensions.

\n \n

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 IPAddress or requestID 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

\n

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.

\n

You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n

\n " } }, "unit": { @@ -2871,7 +2871,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates an access policy associated with an existing\n destination. An access policy is an IAM policy document that is used\n to authorize claims to register a subscription filter against a given destination.

\n

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 *\n as the Principal or the use of the aws:PrincipalOrgId global key.

" + "smithy.api#documentation": "

Creates or updates an access policy associated with an existing\n destination. An access policy is an IAM policy document that is used\n to authorize claims to register a subscription filter against a given destination.

\n

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 *\n as the Principal or the use of the aws:PrincipalOrgId global key.

" } }, "com.amazonaws.cloudwatchlogs#PutDestinationPolicyRequest": { @@ -2959,7 +2959,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uploads a batch of log events to the specified log stream.

\n

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 expectedSequenceToken field from\n InvalidSequenceTokenException. If you call PutLogEvents twice\n within a narrow time period using the same value for sequenceToken, both calls\n might be successful or one might be rejected.

\n

The batch of events must satisfy the following constraints:

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    None of the log events in the batch can be more than 2 hours in the future.

    \n
    • \n
  • \n

    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.

    \n
    • \n
  • \n

    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.)

    \n
    • \n
  • \n

    A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

    \n
    • \n
  • \n

    The maximum number of log events in a batch is 10,000.

    \n
    • \n
  • \n

    There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.

    \n
    • \n
\n

If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is an invalid AWS access key ID or secret key.

" + "smithy.api#documentation": "

Uploads a batch of log events to the specified log stream.

\n

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 expectedSequenceToken field from\n InvalidSequenceTokenException. If you call PutLogEvents twice\n within a narrow time period using the same value for sequenceToken, both calls\n might be successful or one might be rejected.

\n

The batch of events must satisfy the following constraints:

\n
    \n
  • \n

    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.

    \n
    • \n
  • \n

    None of the log events in the batch can be more than 2 hours in the future.

    \n
    • \n
  • \n

    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.

    \n
    • \n
  • \n

    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.)

    \n
    • \n
  • \n

    A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

    \n
    • \n
  • \n

    The maximum number of log events in a batch is 10,000.

    \n
    • \n
  • \n

    There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.

    \n
    • \n
\n

If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is an invalid Amazon Web Services access key ID or secret key.

" } }, "com.amazonaws.cloudwatchlogs#PutLogEventsRequest": { @@ -3034,7 +3034,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 PutLogEvents.

\n

The maximum number of metric filters that can be associated with a log group is\n 100.

\n

When you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.

\n \n

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 IPAddress or requestID 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

\n

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.

\n

You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated AWS Charges.\n

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

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 PutLogEvents.

\n

The maximum number of metric filters that can be associated with a log group is\n 100.

\n

When you create a metric filter, you can also optionally assign a unit and dimensions\n to the metric that is created.

\n \n

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 IPAddress or requestID 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

\n

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.

\n

You can also set up a billing alarm to alert you if your charges are higher than \n expected. For more information, \n see \n Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.\n

\n " } }, "com.amazonaws.cloudwatchlogs#PutMetricFilterRequest": { @@ -3155,7 +3155,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.cloudwatchlogs#PutResourcePolicyRequest": { @@ -3170,7 +3170,7 @@ "policyDocument": { "target": "com.amazonaws.cloudwatchlogs#PolicyDocument", "traits": { - "smithy.api#documentation": "

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.

\n

The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

\n

\n { \n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\", \n \"Effect\": \"Allow\", \n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n }, \n \"Action\":\"logs:PutLogEvents\", \n \"Resource\": \"logArn\"\n }\n ]\n} \n \n

" + "smithy.api#documentation": "

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.

\n

The following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.

\n

CloudWatch Logs also supports aws:SourceArn\n and aws:SourceAccount\ncondition context keys.

\n

In the example resource policy, you would replace the value of SourceArn with the resource making the\n call from Route 53 to CloudWatch Logs and replace the value of SourceAccount with \n the Amazon Web Services account ID making that call.

\n

\n

\n {\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}\n \n

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

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 PutLogEvents 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.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
  • \n

    A logical destination that belongs to a different account, for cross-account delivery.

    \n
    • \n
  • \n

    An Amazon Kinesis Firehose delivery stream that belongs to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    An AWS Lambda function that belongs to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
\n

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 filterName.\n

\n

To perform a PutSubscriptionFilter operation, you must also have the \n iam:PassRole permission.

" + "smithy.api#documentation": "

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 PutLogEvents 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.

\n

The following destinations are supported for subscription filters:

\n
    \n
  • \n

    An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
  • \n

    A logical destination that belongs to a different account, for cross-account delivery.

    \n
    • \n
  • \n

    An Amazon Kinesis Firehose delivery stream that belongs to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    An Lambda function that belongs to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
\n

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 filterName.\n

\n

To perform a PutSubscriptionFilter operation, you must also have the \n iam:PassRole permission.

" } }, "com.amazonaws.cloudwatchlogs#PutSubscriptionFilterRequest": { @@ -3280,7 +3280,7 @@ "destinationArn": { "target": "com.amazonaws.cloudwatchlogs#DestinationArn", "traits": { - "smithy.api#documentation": "

The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:

\n
    \n
  • \n

    An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
  • \n

    A logical destination (specified using an ARN) belonging to a different account, \n for cross-account delivery.

    \n

    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 PutDestinationPolicy.

    \n
    • \n
  • \n

    An Amazon Kinesis Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    An AWS Lambda function belonging to the same account as the subscription filter,\n for same-account delivery.

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

The ARN of the destination to deliver matching log events to. Currently, the supported\n destinations are:

\n
    \n
  • \n

    An Amazon Kinesis stream belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
  • \n

    A logical destination (specified using an ARN) belonging to a different account, \n for cross-account delivery.

    \n

    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 PutDestinationPolicy.

    \n
    • \n
  • \n

    An Amazon Kinesis Firehose delivery stream belonging to the same account as the\n subscription filter, for same-account delivery.

    \n
    • \n
  • \n

    A Lambda function belonging to the same account as the subscription filter,\n for same-account delivery.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -4059,7 +4059,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates the specified tags for the specified log group.

\n

To list the tags for a log group, use ListTagsLogGroup.\n To remove tags, use UntagLogGroup.

\n

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs\n in the Amazon CloudWatch Logs User Guide.

" + "smithy.api#documentation": "

Adds or updates the specified tags for the specified log group.

\n

To list the tags for a log group, use ListTagsLogGroup.\n To remove tags, use UntagLogGroup.

\n

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs\n in the Amazon CloudWatch Logs User Guide.

\n

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.

" } }, "com.amazonaws.cloudwatchlogs#TagLogGroupRequest": { @@ -4195,7 +4195,7 @@ } }, "traits": { - "smithy.api#documentation": "

The most likely cause is an invalid AWS access key ID or secret key.

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

The most likely cause is an invalid Amazon Web Services access key ID or secret key.

", "smithy.api#error": "client" } }, @@ -4210,7 +4210,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified log group.

\n

To list the tags for a log group, use ListTagsLogGroup.\n To add tags, use TagLogGroup.

" + "smithy.api#documentation": "

Removes the specified tags from the specified log group.

\n

To list the tags for a log group, use ListTagsLogGroup.\n To add tags, use TagLogGroup.

\n

CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to \n log groups using the aws:Resource/key-name\n or aws:TagKeys condition keys. \n

" } }, "com.amazonaws.cloudwatchlogs#UntagLogGroupRequest": { diff --git a/aws/sdk/aws-models/models.lex.v2.json b/aws/sdk/aws-models/models.lex.v2.json index 844226cb12..06f947c245 100644 --- a/aws/sdk/aws-models/models.lex.v2.json +++ b/aws/sdk/aws-models/models.lex.v2.json @@ -282,7 +282,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provided the identity of a the bot that was exported.

" + "smithy.api#documentation": "

Provides the identity of a the bot that was exported.

" } }, "com.amazonaws.lexmodelsv2#BotFilter": { @@ -2575,7 +2575,7 @@ "multipleValuesSetting": { "target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting", "traits": { - "smithy.api#documentation": "

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 true in any other locale, Amazon Lex throws a\n ValidationException.

\n

If the multipleValuesSetting is not set, the default\n value is false.

" + "smithy.api#documentation": "

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 true in any other locale, Amazon Lex throws a\n ValidationException.

\n

If the multipleValuesSetting is not set, the default\n value is false.

" } } } @@ -5243,7 +5243,7 @@ "multipleValuesSetting": { "target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting", "traits": { - "smithy.api#documentation": "

Indicates whether the slot accepts multiple values in a\n single utterance.

\n

If the multipleValuesSetting is not set, the default\n value is false.

" + "smithy.api#documentation": "

Indicates whether the slot accepts multiple values in a single\n utterance.

\n

If the multipleValuesSetting is not set, the default\n value is false.

" } } } @@ -5990,6 +5990,12 @@ "smithy.api#documentation": "

The response that Amazon Lex sends to the user when the intent is\n complete.

", "smithy.api#required": {} } + }, + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

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 active field\n isn't specified, the default is true.

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

When the user answers \"no\" to the question defined in\n promptSpecification, Amazon Lex responds with this response\n to acknowledge that the intent was canceled.

", "smithy.api#required": {} } + }, + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

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 active field isn't specified, the default is\n true.

" + } } }, "traits": { @@ -7778,7 +7790,7 @@ "allowMultipleValues": { "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether a slot can return multiple values. When\n true, the slot may return more than one value in a\n response. When false, the slot returns only a single\n value.

\n

Multi-value slots are only available in the en-US locale. If you\n set this value to true in any other locale, Amazon Lex throws a\n ValidationException.

\n

If the allowMutlipleValues is not set, the default\n value is false.

" + "smithy.api#documentation": "

Indicates whether a slot can return multiple values. When\n true, the slot may return more than one value in a\n response. When false, the slot returns only a single\n value.

\n

Multi-value slots are only available in the en-US locale. If you set\n this value to true in any other locale, Amazon Lex throws a\n ValidationException.

\n

If the allowMutlipleValues is not set, the default\n value is false.

" } } }, @@ -7992,7 +8004,7 @@ "smithy.api#box": {}, "smithy.api#range": { "min": 0, - "max": 25 + "max": 100 } } }, @@ -10543,6 +10555,12 @@ "traits": { "smithy.api#documentation": "

A response that Amazon Lex sends periodically to the user to indicate\n that the bot is still waiting for input from the user.

" } + }, + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

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 active field isn't specified, the default is\n true.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/nimble.json b/aws/sdk/aws-models/nimble.json index 1b01c5df1b..843ff750b5 100644 --- a/aws/sdk/aws-models/nimble.json +++ b/aws/sdk/aws-models/nimble.json @@ -210,7 +210,7 @@ "directoryId": { "target": "com.amazonaws.nimble#DirectoryId", "traits": { - "smithy.api#documentation": "

The directory ID of the AWS Directory Service for Microsoft AD to access using this studio component.

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

The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.

", "smithy.api#jsonName": "directoryId" } }, @@ -611,6 +611,13 @@ "smithy.api#jsonName": "launchProfileId" } }, + "ownedBy": { + "target": "com.amazonaws.nimble#__string", + "traits": { + "smithy.api#documentation": "

The user ID of the user that owns the streaming session.

", + "smithy.api#jsonName": "ownedBy" + } + }, "streamingImageId": { "target": "com.amazonaws.nimble#StreamingImageId", "traits": { @@ -773,7 +780,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a new Studio.

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.

The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.

The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.

You may optionally specify a KMS key in the StudioEncryptionConfiguration.

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.

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.

If you delete this grant, the studio will no longer be accessible to your portal users.

If you delete the studio KMS key, your studio will no longer be accessible.

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

Create a new Studio.

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.

The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.

The Admin Role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.

You may optionally specify a KMS key in the StudioEncryptionConfiguration.

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.

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.

If you delete this grant, the studio will no longer be accessible to your portal users.

If you delete the studio KMS key, your studio will no longer be accessible.

", "smithy.api#http": { "method": "POST", "uri": "/2020-08-01/studios", @@ -2803,7 +2810,7 @@ "directoryId": { "target": "com.amazonaws.nimble#DirectoryId", "traits": { - "smithy.api#documentation": "

The directory ID of the AWS Directory Service for Microsoft AD to access using this launch profile.

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

The directory ID of the Directory Service for Microsoft Active Directory to access using this launch profile.

", "smithy.api#jsonName": "directoryId" } }, @@ -3520,7 +3527,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the streaming image resources available to this studio.

This list will contain both images provided by AWS, as well as streaming images that you have created in your studio.

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

List the streaming image resources available to this studio.

This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.

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

The user ID.

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

The user ID of the user that created the streaming session.

", "smithy.api#httpQuery": "createdBy" } }, @@ -3631,6 +3638,13 @@ "smithy.api#httpQuery": "nextToken" } }, + "ownedBy": { + "target": "com.amazonaws.nimble#__string", + "traits": { + "smithy.api#documentation": "

The user ID of the user that owns the streaming session.

", + "smithy.api#httpQuery": "ownedBy" + } + }, "sessionIds": { "target": "com.amazonaws.nimble#__string", "traits": { @@ -3885,7 +3899,7 @@ } ], "traits": { - "smithy.api#documentation": "

List studios in your AWS account in the requested AWS Region.

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

List studios in your Amazon Web Services account in the requested Amazon Web Services Region.

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

Repairs the SSO configuration for a given studio.

If the studio has a valid AWS SSO configuration currently associated with it, this operation will fail with a validation error.

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.

After the AWS SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

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

Repairs the SSO configuration for a given studio.

If the studio has a valid Amazon Web Services SSO configuration currently associated with it, this operation will fail with a validation error.

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.

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.

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

The streaming image session ID.

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

The user ID of the user that owns the streaming session.

", + "smithy.api#jsonName": "ownedBy" + } + }, "sessionId": { - "target": "com.amazonaws.nimble#StreamingImageSessionId", + "target": "com.amazonaws.nimble#StreamingSessionId", "traits": { "smithy.api#documentation": "

The session ID.

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

The user ID of the user that owns the streaming session.

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

The AWS region where the studio resource is located.

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

The Amazon Web Services Region where the studio resource is located.

", "smithy.api#jsonName": "homeRegion" } }, "ssoClientId": { "target": "com.amazonaws.nimble#__string", "traits": { - "smithy.api#documentation": "

The AWS SSO application client ID used to integrate with AWS SSO to enable AWS SSO users to log in to Nimble portal.

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

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.

", "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": { diff --git a/aws/sdk/aws-models/quicksight.json b/aws/sdk/aws-models/quicksight.json index 8a066c641b..9f4ec6d2e9 100644 --- a/aws/sdk/aws-models/quicksight.json +++ b/aws/sdk/aws-models/quicksight.json @@ -59,7 +59,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations associated with your Amazon Web Services account; or a QuickSight namespace in a specific Region;.

" + "smithy.api#documentation": "

The Amazon QuickSight customizations associated with your Amazon Web Services account; or a QuickSight namespace in a specific Amazon Web Services Region;.

" } }, "com.amazonaws.quicksight#AccountSettings": { @@ -1206,7 +1206,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates Amazon QuickSight customizations the current Region;. Currently, you can\n add a custom default theme by using the CreateAccountCustomization or\n UpdateAccountCustomization API operation. To further customize\n QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User\n Guide.\n

\n

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 DescribeAccountCustomization API operation.

\n

Before you use the CreateAccountCustomization 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 \n DescribeThemePermissions\n API operation.\n To share the theme, grant permissions by using the \n \n UpdateThemePermissions\n API operation.

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

Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can\n add a custom default theme by using the CreateAccountCustomization or\n UpdateAccountCustomization API operation. To further customize\n QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User\n Guide.\n

\n

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 DescribeAccountCustomization API operation.

\n

Before you use the CreateAccountCustomization 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 \n DescribeThemePermissions\n API operation.\n To share the theme, grant permissions by using the \n \n UpdateThemePermissions\n API operation.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/customizations", @@ -1235,7 +1235,7 @@ "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

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.

\n

For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

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

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.

\n

For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

", "smithy.api#required": {} } }, @@ -1271,7 +1271,7 @@ "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The QuickSight customizations you're adding in the current Region;.

" + "smithy.api#documentation": "

The QuickSight customizations you're adding in the current Amazon Web Services Region;.

" } }, "RequestId": { @@ -1520,7 +1520,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you create the dashboard. In\n SourceEntity, 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 SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account; and any\n QuickSight-supported Region;.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

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

The entity that you are using as a source when you create the dashboard. In\n SourceEntity, 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 SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account; and any\n QuickSight-supported Amazon Web Services Region;.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

", "smithy.api#required": {} } }, @@ -1652,7 +1652,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

An ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.

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

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;.

", "smithy.api#required": {} } }, @@ -1739,7 +1739,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

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;.

" } }, "IngestionArn": { @@ -1826,7 +1826,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

An ID for the data source. This ID is unique per Region; for each Amazon Web Services account;.

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

An ID for the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

", "smithy.api#required": {} } }, @@ -1894,7 +1894,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

" } }, "CreationStatus": { @@ -2699,7 +2699,7 @@ "CapacityRegion": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "CreationStatus": { @@ -2889,7 +2889,7 @@ "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

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;.

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

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;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2909,7 +2909,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#TemplateSourceEntity", "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account; and any QuickSight-supported Region;.

\n\t\t

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

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

The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account; and any QuickSight-supported Amazon Web Services Region;.

\n\t\t

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

", "smithy.api#required": {} } }, @@ -3129,7 +3129,7 @@ "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

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;.

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

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;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4079,7 +4079,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each \n Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region; for each \n Amazon Web Services account;.

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

Deletes all Amazon QuickSight customizations in this Region; for the specified \n Amazon Web Services account; and QuickSight namespace.

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

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified \n Amazon Web Services account; and QuickSight namespace.

", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/customizations", @@ -4592,7 +4592,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account; that you want to delete QuickSight customizations from in\n this Region;.

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

The ID for the Amazon Web Services account; that you want to delete QuickSight customizations from in\n this Amazon Web Services Region;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4875,7 +4875,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.

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

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;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4894,7 +4894,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

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;.

" } }, "RequestId": { @@ -4960,7 +4960,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

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

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4979,7 +4979,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

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

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 Resolved flag\n included.

\n

To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

\n
    \n
  • \n

    \n Amazon Web Services account; - 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;.

    \n
    • \n
  • \n

    \n Region; - 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.

    \n

    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:

    \n \n
    • \n
  • \n

    \n Namespace - 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;.

    \n
    • \n
  • \n

    \n Applied customizations - 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 CreateAccountCustomization command in\n each Region; where you want to apply the same customizations.

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

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 Resolved flag\n included.

\n

To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

\n
    \n
  • \n

    \n Amazon Web Services account; - 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;.

    \n
    • \n
  • \n

    \n Amazon Web Services Region; - 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.

    \n

    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:

    \n \n
    • \n
  • \n

    \n Namespace - 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;.

    \n
    • \n
  • \n

    \n Applied customizations - 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 CreateAccountCustomization command in\n each Amazon Web Services Region; where you want to apply the same customizations.

    \n
    • \n
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/customizations", @@ -6207,7 +6207,7 @@ "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The QuickSight customizations that exist in the current Region;.

" + "smithy.api#documentation": "

The QuickSight customizations that exist in the current Amazon Web Services Region;.

" } }, "RequestId": { @@ -6281,7 +6281,7 @@ "AccountSettings": { "target": "com.amazonaws.quicksight#AccountSettings", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "RequestId": { @@ -6741,7 +6741,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.

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

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;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6760,7 +6760,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

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;.

" } }, "Permissions": { @@ -6798,7 +6798,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.

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

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;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6911,7 +6911,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

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

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6930,7 +6930,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

" } }, "Permissions": { @@ -6968,7 +6968,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

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

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7606,7 +7606,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#NamespaceInfoV2", "traits": { - "smithy.api#documentation": "

The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Region;, creation status, and identity store. DescribeNamespace 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.

" + "smithy.api#documentation": "

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. DescribeNamespace 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.

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

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.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not\n from the user's browser. The following rules apply to the combination of URL and\n authorization code:

\n
    \n
  • \n

    They must be used together.

    \n
    • \n
  • \n

    They can be used one time only.

    \n
    • \n
  • \n

    They are valid for 5 minutes after you run this command.

    \n
    • \n
  • \n

    The resulting user session is valid for 10 hours.

    \n
    • \n
\n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

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

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.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not\n from the user's browser. The following rules apply to the combination of URL and\n authorization code:

\n
    \n
  • \n

    They must be used together.

    \n
    • \n
  • \n

    They can be used one time only.

    \n
    • \n
  • \n

    They are valid for 5 minutes after you run this command.

    \n
    • \n
  • \n

    The resulting user session is valid for 10 hours.

    \n
    • \n
\n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", @@ -9279,7 +9279,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a session URL and authorization code that you can use to embed the Amazon\n QuickSight console in your web server code. Use GetSessionEmbedUrl 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 \n UpdateUser\n API operation. Use \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

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

Generates a session URL and authorization code that you can use to embed the Amazon\n QuickSight console in your web server code. Use GetSessionEmbedUrl 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 \n UpdateUser\n API operation. Use \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n ", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/session-embed-url", @@ -10566,7 +10566,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all of the datasets belonging to the current Amazon Web Services account; in an Region;.

\n\t\t

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

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

Lists all of the datasets belonging to the current Amazon Web Services account; in an Amazon Web Services Region;.

\n\t\t

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/data-sets", @@ -10663,7 +10663,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists data sources in current Region; that belong to this Amazon Web Services account;.

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

Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account;.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/data-sources", @@ -11580,7 +11580,7 @@ "Namespaces": { "target": "com.amazonaws.quicksight#Namespaces", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "NextToken": { @@ -12835,7 +12835,7 @@ "CapacityRegion": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "

The namespace Region;.

" + "smithy.api#documentation": "

The namespace Amazon Web Services Region;.

" } }, "CreationStatus": { @@ -13631,7 +13631,7 @@ "name": "quicksight" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon QuickSight API Reference\n

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.

", + "smithy.api#documentation": "Amazon QuickSight API Reference\n

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.

", "smithy.api#title": "Amazon QuickSight" } }, @@ -15336,7 +15336,7 @@ "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID for the template. This is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID for the template. This is unique per Amazon Web Services Region; for each Amazon Web Services account;.

" } }, "LastUpdatedTime": { @@ -15526,7 +15526,7 @@ "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the template. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

" } }, "Name": { @@ -15906,7 +15906,7 @@ "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "

The ID of the theme. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

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

Updates Amazon QuickSight customizations the current Region;. Currently, the only\n customization you can use is a theme.

\n

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 DescribeAccountCustomization API operation.

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

Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only\n customization you can use is a theme.

\n

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 DescribeAccountCustomization API operation.

", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/customizations", @@ -16491,7 +16491,7 @@ "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The QuickSight customizations you're updating in the current Region;.

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

The QuickSight customizations you're updating in the current Amazon Web Services Region;.

", "smithy.api#required": {} } } @@ -16521,7 +16521,7 @@ "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "

The QuickSight customizations you're updating in the current Region;.

" + "smithy.api#documentation": "

The QuickSight customizations you're updating in the current Amazon Web Services Region;.

" } }, "RequestId": { @@ -17120,7 +17120,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you update the dashboard. In\n SourceEntity, 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 SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account; and any\n QuickSight-supported Region;.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

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

The entity that you are using as a source when you update the dashboard. In\n SourceEntity, 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 SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account; and any\n QuickSight-supported Amazon Web Services Region;.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

", "smithy.api#required": {} } }, @@ -17285,7 +17285,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

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;.

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

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;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17316,7 +17316,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

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;.

" + "smithy.api#documentation": "

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;.

" } }, "RequestId": { @@ -17348,7 +17348,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

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;.

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

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;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17424,7 +17424,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to create. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

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;.

" } }, "IngestionArn": { @@ -17542,7 +17542,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

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

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17573,7 +17573,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

" } }, "RequestId": { @@ -17605,7 +17605,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

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

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17655,7 +17655,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Region; for each Amazon Web Services account;.

" + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account;.

" } }, "UpdateStatus": { @@ -18399,7 +18399,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#TemplateSourceEntity", "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account; and any QuickSight-supported Region;.

\n\t\t

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

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

The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account; and any QuickSight-supported Amazon Web Services Region;.

\n\t\t

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/rds.json b/aws/sdk/aws-models/rds.json index 2bb3a2be76..177512865f 100644 --- a/aws/sdk/aws-models/rds.json +++ b/aws/sdk/aws-models/rds.json @@ -2421,7 +2421,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n\n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

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

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

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

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

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

The amount of storage in gibibytes (GiB) to allocate for the DB instance.

\n

Type: Integer

\n

\n Amazon Aurora\n

\n

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.

\n\n

\n MySQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n \n

\n MariaDB\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n \n

\n PostgreSQL\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 5 to 3072.

    \n
    • \n
\n \n

\n Oracle\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    \n
    • \n
  • \n

    Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    \n
    • \n
  • \n

    Magnetic storage (standard): Must be an integer from 10 to 3072.

    \n
    • \n
\n \n

\n SQL Server\n

\n

Constraints to the amount of storage for each storage type are the following:\n

\n
    \n
  • \n

    General Purpose (SSD) storage (gp2):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 16384.

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

    Provisioned IOPS storage (io1):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 16384.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 100 to 16384.

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

    Magnetic storage (standard):

    \n
      \n
    • \n

      Enterprise and Standard editions: Must be an integer from 200 to 1024.

      \n
      • \n
    • \n

      Web and Express editions: Must be an integer from 20 to 1024.

      \n
      • \n
    \n
    • \n
" } }, "DBInstanceClass": { @@ -2687,7 +2687,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" } }, "EnableCustomerOwnedIp": { @@ -2963,7 +2963,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" } } } @@ -3831,6 +3831,12 @@ "smithy.api#documentation": "

Specifies the current state of this DB cluster.

" } }, + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when a stopped DB cluster is restarted automatically.

" + } + }, "PercentProgress": { "target": "com.amazonaws.rds#String", "traits": { @@ -5161,6 +5167,12 @@ "smithy.api#documentation": "

Specifies the current state of this database.

\n

For information about DB instance statuses, see\n Viewing DB instance status \n in the Amazon RDS User Guide.\n

" } }, + "AutomaticRestartTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "

The time when a stopped DB instance is restarted automatically.

" + } + }, "MasterUsername": { "target": "com.amazonaws.rds#String", "traits": { @@ -5176,13 +5188,13 @@ "Endpoint": { "target": "com.amazonaws.rds#Endpoint", "traits": { - "smithy.api#documentation": "

Specifies the connection endpoint.

" + "smithy.api#documentation": "

Specifies the connection endpoint.

\n \n

The endpoint might not be shown for instances whose status is creating.

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

Specifies the allocated storage size specified in gibibytes.

" + "smithy.api#documentation": "

Specifies the allocated storage size specified in gibibytes (GiB).

" } }, "InstanceCreateTime": { @@ -5494,7 +5506,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

" } }, "TagList": { @@ -13642,7 +13654,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The new amount of storage (in gibibytes) to allocate for the DB instance.\n

\n \n

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

\n \n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.\n

" + "smithy.api#documentation": "

The new amount of storage in gibibytes (GiB) to allocate for the DB instance.\n

\n \n

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

\n \n

For the valid values for allocated storage for each engine,\n see CreateDBInstance.\n

" } }, "DBInstanceClass": { @@ -13876,7 +13888,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" } }, "CertificateRotationRestart": { @@ -15597,7 +15609,7 @@ "AllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The allocated storage size for the DB instance specified in gibibytes .

" + "smithy.api#documentation": "

The allocated storage size for the DB instance specified in gibibytes (GiB).

" } }, "MasterUserPassword": { @@ -18101,7 +18113,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" } } } @@ -18384,7 +18396,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" + "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

" } }, "SourceDBInstanceAutomatedBackupsArn": { @@ -19913,7 +19925,7 @@ "StorageSize": { "target": "com.amazonaws.rds#RangeList", "traits": { - "smithy.api#documentation": "

The valid range of storage in gibibytes.\n For example, 100 to 16384. \n

" + "smithy.api#documentation": "

The valid range of storage in gibibytes (GiB).\n For example, 100 to 16384. \n

" } }, "ProvisionedIops": { diff --git a/aws/sdk/aws-models/rekognition.json b/aws/sdk/aws-models/rekognition.json index 6a79e617b4..ccdec5fb6f 100644 --- a/aws/sdk/aws-models/rekognition.json +++ b/aws/sdk/aws-models/rekognition.json @@ -166,6 +166,26 @@ "smithy.api#documentation": "

Indicates whether or not the face has a beard, and the confidence level in the\n determination.

" } }, + "com.amazonaws.rekognition#BlackFrame": { + "type": "structure", + "members": { + "MaxPixelThreshold": { + "target": "com.amazonaws.rekognition#MaxPixelThreshold", + "traits": { + "smithy.api#documentation": "

\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

\n

For example, for a full range video with BlackPixelThreshold = 0.1, max_black_pixel_value is 0 + 0.1 * (255-0) = 25.5.

\n

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.

" + } + }, + "MinCoveragePercentage": { + "target": "com.amazonaws.rekognition#MinCoveragePercentage", + "traits": { + "smithy.api#documentation": "

\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

\n

The default value is 99, which means at least 99% of all pixels in the frame are black pixels as per the MaxPixelThreshold\n set. You can reduce this value to allow more noise on the black frame.

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

\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 StartSegmentDetection.\n

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

Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.

" + "smithy.api#documentation": "

Time, in milliseconds from the beginning of the video, that the content moderation label was detected.

" } }, "ModerationLabel": { "target": "com.amazonaws.rekognition#ModerationLabel", "traits": { - "smithy.api#documentation": "

The unsafe content label detected by in the stored video.

" + "smithy.api#documentation": "

The content moderation label detected by in the stored video.

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

Information about an unsafe content label detection in a stored video.

" + "smithy.api#documentation": "

Information about an inappropriate, unwanted, or offensive content label detection in a stored video.

" } }, "com.amazonaws.rekognition#ContentModerationDetections": { @@ -888,7 +908,7 @@ "OutputConfig": { "target": "com.amazonaws.rekognition#OutputConfig", "traits": { - "smithy.api#documentation": "

The Amazon S3 location to store the results of training.

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

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 s3:PutObject permissions on the S3 bucket.

", "smithy.api#required": {} } }, @@ -915,7 +935,7 @@ "KmsKeyId": { "target": "com.amazonaws.rekognition#KmsKeyId", "traits": { - "smithy.api#documentation": "

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 (OutputConfig).

\n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

" + "smithy.api#documentation": "

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 (OutputConfig).

\n

If you choose to use your own CMK, you need the following permissions on the CMK.

\n
    \n
  • \n

    kms:CreateGrant

    \n
    • \n
  • \n

    kms:DescribeKey

    \n
    • \n
  • \n

    kms:GenerateDataKey

    \n
    • \n
  • \n

    kms:Decrypt

    \n
    • \n
\n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

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

Detects text in the input image and converts it into machine-readable text.

\n

Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more ISO basic latin script characters that are not separated by spaces.\n DetectText can detect up to 50 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

\n \n

For more information, see DetectText in the Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Detects text in the input image and converts it into machine-readable text.

\n

Pass the input image as base64-encoded image bytes or as a reference to an image in an\n Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a\n reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not\n supported. The image must be either a .png or .jpeg formatted file.

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more ISO basic latin script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

\n \n

For more information, see DetectText in the Amazon Rekognition Developer Guide.

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

Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by\n StartContentModeration.

\n\n

Unsafe content analysis of a video is an asynchronous operation. You start analysis by calling\n StartContentModeration which returns a job identifier (JobId).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartContentModeration.\n To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.

\n

\n GetContentModeration returns detected unsafe content labels,\n and the time they are detected, in an array, ModerationLabels, of\n ContentModerationDetection objects.\n

\n

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying NAME for the SortBy\n input parameter.

\n

Since video analysis can return a large number of results, use the MaxResults parameter to limit\n the number of labels returned in a single call to GetContentModeration. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetContentModeration\n and populate the NextToken request parameter with the value of NextToken\n returned from the previous call to GetContentModeration.

\n \n

For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

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

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by\n StartContentModeration. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n\n

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling\n StartContentModeration which returns a job identifier (JobId).\n When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartContentModeration.\n To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Working with Stored Videos in the\n Amazon Rekognition Devlopers Guide.

\n

\n GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels,\n and the time they are detected, in an array, ModerationLabels, of\n ContentModerationDetection objects.\n

\n

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the\n video. You can also sort them by moderated label by specifying NAME for the SortBy\n input parameter.

\n

Since video analysis can return a large number of results, use the MaxResults parameter to limit\n the number of labels returned in a single call to GetContentModeration. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetContentModeration\n and populate the NextToken request parameter with the value of NextToken\n returned from the previous call to GetContentModeration.

\n \n

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3048,7 +3068,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "

The identifier for the unsafe content job. Use JobId to identify the job in\n a subsequent call to GetContentModeration.

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

The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in\n a subsequent call to GetContentModeration.

", "smithy.api#required": {} } }, @@ -3061,7 +3081,7 @@ "NextToken": { "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "SortBy": { @@ -3078,7 +3098,7 @@ "JobStatus": { "target": "com.amazonaws.rekognition#VideoJobStatus", "traits": { - "smithy.api#documentation": "

The current status of the unsafe content analysis job.

" + "smithy.api#documentation": "

The current status of the content moderation analysis job.

" } }, "StatusMessage": { @@ -3096,19 +3116,19 @@ "ModerationLabels": { "target": "com.amazonaws.rekognition#ContentModerationDetections", "traits": { - "smithy.api#documentation": "

The detected unsafe content labels and the time(s) they were detected.

" + "smithy.api#documentation": "

The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.

" } }, "NextToken": { "target": "com.amazonaws.rekognition#PaginationToken", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

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

Version number of the moderation detection model that was used to detect unsafe content.

" + "smithy.api#documentation": "

Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.

" } } } @@ -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": "

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.rekognition#ModerationLabels": { @@ -4994,7 +5034,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see\n api-video.

" + "smithy.api#documentation": "

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see\n api-video. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.\n For more information, see Giving access to multiple Amazon SNS topics.

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

If the segment is a shot detection, contains information about the shot detection.

" } + }, + "StartFrameNumber": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "

\n The frame number of the start of a video segment, using a frame index that starts with 0.\n

" + } + }, + "EndFrameNumber": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "

\n The frame number at the end of a video segment, using a frame index that starts with 0.\n

" + } + }, + "DurationFrames": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "

\n The duration of a video segment, expressed in frames.\n

" + } } }, "traits": { @@ -6603,7 +6661,7 @@ "NotificationChannel": { "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n celebrity recognition analysis to.

" + "smithy.api#documentation": "

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 AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

" } }, "JobTag": { @@ -6663,7 +6721,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of unsafe content in a stored video.

\n

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartContentModeration\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

\n

To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

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

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see\n Using the image and video moderation APIs.

\n

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name\n and the filename of the video. StartContentModeration\n returns a job identifier (JobId) which you use to get the results of the analysis.\n When content analysis is finished, Amazon Rekognition Video publishes a completion status\n to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

\n

To get the results of the content analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier\n (JobId) from the initial call to StartContentModeration.

\n \n

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -6673,7 +6731,7 @@ "Video": { "target": "com.amazonaws.rekognition#Video", "traits": { - "smithy.api#documentation": "

The video in which you want to detect unsafe content. The video must be stored\n in an Amazon S3 bucket.

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

The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored\n in an Amazon S3 bucket.

", "smithy.api#required": {} } }, @@ -6692,7 +6750,7 @@ "NotificationChannel": { "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the\n unsafe content analysis to.

" + "smithy.api#documentation": "

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 AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

" } }, "JobTag": { @@ -6709,7 +6767,7 @@ "JobId": { "target": "com.amazonaws.rekognition#JobId", "traits": { - "smithy.api#documentation": "

The identifier for the unsafe content analysis job. Use JobId to identify the job in\n a subsequent call to GetContentModeration.

" + "smithy.api#documentation": "

The identifier for the content analysis job. Use JobId to identify the job in\n a subsequent call to GetContentModeration.

" } } } @@ -6775,7 +6833,7 @@ "NotificationChannel": { "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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 AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

" } }, "FaceAttributes": { @@ -6880,7 +6938,7 @@ "NotificationChannel": { "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.

" + "smithy.api#documentation": "

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 AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

" } }, "JobTag": { @@ -6969,7 +7027,7 @@ "NotificationChannel": { "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection\n operation to.

" + "smithy.api#documentation": "

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 AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

" } }, "JobTag": { @@ -7052,7 +7110,7 @@ "NotificationChannel": { "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection\n operation to.

" + "smithy.api#documentation": "

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 AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

" } }, "JobTag": { @@ -7222,7 +7280,7 @@ "NotificationChannel": { "target": "com.amazonaws.rekognition#NotificationChannel", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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 AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

" } }, "JobTag": { @@ -7330,6 +7388,12 @@ "traits": { "smithy.api#documentation": "

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.

\n

If you don't specify MinSegmentConfidence, GetSegmentDetection returns \n segments with confidence values greater than or equal to 50 percent.

" } + }, + "BlackFrame": { + "target": "com.amazonaws.rekognition#BlackFrame", + "traits": { + "smithy.api#documentation": "

\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

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

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to\n specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

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

Horizontal pixel dimension of the video.

" } + }, + "ColorRange": { + "target": "com.amazonaws.rekognition#VideoColorRange", + "traits": { + "smithy.api#documentation": "

\n A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).\n

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/route53.json b/aws/sdk/aws-models/route53.json index bb54336771..e448307408 100644 --- a/aws/sdk/aws-models/route53.json +++ b/aws/sdk/aws-models/route53.json @@ -406,14 +406,14 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

\n Alias resource records sets only: The value used depends on where you want to route traffic:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the hosted zone ID for your API. You can get the applicable value using the CLI command \n\t\t\t\t\tget-domain-names:

\n\t\t\t\t\t
    \n
  • \n

    For regional APIs, specify the value of regionalHostedZoneId.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of distributionHostedZoneId.

    \n
    • \n
\n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId \n\t\t\t\t\tusing the CLI command \n\t\t\t\t\tdescribe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n\t\t\t\t\t

Specify Z2FDTNDATAQYW2.

\n\t\t\t\t\t \n\t\t\t\t\t\t

Alias resource record sets for CloudFront can't be created in a private zone.

\n\t\t\t\t\t \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the environment in. The environment \n\t\t\t\t\t\tmust have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see \n\t\t\t\t\t Elastic Beanstalk endpoints and quotas in the \n\t\t\t\t\t\t the Amazon Web Services General Reference.

\n\t\t\t\t
\n
ELB load balancer
\n
\n\t\t\t\t\t

Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the \n\t\t\t\t\t\thosted zone ID:

\n\t\t\t\t\t
    \n
  • \n

    \n Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: \n\t\t\t\t\t\t\tUse the value that corresponds with the region that you created your load balancer in. Note that there are \n\t\t\t\t\t\t\tseparate columns for Application and Classic Load Balancers and for Network Load Balancers.

    \n
    • \n
  • \n\t\t\t\t\t\t\t

    \n Management Console: Go to the Amazon EC2 page, choose \n\t\t\t\t\t\t\t\tLoad Balancers in the navigation pane, select the load balancer, and get the value of the \n\t\t\t\t\t\t\t\tHosted zone field on the Description tab.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use DescribeLoadBalancers to get the \n\t\t\t\t\t\t\t\tapplicable value. For more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      Classic Load Balancers: Use \n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers \n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use \n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneId.

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use describe-load-balancers to get the applicable value. \n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      Classic Load Balancers: Use \n\t\t\t\t\t\t\t\t\tdescribe-load-balancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use \n\t\t\t\t\t\t\t\t\tdescribe-load-balancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneId.

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n

Specify Z2BJ6XQ5FK7U4H.

\n
\n
An Amazon S3 bucket configured as a static website
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the bucket in. For more information about \n\t\t\t\t\t\tvalid values, see the table \n\t\t\t\t\t\tAmazon S3 Website Endpoints \n\t\t\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t\t\t
\n
Another Route 53 resource record set in your hosted zone
\n
\n\t\t\t\t\t

Specify the hosted zone ID of your hosted zone. (An alias resource record set\n\t\t\t\t\t\tcan't reference a resource record set in a different hosted zone.)

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

\n Alias resource records sets only: The value used depends on where you want to route traffic:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the hosted zone ID for your API. You can get the applicable value using the CLI command \n\t\t\t\t\tget-domain-names:

\n\t\t\t\t\t
    \n
  • \n

    For regional APIs, specify the value of regionalHostedZoneId.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of distributionHostedZoneId.

    \n
    • \n
\n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId \n\t\t\t\t\tusing the CLI command \n\t\t\t\t\tdescribe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n\t\t\t\t\t

Specify Z2FDTNDATAQYW2.

\n\t\t\t\t\t \n\t\t\t\t\t\t

Alias resource record sets for CloudFront can't be created in a private zone.

\n\t\t\t\t\t \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the environment in. The environment \n\t\t\t\t\t\tmust have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see \n\t\t\t\t\t Elastic Beanstalk endpoints and quotas in the \n\t\t\t\t\t\t the Amazon Web Services General Reference.

\n\t\t\t\t
\n
ELB load balancer
\n
\n\t\t\t\t\t

Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the \n\t\t\t\t\t\thosted zone ID:

\n\t\t\t\t\t
    \n
  • \n

    \n Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: \n\t\t\t\t\t\t\tUse the value that corresponds with the region that you created your load balancer in. Note that there are \n\t\t\t\t\t\t\tseparate columns for Application and Classic Load Balancers and for Network Load Balancers.

    \n
    • \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: Go to the Amazon EC2 page, choose \n\t\t\t\t\t\t\t\tLoad Balancers in the navigation pane, select the load balancer, and get the value of the \n\t\t\t\t\t\t\t\tHosted zone field on the Description tab.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use DescribeLoadBalancers to get the \n\t\t\t\t\t\t\t\tapplicable value. For more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      Classic Load Balancers: Use \n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers \n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use \n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneId.

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use describe-load-balancers to get the applicable value. \n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      Classic Load Balancers: Use \n\t\t\t\t\t\t\t\t\tdescribe-load-balancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use \n\t\t\t\t\t\t\t\t\tdescribe-load-balancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneId.

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n

Specify Z2BJ6XQ5FK7U4H.

\n
\n
An Amazon S3 bucket configured as a static website
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the bucket in. For more information about \n\t\t\t\t\t\tvalid values, see the table \n\t\t\t\t\t\tAmazon S3 Website Endpoints \n\t\t\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t\t\t
\n
Another Route 53 resource record set in your hosted zone
\n
\n\t\t\t\t\t

Specify the hosted zone ID of your hosted zone. (An alias resource record set\n\t\t\t\t\t\tcan't reference a resource record set in a different hosted zone.)

\n\t\t\t\t
\n
", "smithy.api#required": {} } }, "DNSName": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

\n Alias resource record sets only: The value that you specify depends on where you want to route queries:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the applicable domain name for your API. You can get the applicable value using the CLI command \n\t\t\t\t\tget-domain-names:

\n\t\t\t\t\t
    \n
  • \n

    For regional APIs, specify the value of regionalDomainName.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the \n\t\t\t\t\t\t\tassociated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

    \n
    • \n
\n\t\t\t\t\t \n\t\t\t\t\t\t

The name of the record that you're creating must match a custom domain name for your API, such as \n\t\t\t\t\t\t\tapi.example.com.

\n\t\t\t\t\t \n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Enter the API endpoint for the interface endpoint, such as \n\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, \n\t\t\t\t\tthis is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command \n\t\t\t\t\tdescribe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n

Specify the domain name that CloudFront assigned when you created your distribution.

\n\t\t\t\t\t

Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. \n\t\t\t\t\t\tFor example, if the name of the resource record set is acme.example.com, your CloudFront distribution must \n\t\t\t\t\t\tinclude acme.example.com as one of the alternate domain names. For more information, see \n\t\t\t\t\t\tUsing Alternate Domain Names (CNAMEs) in the \n\t\t\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t\t\t\t

You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

\n\t\t\t\t\t \n

For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. \n\t\t\t\t\t\tA distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records \n\t\t\t\t\t\thave the same name, and you can't include the same alternate domain name in more than one distribution.

\n \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, \n\t\t\t\t\t\tyou can create an alias record that routes traffic to the environment. For example, the domain name \n\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

\n\t\t\t\t\t \n\t\t\t\t\t\t

For environments that were created before early 2016, the domain name doesn't include the region. To route traffic \n\t\t\t\t\t\t\tto these environments, you must create a CNAME record instead of an alias record. Note that you can't create a \n\t\t\t\t\t\t\tCNAME record for the root domain name. For example, if your domain name is example.com, you can create a record \n\t\t\t\t\t\t\tthat routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record \n\t\t\t\t\t\t\tthat routes traffic for example.com to your Elastic Beanstalk environment.

\n\t\t\t\t\t \n\t\t\t\t\t

For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. \n\t\t\t\t\t\tYou can use the following methods to get the value of the CNAME attribute:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Management Console: For information about how to get the value by using the console, \n\t\t\t\t\t\t\t\tsee Using Custom Domains with Elastic Beanstalk in the \n\t\t\t\t\t\t\t\tElastic Beanstalk Developer Guide.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Beanstalk API: Use the DescribeEnvironments action to get \n\t\t\t\t\t\t\t\tthe value of the CNAME attribute. For more information, see \n\t\t\t\t\t\t\t\tDescribeEnvironments \n\t\t\t\t\t\t\t\tin the Elastic Beanstalk API Reference.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use the describe-environments command to get the value of the \n\t\t\t\t\t\t\t\tCNAME attribute. For more information, see \n\t\t\t\t\t\t\t\tdescribe-environments in the \n\t\t\t\t\t\t\t\tCLI Command Reference.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
ELB load balancer
\n
\n

Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Management Console, \n\t\t\t\t\tthe ELB API, or the CLI.

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Management Console: Go to the EC2 page, choose Load Balancers \n\t\t\t\t\t\t\t\tin the navigation pane, choose the load balancer, choose the Description tab, and get the value \n\t\t\t\t\t\t\t\tof the DNS name field.

    \n\t\t\t\t\t\t\t

    If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. \n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use DescribeLoadBalancers to get the value \n\t\t\t\t\t\t\t\tof DNSName. For more information, see the applicable guide:

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use describe-load-balancers to get the value of DNSName.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n

Specify the DNS name for your accelerator:

\n\t\t\t\t\t \n\t\t\t\t
\n
Amazon S3 bucket that is configured as a static website
\n
\n

Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, \n\t\t\t\t\ts3-website.us-east-2.amazonaws.com. For more information about valid values, see the table \n\t\t\t\t\tAmazon S3 Website Endpoints \n\t\t\t\t\tin the Amazon Web Services General Reference. For more information about using S3 buckets for websites, \n\t\t\t\t\tsee Getting Started with Amazon Route 53 \n\t\t\t\t\tin the Amazon Route 53 Developer Guide.\n

\n
\n
Another Route 53 resource record set
\n
\n

Specify the value of the Name element for a resource record set in the current hosted zone.

\n\t\t\t\t\t \n

If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), \n\t\t\t\t\t\tyou can't specify the domain name for a record for which the value of Type is CNAME. This is because \n\t\t\t\t\t\tthe alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the \n\t\t\t\t\t\tzone apex isn't supported even for an alias record.

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

\n Alias resource record sets only: The value that you specify depends on where you want to route queries:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the applicable domain name for your API. You can get the applicable value using the CLI command \n\t\t\t\t\tget-domain-names:

\n\t\t\t\t\t
    \n
  • \n

    For regional APIs, specify the value of regionalDomainName.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the \n\t\t\t\t\t\t\tassociated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

    \n
    • \n
\n\t\t\t\t\t \n\t\t\t\t\t\t

The name of the record that you're creating must match a custom domain name for your API, such as \n\t\t\t\t\t\t\tapi.example.com.

\n\t\t\t\t\t \n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Enter the API endpoint for the interface endpoint, such as \n\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, \n\t\t\t\t\tthis is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command \n\t\t\t\t\tdescribe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n

Specify the domain name that CloudFront assigned when you created your distribution.

\n\t\t\t\t\t

Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. \n\t\t\t\t\t\tFor example, if the name of the resource record set is acme.example.com, your CloudFront distribution must \n\t\t\t\t\t\tinclude acme.example.com as one of the alternate domain names. For more information, see \n\t\t\t\t\t\tUsing Alternate Domain Names (CNAMEs) in the \n\t\t\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t\t\t\t

You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

\n\t\t\t\t\t \n

For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. \n\t\t\t\t\t\tA distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records \n\t\t\t\t\t\thave the same name, and you can't include the same alternate domain name in more than one distribution.

\n \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, \n\t\t\t\t\t\tyou can create an alias record that routes traffic to the environment. For example, the domain name \n\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

\n\t\t\t\t\t \n\t\t\t\t\t\t

For environments that were created before early 2016, the domain name doesn't include the region. To route traffic \n\t\t\t\t\t\t\tto these environments, you must create a CNAME record instead of an alias record. Note that you can't create a \n\t\t\t\t\t\t\tCNAME record for the root domain name. For example, if your domain name is example.com, you can create a record \n\t\t\t\t\t\t\tthat routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record \n\t\t\t\t\t\t\tthat routes traffic for example.com to your Elastic Beanstalk environment.

\n\t\t\t\t\t \n\t\t\t\t\t

For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. \n\t\t\t\t\t\tYou can use the following methods to get the value of the CNAME attribute:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: For information about how to get the value by using the console, \n\t\t\t\t\t\t\t\tsee Using Custom Domains with Elastic Beanstalk in the \n\t\t\t\t\t\t\t\tElastic Beanstalk Developer Guide.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Beanstalk API: Use the DescribeEnvironments action to get \n\t\t\t\t\t\t\t\tthe value of the CNAME attribute. For more information, see \n\t\t\t\t\t\t\t\tDescribeEnvironments \n\t\t\t\t\t\t\t\tin the Elastic Beanstalk API Reference.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use the describe-environments command to get the value of the \n\t\t\t\t\t\t\t\tCNAME attribute. For more information, see \n\t\t\t\t\t\t\t\tdescribe-environments in the \n\t\t\t\t\t\t\t\tCLI Command Reference.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
ELB load balancer
\n
\n

Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, \n\t\t\t\t\tthe ELB API, or the CLI.

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: Go to the EC2 page, choose Load Balancers \n\t\t\t\t\t\t\t\tin the navigation pane, choose the load balancer, choose the Description tab, and get the value \n\t\t\t\t\t\t\t\tof the DNS name field.

    \n\t\t\t\t\t\t\t

    If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. \n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use DescribeLoadBalancers to get the value \n\t\t\t\t\t\t\t\tof DNSName. For more information, see the applicable guide:

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use describe-load-balancers to get the value of DNSName.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n

Specify the DNS name for your accelerator:

\n\t\t\t\t\t \n\t\t\t\t
\n
Amazon S3 bucket that is configured as a static website
\n
\n

Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, \n\t\t\t\t\ts3-website.us-east-2.amazonaws.com. For more information about valid values, see the table \n\t\t\t\t\tAmazon S3 Website Endpoints \n\t\t\t\t\tin the Amazon Web Services General Reference. For more information about using S3 buckets for websites, \n\t\t\t\t\tsee Getting Started with Amazon Route 53 \n\t\t\t\t\tin the Amazon Route 53 Developer Guide.\n

\n
\n
Another Route 53 resource record set
\n
\n

Specify the value of the Name element for a resource record set in the current hosted zone.

\n\t\t\t\t\t \n

If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), \n\t\t\t\t\t\tyou can't specify the domain name for a record for which the value of Type is CNAME. This is because \n\t\t\t\t\t\tthe alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the \n\t\t\t\t\t\tzone apex isn't supported even for an alias record.

\n \n\t\t\t\t
\n
", "smithy.api#required": {} } }, @@ -467,7 +467,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an Amazon VPC with a private hosted zone.

\n\t\t \n

To perform the association, the VPC and the private hosted zone must already exist. \n\t\t\tYou can't convert a public hosted zone into a private hosted zone.

\n \n\t\t \n

If you want to associate a VPC that was created by using one account with a private hosted zone that was created \n\t\t\tby using a different account, the account that created the private hosted zone must first submit a \n\t\t\tCreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an \n\t\t\tAssociateVPCWithHostedZone request.

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

Associates an Amazon VPC with a private hosted zone.

\n\t\t \n

To perform the association, the VPC and the private hosted zone must already exist. \n\t\t\tYou can't convert a public hosted zone into a private hosted zone.

\n \n\t\t \n

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created \n\t\t\tby using a different account, the Amazon Web Services account that created the private hosted zone must first submit a \n\t\t\tCreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an \n\t\t\tAssociateVPCWithHostedZone request.

\n ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/associatevpc", @@ -1413,7 +1413,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish \n\t\t\tlog data to an Amazon CloudWatch Logs log group.

\n\t\t

DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

\n\t\t
    \n
  • \n

    Route 53 edge location that responded to the DNS query

    \n
    • \n
  • \n

    Domain or subdomain that was requested

    \n
    • \n
  • \n

    DNS record type, such as A or AAAA

    \n
    • \n
  • \n

    DNS response code, such as NoError or ServFail\n

    \n
    • \n
\n\t\t\n\t\t
\n
Log Group and Resource Policy
\n
\n

Before you create a query logging configuration, perform the following operations.

\n\t\t\t\t\t \n

If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

\n \n\t\t\t\t\t
    \n
  1. \n

    Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a \n\t\t\t\t\t\t\tquery logging configuration. Note the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      You must create the log group in the us-east-1 region.

      \n
      • \n
    • \n

      You must use the same account to create the log group and the hosted zone that you want to \n\t\t\t\t\t\t\t\t\tconfigure query logging for.

      \n
      • \n
    • \n

      When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

      \n\t\t\t\t\t\t\t\t\t

      \n /aws/route53/hosted zone name\n \n

      \n\t\t\t\t\t\t\t\t\t

      In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated \n\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so \n\t\t\t\t\t\t\t\t\t\twe recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create \n\t\t\t\t\t\t\t\t\t\tfor query logging.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    2. \n
  2. \n

    Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to \n\t\t\t\t\t\t\tsend query logs to log streams. For the value of Resource, specify the ARN for the log group that you created \n\t\t\t\t\t\t\tin the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, \n\t\t\t\t\t\t\treplace the hosted zone name with *, for example:

    \n\t\t\t\t\t\t\t

    \n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n

    \n\t\t\t\t\t\t\t \n

    You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, \n\t\t\t\t\t\t\t\tor the CLI.

    \n     \n\t\t\t\t\t\t
    3. \n
\n\t\t\t\t
\n
Log Streams and Edge Locations
\n
\n

When Route 53 finishes creating the configuration for DNS query logging, it does the following:

\n\t\t\t\t\t
    \n
  • \n

    Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the \n\t\t\t\t\t\t\tspecified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.

    \n
    • \n
  • \n

    Begins to send query logs to the applicable log stream.

    \n
    • \n
\n\t\t\t\t\t

The name of each log stream is in the following format:

\n\t\t\t\t\t

\n \n hosted zone ID/edge location code\n \n

\n\t\t\t\t\t

The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code \n\t\t\t\t\t\ttypically corresponds with the International Air Transport Association airport code for an airport near the edge location. \n\t\t\t\t\t\t(These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the \n\t\t\t\t\t\tRoute 53 Product Details page.

\n\t\t\t\t
\n
Queries That Are Logged
\n
\n

Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached \n\t\t\t\t\tthe response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return \n\t\t\t\t\tthe cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. \n\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, \n\t\t\t\t\tquery logs might contain information about only one query out of every several thousand queries that are submitted to DNS. \n\t\t\t\t\tFor more information about how DNS works, see \n\t\t\t\t\tRouting Internet Traffic to Your Website or Web Application\n\t\t\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t\t\t
\n
Log File Format
\n
\n

For a list of the values in each query log and the format of each value, see \n\t\t\t\t\tLogging DNS Queries in the \n\t\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t\t\t
\n
Pricing
\n
\n

For information about charges for query logs, see \n\t\t\t\t\tAmazon CloudWatch Pricing.

\n
\n
How to Stop Logging
\n
\n

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see \n\t\t\t\t\tDeleteQueryLoggingConfig.

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

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish \n\t\t\tlog data to an Amazon CloudWatch Logs log group.

\n\t\t

DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

\n\t\t
    \n
  • \n

    Route 53 edge location that responded to the DNS query

    \n
    • \n
  • \n

    Domain or subdomain that was requested

    \n
    • \n
  • \n

    DNS record type, such as A or AAAA

    \n
    • \n
  • \n

    DNS response code, such as NoError or ServFail\n

    \n
    • \n
\n\t\t\n\t\t
\n
Log Group and Resource Policy
\n
\n

Before you create a query logging configuration, perform the following operations.

\n\t\t\t\t\t \n

If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

\n \n\t\t\t\t\t
    \n
  1. \n

    Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a \n\t\t\t\t\t\t\tquery logging configuration. Note the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      You must create the log group in the us-east-1 region.

      \n
      • \n
    • \n

      You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to \n\t\t\t\t\t\t\t\t\tconfigure query logging for.

      \n
      • \n
    • \n

      When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

      \n\t\t\t\t\t\t\t\t\t

      \n /aws/route53/hosted zone name\n \n

      \n\t\t\t\t\t\t\t\t\t

      In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated \n\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so \n\t\t\t\t\t\t\t\t\t\twe recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create \n\t\t\t\t\t\t\t\t\t\tfor query logging.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    2. \n
  2. \n

    Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to \n\t\t\t\t\t\t\tsend query logs to log streams. For the value of Resource, specify the ARN for the log group that you created \n\t\t\t\t\t\t\tin the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, \n\t\t\t\t\t\t\treplace the hosted zone name with *, for example:

    \n\t\t\t\t\t\t\t

    \n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n

    \n\t\t\t\t\t\t\t \n

    You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, \n\t\t\t\t\t\t\t\tor the CLI.

    \n     \n\t\t\t\t\t\t
    3. \n
\n\t\t\t\t
\n
Log Streams and Edge Locations
\n
\n

When Route 53 finishes creating the configuration for DNS query logging, it does the following:

\n\t\t\t\t\t
    \n
  • \n

    Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the \n\t\t\t\t\t\t\tspecified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.

    \n
    • \n
  • \n

    Begins to send query logs to the applicable log stream.

    \n
    • \n
\n\t\t\t\t\t

The name of each log stream is in the following format:

\n\t\t\t\t\t

\n \n hosted zone ID/edge location code\n \n

\n\t\t\t\t\t

The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code \n\t\t\t\t\t\ttypically corresponds with the International Air Transport Association airport code for an airport near the edge location. \n\t\t\t\t\t\t(These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the \n\t\t\t\t\t\tRoute 53 Product Details page.

\n\t\t\t\t
\n
Queries That Are Logged
\n
\n

Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached \n\t\t\t\t\tthe response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return \n\t\t\t\t\tthe cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. \n\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, \n\t\t\t\t\tquery logs might contain information about only one query out of every several thousand queries that are submitted to DNS. \n\t\t\t\t\tFor more information about how DNS works, see \n\t\t\t\t\tRouting Internet Traffic to Your Website or Web Application\n\t\t\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t\t\t
\n
Log File Format
\n
\n

For a list of the values in each query log and the format of each value, see \n\t\t\t\t\tLogging DNS Queries in the \n\t\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t\t\t
\n
Pricing
\n
\n

For information about charges for query logs, see \n\t\t\t\t\tAmazon CloudWatch Pricing.

\n
\n
How to Stop Logging
\n
\n

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see \n\t\t\t\t\tDeleteQueryLoggingConfig.

\n\t\t\t\t
\n
", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/queryloggingconfig", @@ -1492,7 +1492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by \n\t\t\tthe same account.

\n\t\t

You can also create a reusable delegation set that uses the four name servers that are associated \n\t\t\twith an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.

\n\t\t \n\t\t\t

You can't associate a reusable delegation set with a private hosted zone.

\n\t\t \n\t\t

For information about using a reusable delegation set to configure white label name servers, see \n\t\t\tConfiguring White Label Name Servers.

\n\t\t\n\t\t

The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for \n\t\t\tconfiguring white label name servers. You need to perform the following steps:

\n\t\t
    \n
  1. \n

    Create a reusable delegation set.

    \n
    2. \n
  2. \n

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    \n
    3. \n
  3. \n

    Recreate resource record sets in the new hosted zones.

    \n
    4. \n
  4. \n

    Change the registrar's name servers to use the name servers for the new hosted zones.

    \n
    5. \n
  5. \n

    Monitor traffic for the website or application.

    \n
    6. \n
  6. \n

    Change TTLs back to their original values.

    \n
    7. \n
\n\t\t\n\t\t

If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use \n\t\t\tany of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more \n\t\t\tname servers that are assigned to the reusable delegation set, you can do one of the following:

\n\t\t
    \n
  • \n

    For small numbers of hosted zones—up to a few hundred—it's relatively easy to create \n\t\t\t\treusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers \n\t\t\t\tin your hosted zones.

    \n
    • \n
  • \n

    For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.

    \n
    • \n
  • \n

    For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers \n\t\t\t\tto hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the \n\t\t\t\treusable delegation set.

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

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by \n\t\t\tthe same Amazon Web Services account.

\n\t\t

You can also create a reusable delegation set that uses the four name servers that are associated \n\t\t\twith an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.

\n\t\t \n\t\t\t

You can't associate a reusable delegation set with a private hosted zone.

\n\t\t \n\t\t

For information about using a reusable delegation set to configure white label name servers, see \n\t\t\tConfiguring White Label Name Servers.

\n\t\t\n\t\t

The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for \n\t\t\tconfiguring white label name servers. You need to perform the following steps:

\n\t\t
    \n
  1. \n

    Create a reusable delegation set.

    \n
    2. \n
  2. \n

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    \n
    3. \n
  3. \n

    Recreate resource record sets in the new hosted zones.

    \n
    4. \n
  4. \n

    Change the registrar's name servers to use the name servers for the new hosted zones.

    \n
    5. \n
  5. \n

    Monitor traffic for the website or application.

    \n
    6. \n
  6. \n

    Change TTLs back to their original values.

    \n
    7. \n
\n\t\t\n\t\t

If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use \n\t\t\tany of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more \n\t\t\tname servers that are assigned to the reusable delegation set, you can do one of the following:

\n\t\t
    \n
  • \n

    For small numbers of hosted zones—up to a few hundred—it's relatively easy to create \n\t\t\t\treusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers \n\t\t\t\tin your hosted zones.

    \n
    • \n
  • \n

    For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.

    \n
    • \n
  • \n

    For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers \n\t\t\t\tto hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the \n\t\t\t\treusable delegation set.

    \n
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/delegationset", @@ -1832,7 +1832,7 @@ } ], "traits": { - "smithy.api#documentation": "

Authorizes the account that created a specified VPC to submit an AssociateVPCWithHostedZone \n\t\t\trequest to associate the VPC with a specified hosted zone that was created by a different account. \n\t\t\tTo submit a CreateVPCAssociationAuthorization request, you must use the account that created the \n\t\t\thosted zone. After you authorize the association, use the account that created the VPC to submit an \n\t\t\tAssociateVPCWithHostedZone request.

\n\t\t \n

If you want to associate multiple VPCs that you created by using one account with a hosted zone \n\t\t\tthat you created by using a different account, you must submit one authorization request for each VPC.

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

Authorizes the Amazon Web Services account that created a specified VPC to submit an AssociateVPCWithHostedZone \n\t\t\trequest to associate the VPC with a specified hosted zone that was created by a different account. \n\t\t\tTo submit a CreateVPCAssociationAuthorization request, you must use the account that created the \n\t\t\thosted zone. After you authorize the association, use the account that created the VPC to submit an \n\t\t\tAssociateVPCWithHostedZone request.

\n\t\t \n

If you want to associate multiple VPCs that you created by using one account with a hosted zone \n\t\t\tthat you created by using a different account, you must submit one authorization request for each VPC.

\n ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", @@ -2204,7 +2204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a hosted zone.

\n\t\t\n\t\t

If the hosted zone was created by another service, such as Cloud Map, see \n\t\t\tDeleting \n\t\t\tPublic Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. \n\t\t\t(The process is the same for public and private hosted zones that were created by another service.)

\n\t\t\n\t\t

If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, \n\t\t\twe recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.

\n\t\t\n\t\t \n\t\t\t

If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your \n\t\t\t\tdomain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone \n\t\t\t\tand you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, \n\t\t\t\tsomeone could hijack the domain and route traffic to their own resources using your domain name.

\n\t\t \n\t\t\n\t\t

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. \n\t\t\tWhen you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, \n\t\t\tsee UpdateDomainNameservers\n\t\t\tfor information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with \n\t\t\tanother registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, \n\t\t\tperform an internet search on \"free DNS service.\"

\n\n\t\t

You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. \n\t\t\tIf the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. \n\t\t\tIf you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a \n\t\t\tHostedZoneNotEmpty error. For information about deleting records from your hosted zone, see \n\t\t\tChangeResourceRecordSets.

\n\t\t

To verify that the hosted zone has been deleted, do one of the following:

\n\t\t
    \n
  • \n

    Use the GetHostedZone action to request information about the hosted zone.

    \n
    • \n
  • \n

    Use the ListHostedZones action to get a list of the hosted zones associated with the current \n\t\t\t\taccount.

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

Deletes a hosted zone.

\n\t\t\n\t\t

If the hosted zone was created by another service, such as Cloud Map, see \n\t\t\tDeleting \n\t\t\tPublic Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. \n\t\t\t(The process is the same for public and private hosted zones that were created by another service.)

\n\t\t\n\t\t

If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, \n\t\t\twe recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.

\n\t\t\n\t\t \n\t\t\t

If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your \n\t\t\t\tdomain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone \n\t\t\t\tand you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, \n\t\t\t\tsomeone could hijack the domain and route traffic to their own resources using your domain name.

\n\t\t \n\t\t\n\t\t

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. \n\t\t\tWhen you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, \n\t\t\tsee UpdateDomainNameservers\n\t\t\tfor information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with \n\t\t\tanother registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, \n\t\t\tperform an internet search on \"free DNS service.\"

\n\n\t\t

You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. \n\t\t\tIf the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. \n\t\t\tIf you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a \n\t\t\tHostedZoneNotEmpty error. For information about deleting records from your hosted zone, see \n\t\t\tChangeResourceRecordSets.

\n\t\t

To verify that the hosted zone has been deleted, do one of the following:

\n\t\t
    \n
  • \n

    Use the GetHostedZone action to request information about the hosted zone.

    \n
    • \n
  • \n

    Use the ListHostedZones action to get a list of the hosted zones associated with the current \n\t\t\t\tAmazon Web Services account.

    \n
    • \n
", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/hostedzone/{Id}", @@ -2550,7 +2550,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC \n\t\t\twith a hosted zone that was created by a different account. You must use the account that created the hosted zone \n\t\t\tto submit a DeleteVPCAssociationAuthorization request.

\n\t\t \n\t\t\t

Sending this request only prevents the account that created the VPC from associating the VPC \n\t\t\t\twith the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, \n\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. \n\t\t\t\tIf you want to delete an existing association, use DisassociateVPCFromHostedZone.

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

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC \n\t\t\twith a hosted zone that was created by a different account. You must use the account that created the hosted zone \n\t\t\tto submit a DeleteVPCAssociationAuthorization request.

\n\t\t \n\t\t\t

Sending this request only prevents the Amazon Web Services account that created the VPC from associating the VPC \n\t\t\t\twith the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, \n\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. \n\t\t\t\tIf you want to delete an existing association, use DisassociateVPCFromHostedZone.

\n\t\t ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/deauthorizevpcassociation", @@ -2564,7 +2564,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one account with a hosted zone \n\t\t\tthat was created with a different account, the ID of the hosted zone.

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

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone \n\t\t\tthat was created with a different Amazon Web Services account, the ID of the hosted zone.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2572,13 +2572,13 @@ "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { - "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one account with a hosted zone \n\t\t\tthat was created with a different account, a complex type that includes the ID and region of the VPC.

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

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone \n\t\t\tthat was created with a different Amazon Web Services account, a complex type that includes the ID and region of the VPC.

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

A complex type that contains information about the request to remove authorization to associate a VPC \n\t\t\tthat was created by one account with a hosted zone that was created with a different account.

" + "smithy.api#documentation": "

A complex type that contains information about the request to remove authorization to associate a VPC \n\t\t\tthat was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account.

" } }, "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse": { @@ -3051,7 +3051,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the specified limit for the current account, for example, the maximum number of health checks that you \n\t\t\tcan create using the account.

\n\t\t

For the default limit, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide. To request a higher limit, \n\t\t\topen a case.

\n\t\t \n

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Management Console and open the Trusted Advisor console at \n\t\t\thttps://console.aws.amazon.com/trustedadvisor/. Then choose \n\t\t\tService limits in the navigation pane.

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

Gets the specified limit for the current account, for example, the maximum number of health checks that you \n\t\t\tcan create using the account.

\n\t\t

For the default limit, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide. To request a higher limit, \n\t\t\topen a case.

\n\t\t \n

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services Management Console and open the Trusted Advisor console at \n\t\t\thttps://console.aws.amazon.com/trustedadvisor/. Then choose \n\t\t\tService limits in the navigation pane.

\n\t\t ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/accountlimit/{Type}", @@ -3375,7 +3375,7 @@ "target": "com.amazonaws.route53#GetHealthCheckCountResponse" }, "traits": { - "smithy.api#documentation": "

Retrieves the number of health checks that are associated with the current account.

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

Retrieves the number of health checks that are associated with the current Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/healthcheckcount", @@ -3387,7 +3387,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

A request for the number of health checks that are associated with the current account.

" + "smithy.api#documentation": "

A request for the number of health checks that are associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#GetHealthCheckCountResponse": { @@ -3396,7 +3396,7 @@ "HealthCheckCount": { "target": "com.amazonaws.route53#HealthCheckCount", "traits": { - "smithy.api#documentation": "

The number of health checks associated with the current account.

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

The number of health checks associated with the current Amazon Web Services account.

", "smithy.api#required": {} } } @@ -3483,7 +3483,7 @@ "HealthCheck": { "target": "com.amazonaws.route53#HealthCheck", "traits": { - "smithy.api#documentation": "

A complex type that contains information about one health check that is associated with\n\t\t\tthe current account.

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

A complex type that contains information about one health check that is associated with\n\t\t\tthe current Amazon Web Services account.

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

Retrieves the number of hosted zones that are associated with the current account.

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

Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzonecount", @@ -3599,7 +3599,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

A request to retrieve a count of all the hosted zones that are associated with the current account.

" + "smithy.api#documentation": "

A request to retrieve a count of all the hosted zones that are associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#GetHostedZoneCountResponse": { @@ -3608,7 +3608,7 @@ "HostedZoneCount": { "target": "com.amazonaws.route53#HostedZoneCount", "traits": { - "smithy.api#documentation": "

The total number of public and private hosted zones that are associated with the current account.

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

The total number of public and private hosted zones that are associated with the current Amazon Web Services account.

", "smithy.api#required": {} } } @@ -3973,7 +3973,7 @@ "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse" }, "traits": { - "smithy.api#documentation": "

Gets the number of traffic policy instances that are associated with the current account.

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

Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstancecount", @@ -3985,7 +3985,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Request to get the number of traffic policy instances that are associated with the current account.

" + "smithy.api#documentation": "

Request to get the number of traffic policy instances that are associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse": { @@ -3994,7 +3994,7 @@ "TrafficPolicyInstanceCount": { "target": "com.amazonaws.route53#TrafficPolicyInstanceCount", "traits": { - "smithy.api#documentation": "

The number of traffic policy instances that are associated with the current account.

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

The number of traffic policy instances that are associated with the current Amazon Web Services account.

", "smithy.api#required": {} } } @@ -4168,7 +4168,7 @@ "FullyQualifiedDomainName": { "target": "com.amazonaws.route53#FullyQualifiedDomainName", "traits": { - "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

\n\t\t\n\t\t

\n If you specify a value for \n IPAddress:

\n\t\t

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName \n\t\t\tin the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint \n\t\t\ton which you want Route 53 to perform health checks.

\n\t\t

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify another value for Port and any value except TCP for Type, Route 53 passes \n\t\t\t\t\tFullyQualifiedDomainName:Port to the endpoint in the Host header.

    \n\t\t\t
    • \n
\n\t\t

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the \n\t\t\tHost header in each of the preceding cases.

\n\t\t\n\t\t

\n If you don't specify a value for IPAddress\n :

\n\t\t

Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for \n\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

\n\t\t \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's \n\t\t\tno resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \n\t\t\t\"DNS resolution failed\" error.

\n \n\t\t

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by \n\t\t\tFullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a \n\t\t\thealth check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, \n\t\t\tspecify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

\n\t\t \n\t\t\t

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the \n\t\t\t\tresource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

\n\t\t \n\t\t

In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or \n\t\t\tHTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you \n\t\t\tspecify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

" + "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

\n\t\t\n\t\t

\n If you specify a value for \n IPAddress:

\n\t\t

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName \n\t\t\tin the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint \n\t\t\ton which you want Route 53 to perform health checks.

\n\t\t

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify another value for Port and any value except TCP for Type, Route 53 passes \n\t\t\t\t\tFullyQualifiedDomainName:Port to the endpoint in the Host header.

    \n\t\t\t
    • \n
\n\t\t

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the \n\t\t\tHost header in each of the preceding cases.

\n\t\t\n\t\t

\n If you don't specify a value for \n IPAddress:

\n\t\t

Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for \n\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

\n\t\t \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's \n\t\t\tno resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \n\t\t\t\"DNS resolution failed\" error.

\n \n\t\t

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by \n\t\t\tFullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a \n\t\t\thealth check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, \n\t\t\tspecify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

\n\t\t \n\t\t\t

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the \n\t\t\t\tresource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

\n\t\t \n\t\t

In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or \n\t\t\tHTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you \n\t\t\tspecify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

" } }, "SearchString": { @@ -4246,7 +4246,7 @@ "RoutingControlArn": { "target": "com.amazonaws.route53#RoutingControlArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Route53 Application Recovery Controller routing control.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

\n\t\t

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

" } } }, @@ -4646,7 +4646,7 @@ "OwningAccount": { "target": "com.amazonaws.route53#AWSAccountID", "traits": { - "smithy.api#documentation": "

If the hosted zone was created by an account, or was created by an Amazon Web Services service that creates hosted zones using the current account, \n\t\t\tOwningAccount contains the account ID of that account. For example, when you use Cloud Map to create a hosted zone, Cloud Map \n\t\t\tcreates the hosted zone using the current account.

" + "smithy.api#documentation": "

If the hosted zone was created by an Amazon Web Services account, or was created by an Amazon Web Services service that creates hosted zones using the current account, \n\t\t\tOwningAccount contains the account ID of that account. For example, when you use Cloud Map to create a hosted zone, Cloud Map \n\t\t\tcreates the hosted zone using the current Amazon Web Services account.

" } }, "OwningService": { @@ -4716,7 +4716,7 @@ "Owner": { "target": "com.amazonaws.route53#HostedZoneOwner", "traits": { - "smithy.api#documentation": "

The owner of a private hosted zone that the specified VPC is associated with. The owner can be either an account or \n\t\t\tan Amazon Web Services service.

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

The owner of a private hosted zone that the specified VPC is associated with. The owner can be either an Amazon Web Services account or \n\t\t\tan Amazon Web Services service.

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

Retrieve a list of the health checks that are associated with the current account.

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

Retrieve a list of the health checks that are associated with the current Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/healthcheck", @@ -5335,7 +5335,7 @@ } }, "traits": { - "smithy.api#documentation": "

A request to retrieve a list of the health checks that are associated with the current account.

" + "smithy.api#documentation": "

A request to retrieve a list of the health checks that are associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListHealthChecksResponse": { @@ -5344,7 +5344,7 @@ "HealthChecks": { "target": "com.amazonaws.route53#HealthChecks", "traits": { - "smithy.api#documentation": "

A complex type that contains one HealthCheck element for each health check that is associated with the current \n\t\t\taccount.

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

A complex type that contains one HealthCheck element for each health check that is associated with the current \n\t\t\tAmazon Web Services account.

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

Retrieves a list of the public and private hosted zones that are associated with the current account. The response \n\t\t\tincludes a HostedZones child element for each hosted zone.

\n\t\t

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the \n\t\t\tmaxitems parameter to list them in groups of up to 100.

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

Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response \n\t\t\tincludes a HostedZones child element for each hosted zone.

\n\t\t

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the \n\t\t\tmaxitems parameter to list them in groups of up to 100.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzone", @@ -5431,7 +5431,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element \n\t\t\tfor each hosted zone created by the current account.

\n\t\t

\n ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

\n\n\t\t

\n com.example.www.\n

\n\n\t\t

Note the trailing dot, which can change the sort order in some circumstances.

\n\t\t

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name \n\t\t\tusing the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone \n\t\t\tfor exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

\n\n\t\t

\n com.ex\\344mple.\n

\n\t\t\n\t\t

The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, \n\t\t\tincluding internationalized domain names, see DNS Domain Name Format in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list \n\t\t\tthem in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

\n\t\t
    \n
  • \n\t\t\t\t

    The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the \n\t\t\t\t\tdnsname and hostedzoneid parameters in the request that produced the current response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The MaxItems element in the response contains the value, if any, that you specified for the maxitems \n\t\t\t\t\tparameter in the request that produced the current response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If the value of IsTruncated in the response is true, there are more hosted zones associated with the \n\t\t\t\t\tcurrent account.

    \n\t\t\t\t

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. \n\t\t\t\t\tThe NextDNSName element and NextHostedZoneId elements are omitted from the response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the \n\t\t\t\t\thosted zone ID of the next hosted zone that is associated with the current account. If you want to list more hosted zones, \n\t\t\t\t\tmake another call to ListHostedZonesByName, and specify the value of NextDNSName and \n\t\t\t\t\tNextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

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

Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element \n\t\t\tfor each hosted zone created by the current Amazon Web Services account.

\n\t\t

\n ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

\n\n\t\t

\n com.example.www.\n

\n\n\t\t

Note the trailing dot, which can change the sort order in some circumstances.

\n\t\t

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name \n\t\t\tusing the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone \n\t\t\tfor exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

\n\n\t\t

\n com.ex\\344mple.\n

\n\t\t\n\t\t

The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, \n\t\t\tincluding internationalized domain names, see DNS Domain Name Format in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list \n\t\t\tthem in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

\n\t\t
    \n
  • \n\t\t\t\t

    The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the \n\t\t\t\t\tdnsname and hostedzoneid parameters in the request that produced the current response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The MaxItems element in the response contains the value, if any, that you specified for the maxitems \n\t\t\t\t\tparameter in the request that produced the current response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If the value of IsTruncated in the response is true, there are more hosted zones associated with the \n\t\t\t\t\tcurrent Amazon Web Services account.

    \n\t\t\t\t

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. \n\t\t\t\t\tThe NextDNSName element and NextHostedZoneId elements are omitted from the response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the \n\t\t\t\t\thosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, \n\t\t\t\t\tmake another call to ListHostedZonesByName, and specify the value of NextDNSName and \n\t\t\t\t\tNextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

    \n\t\t\t
    • \n
", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzonesbyname", @@ -5445,7 +5445,7 @@ "DNSName": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to \n\t\t\tspecify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of \n\t\t\tthe hosted zones that were created by the current account, in ASCII order. For subsequent requests, include both dnsname and \n\t\t\thostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

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

(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to \n\t\t\tspecify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of \n\t\t\tthe hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and \n\t\t\thostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

", "smithy.api#httpQuery": "dnsname" } }, @@ -5465,7 +5465,7 @@ } }, "traits": { - "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the current account in ASCII order by domain \n\t\t\tname.

" + "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account in ASCII order by domain \n\t\t\tname.

" } }, "com.amazonaws.route53#ListHostedZonesByNameResponse": { @@ -5538,7 +5538,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless of which account or Amazon Web Services service owns the \n\t\t\thosted zones. The HostedZoneOwner structure in the response contains one of the following values:

\n\t\t
    \n
  • \n

    An OwningAccount element, which contains the account number of either the current account or \n\t\t\t\tanother account. Some services, such as Cloud Map, create hosted zones using the current account.

    \n\t\t\t
    • \n
  • \n

    An OwningService element, which identifies the Amazon Web Services service that created and owns the hosted zone. \n\t\t\t\tFor example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of Owner is \n\t\t\t\tefs.amazonaws.com.

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

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the \n\t\t\thosted zones. The HostedZoneOwner structure in the response contains one of the following values:

\n\t\t
    \n
  • \n

    An OwningAccount element, which contains the account number of either the current Amazon Web Services account or \n\t\t\t\tanother Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account.

    \n\t\t\t
    • \n
  • \n

    An OwningService element, which identifies the Amazon Web Services service that created and owns the hosted zone. \n\t\t\t\tFor example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of Owner is \n\t\t\t\tefs.amazonaws.com.

    \n\t\t\t
    • \n
", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzonesbyvpc", @@ -5581,7 +5581,7 @@ } }, "traits": { - "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless of which account created the hosted zones.

" + "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account created the hosted zones.

" } }, "com.amazonaws.route53#ListHostedZonesByVPCResponse": { @@ -5635,7 +5635,7 @@ } }, "traits": { - "smithy.api#documentation": "

A request to retrieve a list of the public and private hosted zones that are associated with the current account.

" + "smithy.api#documentation": "

A request to retrieve a list of the public and private hosted zones that are associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListHostedZonesResponse": { @@ -5697,7 +5697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the configurations for DNS query logging that are associated with the current account or the configuration \n\t\t\tthat is associated with a specified hosted zone.

\n\n\t\t

For more information about DNS query logs, see \n\t\t\tCreateQueryLoggingConfig. \n\t\t\tAdditional information, including the format of DNS query logs, appears in \n\t\t\tLogging DNS Queries \n\t\t\tin the Amazon Route 53 Developer Guide.

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

Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration \n\t\t\tthat is associated with a specified hosted zone.

\n\n\t\t

For more information about DNS query logs, see \n\t\t\tCreateQueryLoggingConfig. \n\t\t\tAdditional information, including the format of DNS query logs, appears in \n\t\t\tLogging DNS Queries \n\t\t\tin the Amazon Route 53 Developer Guide.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/queryloggingconfig", @@ -5717,21 +5717,21 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in \n\t\t\tHostedZoneId.

\n\t\t

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations \n\t\t\tthat are associated with the current account.

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

(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in \n\t\t\tHostedZoneId.

\n\t\t

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations \n\t\t\tthat are associated with the current Amazon Web Services account.

", "smithy.api#httpQuery": "hostedzoneid" } }, "NextToken": { "target": "com.amazonaws.route53#PaginationToken", "traits": { - "smithy.api#documentation": "

(Optional) If the current account has more than MaxResults query logging configurations, use NextToken \n\t\t\tto get the second and subsequent pages of results.

\n\t\t

For the first ListQueryLoggingConfigs request, omit this value.

\n\t\t

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value \n\t\t\tfor NextToken in the request.

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

(Optional) If the current Amazon Web Services account has more than MaxResults query logging configurations, use NextToken \n\t\t\tto get the second and subsequent pages of results.

\n\t\t

For the first ListQueryLoggingConfigs request, omit this value.

\n\t\t

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value \n\t\t\tfor NextToken in the request.

", "smithy.api#httpQuery": "nexttoken" } }, "MaxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. \n\t\t\tIf the current account has more than MaxResults configurations, use the value of \n\t\t\tNextToken \n\t\t\tin the response to get the next page of results.

\n\t\t

If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.

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

(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. \n\t\t\tIf the current Amazon Web Services account has more than MaxResults configurations, use the value of \n\t\t\tNextToken \n\t\t\tin the response to get the next page of results.

\n\t\t

If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.

", "smithy.api#httpQuery": "maxresults" } } @@ -5743,14 +5743,14 @@ "QueryLoggingConfigs": { "target": "com.amazonaws.route53#QueryLoggingConfigs", "traits": { - "smithy.api#documentation": "

An array that contains one \n\t\t\tQueryLoggingConfig element \n\t\t\tfor each configuration for DNS query logging that is associated with the current account.

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

An array that contains one \n\t\t\tQueryLoggingConfig element \n\t\t\tfor each configuration for DNS query logging that is associated with the current Amazon Web Services account.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.route53#PaginationToken", "traits": { - "smithy.api#documentation": "

If a response includes the last of the query logging configurations that are associated with the current account, \n\t\t\tNextToken doesn't appear in the response.

\n\t\t

If a response doesn't include the last of the configurations, you can get more configurations by submitting another \n\t\t\tListQueryLoggingConfigs \n\t\t\trequest. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in \n\t\t\tNextToken in the next request.

" + "smithy.api#documentation": "

If a response includes the last of the query logging configurations that are associated with the current Amazon Web Services account, \n\t\t\tNextToken doesn't appear in the response.

\n\t\t

If a response doesn't include the last of the configurations, you can get more configurations by submitting another \n\t\t\tListQueryLoggingConfigs \n\t\t\trequest. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in \n\t\t\tNextToken in the next request.

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

Retrieves a list of the reusable delegation sets that are associated with the current account.

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

Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/delegationset", @@ -5912,7 +5912,7 @@ } }, "traits": { - "smithy.api#documentation": "

A request to get a list of the reusable delegation sets that are associated with the current account.

" + "smithy.api#documentation": "

A request to get a list of the reusable delegation sets that are associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListReusableDelegationSetsResponse": { @@ -5921,7 +5921,7 @@ "DelegationSets": { "target": "com.amazonaws.route53#DelegationSets", "traits": { - "smithy.api#documentation": "

A complex type that contains one DelegationSet element for each reusable delegation set that was created \n\t\t\tby the current account.

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

A complex type that contains one DelegationSet element for each reusable delegation set that was created \n\t\t\tby the current Amazon Web Services account.

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

A complex type that contains information about the reusable delegation sets that are associated with the current account.

" + "smithy.api#documentation": "

A complex type that contains information about the reusable delegation sets that are associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListTagsForResource": { @@ -6116,7 +6116,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the latest version for every traffic policy that is associated with the current account. \n\t\t\tPolicies are listed in the order that they were created in.

\n\t\t\n\t\t

For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see \n\t\t\tDeleteTrafficPolicy.\n\n\t\t

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

Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. \n\t\t\tPolicies are listed in the order that they were created in.

\n\t\t\n\t\t

For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see \n\t\t\tDeleteTrafficPolicy.\n\n\t\t

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicies", @@ -6143,7 +6143,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the information about the request to list the traffic policies that are associated \n\t\t\twith the current account.

" + "smithy.api#documentation": "

A complex type that contains the information about the request to list the traffic policies that are associated \n\t\t\twith the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListTrafficPoliciesResponse": { @@ -6152,7 +6152,7 @@ "TrafficPolicySummaries": { "target": "com.amazonaws.route53#TrafficPolicySummaries", "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current account.

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

A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account.

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

Gets information about the traffic policy instances that you created by using the current account.

\n\t\t \n\t\t\t

After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the \n\t\t\t\tresource record sets that are specified in the traffic policy definition. For more information, see the State response element.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the \n\t\t\tMaxItems parameter to list them in groups of up to 100.

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

Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.

\n\t\t \n\t\t\t

After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the \n\t\t\t\tresource record sets that are specified in the traffic policy definition. For more information, see the State response element.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the \n\t\t\tMaxItems parameter to list them in groups of up to 100.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstances", @@ -6473,7 +6473,7 @@ } }, "traits": { - "smithy.api#documentation": "

A request to get information about the traffic policy instances that you created by using the current account.

" + "smithy.api#documentation": "

A request to get information about the traffic policy instances that you created by using the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListTrafficPolicyInstancesResponse": { @@ -7967,7 +7967,7 @@ } }, "traits": { - "smithy.api#documentation": "

This health check can't be created because the current account has reached the limit on the number of active health checks.

\n\t\t

For information about default limits, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

For information about how to get the current limit for an account, see \n\t\t\tGetAccountLimit. To request a \n\t\t\thigher limit, create a case with the Amazon Web Services Support Center.

\n\n\t\t

You have reached the maximum number of active health checks for an account. To request a higher limit, \n\t\t\tcreate a case with the Amazon Web Services Support Center.

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

This health check can't be created because the current account has reached the limit on the number of active health checks.

\n\t\t

For information about default limits, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

For information about how to get the current limit for an account, see \n\t\t\tGetAccountLimit. To request a \n\t\t\thigher limit, create a case with the Amazon Web Services Support Center.

\n\n\t\t

You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, \n\t\t\tcreate a case with the Amazon Web Services Support Center.

", "smithy.api#error": "client" } }, @@ -8346,13 +8346,13 @@ "TrafficPolicyCount": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

The number of traffic policies that are associated with the current account.

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

The number of traffic policies that are associated with the current Amazon Web Services account.

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

A complex type that contains information about the latest version of one traffic policy \n\t\t\tthat is associated with the current account.

" + "smithy.api#documentation": "

A complex type that contains information about the latest version of one traffic policy \n\t\t\tthat is associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#TrafficPolicyVersion": { diff --git a/aws/sdk/aws-models/route53resolver.json b/aws/sdk/aws-models/route53resolver.json index 1c949c26c5..c7ef154270 100644 --- a/aws/sdk/aws-models/route53resolver.json +++ b/aws/sdk/aws-models/route53resolver.json @@ -825,7 +825,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. \n\t\t\tResolver can log queries only for VPCs that are in the same Region as the query logging configuration.

\n\t\t\n\t\t

To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see \n\t\t\tAssociateResolverQueryLogConfig.

\n\t\t\n\t\t

You can optionally use AWS Resource Access Manager (AWS RAM) to share a query logging configuration with other AWS accounts. The other accounts \n\t\t\tcan then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all \n\t\t\tVPCs that are associated with the configuration.

" + "smithy.api#documentation": "

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. \n\t\t\tResolver can log queries only for VPCs that are in the same Region as the query logging configuration.

\n\t\t\n\t\t

To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see \n\t\t\tAssociateResolverQueryLogConfig.

\n\t\t\n\t\t

You can optionally use Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services accounts. The other accounts \n\t\t\tcan then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all \n\t\t\tVPCs that are associated with the configuration.

" } }, "com.amazonaws.route53resolver#CreateResolverQueryLogConfigRequest": { @@ -1224,7 +1224,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are \n\t\t\tassociated with the configuration. This also applies if the query logging configuration is shared with other AWS accounts, and \n\t\t\tthe other accounts have associated VPCs with the shared configuration.

\n\t\t\n\t\t

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See \n\t\t\tDisassociateResolverQueryLogConfig.

\n\t\t\t\n\t\t

If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing \n\t\t\tthe configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs \n\t\t\tthat they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically \n\t\t\tdisassociated from the configuration.

" + "smithy.api#documentation": "

Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are \n\t\t\tassociated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and \n\t\t\tthe other accounts have associated VPCs with the shared configuration.

\n\t\t\n\t\t

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See \n\t\t\tDisassociateResolverQueryLogConfig.

\n\t\t\t\n\t\t

If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing \n\t\t\tthe configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs \n\t\t\tthat they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically \n\t\t\tdisassociated from the configuration.

" } }, "com.amazonaws.route53resolver#DeleteResolverQueryLogConfigRequest": { @@ -1457,7 +1457,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a VPC from a query logging configuration.

\n\t\t\n\t\t \n\t\t\t

Before you can delete a query logging configuration, you must first disassociate all VPCs\n\t\t\t\tfrom the configuration. If you used AWS Resource Access Manager (AWS RAM) to share a\n\t\t\t\tquery logging configuration with other accounts, VPCs can be disassociated from the\n\t\t\t\tconfiguration in the following ways:

\n\t\t\t
    \n
  • \n

    The accounts that you shared the configuration with can disassociate VPCs from the configuration.

    \n
    • \n
  • \n

    You can stop sharing the configuration.

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

Disassociates a VPC from a query logging configuration.

\n\t\t\n\t\t \n\t\t\t

Before you can delete a query logging configuration, you must first disassociate all VPCs\n\t\t\t\tfrom the configuration. If you used Resource Access Manager (RAM) to share a\n\t\t\t\tquery logging configuration with other accounts, VPCs can be disassociated from the\n\t\t\t\tconfiguration in the following ways:

\n\t\t\t
    \n
  • \n

    The accounts that you shared the configuration with can disassociate VPCs from the configuration.

    \n
    • \n
  • \n

    You can stop sharing the configuration.

    \n
    • \n
\n\t\t " } }, "com.amazonaws.route53resolver#DisassociateResolverQueryLogConfigRequest": { @@ -1573,7 +1573,7 @@ "Name": { "target": "com.amazonaws.route53resolver#FilterName", "traits": { - "smithy.api#documentation": "

The name of the parameter that you want to use to filter objects.

\n\t\t

The valid values for Name depend on the action that you're including the filter in, \n\t\t\tListResolverEndpoints, \n\t\t\tListResolverRules, \n\t\t\tListResolverRuleAssociations, \n\t\t\tListResolverQueryLogConfigs,\n\t\t\tor \n\t\t\tListResolverQueryLogConfigAssociations.

\n\t\t\n\t\t \n\t\t\t

In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, \n\t\t\t\tCreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.

\n\t\t \n\t\t\n\t\t

\n ListResolverEndpoints\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n CreatorRequestId: The value that you specified when you created the Resolver endpoint.

    \n
    • \n
  • \n

    \n Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION \n\t\t\t\tfor Name, specify INBOUND or OUTBOUND for Values.

    \n
    • \n
  • \n

    \n HostVpcId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or \n\t\t\t\tthe VPC that outbound queries pass through on the way from your VPCs to your network. In a \n\t\t\t\tCreateResolverEndpoint\n\t\t\t\trequest, SubnetId indirectly identifies the VPC. In a \n\t\t\t\tGetResolverEndpoint\n\t\t\t\trequest, the VPC ID for a Resolver endpoint \n\t\t\t\tis returned in the HostVPCId element.

    \n
    • \n
  • \n

    \n IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.

    \n
    • \n
  • \n

    \n Name: The name of the Resolver endpoint.

    \n
    • \n
  • \n

    \n SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the \n\t\t\t\tResolver endpoint.

    \n
    • \n
  • \n

    \n Status: The status of the Resolver endpoint. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING,\n\t\t\t\tAUTO_RECOVERING, ACTION_NEEDED, or DELETING. For more information, see Status in\n\t\t\t\tResolverEndpoint.

    \n
    • \n
\n\t\t\n\t\t

\n ListResolverRules\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n CreatorRequestId: The value that you specified when you created the Resolver rule.

    \n
    • \n
  • \n

    \n DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the value that \n\t\t\t\tyou specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, \n\t\t\t\tspecify the following value. Note the \".\" after com:

    \n\t\t\t\t

    \n example.com.\n

    \n\t\t\t
    • \n
  • \n

    \n Name: The name of the Resolver rule.

    \n
    • \n
  • \n

    \n ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.

    \n\t\t\t\t \n

    You can filter on the Resolver endpoint only for rules that have a value of FORWARD for \n\t\t\t\t\tRuleType.

    \n     \n\t\t\t
    • \n
  • \n

    \n Status: The status of the Resolver rule. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: COMPLETE, DELETING, UPDATING, \n\t\t\t\tor FAILED.

    \n
    • \n
  • \n

    \n Type: The type of the Resolver rule. If you specify TYPE \n\t\t\t\tfor Name, specify FORWARD or SYSTEM for Values.

    \n
    • \n
\n\t\t\n\t\t

\n ListResolverRuleAssociations\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n Name: The name of the Resolver rule association.

    \n
    • \n
  • \n

    \n ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.

    \n
    • \n
  • \n

    \n Status: The status of the Resolver rule association. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: CREATING, COMPLETE, DELETING, or \n\t\t\t\tFAILED.

    \n\t\t\t
    • \n
  • \n

    \n VPCId: The ID of the VPC that the Resolver rule is associated with.

    \n
    • \n
\n\n\t\t

\n ListResolverQueryLogConfigs\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n Arn: The ARN for the query logging configuration.

    \n
    • \n
  • \n

    \n AssociationCount: The number of VPCs that are associated with the query logging configuration.

    \n
    • \n
  • \n

    \n CreationTime: The date and time that the query logging configuration was created, in Unix time format and \n\t\t\t\tCoordinated Universal Time (UTC).

    \n
    • \n
  • \n

    \n CreatorRequestId: A unique string that identifies the request that created the query logging configuration.

    \n
    • \n
  • \n

    \n Destination: The AWS service that you want to forward query logs to. Valid values include the following:

    \n\t\t\t\t
      \n
    • \n

      \n S3\n

      \n
      • \n
    • \n

      \n CloudWatchLogs\n

      \n
      • \n
    • \n

      \n KinesisFirehose\n

      \n
      • \n
    \n\t\t\t
    • \n
  • \n

    \n DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an \n\t\t\t\tS3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.

    \n
    • \n
  • \n

    \n Id: The ID of the query logging configuration

    \n
    • \n
  • \n

    \n Name: The name of the query logging configuration

    \n
    • \n
  • \n

    \n OwnerId: The AWS account ID for the account that created the query logging configuration.

    \n
    • \n
  • \n

    \n ShareStatus: An indication of whether the query logging configuration is shared with other AWS accounts, \n\t\t\t\tor was shared with the current account by another AWS account. Valid values include: NOT_SHARED, SHARED_WITH_ME, \n\t\t\t\tor SHARED_BY_ME.

    \n
    • \n
  • \n

    \n Status: The status of the query logging configuration. If you specify Status for Name, \n\t\t\t\tspecify the applicable status code for Values: CREATING, CREATED, \n\t\t\t\tDELETING, or FAILED. For more information, see \n\t\t\t\tStatus.\n\t\t\t\t

    \n\t\t\t
    • \n
\n\t\t\n\t\t

\n ListResolverQueryLogConfigAssociations\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n CreationTime: The date and time that the VPC was associated with the query logging configuration, in Unix time format and \n\t\t\t\tCoordinated Universal Time (UTC).

    \n
    • \n
  • \n

    \n Error: If the value of Status is FAILED, specify the cause: \n\t\t\t\tDESTINATION_NOT_FOUND or ACCESS_DENIED.

    \n
    • \n
  • \n

    \n Id: The ID of the query logging association.

    \n
    • \n
  • \n

    \n ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.

    \n
    • \n
  • \n

    \n ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.

    \n
    • \n
  • \n

    \n Status: The status of the query logging association. If you specify Status for Name, \n\t\t\t\tspecify the applicable status code for Values: CREATING, CREATED, \n\t\t\t\tDELETING, or FAILED. For more information, see \n\t\t\t Status.\n\t\t\t\t

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

The name of the parameter that you want to use to filter objects.

\n\t\t

The valid values for Name depend on the action that you're including the filter in, \n\t\t\tListResolverEndpoints, \n\t\t\tListResolverRules, \n\t\t\tListResolverRuleAssociations, \n\t\t\tListResolverQueryLogConfigs,\n\t\t\tor \n\t\t\tListResolverQueryLogConfigAssociations.

\n\t\t\n\t\t \n\t\t\t

In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, \n\t\t\t\tCreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.

\n\t\t \n\t\t\n\t\t

\n ListResolverEndpoints\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n CreatorRequestId: The value that you specified when you created the Resolver endpoint.

    \n
    • \n
  • \n

    \n Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION \n\t\t\t\tfor Name, specify INBOUND or OUTBOUND for Values.

    \n
    • \n
  • \n

    \n HostVPCId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or \n\t\t\t\tthe VPC that outbound queries pass through on the way from your VPCs to your network. In a \n\t\t\t\tCreateResolverEndpoint\n\t\t\t\trequest, SubnetId indirectly identifies the VPC. In a \n\t\t\t\tGetResolverEndpoint\n\t\t\t\trequest, the VPC ID for a Resolver endpoint \n\t\t\t\tis returned in the HostVPCId element.

    \n
    • \n
  • \n

    \n IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.

    \n
    • \n
  • \n

    \n Name: The name of the Resolver endpoint.

    \n
    • \n
  • \n

    \n SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the \n\t\t\t\tResolver endpoint.

    \n
    • \n
  • \n

    \n Status: The status of the Resolver endpoint. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING,\n\t\t\t\tAUTO_RECOVERING, ACTION_NEEDED, or DELETING. For more information, see Status in\n\t\t\t\tResolverEndpoint.

    \n
    • \n
\n\t\t\n\t\t

\n ListResolverRules\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n CreatorRequestId: The value that you specified when you created the Resolver rule.

    \n
    • \n
  • \n

    \n DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the value that \n\t\t\t\tyou specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, \n\t\t\t\tspecify the following value. Note the \".\" after com:

    \n\t\t\t\t

    \n example.com.\n

    \n\t\t\t
    • \n
  • \n

    \n Name: The name of the Resolver rule.

    \n
    • \n
  • \n

    \n ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.

    \n\t\t\t\t \n

    You can filter on the Resolver endpoint only for rules that have a value of FORWARD for \n\t\t\t\t\tRuleType.

    \n     \n\t\t\t
    • \n
  • \n

    \n Status: The status of the Resolver rule. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: COMPLETE, DELETING, UPDATING, \n\t\t\t\tor FAILED.

    \n
    • \n
  • \n

    \n Type: The type of the Resolver rule. If you specify TYPE \n\t\t\t\tfor Name, specify FORWARD or SYSTEM for Values.

    \n
    • \n
\n\t\t\n\t\t

\n ListResolverRuleAssociations\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n Name: The name of the Resolver rule association.

    \n
    • \n
  • \n

    \n ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.

    \n
    • \n
  • \n

    \n Status: The status of the Resolver rule association. If you specify Status for Name, \n\t\t\t\tspecify one of the following status codes for Values: CREATING, COMPLETE, DELETING, or \n\t\t\t\tFAILED.

    \n\t\t\t
    • \n
  • \n

    \n VPCId: The ID of the VPC that the Resolver rule is associated with.

    \n
    • \n
\n\n\t\t

\n ListResolverQueryLogConfigs\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n Arn: The ARN for the query logging configuration.

    \n
    • \n
  • \n

    \n AssociationCount: The number of VPCs that are associated with the query logging configuration.

    \n
    • \n
  • \n

    \n CreationTime: The date and time that the query logging configuration was created, in Unix time format and \n\t\t\t\tCoordinated Universal Time (UTC).

    \n
    • \n
  • \n

    \n CreatorRequestId: A unique string that identifies the request that created the query logging configuration.

    \n
    • \n
  • \n

    \n Destination: The Amazon Web Services service that you want to forward query logs to. Valid values include the following:

    \n\t\t\t\t
      \n
    • \n

      \n S3\n

      \n
      • \n
    • \n

      \n CloudWatchLogs\n

      \n
      • \n
    • \n

      \n KinesisFirehose\n

      \n
      • \n
    \n\t\t\t
    • \n
  • \n

    \n DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an \n\t\t\t\tS3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.

    \n
    • \n
  • \n

    \n Id: The ID of the query logging configuration

    \n
    • \n
  • \n

    \n Name: The name of the query logging configuration

    \n
    • \n
  • \n

    \n OwnerId: The Amazon Web Services account ID for the account that created the query logging configuration.

    \n
    • \n
  • \n

    \n ShareStatus: An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, \n\t\t\t\tor was shared with the current account by another Amazon Web Services account. Valid values include: NOT_SHARED, SHARED_WITH_ME, \n\t\t\t\tor SHARED_BY_ME.

    \n
    • \n
  • \n

    \n Status: The status of the query logging configuration. If you specify Status for Name, \n\t\t\t\tspecify the applicable status code for Values: CREATING, CREATED, \n\t\t\t\tDELETING, or FAILED. For more information, see \n\t\t\t\tStatus.\n\t\t\t\t

    \n\t\t\t
    • \n
\n\t\t\n\t\t

\n ListResolverQueryLogConfigAssociations\n

\n\t\t

Valid values for Name include the following:

\n\t\t
    \n
  • \n

    \n CreationTime: The date and time that the VPC was associated with the query logging configuration, in Unix time format and \n\t\t\t\tCoordinated Universal Time (UTC).

    \n
    • \n
  • \n

    \n Error: If the value of Status is FAILED, specify the cause: \n\t\t\t\tDESTINATION_NOT_FOUND or ACCESS_DENIED.

    \n
    • \n
  • \n

    \n Id: The ID of the query logging association.

    \n
    • \n
  • \n

    \n ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.

    \n
    • \n
  • \n

    \n ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.

    \n
    • \n
  • \n

    \n Status: The status of the query logging association. If you specify Status for Name, \n\t\t\t\tspecify the applicable status code for Values: CREATING, CREATED, \n\t\t\t\tDELETING, or FAILED. For more information, see \n\t\t\t Status.\n\t\t\t\t

    \n\t\t\t
    • \n
" } }, "Values": { @@ -1635,7 +1635,7 @@ "OwnerId": { "target": "com.amazonaws.route53resolver#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the owner of the VPC that this firewall configuration applies to.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.

" } }, "FirewallFailOpen": { @@ -1976,7 +1976,7 @@ "OwnerId": { "target": "com.amazonaws.route53resolver#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the account that created the rule group. When a rule group is shared with your account,\n this is the account that has shared the rule group with you.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account,\n this is the account that has shared the rule group with you.

" } }, "CreatorRequestId": { @@ -1988,7 +1988,7 @@ "ShareStatus": { "target": "com.amazonaws.route53resolver#ShareStatus", "traits": { - "smithy.api#documentation": "

Whether the rule group is shared with other AWS accounts, or was shared with the current account by another \n AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

" + "smithy.api#documentation": "

Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another \n Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

" } }, "CreationTime": { @@ -2056,7 +2056,7 @@ "ManagedOwnerName": { "target": "com.amazonaws.route53resolver#ServicePrinciple", "traits": { - "smithy.api#documentation": "

The owner of the association, used only for associations that are not managed by you. If you use AWS Firewall Manager to \n manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.

" + "smithy.api#documentation": "

The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to \n manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.

" } }, "Status": { @@ -2143,7 +2143,7 @@ "OwnerId": { "target": "com.amazonaws.route53resolver#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the account that created the rule group. When a rule group is shared with your account,\n this is the account that has shared the rule group with you.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account,\n this is the account that has shared the rule group with you.

" } }, "CreatorRequestId": { @@ -2155,7 +2155,7 @@ "ShareStatus": { "target": "com.amazonaws.route53resolver#ShareStatus", "traits": { - "smithy.api#documentation": "

Whether the rule group is shared with other AWS accounts, or was shared with the current account by another \n AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

" + "smithy.api#documentation": "

Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another \n Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

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

Returns the AWS Identity and Access Management (AWS IAM) policy for sharing the\n\t\t\tspecified rule group. You can use the policy to share the rule group using AWS Resource\n\t\t\tAccess Manager (AWS RAM).

" + "smithy.api#documentation": "

Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the\n \tspecified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

" } }, "com.amazonaws.route53resolver#GetFirewallRuleGroupPolicyRequest": { @@ -2426,7 +2426,7 @@ "FirewallRuleGroupPolicy": { "target": "com.amazonaws.route53resolver#FirewallRuleGroupPolicy", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (AWS IAM) policy for sharing the specified rule\n\t\t\tgroup. You can use the policy to share the rule group using AWS Resource Access Manager\n\t\t\t(AWS RAM).

" + "smithy.api#documentation": "

The Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule\n\t\t\tgroup. You can use the policy to share the rule group using Resource Access Manager\n\t\t\t(RAM).

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

Gets information about a query logging policy. A query logging policy specifies the Resolver query logging \n\t\t\toperations and resources that you want to allow another AWS account to be able to use.

" + "smithy.api#documentation": "

Gets information about a query logging policy. A query logging policy specifies the Resolver query logging \n\t\t\toperations and resources that you want to allow another Amazon Web Services account to be able to use.

" } }, "com.amazonaws.route53resolver#GetResolverQueryLogConfigPolicyRequest": { @@ -3733,7 +3733,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the configurations for DNSSEC validation that are associated with the current AWS account.

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

Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3754,7 +3754,7 @@ "NextToken": { "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

(Optional) If the current AWS account has more than MaxResults DNSSEC configurations, use NextToken \n\t\t\tto get the second and subsequent pages of results.

\n\t\t

For the first ListResolverDnssecConfigs request, omit this value.

\n\t\t

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value \n\t\t\tfor NextToken in the request.

" + "smithy.api#documentation": "

(Optional) If the current Amazon Web Services account has more than MaxResults DNSSEC configurations, use NextToken \n\t\t\tto get the second and subsequent pages of results.

\n\t\t

For the first ListResolverDnssecConfigs request, omit this value.

\n\t\t

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value \n\t\t\tfor NextToken in the request.

" } }, "Filters": { @@ -3771,13 +3771,13 @@ "NextToken": { "target": "com.amazonaws.route53resolver#NextToken", "traits": { - "smithy.api#documentation": "

If a response includes the last of the DNSSEC configurations that are associated with the current AWS account, \n\t\t\tNextToken doesn't appear in the response.

\n\t\t

If a response doesn't include the last of the configurations, you can get more configurations by submitting another \n\t\t\tListResolverDnssecConfigs \n\t\t\trequest. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in \n\t\t\tNextToken in the next request.

" + "smithy.api#documentation": "

If a response includes the last of the DNSSEC configurations that are associated with the current Amazon Web Services account, \n\t\t\tNextToken doesn't appear in the response.

\n\t\t

If a response doesn't include the last of the configurations, you can get more configurations by submitting another \n\t\t\tListResolverDnssecConfigs \n\t\t\trequest. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in \n\t\t\tNextToken in the next request.

" } }, "ResolverDnssecConfigs": { "target": "com.amazonaws.route53resolver#ResolverDnssecConfigList", "traits": { - "smithy.api#documentation": "

An array that contains one \n\t\t\tResolverDnssecConfig element \n\t\t\tfor each configuration for DNSSEC validation that is associated with the current AWS account.

" + "smithy.api#documentation": "

An array that contains one \n\t\t\tResolverDnssecConfig element \n\t\t\tfor each configuration for DNSSEC validation that is associated with the current Amazon Web Services account.

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

Lists all the Resolver endpoints that were created using the current AWS account.

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

Lists all the Resolver endpoints that were created using the current Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3940,7 +3940,7 @@ "ResolverEndpoints": { "target": "com.amazonaws.route53resolver#ResolverEndpoints", "traits": { - "smithy.api#documentation": "

The Resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.

" + "smithy.api#documentation": "

The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any.

" } } } @@ -4108,7 +4108,7 @@ "SortBy": { "target": "com.amazonaws.route53resolver#SortByKey", "traits": { - "smithy.api#documentation": "

The element that you want Resolver to sort query logging configurations by.

\n\t\t \n\t\t\t

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, \n\t\t\t\tyou must use the same value for SortBy, if any, as in the previous request.

\n\t\t \n\t\t\n\t\t

Valid values include the following elements:

\n\t\t
    \n
  • \n

    \n Arn: The ARN of the query logging configuration

    \n
    • \n
  • \n

    \n AssociationCount: The number of VPCs that are associated with the specified configuration

    \n
    • \n
  • \n

    \n CreationTime: The date and time that Resolver returned when the configuration was created

    \n
    • \n
  • \n

    \n CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created

    \n
    • \n
  • \n

    \n DestinationArn: The location that logs are sent to

    \n
    • \n
  • \n

    \n Id: The ID of the configuration

    \n
    • \n
  • \n

    \n Name: The name of the configuration

    \n
    • \n
  • \n

    \n OwnerId: The AWS account number of the account that created the configuration

    \n
    • \n
  • \n

    \n ShareStatus: Whether the configuration is shared with other AWS accounts or shared with the current account by \n\t\t\t\tanother AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

    \n
    • \n
  • \n

    \n Status: The current status of the configuration. Valid values include the following:

    \n\t\t\t\t\n\t\t\t\t
      \n
    • \n

      \n CREATING: Resolver is creating the query logging configuration.

      \n
      • \n
    • \n

      \n CREATED: The query logging configuration was successfully created. \n\t\t\t\t\t\tResolver is logging queries that originate in the specified VPC.

      \n
      • \n
    • \n

      \n DELETING: Resolver is deleting this query logging configuration.

      \n
      • \n
    • \n

      \n FAILED: Resolver either couldn't create or couldn't delete the query logging configuration.\n\t\t\t\t\t\tHere are two common causes:

      \n\t\t\t\t\t\t
        \n
      • \n

        The specified destination (for example, an Amazon S3 bucket) was deleted.

        \n
        • \n
      • \n

        Permissions don't allow sending logs to the destination.

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

The element that you want Resolver to sort query logging configurations by.

\n\t\t \n\t\t\t

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, \n\t\t\t\tyou must use the same value for SortBy, if any, as in the previous request.

\n\t\t \n\t\t\n\t\t

Valid values include the following elements:

\n\t\t
    \n
  • \n

    \n Arn: The ARN of the query logging configuration

    \n
    • \n
  • \n

    \n AssociationCount: The number of VPCs that are associated with the specified configuration

    \n
    • \n
  • \n

    \n CreationTime: The date and time that Resolver returned when the configuration was created

    \n
    • \n
  • \n

    \n CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created

    \n
    • \n
  • \n

    \n DestinationArn: The location that logs are sent to

    \n
    • \n
  • \n

    \n Id: The ID of the configuration

    \n
    • \n
  • \n

    \n Name: The name of the configuration

    \n
    • \n
  • \n

    \n OwnerId: The Amazon Web Services account number of the account that created the configuration

    \n
    • \n
  • \n

    \n ShareStatus: Whether the configuration is shared with other Amazon Web Services accounts or shared with the current account by \n\t\t\t\tanother Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

    \n
    • \n
  • \n

    \n Status: The current status of the configuration. Valid values include the following:

    \n\t\t\t\t\n\t\t\t\t
      \n
    • \n

      \n CREATING: Resolver is creating the query logging configuration.

      \n
      • \n
    • \n

      \n CREATED: The query logging configuration was successfully created. \n\t\t\t\t\t\tResolver is logging queries that originate in the specified VPC.

      \n
      • \n
    • \n

      \n DELETING: Resolver is deleting this query logging configuration.

      \n
      • \n
    • \n

      \n FAILED: Resolver either couldn't create or couldn't delete the query logging configuration.\n\t\t\t\t\t\tHere are two common causes:

      \n\t\t\t\t\t\t
        \n
      • \n

        The specified destination (for example, an Amazon S3 bucket) was deleted.

        \n
        • \n
      • \n

        Permissions don't allow sending logs to the destination.

        \n
        • \n
      \n\t\t\t\t\t
      • \n
    \n\t\t\t
    • \n
" } }, "SortOrder": { @@ -4174,7 +4174,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the associations that were created between Resolver rules and VPCs using the current AWS account.

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

Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4224,7 +4224,7 @@ "ResolverRuleAssociations": { "target": "com.amazonaws.route53resolver#ResolverRuleAssociations", "traits": { - "smithy.api#documentation": "

The associations that were created between Resolver rules and VPCs using the current AWS account, and that match the \n\t\t\tspecified filters, if any.

" + "smithy.api#documentation": "

The associations that were created between Resolver rules and VPCs using the current Amazon Web Services account, and that match the \n\t\t\tspecified filters, if any.

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

Lists the Resolver rules that were created using the current AWS account.

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

Lists the Resolver rules that were created using the current Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4305,7 +4305,7 @@ "ResolverRules": { "target": "com.amazonaws.route53resolver#ResolverRules", "traits": { - "smithy.api#documentation": "

The Resolver rules that were created using the current AWS account and that match the specified filters, if any.

" + "smithy.api#documentation": "

The Resolver rules that were created using the current Amazon Web Services account and that match the specified filters, if any.

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

Attaches an AWS Identity and Access Management (AWS IAM) policy for sharing the rule\n\t\t\tgroup. You can use the policy to share the rule group using AWS Resource Access Manager\n\t\t\t(AWS RAM).

" + "smithy.api#documentation": "

Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule\n\t\t\tgroup. You can use the policy to share the rule group using Resource Access Manager\n\t\t\t(RAM).

" } }, "com.amazonaws.route53resolver#PutFirewallRuleGroupPolicyRequest": { @@ -4485,7 +4485,7 @@ "FirewallRuleGroupPolicy": { "target": "com.amazonaws.route53resolver#FirewallRuleGroupPolicy", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (AWS IAM) policy to attach to the rule group.

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

The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group.

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

Specifies an AWS account that you want to share a query logging configuration with, the query logging configuration that you want to share, \n\t\t\tand the operations that you want the account to be able to perform on the configuration.

" + "smithy.api#documentation": "

Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, \n\t\t\tand the operations that you want the account to be able to perform on the configuration.

" } }, "com.amazonaws.route53resolver#PutResolverQueryLogConfigPolicyRequest": { @@ -4547,7 +4547,7 @@ "ResolverQueryLogConfigPolicy": { "target": "com.amazonaws.route53resolver#ResolverQueryLogConfigPolicy", "traits": { - "smithy.api#documentation": "

An AWS Identity and Access Management policy statement that lists the query logging configurations that you want to share with another AWS account \n\t\t\tand the operations that you want the account to be able to perform. You can specify the following operations in the Actions section \n\t\t\tof the statement:

\n\t\t
    \n
  • \n

    \n route53resolver:AssociateResolverQueryLogConfig\n

    \n
    • \n
  • \n

    \n route53resolver:DisassociateResolverQueryLogConfig\n

    \n
    • \n
  • \n

    \n route53resolver:ListResolverQueryLogConfigAssociations\n

    \n
    • \n
  • \n

    \n route53resolver:ListResolverQueryLogConfigs\n

    \n
    • \n
\n\t\t\n\t\t

In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share \n\t\t\twith the account that you specified in Arn.

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

An Identity and Access Management policy statement that lists the query logging configurations that you want to share with another Amazon Web Services account \n\t\t\tand the operations that you want the account to be able to perform. You can specify the following operations in the Actions section \n\t\t\tof the statement:

\n\t\t
    \n
  • \n

    \n route53resolver:AssociateResolverQueryLogConfig\n

    \n
    • \n
  • \n

    \n route53resolver:DisassociateResolverQueryLogConfig\n

    \n
    • \n
  • \n

    \n route53resolver:ListResolverQueryLogConfigAssociations\n

    \n
    • \n
  • \n

    \n route53resolver:ListResolverQueryLogConfigs\n

    \n
    • \n
\n\t\t\n\t\t

In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share \n\t\t\twith the account that you specified in Arn.

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

Specifies an AWS rule that you want to share with another account, the account that you want to share the rule with, \n\t\t\tand the operations that you want the account to be able to perform on the rule.

" + "smithy.api#documentation": "

Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, \n\t\t\tand the operations that you want the account to be able to perform on the rule.

" } }, "com.amazonaws.route53resolver#PutResolverRulePolicyRequest": { @@ -4606,7 +4606,7 @@ "ResolverRulePolicy": { "target": "com.amazonaws.route53resolver#ResolverRulePolicy", "traits": { - "smithy.api#documentation": "

An AWS Identity and Access Management policy statement that lists the rules that you want to share with another AWS account and the operations that you want the account \n\t\t\tto be able to perform. You can specify the following operations in the Action section of the statement:

\n\t\t\t
    \n
  • \n

    \n route53resolver:GetResolverRule\n

    \n
    • \n
  • \n

    \n route53resolver:AssociateResolverRule\n

    \n
    • \n
  • \n

    \n route53resolver:DisassociateResolverRule\n

    \n
    • \n
  • \n

    \n route53resolver:ListResolverRules\n

    \n
    • \n
  • \n

    \n route53resolver:ListResolverRuleAssociations\n

    \n
    • \n
\n\t\t\n\t\t

In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN \n\t\t\tthat you specified in Arn.

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

An Identity and Access Management policy statement that lists the rules that you want to share with another Amazon Web Services account and the operations that you want the account \n\t\t\tto be able to perform. You can specify the following operations in the Action section of the statement:

\n\t\t\t
    \n
  • \n

    \n route53resolver:GetResolverRule\n

    \n
    • \n
  • \n

    \n route53resolver:AssociateResolverRule\n

    \n
    • \n
  • \n

    \n route53resolver:DisassociateResolverRule\n

    \n
    • \n
  • \n

    \n route53resolver:ListResolverRules\n

    \n
    • \n
  • \n

    \n route53resolver:ListResolverRuleAssociations\n

    \n
    • \n
\n\t\t\n\t\t

In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN \n\t\t\tthat you specified in Arn.

", "smithy.api#required": {} } } @@ -4831,7 +4831,7 @@ "OwnerId": { "target": "com.amazonaws.route53resolver#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the account that created the query logging configuration.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the account that created the query logging configuration.

" } }, "Status": { @@ -4843,7 +4843,7 @@ "ShareStatus": { "target": "com.amazonaws.route53resolver#ShareStatus", "traits": { - "smithy.api#documentation": "

An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another \n\t\t\tAWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

" + "smithy.api#documentation": "

An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another \n\t\t\tAmazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

" } }, "AssociationCount": { @@ -5110,7 +5110,7 @@ "OwnerId": { "target": "com.amazonaws.route53resolver#AccountId", "traits": { - "smithy.api#documentation": "

When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

" + "smithy.api#documentation": "

When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.

" } }, "ShareStatus": { @@ -5564,7 +5564,7 @@ "name": "route53resolver" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC\n\t\t\tfrom Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names\n\t\t\tsuch as domain names for EC2 instances or Elastic Load Balancing load balancers.\n\t\t\tResolver performs recursive lookups against public name servers for all other domain\n\t\t\tnames.

\n\n\t\t

You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:

\n\n\t\t

\n Forward DNS queries from resolvers on your network to Route 53 Resolver\n

\n\n\t\t

DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers \n\t\t\tto easily resolve domain names for AWS resources such as EC2 instances or records in a Route 53 private hosted zone. \n\t\t\tFor more information, see \n\t\t\tHow DNS Resolvers \n\t\t\ton Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.

\n\t\t\n\t\t

\n Conditionally forward queries from a VPC to resolvers on your network\n

\n\n\t\t

You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. \n\t\t\tTo forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward \n\t\t\t(such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. \n\t\t\tIf a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match \n\t\t\t(acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see \n\t\t\tHow Route 53 Resolver \n\t\t\tForwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

\n\n\t\t

Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose\n\t\t\twhether to forward queries from your VPCs to your network (outbound queries), from your\n\t\t\tnetwork to your VPCs (inbound queries), or both.

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

When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC\n\t\t\tfrom Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names\n\t\t\tsuch as domain names for EC2 instances or Elastic Load Balancing load balancers.\n\t\t\tResolver performs recursive lookups against public name servers for all other domain\n\t\t\tnames.

\n\n\t\t

You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:

\n\n\t\t

\n Forward DNS queries from resolvers on your network to Route 53 Resolver\n

\n\n\t\t

DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers \n\t\t\tto easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. \n\t\t\tFor more information, see \n\t\t\tHow DNS Resolvers \n\t\t\ton Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.

\n\t\t\n\t\t

\n Conditionally forward queries from a VPC to resolvers on your network\n

\n\n\t\t

You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. \n\t\t\tTo forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward \n\t\t\t(such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. \n\t\t\tIf a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match \n\t\t\t(acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see \n\t\t\tHow Route 53 Resolver \n\t\t\tForwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

\n\n\t\t

Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose\n\t\t\twhether to forward queries from your VPCs to your network (outbound queries), from your\n\t\t\tnetwork to your VPCs (inbound queries), or both.

", "smithy.api#title": "Amazon Route 53 Resolver" } }, diff --git a/aws/sdk/aws-models/runtime.sagemaker.json b/aws/sdk/aws-models/runtime.sagemaker.json index 114c1deeaf..37c333aeaf 100644 --- a/aws/sdk/aws-models/runtime.sagemaker.json +++ b/aws/sdk/aws-models/runtime.sagemaker.json @@ -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": "

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.

\n \n

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.

\n \n

Amazon SageMaker strips all POST 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.

\n \n

Calls to InvokeEndpointAsync are authenticated by using AWS Signature\n Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API\n Reference.

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

The name of the endpoint that you specified when you created the endpoint using \n the \n CreateEndpoint\n API.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContentType": { + "target": "com.amazonaws.sagemakerruntime#Header", + "traits": { + "smithy.api#documentation": "

The MIME type of the input data in the request body.

", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Content-Type" + } + }, + "Accept": { + "target": "com.amazonaws.sagemakerruntime#Header", + "traits": { + "smithy.api#documentation": "

The desired MIME type of the inference in the response.

", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Accept" + } + }, + "CustomAttributes": { + "target": "com.amazonaws.sagemakerruntime#CustomAttributesHeader", + "traits": { + "smithy.api#documentation": "

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 Section 3.3.6. \n Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).

\n \n

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 Trace ID: in your post-processing function.

\n \n

This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.

", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Custom-Attributes" + } + }, + "InferenceId": { + "target": "com.amazonaws.sagemakerruntime#InferenceId", + "traits": { + "smithy.api#documentation": "

The identifier for the inference request. Amazon SageMaker will generate an identifier for you \n if none is specified.

", + "smithy.api#httpHeader": "X-Amzn-SageMaker-Inference-Id" + } + }, + "InputLocation": { + "target": "com.amazonaws.sagemakerruntime#InputLocationHeader", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI where the inference request payload is stored.

", + "smithy.api#httpHeader": "X-Amzn-SageMaker-InputLocation", + "smithy.api#required": {} + } + }, + "RequestTTLSeconds": { + "target": "com.amazonaws.sagemakerruntime#RequestTTLSecondsHeader", + "traits": { + "smithy.api#documentation": "

Maximum age in seconds a request can be in the queue before it is marked as expired.

", + "smithy.api#httpHeader": "X-Amzn-SageMaker-RequestTTLSeconds" + } + } + } + }, + "com.amazonaws.sagemakerruntime#InvokeEndpointAsyncOutput": { + "type": "structure", + "members": { + "InferenceId": { + "target": "com.amazonaws.sagemakerruntime#Header", + "traits": { + "smithy.api#documentation": "

Identifier for an inference request. This will be the same as the InferenceId specified \n in the input. Amazon SageMaker will generate an identifier for you if you do not specify one.

" + } + }, + "OutputLocation": { + "target": "com.amazonaws.sagemakerruntime#Header", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI where the inference response payload is stored.

", + "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": { diff --git a/aws/sdk/aws-models/s3.json b/aws/sdk/aws-models/s3.json index b5293082c6..12c31ab074 100644 --- a/aws/sdk/aws-models/s3.json +++ b/aws/sdk/aws-models/s3.json @@ -85,7 +85,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name to which the upload was taking place.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name to which the upload was taking place.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally\n unique, and the namespace is shared by all AWS accounts.

" + "smithy.api#documentation": "

In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally\n unique, and the namespace is shared by all Amazon Web Services accounts.

" } }, "com.amazonaws.s3#BucketAccelerateStatus": { @@ -722,7 +722,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error\n in all AWS Regions except in the North Virginia Region. For legacy compatibility, if you\n re-create an existing bucket that you already own in the North Virginia Region, Amazon S3\n returns 200 OK and resets the bucket access control lists (ACLs).

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

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error\n in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you\n re-create an existing bucket that you already own in the North Virginia Region, Amazon S3\n returns 200 OK and resets the bucket access control lists (ACLs).

", "smithy.api#error": "client" } }, @@ -1168,7 +1168,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket that contains the newly created object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

" } }, "Key": { @@ -1193,7 +1193,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

If you specified server-side encryption either with an Amazon S3-managed encryption key or an\n AWS KMS customer master key (CMK) in your initiate multipart upload request, the response\n includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the\n object.

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

If you specified server-side encryption either with an Amazon S3-managed encryption key or an\n Amazon Web Services KMS customer master key (CMK) in your initiate multipart upload request, the response\n includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the\n object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, @@ -1207,14 +1207,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

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

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

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

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -1235,7 +1235,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

Name of the bucket to which the multipart upload was initiated.

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

Name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

Creates a copy of an object that is already stored in Amazon S3.

\n \n

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy\n an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API.\n For more information, see Copy Object Using the REST Multipart Upload API.

\n \n

All copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the Region\n that you want to copy the object from and the Region that you want to copy the object to\n must be enabled for your account.

\n

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. Design your application to parse the\n contents of the response and handle it appropriately.

\n

If the copy is successful, you receive a response with information about the copied\n object.

\n \n

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.

\n \n

The copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.

\n \n

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer Acceleration.

\n \n

\n Metadata\n

\n

When copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.

\n

To specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.

\n

\n \n x-amz-copy-source-if Headers\n

\n

To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:

\n
    \n
  • \n

    \n x-amz-copy-source-if-match\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-none-match\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-unmodified-since\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-modified-since\n

    \n
    • \n
\n

If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

\n
    \n
  • \n

    \n x-amz-copy-source-if-match condition evaluates to true

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-unmodified-since condition evaluates to\n false

    \n
    • \n
\n\n

If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:

\n
    \n
  • \n

    \n x-amz-copy-source-if-none-match condition evaluates to false

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-modified-since condition evaluates to\n true

    \n
    • \n
\n\n \n

All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.

\n \n

\n Server-side encryption\n

\n

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related \n headers to encrypt the object using server-side encryption with AWS managed encryption keys \n (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 \n encrypts your data as it writes it to disks in its data centers and decrypts the data when \n you access it. For more information about server-side encryption, see Using\n Server-Side Encryption.

\n

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more\n information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

\n

\n Access Control List (ACL)-Specific Request\n Headers\n

\n

When copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual AWS accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.

\n\n

\n Storage Class Options\n

\n

You can use the CopyObject action to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass parameter. For\n more information, see Storage\n Classes in the Amazon S3 User Guide.

\n

\n Versioning\n

\n

By default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.

\n

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.

\n

If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.

\n

If the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.

\n

The following operations are related to CopyObject:

\n \n

For more information, see Copying\n Objects.

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

Creates a copy of an object that is already stored in Amazon S3.

\n \n

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy\n an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API.\n For more information, see Copy Object Using the REST Multipart Upload API.

\n \n

All copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the Region\n that you want to copy the object from and the Region that you want to copy the object to\n must be enabled for your account.

\n

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. Design your application to parse the\n contents of the response and handle it appropriately.

\n

If the copy is successful, you receive a response with information about the copied\n object.

\n \n

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.

\n \n

The copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.

\n \n

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer Acceleration.

\n \n

\n Metadata\n

\n

When copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.

\n

To specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.

\n

\n \n x-amz-copy-source-if Headers\n

\n

To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:

\n
    \n
  • \n

    \n x-amz-copy-source-if-match\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-none-match\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-unmodified-since\n

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-modified-since\n

    \n
    • \n
\n

If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

\n
    \n
  • \n

    \n x-amz-copy-source-if-match condition evaluates to true

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-unmodified-since condition evaluates to\n false

    \n
    • \n
\n\n

If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:

\n
    \n
  • \n

    \n x-amz-copy-source-if-none-match condition evaluates to false

    \n
    • \n
  • \n

    \n x-amz-copy-source-if-modified-since condition evaluates to\n true

    \n
    • \n
\n\n \n

All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.

\n \n

\n Server-side encryption\n

\n

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related \n headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys \n (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 \n encrypts your data as it writes it to disks in its data centers and decrypts the data when \n you access it. For more information about server-side encryption, see Using\n Server-Side Encryption.

\n

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more\n information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

\n

\n Access Control List (ACL)-Specific Request\n Headers\n

\n

When copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.

\n\n

\n Storage Class Options\n

\n

You can use the CopyObject action to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass parameter. For\n more information, see Storage\n Classes in the Amazon S3 User Guide.

\n

\n Versioning\n

\n

By default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.

\n

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.

\n

If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.

\n

If the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.

\n

The following operations are related to CopyObject:

\n \n

For more information, see Copying\n Objects.

", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?x-id=CopyObject", @@ -1468,21 +1468,21 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

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

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

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

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

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

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -1507,7 +1507,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the destination bucket.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

The name of the destination bucket.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1550,7 +1550,7 @@ "CopySource": { "target": "com.amazonaws.s3#CopySource", "traits": { - "smithy.api#documentation": "

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access point:

\n
    \n
  • \n

    For objects not accessed through an access point, specify the name of the source\n bucket and the key of the source object, separated by a slash (/). For example, to\n copy the object reports/january.pdf from the bucket\n awsexamplebucket, use\n awsexamplebucket/reports/january.pdf. The value must be URL\n encoded.

    \n
    • \n
  • \n

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    \n \n

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    \n     \n

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

    \n
    • \n
\n

To copy a specific version of an object, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

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

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access point:

\n
    \n
  • \n

    For objects not accessed through an access point, specify the name of the source\n bucket and the key of the source object, separated by a slash (/). For example, to\n copy the object reports/january.pdf from the bucket\n awsexamplebucket, use\n awsexamplebucket/reports/january.pdf. The value must be URL\n encoded.

    \n
    • \n
  • \n

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    \n \n

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

    \n     \n

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

    \n
    • \n
\n

To copy a specific version of an object, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

", "smithy.api#httpHeader": "x-amz-copy-source", "smithy.api#required": {} } @@ -1692,14 +1692,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for\n an object protected by AWS KMS will fail if not made via SSL or using SigV4. For\n information about configuring using any of the officially supported AWS SDKs and AWS CLI,\n see Specifying the\n Signature Version in Request Authentication in the Amazon S3 User Guide.

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

Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for\n an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For\n information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI,\n see Specifying the\n Signature Version in Request Authentication in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

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

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, @@ -1787,7 +1787,7 @@ "ETag": { "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "

Returns the ETag of the new object. The ETag reflects only changes to the contents of an\n object, not its metadata. The source and destination ETag is identical for a successfully\n copied non-multipart object.

" + "smithy.api#documentation": "

Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.

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

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.

\n

Not every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.

\n

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

\n

By default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.

\n \n

If you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.

\n \n

When creating a bucket using this operation, you can optionally specify the accounts or\n groups that should be granted specific permissions on the bucket. There are two ways to\n grant the appropriate permissions using the request headers.

\n
    \n
  • \n

    Specify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an AWS\n account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an AWS account

      \n \n

      Using email addresses to specify a grantee is only supported in the following AWS Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

    \n
    • \n
\n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.

\n \n\n\n

The following operations are related to CreateBucket:

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

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.

\n

Not every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.

\n

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

\n

By default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.

\n \n

If you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.

\n \n

When creating a bucket using this operation, you can optionally specify the accounts or\n groups that should be granted specific permissions on the bucket. There are two ways to\n grant the appropriate permissions using the request headers.

\n
    \n
  • \n

    Specify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

    \n
    • \n
\n \n

You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.

\n \n\n

\n Permissions\n

\n

If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, \n authenticated-read, or if you specify access permissions explicitly through any other ACL, both \n s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the \n CreateBucket request is private, only s3:CreateBucket permission is needed.

\n

If ObjectLockEnabledForBucket is set to true in your CreateBucket request, \n s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

\n\n

The following operations are related to CreateBucket:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}", @@ -1987,7 +1987,7 @@ "target": "com.amazonaws.s3#CreateMultipartUploadOutput" }, "traits": { - "smithy.api#documentation": "

This action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.

\n\n

For more information about multipart uploads, see Multipart Upload Overview.

\n\n

If you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n action and Amazon S3 aborts the multipart upload. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\n\n

For information about the permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions.

\n\n

For request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating\n Requests (AWS Signature Version 4).

\n\n \n

After you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.

\n \n\n

You can optionally request server-side encryption. For server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can provide your own encryption key, or use AWS Key Management Service (AWS\n KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide\n your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload.

\n

To perform a multipart upload with encryption using an AWS KMS CMK, the requester must\n have permission to the kms:Decrypt and kms:GenerateDataKey*\n actions on the key. These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API\n and permissions in the Amazon S3 User Guide.

\n\n

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account\n as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM\n user or role belongs to a different account than the key, then you must have the\n permissions on both the key policy and your IAM user or role.

\n\n\n

For more information, see Protecting\n Data Using Server-Side Encryption.

\n\n
\n
Access Permissions
\n
\n

When copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. For\n more information, see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL)\n Overview.

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.

\n
\n
Server-Side- Encryption-Specific Request Headers
\n
\n

You can optionally tell Amazon S3 to encrypt data at rest using server-side\n encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. The option you use depends on whether you want to use AWS managed\n encryption keys or provide your own encryption key.

\n
    \n
  • \n

    Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored\n in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys\n used to encrypt data, specify the following headers in the request.

    \n
      \n
    • \n

      x-amz-server-side-encryption

      \n
      • \n
    • \n

      x-amz-server-side-encryption-aws-kms-key-id

      \n
      • \n
    • \n

      x-amz-server-side-encryption-context

      \n
      • \n
    \n \n

    If you specify x-amz-server-side-encryption:aws:kms, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id,\n Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.

    \n     \n \n

    All GET and PUT requests for an object protected by AWS KMS fail if\n you don't make them with SSL or by using SigV4.

    \n     \n

    For more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.

    \n
    • \n
  • \n

    Use customer-provided encryption keys – If you want to manage your own\n encryption keys, provide all the following headers in the request.

    \n
      \n
    • \n

      x-amz-server-side-encryption-customer-algorithm

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key-MD5

      \n
      • \n
    \n

    For more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.

    \n
    • \n
\n
\n
Access-Control-List (ACL)-Specific Request Headers
\n
\n

You also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n control. When adding a new object, you can grant permissions to individual AWS\n accounts or to predefined groups defined by Amazon S3. These permissions are then added\n to the access control list (ACL) on the object. For more information, see Using ACLs. With this\n operation, you can grant access permissions using one of the following two\n methods:

\n
    \n
  • \n

    Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly — To explicitly grant access\n permissions to specific AWS accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access\n Control List (ACL) Overview. In the header, you specify a list of\n grantees who get the specific permission. To grant permissions explicitly,\n use:

    \n
      \n
    • \n

      x-amz-grant-read

      \n
      • \n
    • \n

      x-amz-grant-write

      \n
      • \n
    • \n

      x-amz-grant-read-acp

      \n
      • \n
    • \n

      x-amz-grant-write-acp

      \n
      • \n
    • \n

      x-amz-grant-full-control

      \n
      • \n
    \n

    You specify each grantee as a type=value pair, where the type is one of\n the following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID\n of an AWS account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email\n address of an AWS account

      \n \n

      Using email addresses to specify a grantee is only supported in the following AWS Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

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

The following operations are related to CreateMultipartUpload:

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

This action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.

\n\n

For more information about multipart uploads, see Multipart Upload Overview.

\n\n

If you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n action and Amazon S3 aborts the multipart upload. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

\n\n

For information about the permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions.

\n\n

For request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating\n Requests (Amazon Web Services Signature Version 4).

\n\n \n

After you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.

\n \n\n

You can optionally request server-side encryption. For server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can provide your own encryption key, or use Amazon Web Services Key Management Service (Amazon Web Services\n KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide\n your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload.

\n

To perform a multipart upload with encryption using an Amazon Web Services KMS CMK, the requester must\n have permission to the kms:Decrypt and kms:GenerateDataKey*\n actions on the key. These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API\n and permissions in the Amazon S3 User Guide.

\n\n

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account\n as the Amazon Web Services KMS CMK, then you must have these permissions on the key policy. If your IAM\n user or role belongs to a different account than the key, then you must have the\n permissions on both the key policy and your IAM user or role.

\n\n\n

For more information, see Protecting\n Data Using Server-Side Encryption.

\n\n
\n
Access Permissions
\n
\n

When copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. For\n more information, see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL)\n Overview.

    \n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.

\n
\n
Server-Side- Encryption-Specific Request Headers
\n
\n

You can optionally tell Amazon S3 to encrypt data at rest using server-side\n encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. The option you use depends on whether you want to use Amazon Web Services managed\n encryption keys or provide your own encryption key.

\n
    \n
  • \n

    Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored\n in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys\n used to encrypt data, specify the following headers in the request.

    \n
      \n
    • \n

      x-amz-server-side-encryption

      \n
      • \n
    • \n

      x-amz-server-side-encryption-aws-kms-key-id

      \n
      • \n
    • \n

      x-amz-server-side-encryption-context

      \n
      • \n
    \n \n

    If you specify x-amz-server-side-encryption:aws:kms, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id,\n Amazon S3 uses the Amazon Web Services managed CMK in Amazon Web Services KMS to protect the data.

    \n     \n \n

    All GET and PUT requests for an object protected by Amazon Web Services KMS fail if\n you don't make them with SSL or by using SigV4.

    \n     \n

    For more information about server-side encryption with CMKs stored in Amazon Web Services\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services\n KMS.

    \n
    • \n
  • \n

    Use customer-provided encryption keys – If you want to manage your own\n encryption keys, provide all the following headers in the request.

    \n
      \n
    • \n

      x-amz-server-side-encryption-customer-algorithm

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key

      \n
      • \n
    • \n

      x-amz-server-side-encryption-customer-key-MD5

      \n
      • \n
    \n

    For more information about server-side encryption with CMKs stored in Amazon Web Services\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon Web Services\n KMS.

    \n
    • \n
\n
\n
Access-Control-List (ACL)-Specific Request Headers
\n
\n

You also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added\n to the access control list (ACL) on the object. For more information, see Using ACLs. With this\n operation, you can grant access permissions using one of the following two\n methods:

\n
    \n
  • \n

    Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly — To explicitly grant access\n permissions to specific Amazon Web Services accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access\n Control List (ACL) Overview. In the header, you specify a list of\n grantees who get the specific permission. To grant permissions explicitly,\n use:

    \n
      \n
    • \n

      x-amz-grant-read

      \n
      • \n
    • \n

      x-amz-grant-write

      \n
      • \n
    • \n

      x-amz-grant-read-acp

      \n
      • \n
    • \n

      x-amz-grant-write-acp

      \n
      • \n
    • \n

      x-amz-grant-full-control

      \n
      • \n
    \n

    You specify each grantee as a type=value pair, where the type is one of\n the following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID\n of an Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email\n address of an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

    \n

    \n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n

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

The following operations are related to CreateMultipartUpload:

\n ", "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?uploads&x-id=CreateMultipartUpload", @@ -2015,7 +2015,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#xmlName": "Bucket" } }, @@ -2055,21 +2055,21 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

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

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

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

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

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

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -2097,7 +2097,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which to initiate the upload

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

The name of the bucket to which to initiate the upload

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2232,14 +2232,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object\n encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not\n made via SSL or using SigV4. For information about configuring using any of the officially\n supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 User Guide.

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

Specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for object\n encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not\n made via SSL or using SigV4. For information about configuring using any of the officially\n supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

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

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, @@ -2674,7 +2674,7 @@ "target": "com.amazonaws.s3#DeleteBucketPolicyRequest" }, "traits": { - "smithy.api#documentation": "

This implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n AWS account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.

\n\n

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n

For more information about bucket policies, see Using Bucket Policies and\n UserPolicies.

\n

The following operations are related to DeleteBucketPolicy\n

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

This implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n Amazon Web Services account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.

\n\n

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n

For more information about bucket policies, see Using Bucket Policies and\n UserPolicies.

\n

The following operations are related to DeleteBucketPolicy\n

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/{Bucket}?policy", @@ -2951,7 +2951,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name of the bucket containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name of the bucket containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3035,7 +3035,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the objects from which to remove the tags.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name containing the objects from which to remove the tags.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3117,7 +3117,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the objects to delete.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

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

The bucket name containing the objects to delete.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3251,7 +3251,7 @@ "Account": { "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n change replica ownership to the AWS account that owns the destination bucket by specifying\n the AccessControlTranslation property, this is the account ID of the\n destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n change replica ownership to the Amazon Web Services account that owns the destination bucket by specifying\n the AccessControlTranslation property, this is the account ID of the\n destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the Amazon S3 User Guide.

" } }, "StorageClass": { @@ -3263,7 +3263,7 @@ "AccessControlTranslation": { "target": "com.amazonaws.s3#AccessControlTranslation", "traits": { - "smithy.api#documentation": "

Specify this only in a cross-account scenario (where source and destination bucket\n owners are not the same), and you want to change replica ownership to the AWS account that\n owns the destination bucket. If this is not specified in the replication configuration, the\n replicas are owned by same AWS account that owns the source object.

" + "smithy.api#documentation": "

Specify this only in a cross-account scenario (where source and destination bucket\n owners are not the same), and you want to change replica ownership to the Amazon Web Services account that\n owns the destination bucket. If this is not specified in the replication configuration, the\n replicas are owned by same Amazon Web Services account that owns the source object.

" } }, "EncryptionConfiguration": { @@ -3326,7 +3326,7 @@ "KMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only\n supports symmetric CMKs. For more information, see Using symmetric and\n asymmetric keys in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

If the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results. Amazon S3 only\n supports symmetric CMKs. For more information, see Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

" } }, "KMSContext": { @@ -3346,7 +3346,7 @@ "ReplicaKmsKeyID": { "target": "com.amazonaws.s3#ReplicaKmsKeyID", "traits": { - "smithy.api#documentation": "

Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key\n stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses\n this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys.\n For more information, see Using symmetric and\n asymmetric keys in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key\n stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses\n this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys.\n For more information, see Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

" } } }, @@ -3382,7 +3382,7 @@ "Code": { "target": "com.amazonaws.s3#Code", "traits": { - "smithy.api#documentation": "

The error code is a string that uniquely identifies an error condition. It is meant to\n be read and understood by programs that detect and handle errors by type.

\n

\n Amazon S3 error codes\n

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

      \n Code: AccessDenied

      \n
      • \n
    • \n

      \n Description: Access Denied

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: AccountProblem

      \n
      • \n
    • \n

      \n Description: There is a problem with your AWS account\n that prevents the action from completing successfully. Contact AWS Support\n for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: AllAccessDisabled

      \n
      • \n
    • \n

      \n Description: All access to this Amazon S3 resource has been\n disabled. Contact AWS Support for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: AmbiguousGrantByEmailAddress

      \n
      • \n
    • \n

      \n Description: The email address you provided is\n associated with more than one account.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: AuthorizationHeaderMalformed

      \n
      • \n
    • \n

      \n Description: The authorization header you provided is\n invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

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

      \n Code: BadDigest

      \n
      • \n
    • \n

      \n Description: The Content-MD5 you specified did not\n match what we received.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: BucketAlreadyExists

      \n
      • \n
    • \n

      \n Description: The requested bucket name is not\n available. The bucket namespace is shared by all users of the system. Please\n select a different name and try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: BucketAlreadyOwnedByYou

      \n
      • \n
    • \n

      \n Description: The bucket you tried to create already\n exists, and you own it. Amazon S3 returns this error in all AWS Regions except in\n the North Virginia Region. For legacy compatibility, if you re-create an\n existing bucket that you already own in the North Virginia Region, Amazon S3 returns\n 200 OK and resets the bucket access control lists (ACLs).

      \n
      • \n
    • \n

      \n Code: 409 Conflict (in all Regions except the North\n Virginia Region)

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: BucketNotEmpty

      \n
      • \n
    • \n

      \n Description: The bucket you tried to delete is not\n empty.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: CredentialsNotSupported

      \n
      • \n
    • \n

      \n Description: This request does not support\n credentials.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: CrossLocationLoggingProhibited

      \n
      • \n
    • \n

      \n Description: Cross-location logging not allowed.\n Buckets in one geographic location cannot log information to a bucket in\n another location.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: EntityTooSmall

      \n
      • \n
    • \n

      \n Description: Your proposed upload is smaller than the\n minimum allowed object size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: EntityTooLarge

      \n
      • \n
    • \n

      \n Description: Your proposed upload exceeds the maximum\n allowed object size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: ExpiredToken

      \n
      • \n
    • \n

      \n Description: The provided token has expired.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: IllegalVersioningConfigurationException

      \n
      • \n
    • \n

      \n Description: Indicates that the versioning\n configuration specified in the request is invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: IncompleteBody

      \n
      • \n
    • \n

      \n Description: You did not provide the number of bytes\n specified by the Content-Length HTTP header

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: IncorrectNumberOfFilesInPostRequest

      \n
      • \n
    • \n

      \n Description: POST requires exactly one file upload per\n request.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InlineDataTooLarge

      \n
      • \n
    • \n

      \n Description: Inline data exceeds the maximum allowed\n size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InternalError

      \n
      • \n
    • \n

      \n Description: We encountered an internal error. Please\n try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 500 Internal Server Error

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

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

      \n Code: InvalidAccessKeyId

      \n
      • \n
    • \n

      \n Description: The AWS access key ID you provided does\n not exist in our records.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidAddressingHeader

      \n
      • \n
    • \n

      \n Description: You must specify the Anonymous\n role.

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidArgument

      \n
      • \n
    • \n

      \n Description: Invalid Argument

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidBucketName

      \n
      • \n
    • \n

      \n Description: The specified bucket is not valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidBucketState

      \n
      • \n
    • \n

      \n Description: The request is not valid with the current\n state of the bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidDigest

      \n
      • \n
    • \n

      \n Description: The Content-MD5 you specified is not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidEncryptionAlgorithmError

      \n
      • \n
    • \n

      \n Description: The encryption request you specified is\n not valid. The valid value is AES256.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidLocationConstraint

      \n
      • \n
    • \n

      \n Description: The specified location constraint is not\n valid. For more information about Regions, see How to Select a\n Region for Your Buckets.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidObjectState

      \n
      • \n
    • \n

      \n Description: The action is not valid for the current\n state of the object.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidPart

      \n
      • \n
    • \n

      \n Description: One or more of the specified parts could\n not be found. The part might not have been uploaded, or the specified entity\n tag might not have matched the part's entity tag.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidPartOrder

      \n
      • \n
    • \n

      \n Description: The list of parts was not in ascending\n order. Parts list must be specified in order by part number.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidPayer

      \n
      • \n
    • \n

      \n Description: All access to this object has been\n disabled. Please contact AWS Support for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidPolicyDocument

      \n
      • \n
    • \n

      \n Description: The content of the form does not meet the\n conditions specified in the policy document.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidRange

      \n
      • \n
    • \n

      \n Description: The requested range cannot be\n satisfied.

      \n
      • \n
    • \n

      \n HTTP Status Code: 416 Requested Range Not\n Satisfiable

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Please use AWS4-HMAC-SHA256.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: SOAP requests must be made over an HTTPS\n connection.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with non-DNS compliant names.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with periods (.) in their names.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate endpoint only\n supports virtual style requests.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate is not configured\n on this bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate is disabled on\n this bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported on this bucket. Contact AWS Support for more information.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

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

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration cannot be\n enabled on this bucket. Contact AWS Support for more information.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

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

      \n Code: InvalidSecurity

      \n
      • \n
    • \n

      \n Description: The provided security credentials are not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidSOAPRequest

      \n
      • \n
    • \n

      \n Description: The SOAP request body is invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

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

      \n Code: InvalidStorageClass

      \n
      • \n
    • \n

      \n Description: The storage class you specified is not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidTargetBucketForLogging

      \n
      • \n
    • \n

      \n Description: The target bucket for logging does not\n exist, is not owned by you, or does not have the appropriate grants for the\n log-delivery group.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidToken

      \n
      • \n
    • \n

      \n Description: The provided token is malformed or\n otherwise invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidURI

      \n
      • \n
    • \n

      \n Description: Couldn't parse the specified URI.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: KeyTooLongError

      \n
      • \n
    • \n

      \n Description: Your key is too long.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedACLError

      \n
      • \n
    • \n

      \n Description: The XML you provided was not well-formed\n or did not validate against our published schema.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedPOSTRequest

      \n
      • \n
    • \n

      \n Description: The body of your POST request is not\n well-formed multipart/form-data.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedXML

      \n
      • \n
    • \n

      \n Description: This happens when the user sends malformed\n XML (XML that doesn't conform to the published XSD) for the configuration. The\n error message is, \"The XML you provided was not well-formed or did not validate\n against our published schema.\"

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MaxMessageLengthExceeded

      \n
      • \n
    • \n

      \n Description: Your request was too big.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MaxPostPreDataLengthExceededError

      \n
      • \n
    • \n

      \n Description: Your POST request fields preceding the\n upload file were too large.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MetadataTooLarge

      \n
      • \n
    • \n

      \n Description: Your metadata headers exceed the maximum\n allowed metadata size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MethodNotAllowed

      \n
      • \n
    • \n

      \n Description: The specified method is not allowed\n against this resource.

      \n
      • \n
    • \n

      \n HTTP Status Code: 405 Method Not Allowed

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingAttachment

      \n
      • \n
    • \n

      \n Description: A SOAP attachment was expected, but none\n were found.

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingContentLength

      \n
      • \n
    • \n

      \n Description: You must provide the Content-Length HTTP\n header.

      \n
      • \n
    • \n

      \n HTTP Status Code: 411 Length Required

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingRequestBodyError

      \n
      • \n
    • \n

      \n Description: This happens when the user sends an empty\n XML document as a request. The error message is, \"Request body is empty.\"\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingSecurityElement

      \n
      • \n
    • \n

      \n Description: The SOAP 1.1 request is missing a security\n element.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingSecurityHeader

      \n
      • \n
    • \n

      \n Description: Your request is missing a required\n header.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoLoggingStatusForKey

      \n
      • \n
    • \n

      \n Description: There is no such thing as a logging status\n subresource for a key.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchBucket

      \n
      • \n
    • \n

      \n Description: The specified bucket does not\n exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchBucketPolicy

      \n
      • \n
    • \n

      \n Description: The specified bucket does not have a\n bucket policy.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchKey

      \n
      • \n
    • \n

      \n Description: The specified key does not exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchLifecycleConfiguration

      \n
      • \n
    • \n

      \n Description: The lifecycle configuration does not\n exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchUpload

      \n
      • \n
    • \n

      \n Description: The specified multipart upload does not\n exist. The upload ID might be invalid, or the multipart upload might have been\n aborted or completed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchVersion

      \n
      • \n
    • \n

      \n Description: Indicates that the version ID specified in\n the request does not match an existing version.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NotImplemented

      \n
      • \n
    • \n

      \n Description: A header you provided implies\n functionality that is not implemented.

      \n
      • \n
    • \n

      \n HTTP Status Code: 501 Not Implemented

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NotSignedUp

      \n
      • \n
    • \n

      \n Description: Your account is not signed up for the Amazon S3\n service. You must sign up before you can use Amazon S3. You can sign up at the\n following URL: https://aws.amazon.com/s3

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: OperationAborted

      \n
      • \n
    • \n

      \n Description: A conflicting conditional action is\n currently in progress against this resource. Try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: PermanentRedirect

      \n
      • \n
    • \n

      \n Description: The bucket you are attempting to access\n must be addressed using the specified endpoint. Send all future requests to\n this endpoint.

      \n
      • \n
    • \n

      \n HTTP Status Code: 301 Moved Permanently

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: PreconditionFailed

      \n
      • \n
    • \n

      \n Description: At least one of the preconditions you\n specified did not hold.

      \n
      • \n
    • \n

      \n HTTP Status Code: 412 Precondition Failed

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: Redirect

      \n
      • \n
    • \n

      \n Description: Temporary redirect.

      \n
      • \n
    • \n

      \n HTTP Status Code: 307 Moved Temporarily

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress

      \n
      • \n
    • \n

      \n Description: Object restore is already in\n progress.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestIsNotMultiPartContent

      \n
      • \n
    • \n

      \n Description: Bucket POST must be of the enclosure-type\n multipart/form-data.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTimeout

      \n
      • \n
    • \n

      \n Description: Your socket connection to the server was\n not read from or written to within the timeout period.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTimeTooSkewed

      \n
      • \n
    • \n

      \n Description: The difference between the request time\n and the server's time is too large.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTorrentOfBucketError

      \n
      • \n
    • \n

      \n Description: Requesting the torrent file of a bucket is\n not permitted.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: SignatureDoesNotMatch

      \n
      • \n
    • \n

      \n Description: The request signature we calculated does\n not match the signature you provided. Check your AWS secret access key and\n signing method. For more information, see REST Authentication and\n SOAP Authentication\n for details.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: ServiceUnavailable

      \n
      • \n
    • \n

      \n Description: Reduce your request rate.

      \n
      • \n
    • \n

      \n HTTP Status Code: 503 Service Unavailable

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: SlowDown

      \n
      • \n
    • \n

      \n Description: Reduce your request rate.

      \n
      • \n
    • \n

      \n HTTP Status Code: 503 Slow Down

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TemporaryRedirect

      \n
      • \n
    • \n

      \n Description: You are being redirected to the bucket\n while DNS updates.

      \n
      • \n
    • \n

      \n HTTP Status Code: 307 Moved Temporarily

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TokenRefreshRequired

      \n
      • \n
    • \n

      \n Description: The provided token must be\n refreshed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TooManyBuckets

      \n
      • \n
    • \n

      \n Description: You have attempted to create more buckets\n than allowed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UnexpectedContent

      \n
      • \n
    • \n

      \n Description: This request does not support\n content.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UnresolvableGrantByEmailAddress

      \n
      • \n
    • \n

      \n Description: The email address you provided does not\n match any account on record.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UserKeyMustBeSpecified

      \n
      • \n
    • \n

      \n Description: The bucket POST must contain the specified\n field name. If it is specified, check the order of the fields.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
\n

" + "smithy.api#documentation": "

The error code is a string that uniquely identifies an error condition. It is meant to\n be read and understood by programs that detect and handle errors by type.

\n

\n Amazon S3 error codes\n

\n
    \n
  • \n
      \n
    • \n

      \n Code: AccessDenied

      \n
      • \n
    • \n

      \n Description: Access Denied

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: AccountProblem

      \n
      • \n
    • \n

      \n Description: There is a problem with your Amazon Web Services account\n that prevents the action from completing successfully. Contact Amazon Web Services Support\n for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: AllAccessDisabled

      \n
      • \n
    • \n

      \n Description: All access to this Amazon S3 resource has been\n disabled. Contact Amazon Web Services Support for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: AmbiguousGrantByEmailAddress

      \n
      • \n
    • \n

      \n Description: The email address you provided is\n associated with more than one account.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: AuthorizationHeaderMalformed

      \n
      • \n
    • \n

      \n Description: The authorization header you provided is\n invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: BadDigest

      \n
      • \n
    • \n

      \n Description: The Content-MD5 you specified did not\n match what we received.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: BucketAlreadyExists

      \n
      • \n
    • \n

      \n Description: The requested bucket name is not\n available. The bucket namespace is shared by all users of the system. Please\n select a different name and try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: BucketAlreadyOwnedByYou

      \n
      • \n
    • \n

      \n Description: The bucket you tried to create already\n exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in\n the North Virginia Region. For legacy compatibility, if you re-create an\n existing bucket that you already own in the North Virginia Region, Amazon S3 returns\n 200 OK and resets the bucket access control lists (ACLs).

      \n
      • \n
    • \n

      \n Code: 409 Conflict (in all Regions except the North\n Virginia Region)

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: BucketNotEmpty

      \n
      • \n
    • \n

      \n Description: The bucket you tried to delete is not\n empty.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: CredentialsNotSupported

      \n
      • \n
    • \n

      \n Description: This request does not support\n credentials.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: CrossLocationLoggingProhibited

      \n
      • \n
    • \n

      \n Description: Cross-location logging not allowed.\n Buckets in one geographic location cannot log information to a bucket in\n another location.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: EntityTooSmall

      \n
      • \n
    • \n

      \n Description: Your proposed upload is smaller than the\n minimum allowed object size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: EntityTooLarge

      \n
      • \n
    • \n

      \n Description: Your proposed upload exceeds the maximum\n allowed object size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: ExpiredToken

      \n
      • \n
    • \n

      \n Description: The provided token has expired.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: IllegalVersioningConfigurationException

      \n
      • \n
    • \n

      \n Description: Indicates that the versioning\n configuration specified in the request is invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: IncompleteBody

      \n
      • \n
    • \n

      \n Description: You did not provide the number of bytes\n specified by the Content-Length HTTP header

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: IncorrectNumberOfFilesInPostRequest

      \n
      • \n
    • \n

      \n Description: POST requires exactly one file upload per\n request.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InlineDataTooLarge

      \n
      • \n
    • \n

      \n Description: Inline data exceeds the maximum allowed\n size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InternalError

      \n
      • \n
    • \n

      \n Description: We encountered an internal error. Please\n try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 500 Internal Server Error

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidAccessKeyId

      \n
      • \n
    • \n

      \n Description: The Amazon Web Services access key ID you provided does\n not exist in our records.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidAddressingHeader

      \n
      • \n
    • \n

      \n Description: You must specify the Anonymous\n role.

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidArgument

      \n
      • \n
    • \n

      \n Description: Invalid Argument

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidBucketName

      \n
      • \n
    • \n

      \n Description: The specified bucket is not valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidBucketState

      \n
      • \n
    • \n

      \n Description: The request is not valid with the current\n state of the bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidDigest

      \n
      • \n
    • \n

      \n Description: The Content-MD5 you specified is not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidEncryptionAlgorithmError

      \n
      • \n
    • \n

      \n Description: The encryption request you specified is\n not valid. The valid value is AES256.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidLocationConstraint

      \n
      • \n
    • \n

      \n Description: The specified location constraint is not\n valid. For more information about Regions, see How to Select a\n Region for Your Buckets.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidObjectState

      \n
      • \n
    • \n

      \n Description: The action is not valid for the current\n state of the object.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidPart

      \n
      • \n
    • \n

      \n Description: One or more of the specified parts could\n not be found. The part might not have been uploaded, or the specified entity\n tag might not have matched the part's entity tag.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidPartOrder

      \n
      • \n
    • \n

      \n Description: The list of parts was not in ascending\n order. Parts list must be specified in order by part number.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidPayer

      \n
      • \n
    • \n

      \n Description: All access to this object has been\n disabled. Please contact Amazon Web Services Support for further assistance.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidPolicyDocument

      \n
      • \n
    • \n

      \n Description: The content of the form does not meet the\n conditions specified in the policy document.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRange

      \n
      • \n
    • \n

      \n Description: The requested range cannot be\n satisfied.

      \n
      • \n
    • \n

      \n HTTP Status Code: 416 Requested Range Not\n Satisfiable

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Please use AWS4-HMAC-SHA256.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: SOAP requests must be made over an HTTPS\n connection.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with non-DNS compliant names.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with periods (.) in their names.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate endpoint only\n supports virtual style requests.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate is not configured\n on this bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Accelerate is disabled on\n this bucket.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration is not\n supported on this bucket. Contact Amazon Web Services Support for more information.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidRequest

      \n
      • \n
    • \n

      \n Description: Amazon S3 Transfer Acceleration cannot be\n enabled on this bucket. Contact Amazon Web Services Support for more information.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n Code: N/A

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidSecurity

      \n
      • \n
    • \n

      \n Description: The provided security credentials are not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidSOAPRequest

      \n
      • \n
    • \n

      \n Description: The SOAP request body is invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidStorageClass

      \n
      • \n
    • \n

      \n Description: The storage class you specified is not\n valid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidTargetBucketForLogging

      \n
      • \n
    • \n

      \n Description: The target bucket for logging does not\n exist, is not owned by you, or does not have the appropriate grants for the\n log-delivery group.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidToken

      \n
      • \n
    • \n

      \n Description: The provided token is malformed or\n otherwise invalid.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: InvalidURI

      \n
      • \n
    • \n

      \n Description: Couldn't parse the specified URI.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: KeyTooLongError

      \n
      • \n
    • \n

      \n Description: Your key is too long.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedACLError

      \n
      • \n
    • \n

      \n Description: The XML you provided was not well-formed\n or did not validate against our published schema.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedPOSTRequest

      \n
      • \n
    • \n

      \n Description: The body of your POST request is not\n well-formed multipart/form-data.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MalformedXML

      \n
      • \n
    • \n

      \n Description: This happens when the user sends malformed\n XML (XML that doesn't conform to the published XSD) for the configuration. The\n error message is, \"The XML you provided was not well-formed or did not validate\n against our published schema.\"

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MaxMessageLengthExceeded

      \n
      • \n
    • \n

      \n Description: Your request was too big.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MaxPostPreDataLengthExceededError

      \n
      • \n
    • \n

      \n Description: Your POST request fields preceding the\n upload file were too large.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MetadataTooLarge

      \n
      • \n
    • \n

      \n Description: Your metadata headers exceed the maximum\n allowed metadata size.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MethodNotAllowed

      \n
      • \n
    • \n

      \n Description: The specified method is not allowed\n against this resource.

      \n
      • \n
    • \n

      \n HTTP Status Code: 405 Method Not Allowed

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingAttachment

      \n
      • \n
    • \n

      \n Description: A SOAP attachment was expected, but none\n were found.

      \n
      • \n
    • \n

      \n HTTP Status Code: N/A

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingContentLength

      \n
      • \n
    • \n

      \n Description: You must provide the Content-Length HTTP\n header.

      \n
      • \n
    • \n

      \n HTTP Status Code: 411 Length Required

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingRequestBodyError

      \n
      • \n
    • \n

      \n Description: This happens when the user sends an empty\n XML document as a request. The error message is, \"Request body is empty.\"\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingSecurityElement

      \n
      • \n
    • \n

      \n Description: The SOAP 1.1 request is missing a security\n element.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: MissingSecurityHeader

      \n
      • \n
    • \n

      \n Description: Your request is missing a required\n header.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoLoggingStatusForKey

      \n
      • \n
    • \n

      \n Description: There is no such thing as a logging status\n subresource for a key.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchBucket

      \n
      • \n
    • \n

      \n Description: The specified bucket does not\n exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchBucketPolicy

      \n
      • \n
    • \n

      \n Description: The specified bucket does not have a\n bucket policy.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchKey

      \n
      • \n
    • \n

      \n Description: The specified key does not exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchLifecycleConfiguration

      \n
      • \n
    • \n

      \n Description: The lifecycle configuration does not\n exist.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchUpload

      \n
      • \n
    • \n

      \n Description: The specified multipart upload does not\n exist. The upload ID might be invalid, or the multipart upload might have been\n aborted or completed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NoSuchVersion

      \n
      • \n
    • \n

      \n Description: Indicates that the version ID specified in\n the request does not match an existing version.

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NotImplemented

      \n
      • \n
    • \n

      \n Description: A header you provided implies\n functionality that is not implemented.

      \n
      • \n
    • \n

      \n HTTP Status Code: 501 Not Implemented

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: NotSignedUp

      \n
      • \n
    • \n

      \n Description: Your account is not signed up for the Amazon S3\n service. You must sign up before you can use Amazon S3. You can sign up at the\n following URL: Amazon S3\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: OperationAborted

      \n
      • \n
    • \n

      \n Description: A conflicting conditional action is\n currently in progress against this resource. Try again.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: PermanentRedirect

      \n
      • \n
    • \n

      \n Description: The bucket you are attempting to access\n must be addressed using the specified endpoint. Send all future requests to\n this endpoint.

      \n
      • \n
    • \n

      \n HTTP Status Code: 301 Moved Permanently

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: PreconditionFailed

      \n
      • \n
    • \n

      \n Description: At least one of the preconditions you\n specified did not hold.

      \n
      • \n
    • \n

      \n HTTP Status Code: 412 Precondition Failed

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: Redirect

      \n
      • \n
    • \n

      \n Description: Temporary redirect.

      \n
      • \n
    • \n

      \n HTTP Status Code: 307 Moved Temporarily

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress

      \n
      • \n
    • \n

      \n Description: Object restore is already in\n progress.

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestIsNotMultiPartContent

      \n
      • \n
    • \n

      \n Description: Bucket POST must be of the enclosure-type\n multipart/form-data.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTimeout

      \n
      • \n
    • \n

      \n Description: Your socket connection to the server was\n not read from or written to within the timeout period.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTimeTooSkewed

      \n
      • \n
    • \n

      \n Description: The difference between the request time\n and the server's time is too large.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: RequestTorrentOfBucketError

      \n
      • \n
    • \n

      \n Description: Requesting the torrent file of a bucket is\n not permitted.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: SignatureDoesNotMatch

      \n
      • \n
    • \n

      \n Description: The request signature we calculated does\n not match the signature you provided. Check your Amazon Web Services secret access key and\n signing method. For more information, see REST Authentication and\n SOAP Authentication\n for details.

      \n
      • \n
    • \n

      \n HTTP Status Code: 403 Forbidden

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: ServiceUnavailable

      \n
      • \n
    • \n

      \n Description: Reduce your request rate.

      \n
      • \n
    • \n

      \n HTTP Status Code: 503 Service Unavailable

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: SlowDown

      \n
      • \n
    • \n

      \n Description: Reduce your request rate.

      \n
      • \n
    • \n

      \n HTTP Status Code: 503 Slow Down

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Server

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TemporaryRedirect

      \n
      • \n
    • \n

      \n Description: You are being redirected to the bucket\n while DNS updates.

      \n
      • \n
    • \n

      \n HTTP Status Code: 307 Moved Temporarily

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TokenRefreshRequired

      \n
      • \n
    • \n

      \n Description: The provided token must be\n refreshed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: TooManyBuckets

      \n
      • \n
    • \n

      \n Description: You have attempted to create more buckets\n than allowed.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UnexpectedContent

      \n
      • \n
    • \n

      \n Description: This request does not support\n content.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UnresolvableGrantByEmailAddress

      \n
      • \n
    • \n

      \n Description: The email address you provided does not\n match any account on record.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: UserKeyMustBeSpecified

      \n
      • \n
    • \n

      \n Description: The bucket POST must contain the specified\n field name. If it is specified, check the order of the fields.

      \n
      • \n
    • \n

      \n HTTP Status Code: 400 Bad Request

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client

      \n
      • \n
    \n
    • \n
\n

" } }, "Message": { @@ -4074,7 +4074,7 @@ }, "traits": { "aws.customizations#s3UnwrappedXmlOutput": {}, - "smithy.api#documentation": "

Returns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.

\n\n

To use this implementation of the operation, you must be the bucket owner.

\n\n

The following operations are related to GetBucketLocation:

\n ", + "smithy.api#documentation": "

Returns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.

\n\n

To use this implementation of the operation, you must be the bucket owner.

\n \n

To use this API against an access point, provide the alias of the access point in place of the bucket name.

\n\n

The following operations are related to GetBucketLocation:

\n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?location", @@ -4316,7 +4316,7 @@ "target": "com.amazonaws.s3#GetBucketPolicyOutput" }, "traits": { - "smithy.api#documentation": "

Returns the policy of a specified bucket. If you are using an identity other than the\n root user of the AWS account that owns the bucket, the calling identity must have the\n GetBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n\n

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n\n

The following action is related to GetBucketPolicy:

\n ", + "smithy.api#documentation": "

Returns the policy of a specified bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n GetBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n\n

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n\n

The following action is related to GetBucketPolicy:

\n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?policy", @@ -4700,7 +4700,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.

\n\n

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.

\n\n

To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.

\n\n

To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

\n\n

If the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.

\n\n

Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n
    \n
  • \n

    x-amz-server-side-encryption-customer-algorithm

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key-MD5

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n\n

Assuming you have permission to read object tags (permission for the\n s3:GetObjectVersionTagging action), the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n
    \n
  • \n

    If you have the s3:ListBucket permission on the bucket, Amazon S3 will\n return an HTTP status code 404 (\"no such key\") error.

    \n
    • \n
  • \n

    If you don’t have the s3:ListBucket permission, Amazon S3 will return an\n HTTP status code 403 (\"access denied\") error.

    \n
    • \n
\n\n\n

\n Versioning\n

\n

By default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.

\n\n \n

If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.

\n \n\n\n

For more information about versioning, see PutBucketVersioning.

\n\n

\n Overriding Response Header Values\n

\n

There are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.

\n\n

You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.

\n\n \n

You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.

\n \n
    \n
  • \n

    \n response-content-type\n

    \n
    • \n
  • \n

    \n response-content-language\n

    \n
    • \n
  • \n

    \n response-expires\n

    \n
    • \n
  • \n

    \n response-cache-control\n

    \n
    • \n
  • \n

    \n response-content-disposition\n

    \n
    • \n
  • \n

    \n response-content-encoding\n

    \n
    • \n
\n\n

\n Additional Considerations about Request Headers\n

\n\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.

\n\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.

\n\n

For more information about conditional requests, see RFC 7232.

\n\n

The following operations are related to GetObject:

\n ", + "smithy.api#documentation": "

Retrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.

\n\n

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.

\n\n

To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.

\n\n

To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

\n\n

If the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.

\n\n

Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services\n KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n
    \n
  • \n

    x-amz-server-side-encryption-customer-algorithm

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key-MD5

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n\n

Assuming you have permission to read object tags (permission for the\n s3:GetObjectVersionTagging action), the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n
    \n
  • \n

    If you have the s3:ListBucket permission on the bucket, Amazon S3 will\n return an HTTP status code 404 (\"no such key\") error.

    \n
    • \n
  • \n

    If you don’t have the s3:ListBucket permission, Amazon S3 will return an\n HTTP status code 403 (\"access denied\") error.

    \n
    • \n
\n\n\n

\n Versioning\n

\n

By default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.

\n\n \n
    \n
  • \n

    You need the s3:GetObjectVersion permission to access a specific version of an object.\n

    \n
    • \n
  • \n

    If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.

    \n
    • \n
\n \n\n\n

For more information about versioning, see PutBucketVersioning.

\n\n

\n Overriding Response Header Values\n

\n

There are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.

\n\n

You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.

\n\n \n

You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.

\n \n
    \n
  • \n

    \n response-content-type\n

    \n
    • \n
  • \n

    \n response-content-language\n

    \n
    • \n
  • \n

    \n response-expires\n

    \n
    • \n
  • \n

    \n response-cache-control\n

    \n
    • \n
  • \n

    \n response-content-disposition\n

    \n
    • \n
  • \n

    \n response-content-encoding\n

    \n
    • \n
\n\n

\n Additional Considerations about Request Headers\n

\n\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.

\n\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.

\n\n

For more information about conditional requests, see RFC 7232.

\n\n

The following operations are related to GetObject:

\n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}/{Key+}?x-id=GetObject", @@ -4763,7 +4763,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name that contains the object for which to get the ACL information.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name that contains the object for which to get the ACL information.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4833,7 +4833,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object whose Legal Hold status you want to retrieve.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object whose Legal Hold status you want to retrieve.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4903,7 +4903,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to retrieve.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket whose Object Lock configuration you want to retrieve.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5077,14 +5077,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#documentation": "

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -5151,7 +5151,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5329,7 +5329,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object whose retention settings you want to retrieve.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object whose retention settings you want to retrieve.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5409,7 +5409,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object for which to get the tagging information.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object for which to get the tagging information.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5628,7 +5628,7 @@ "EmailAddress": { "target": "com.amazonaws.s3#EmailAddress", "traits": { - "smithy.api#documentation": "

Email address of the grantee.

\n \n

Using email addresses to specify a grantee is only supported in the following AWS Regions:

\n
    \n
  • \n

    US East (N. Virginia)

    \n
    • \n
  • \n

    US West (N. California)

    \n
    • \n
  • \n

    US West (Oregon)

    \n
    • \n
  • \n

    Asia Pacific (Singapore)

    \n
    • \n
  • \n

    Asia Pacific (Sydney)

    \n
    • \n
  • \n

    Asia Pacific (Tokyo)

    \n
    • \n
  • \n

    Europe (Ireland)

    \n
    • \n
  • \n

    South America (São Paulo)

    \n
    • \n
\n

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

\n " + "smithy.api#documentation": "

Email address of the grantee.

\n \n

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

\n
    \n
  • \n

    US East (N. Virginia)

    \n
    • \n
  • \n

    US West (N. California)

    \n
    • \n
  • \n

    US West (Oregon)

    \n
    • \n
  • \n

    Asia Pacific (Singapore)

    \n
    • \n
  • \n

    Asia Pacific (Sydney)

    \n
    • \n
  • \n

    Asia Pacific (Tokyo)

    \n
    • \n
  • \n

    Europe (Ireland)

    \n
    • \n
  • \n

    South America (São Paulo)

    \n
    • \n
\n

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

\n " } }, "ID": { @@ -5677,7 +5677,7 @@ } ], "traits": { - "smithy.api#documentation": "

This action is useful to determine if a bucket exists and you have permission to\n access it. The action returns a 200 OK if the bucket exists and you have\n permission to access it.

\n \n \n

If the bucket does not exist or you do not have permission to access it, the HEAD request\n returns a generic 404 Not Found or 403 Forbidden code. A message body is not \n included, so you cannot determine the exception beyond these error codes.

\n\n

To use this operation, you must have permissions to perform the\n s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

", + "smithy.api#documentation": "

This action is useful to determine if a bucket exists and you have permission to\n access it. The action returns a 200 OK if the bucket exists and you have\n permission to access it.

\n \n \n

If the bucket does not exist or you do not have permission to access it, the HEAD request\n returns a generic 404 Not Found or 403 Forbidden code. A message body is not \n included, so you cannot determine the exception beyond these error codes.

\n\n

To use this operation, you must have permissions to perform the\n s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n\n

To use this API against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information see, Using access points.

", "smithy.api#http": { "method": "HEAD", "uri": "/{Bucket}", @@ -5721,7 +5721,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5749,7 +5749,7 @@ } ], "traits": { - "smithy.api#documentation": "

The HEAD action retrieves metadata from an object without returning the object\n itself. This action is useful if you're only interested in an object's metadata. To use\n HEAD, you must have READ access to the object.

\n\n

A HEAD request has the same options as a GET action on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic 404 Not Found or 403 Forbidden code. It is not \n possible to retrieve the exact exception beyond these error codes.

\n\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:

\n
    \n
  • \n

    x-amz-server-side-encryption-customer-algorithm

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key-MD5

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n \n
    \n
  • \n

    Encryption request headers, like x-amz-server-side-encryption, should\n not be sent for GET requests if your object uses server-side encryption with CMKs stored\n in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys\n (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest\n error.

    \n
    • \n
  • \n

    \n The last modified property in this case is the creation date of the object.

    \n
    • \n
\n \n\n\n

Request headers are limited to 8 KB in size. For more information, see Common Request\n Headers.

\n

Consider the following when using request headers:

\n
    \n
  • \n

    Consideration 1 – If both of the If-Match and\n If-Unmodified-Since headers are present in the request as\n follows:

    \n
      \n
    • \n

      \n If-Match condition evaluates to true, and;

      \n
      • \n
    • \n

      \n If-Unmodified-Since condition evaluates to\n false;

      \n
      • \n
    \n

    Then Amazon S3 returns 200 OK and the data requested.

    \n
    • \n
  • \n

    Consideration 2 – If both of the If-None-Match and\n If-Modified-Since headers are present in the request as\n follows:

    \n
      \n
    • \n

      \n If-None-Match condition evaluates to false,\n and;

      \n
      • \n
    • \n

      \n If-Modified-Since condition evaluates to\n true;

      \n
      • \n
    \n

    Then Amazon S3 returns the 304 Not Modified response code.

    \n
    • \n
\n\n

For more information about conditional requests, see RFC 7232.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n
    \n
  • \n

    If you have the s3:ListBucket permission on the bucket, Amazon S3 returns\n an HTTP status code 404 (\"no such key\") error.

    \n
    • \n
  • \n

    If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP\n status code 403 (\"access denied\") error.

    \n
    • \n
\n\n

The following action is related to HeadObject:

\n ", + "smithy.api#documentation": "

The HEAD action retrieves metadata from an object without returning the object\n itself. This action is useful if you're only interested in an object's metadata. To use\n HEAD, you must have READ access to the object.

\n\n

A HEAD request has the same options as a GET action on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic 404 Not Found or 403 Forbidden code. It is not \n possible to retrieve the exact exception beyond these error codes.

\n\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:

\n
    \n
  • \n

    x-amz-server-side-encryption-customer-algorithm

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key-MD5

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n \n
    \n
  • \n

    Encryption request headers, like x-amz-server-side-encryption, should\n not be sent for GET requests if your object uses server-side encryption with CMKs stored\n in Amazon Web Services KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys\n (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest\n error.

    \n
    • \n
  • \n

    \n The last modified property in this case is the creation date of the object.

    \n
    • \n
\n \n\n\n

Request headers are limited to 8 KB in size. For more information, see Common Request\n Headers.

\n

Consider the following when using request headers:

\n
    \n
  • \n

    Consideration 1 – If both of the If-Match and\n If-Unmodified-Since headers are present in the request as\n follows:

    \n
      \n
    • \n

      \n If-Match condition evaluates to true, and;

      \n
      • \n
    • \n

      \n If-Unmodified-Since condition evaluates to\n false;

      \n
      • \n
    \n

    Then Amazon S3 returns 200 OK and the data requested.

    \n
    • \n
  • \n

    Consideration 2 – If both of the If-None-Match and\n If-Modified-Since headers are present in the request as\n follows:

    \n
      \n
    • \n

      \n If-None-Match condition evaluates to false,\n and;

      \n
      • \n
    • \n

      \n If-Modified-Since condition evaluates to\n true;

      \n
      • \n
    \n

    Then Amazon S3 returns the 304 Not Modified response code.

    \n
    • \n
\n\n

For more information about conditional requests, see RFC 7232.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n
    \n
  • \n

    If you have the s3:ListBucket permission on the bucket, Amazon S3 returns\n an HTTP status code 404 (\"no such key\") error.

    \n
    • \n
  • \n

    If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP\n status code 403 (\"access denied\") error.

    \n
    • \n
\n\n

The following action is related to HeadObject:

\n ", "smithy.api#http": { "method": "HEAD", "uri": "/{Bucket}/{Key+}", @@ -5912,7 +5912,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

If the object is stored using server-side encryption either with an AWS KMS customer\n master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with\n the value of the server-side encryption algorithm used when storing this object in Amazon\n S3 (for example, AES256, aws:kms).

", + "smithy.api#documentation": "

If the object is stored using server-side encryption either with an Amazon Web Services KMS customer\n master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with\n the value of the server-side encryption algorithm used when storing this object in Amazon\n S3 (for example, AES256, aws:kms).

", "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, @@ -5940,14 +5940,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#documentation": "

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#documentation": "

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -6007,7 +6007,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6153,7 +6153,7 @@ "ID": { "target": "com.amazonaws.s3#ID", "traits": { - "smithy.api#documentation": "

If the principal is an AWS account, it provides the Canonical User ID. If the principal\n is an IAM User, it provides a user ARN value.

" + "smithy.api#documentation": "

If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal\n is an IAM User, it provides a user ARN value.

" } }, "DisplayName": { @@ -6701,7 +6701,7 @@ "LambdaFunctionArn": { "target": "com.amazonaws.s3#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the\n specified event type occurs.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the\n specified event type occurs.

", "smithy.api#required": {}, "smithy.api#xmlName": "CloudFunction" } @@ -6709,7 +6709,7 @@ "Events": { "target": "com.amazonaws.s3#EventList", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information,\n see Supported\n Event Types in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The Amazon S3 bucket event for which to invoke the Lambda function. For more information,\n see Supported\n Event Types in the Amazon S3 User Guide.

", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Event" @@ -6720,7 +6720,7 @@ } }, "traits": { - "smithy.api#documentation": "

A container for specifying the configuration for AWS Lambda notifications.

" + "smithy.api#documentation": "

A container for specifying the configuration for Lambda notifications.

" } }, "com.amazonaws.s3#LambdaFunctionConfigurationList": { @@ -7230,7 +7230,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

" + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

" } }, "KeyMarker": { @@ -7313,7 +7313,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7635,7 +7635,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket containing the objects.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket containing the objects.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7656,7 +7656,7 @@ "Marker": { "target": "com.amazonaws.s3#Marker", "traits": { - "smithy.api#documentation": "

Specifies the key to start with when listing objects in a bucket.

", + "smithy.api#documentation": "

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after\n this specified key. Marker can be any key in the bucket.

", "smithy.api#httpQuery": "marker" } }, @@ -7704,7 +7704,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use\n the request parameters as selection criteria to return a subset of the objects in a bucket. A \n 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately. \n Objects are returned sorted in an ascending order of the respective key names in the list.\n For more information about listing objects, see Listing object keys \n programmatically\n

\n\n

To use this operation, you must have READ access to the bucket.

\n\n

To use this action in an AWS Identity and Access Management (IAM) policy, you must\n have permissions to perform the s3:ListBucket action. The bucket owner has\n this permission by default and can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n \n

This section describes the latest revision of this action. We recommend that you use this\n revised API for application development. For backward compatibility, Amazon S3 continues to\n support the prior version of this API, ListObjects.

\n \n\n

To get a list of your buckets, see ListBuckets.

\n\n

The following operations are related to ListObjectsV2:

\n ", + "smithy.api#documentation": "

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use\n the request parameters as selection criteria to return a subset of the objects in a bucket. A \n 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately. \n Objects are returned sorted in an ascending order of the respective key names in the list.\n For more information about listing objects, see Listing object keys \n programmatically\n

\n\n

To use this operation, you must have READ access to the bucket.

\n\n

To use this action in an Identity and Access Management (IAM) policy, you must\n have permissions to perform the s3:ListBucket action. The bucket owner has\n this permission by default and can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n \n

This section describes the latest revision of this action. We recommend that you use this\n revised API for application development. For backward compatibility, Amazon S3 continues to\n support the prior version of this API, ListObjects.

\n \n\n

To get a list of your buckets, see ListBuckets.

\n\n

The following operations are related to ListObjectsV2:

\n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?list-type=2", @@ -7736,7 +7736,7 @@ "Name": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

" } }, "Prefix": { @@ -7805,7 +7805,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

Bucket name to list.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

Bucket name to list.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7918,7 +7918,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

" + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

" } }, "Key": { @@ -7968,7 +7968,7 @@ "Initiator": { "target": "com.amazonaws.s3#Initiator", "traits": { - "smithy.api#documentation": "

Container element that identifies who initiated the multipart upload. If the initiator\n is an AWS account, this element provides the same information as the Owner\n element. If the initiator is an IAM User, this element provides the user ARN and display\n name.

" + "smithy.api#documentation": "

Container element that identifies who initiated the multipart upload. If the initiator\n is an Amazon Web Services account, this element provides the same information as the Owner\n element. If the initiator is an IAM User, this element provides the user ARN and display\n name.

" } }, "Owner": { @@ -8000,7 +8000,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the parts are being uploaded.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket to which the parts are being uploaded.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8470,7 +8470,7 @@ "LambdaFunctionConfigurations": { "target": "com.amazonaws.s3#LambdaFunctionConfigurationList", "traits": { - "smithy.api#documentation": "

Describes the AWS Lambda functions to invoke and the events for which to invoke\n them.

", + "smithy.api#documentation": "

Describes the Lambda functions to invoke and the events for which to invoke\n them.

", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "CloudFunctionConfiguration" } @@ -8518,7 +8518,7 @@ "ETag": { "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "

The entity tag is a hash of the object. The ETag reflects changes only to the contents\n of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n data. Whether or not it is depends on how the object was created and how it is encrypted as\n described below:

\n
    \n
  • \n

    Objects created by the PUT Object, POST Object, or Copy operation, or through the\n AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are\n an MD5 digest of their object data.

    \n
    • \n
  • \n

    Objects created by the PUT Object, POST Object, or Copy operation, or through the\n AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are\n not an MD5 digest of their object data.

    \n
    • \n
  • \n

    If an object is created by either the Multipart Upload or Part Copy operation, the\n ETag is not an MD5 digest, regardless of the method of encryption.

    \n
    • \n
" + "smithy.api#documentation": "

The entity tag is a hash of the object. The ETag reflects changes only to the contents\n of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n data. Whether or not it is depends on how the object was created and how it is encrypted as\n described below:

\n
    \n
  • \n

    Objects created by the PUT Object, POST Object, or Copy operation, or through the\n Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are\n an MD5 digest of their object data.

    \n
    • \n
  • \n

    Objects created by the PUT Object, POST Object, or Copy operation, or through the\n Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are\n not an MD5 digest of their object data.

    \n
    • \n
  • \n

    If an object is created by either the Multipart Upload or Part Copy operation, the\n ETag is not an MD5 digest, regardless of the method of encryption.

    \n
    • \n
" } }, "Size": { @@ -9208,7 +9208,7 @@ "RestrictPublicBuckets": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only AWS service\n principals and authorized users within this account if the bucket has a public\n policy.

\n

Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.

", + "smithy.api#documentation": "

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only Amazon Web Service\n principals and authorized users within this account if the bucket has a public\n policy.

\n

Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.

", "smithy.api#xmlName": "RestrictPublicBuckets" } } @@ -9266,7 +9266,7 @@ "target": "com.amazonaws.s3#PutBucketAclRequest" }, "traits": { - "smithy.api#documentation": "

Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set\n the ACL of a bucket, you must have WRITE_ACP permission.

\n\n

You can use one of the following two ways to set a bucket's permissions:

\n
    \n
  • \n

    Specify the ACL in the request body

    \n
    • \n
  • \n

    Specify permissions using request headers

    \n
    • \n
\n\n \n

You cannot specify access permission using both the body and the request\n headers.

\n \n\n

Depending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.

\n\n\n

\n Access Permissions\n

\n

You can set access permissions using one of the following methods:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an AWS\n account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an AWS account

      \n \n

      Using email addresses to specify a grantee is only supported in the following AWS Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two AWS accounts identified by their email addresses.

    \n

    \n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n

    \n\n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>lt;/Grantee>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.

    \n \n

    Using email addresses to specify a grantee is only supported in the following AWS Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

    \n     \n
    • \n
\n\n\n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set\n the ACL of a bucket, you must have WRITE_ACP permission.

\n\n

You can use one of the following two ways to set a bucket's permissions:

\n
    \n
  • \n

    Specify the ACL in the request body

    \n
    • \n
  • \n

    Specify permissions using request headers

    \n
    • \n
\n\n \n

You cannot specify access permission using both the body and the request\n headers.

\n \n\n

Depending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.

\n\n\n

\n Access Permissions\n

\n

You can set access permissions using one of the following methods:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.

    \n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two Amazon Web Services accounts identified by their email addresses.

    \n

    \n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n

    \n\n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>lt;/Grantee>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n\n\n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?acl", @@ -9296,7 +9296,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -9432,7 +9432,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -9460,7 +9460,7 @@ "target": "com.amazonaws.s3#PutBucketEncryptionRequest" }, "traits": { - "smithy.api#documentation": "

This action uses the encryption subresource to configure default\n encryption and Amazon S3 Bucket Key for an existing bucket.

\n

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys\n (SSE-S3) or AWS KMS customer master keys (SSE-KMS). If you specify default encryption\n using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default\n encryption, see Amazon S3 default bucket encryption\n in the Amazon S3 User Guide. For more information about S3 Bucket Keys,\n see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

\n \n

This action requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature\n Version 4).

\n \n

To use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.

\n \n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

This action uses the encryption subresource to configure default\n encryption and Amazon S3 Bucket Key for an existing bucket.

\n

Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys\n (SSE-S3) or Amazon Web Services KMS customer master keys (SSE-KMS). If you specify default encryption\n using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default\n encryption, see Amazon S3 default bucket encryption\n in the Amazon S3 User Guide. For more information about S3 Bucket Keys,\n see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

\n \n

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature\n Version 4).

\n \n

To use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.

\n \n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?encryption", @@ -9475,7 +9475,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed\n keys (SSE-S3) or customer master keys stored in AWS KMS (SSE-KMS). For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption\n in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed\n keys (SSE-S3) or customer master keys stored in Amazon Web Services KMS (SSE-KMS). For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption\n in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9483,7 +9483,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -9554,7 +9554,7 @@ "target": "com.amazonaws.s3#PutBucketInventoryConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

This implementation of the PUT action adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.

\n

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same AWS Region as the\n source bucket.

\n

When you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3\n Inventory in the Amazon S3 User Guide.

\n \n

You must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see \n Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.

\n \n

\n Special Errors\n

\n
    \n
  • \n

    \n HTTP 400 Bad Request Error\n

    \n
      \n
    • \n

      \n Code: InvalidArgument

      \n
      • \n
    • \n

      \n Cause: Invalid Argument

      \n
      • \n
    \n
    • \n
  • \n

    \n HTTP 400 Bad Request Error\n

    \n
      \n
    • \n

      \n Code: TooManyConfigurations

      \n
      • \n
    • \n

      \n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.

      \n
      • \n
    \n
    • \n
  • \n

    \n HTTP 403 Forbidden Error\n

    \n
      \n
    • \n

      \n Code: AccessDenied

      \n
      • \n
    • \n

      \n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutInventoryConfiguration bucket\n permission to set the configuration on the bucket.

      \n
      • \n
    \n
    • \n
\n \n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

This implementation of the PUT action adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.

\n

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same Amazon Web Services Region as the\n source bucket.

\n

When you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3\n Inventory in the Amazon S3 User Guide.

\n \n

You must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see \n Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.

\n \n

\n Special Errors\n

\n
    \n
  • \n

    \n HTTP 400 Bad Request Error\n

    \n
      \n
    • \n

      \n Code: InvalidArgument

      \n
      • \n
    • \n

      \n Cause: Invalid Argument

      \n
      • \n
    \n
    • \n
  • \n

    \n HTTP 400 Bad Request Error\n

    \n
      \n
    • \n

      \n Code: TooManyConfigurations

      \n
      • \n
    • \n

      \n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.

      \n
      • \n
    \n
    • \n
  • \n

    \n HTTP 403 Forbidden Error\n

    \n
      \n
    • \n

      \n Code: AccessDenied

      \n
      • \n
    • \n

      \n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutInventoryConfiguration bucket\n permission to set the configuration on the bucket.

      \n
      • \n
    \n
    • \n
\n \n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?inventory", @@ -9605,7 +9605,7 @@ "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. For information about lifecycle configuration, see Managing your storage\n lifecycle.

\n\n \n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.

\n \n\n \n\n

\n Rules\n

\n

You specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. Each rule consists of\n the following:

\n\n
    \n
  • \n

    Filter identifying a subset of objects to which the rule applies. The filter can\n be based on a key name prefix, object tags, or a combination of both.

    \n
    • \n
  • \n

    Status whether the rule is in effect.

    \n
    • \n
  • \n

    One or more lifecycle transition and expiration actions that you want Amazon S3 to\n perform on the objects identified by the filter. If the state of your bucket is\n versioning-enabled or versioning-suspended, you can have many versions of the same\n object (one current version and zero or more noncurrent versions). Amazon S3 provides\n predefined actions that you can specify for current and noncurrent object\n versions.

    \n
    • \n
\n\n

For more information, see Object\n Lifecycle Management and Lifecycle Configuration Elements.

\n\n\n

\n Permissions\n

\n\n\n

By default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the AWS account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.

\n\n

You can also explicitly deny permissions. Explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:

\n\n
    \n
  • \n

    s3:DeleteObject

    \n
    • \n
  • \n

    s3:DeleteObjectVersion

    \n
    • \n
  • \n

    s3:PutLifecycleConfiguration

    \n
    • \n
\n\n\n

For more information about permissions, see Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

The following are related to PutBucketLifecycleConfiguration:

\n ", + "smithy.api#documentation": "

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. For information about lifecycle configuration, see Managing your storage\n lifecycle.

\n\n \n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.

\n \n\n \n\n

\n Rules\n

\n

You specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. Each rule consists of\n the following:

\n\n
    \n
  • \n

    Filter identifying a subset of objects to which the rule applies. The filter can\n be based on a key name prefix, object tags, or a combination of both.

    \n
    • \n
  • \n

    Status whether the rule is in effect.

    \n
    • \n
  • \n

    One or more lifecycle transition and expiration actions that you want Amazon S3 to\n perform on the objects identified by the filter. If the state of your bucket is\n versioning-enabled or versioning-suspended, you can have many versions of the same\n object (one current version and zero or more noncurrent versions). Amazon S3 provides\n predefined actions that you can specify for current and noncurrent object\n versions.

    \n
    • \n
\n\n

For more information, see Object\n Lifecycle Management and Lifecycle Configuration Elements.

\n\n\n

\n Permissions\n

\n\n\n

By default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the Amazon Web Services account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.

\n\n

You can also explicitly deny permissions. Explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:

\n\n
    \n
  • \n

    s3:DeleteObject

    \n
    • \n
  • \n

    s3:DeleteObjectVersion

    \n
    • \n
  • \n

    s3:PutLifecycleConfiguration

    \n
    • \n
\n\n\n

For more information about permissions, see Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

The following are related to PutBucketLifecycleConfiguration:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?lifecycle", @@ -9648,7 +9648,7 @@ "target": "com.amazonaws.s3#PutBucketLoggingRequest" }, "traits": { - "smithy.api#documentation": "

Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same AWS Region as the\n source bucket. To set the logging status of a bucket, you must be the bucket owner.

\n\n

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.

\n\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request.

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
\n\n\n

To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:

\n\n

\n \n

\n\n

For more information about server access logging, see Server Access Logging.

\n\n

For more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.

\n\n

The following operations are related to PutBucketLogging:

\n ", + "smithy.api#documentation": "

Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the\n source bucket. To set the logging status of a bucket, you must be the bucket owner.

\n\n

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.

\n\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request.

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
\n\n\n

To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:

\n\n

\n \n

\n\n

For more information about server access logging, see Server Access Logging.

\n\n

For more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.

\n\n

The following operations are related to PutBucketLogging:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?logging", @@ -9671,7 +9671,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The MD5 hash of the PutBucketLogging request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The MD5 hash of the PutBucketLogging request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -9750,7 +9750,7 @@ "target": "com.amazonaws.s3#PutBucketNotificationConfigurationRequest" }, "traits": { - "smithy.api#documentation": "

Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.

\n\n

Using this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.

\n\n

By default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.

\n\n

\n \n

\n

\n \n

\n

This action replaces the existing notification configuration with the configuration\n you include in the request body.

\n\n

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3\n Events.

\n\n

You can disable notifications by adding the empty NotificationConfiguration\n element.

\n\n

By default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with s3:PutBucketNotification permission.

\n\n \n

The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add\n the configuration to your bucket.

\n \n\n

\n Responses\n

\n

If the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.

\n\n

The following action is related to\n PutBucketNotificationConfiguration:

\n ", + "smithy.api#documentation": "

Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.

\n\n

Using this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.

\n\n

By default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.

\n\n

\n \n

\n

\n \n

\n

This action replaces the existing notification configuration with the configuration\n you include in the request body.

\n\n

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3\n Events.

\n\n

You can disable notifications by adding the empty NotificationConfiguration\n element.

\n\n

By default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with s3:PutBucketNotification permission.

\n\n \n

The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add\n the configuration to your bucket.

\n \n\n

\n Responses\n

\n

If the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.

\n\n

The following action is related to\n PutBucketNotificationConfiguration:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?notification", @@ -9815,7 +9815,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The MD5 hash of the OwnershipControls request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The MD5 hash of the OwnershipControls request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -9843,7 +9843,7 @@ "target": "com.amazonaws.s3#PutBucketPolicyRequest" }, "traits": { - "smithy.api#documentation": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the AWS account that owns the bucket, the calling identity must have the\n PutBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n\n

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n\n\n

For more information about bucket policies, see Using Bucket Policies and User\n Policies.

\n\n

The following operations are related to PutBucketPolicy:

\n ", + "smithy.api#documentation": "

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n PutBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.

\n\n

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.

\n\n \n

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.

\n \n

For more information, see Bucket policy examples.

\n\n

The following operations are related to PutBucketPolicy:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?policy", @@ -9866,7 +9866,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The MD5 hash of the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The MD5 hash of the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -9900,7 +9900,7 @@ "target": "com.amazonaws.s3#PutBucketReplicationRequest" }, "traits": { - "smithy.api#documentation": "

Creates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.

\n \n

To perform this operation, the user or role performing the action must have the\n iam:PassRole permission.

\n \n

Specify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information.

\n\n\n

A replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.

\n\n

To specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n \n

For information about enabling versioning on a bucket, see Using Versioning.

\n\n

By default, a resource owner, in this case the AWS account that created the bucket, can\n perform this operation. The resource owner can also grant others permissions to perform the\n operation. For more information about permissions, see Specifying Permissions in a Policy\n and Managing Access Permissions to Your\n Amazon S3 Resources.

\n\n

\n Handling Replication of Encrypted Objects\n

\n

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the\n following: SourceSelectionCriteria, SseKmsEncryptedObjects,\n Status, EncryptionConfiguration, and\n ReplicaKmsKeyID. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using CMKs stored in AWS KMS.

\n\n

For information on PutBucketReplication errors, see List of\n replication-related error codes\n

\n\n\n

The following operations are related to PutBucketReplication:

\n ", + "smithy.api#documentation": "

Creates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.

\n \n

Specify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information.

\n\n\n

A replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.

\n\n

To specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.

\n \n

If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.

\n \n

For information about enabling versioning on a bucket, see Using Versioning.

\n\n

\n Handling Replication of Encrypted Objects\n

\n

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with CMKs stored in Amazon Web Services KMS. To replicate Amazon Web Services KMS-encrypted objects, add the\n following: SourceSelectionCriteria, SseKmsEncryptedObjects,\n Status, EncryptionConfiguration, and\n ReplicaKmsKeyID. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using CMKs stored in Amazon Web Services KMS.

\n\n

For information on PutBucketReplication errors, see List of\n replication-related error codes\n

\n\n

\n Permissions\n

\n

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration \n permissions for the bucket. \n

\n

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can\n perform this operation. The resource owner can also grant others permissions to perform the\n operation. For more information about permissions, see Specifying Permissions in a Policy\n and Managing Access Permissions to Your\n Amazon S3 Resources.

\n \n

To perform this operation, the user or role performing the action must have the\n iam:PassRole permission.

\n \n\n

The following operations are related to PutBucketReplication:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?replication", @@ -9923,7 +9923,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -9980,7 +9980,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10008,7 +10008,7 @@ "target": "com.amazonaws.s3#PutBucketTaggingRequest" }, "traits": { - "smithy.api#documentation": "

Sets the tags for a bucket.

\n

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign\n up to get your AWS account bill with tag key values included. Then, to see the cost of\n combined resources, organize your billing information according to resources with the same\n tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation\n and Tagging and Using Cost Allocation in Amazon S3 Bucket\n Tags.

\n\n \n

\n When this operation sets the tags for a bucket, it will overwrite any current tags the \n bucket already has. You cannot use this operation to add tags to an existing list of tags.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

\n PutBucketTagging has the following special errors:

\n
    \n
  • \n

    Error code: InvalidTagError\n

    \n \n
    • \n
  • \n

    Error code: MalformedXMLError\n

    \n
      \n
    • \n

      Description: The XML provided does not match the schema.

      \n
      • \n
    \n
    • \n
  • \n

    Error code: OperationAbortedError \n

    \n
      \n
    • \n

      Description: A conflicting conditional action is currently in progress\n against this resource. Please try again.

      \n
      • \n
    \n
    • \n
  • \n

    Error code: InternalError\n

    \n
      \n
    • \n

      Description: The service was unable to apply the provided tag to the\n bucket.

      \n
      • \n
    \n
    • \n
\n\n\n

The following operations are related to PutBucketTagging:

\n ", + "smithy.api#documentation": "

Sets the tags for a bucket.

\n

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign\n up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of\n combined resources, organize your billing information according to resources with the same\n tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation\n and Tagging and Using Cost Allocation in Amazon S3 Bucket\n Tags.

\n\n \n

\n When this operation sets the tags for a bucket, it will overwrite any current tags the \n bucket already has. You cannot use this operation to add tags to an existing list of tags.

\n \n

To use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.

\n\n

\n PutBucketTagging has the following special errors:

\n
    \n
  • \n

    Error code: InvalidTagError\n

    \n \n
    • \n
  • \n

    Error code: MalformedXMLError\n

    \n
      \n
    • \n

      Description: The XML provided does not match the schema.

      \n
      • \n
    \n
    • \n
  • \n

    Error code: OperationAbortedError \n

    \n
      \n
    • \n

      Description: A conflicting conditional action is currently in progress\n against this resource. Please try again.

      \n
      • \n
    \n
    • \n
  • \n

    Error code: InternalError\n

    \n
      \n
    • \n

      Description: The service was unable to apply the provided tag to the\n bucket.

      \n
      • \n
    \n
    • \n
\n\n\n

The following operations are related to PutBucketTagging:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?tagging", @@ -10031,7 +10031,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10082,7 +10082,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10140,7 +10140,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10171,7 +10171,7 @@ "target": "com.amazonaws.s3#PutObjectOutput" }, "traits": { - "smithy.api#documentation": "

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.

\n\n\n

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket.

\n\n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object\n locking; if you need this, make sure to build it into your application layer or use\n versioning instead.

\n\n

To ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.

\n \n

The Content-MD5 header is required for any request to upload an object\n with a retention period configured using Amazon S3 Object Lock. For more information about\n Amazon S3 Object Lock, see Amazon S3 Object Lock Overview\n in the Amazon S3 User Guide.

\n \n\n\n

\n Server-side Encryption\n

\n

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts \n your data as it writes it to disks in its data centers and decrypts the data\n when you access it. You have the option to provide your own encryption key or use AWS\n managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side\n Encryption.

\n

If you request server-side encryption using AWS Key Management Service (SSE-KMS), you can enable \n an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the \n Amazon S3 User Guide.

\n

\n Access Control List (ACL)-Specific Request\n Headers\n

\n

You can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.

\n\n

\n Storage Class Options\n

\n

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.

\n\n\n

\n Versioning\n

\n

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects.

\n

For more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.

\n\n\n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.

\n\n\n

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket.

\n\n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object\n locking; if you need this, make sure to build it into your application layer or use\n versioning instead.

\n\n

To ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.

\n \n
    \n
  • \n

    To successfully complete the PutObject request, you must have the \n s3:PutObject in your IAM permissions.

    \n
    • \n
  • \n

    To successfully change the objects acl of your PutObject request, \n you must have the s3:PutObjectAcl in your IAM permissions.

    \n
    • \n
  • \n

    The Content-MD5 header is required for any request to upload an object\n with a retention period configured using Amazon S3 Object Lock. For more information about\n Amazon S3 Object Lock, see Amazon S3 Object Lock Overview\n in the Amazon S3 User Guide.

    \n
    • \n
\n \n\n

\n Server-side Encryption\n

\n

You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts \n your data as it writes it to disks in its data centers and decrypts the data\n when you access it. You have the option to provide your own encryption key or use Amazon Web Services\n managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side\n Encryption.

\n

If you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable \n an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the \n Amazon S3 User Guide.

\n

\n Access Control List (ACL)-Specific Request\n Headers\n

\n

You can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.

\n\n

\n Storage Class Options\n

\n

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.

\n\n\n

\n Versioning\n

\n

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects.

\n

For more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.

\n\n\n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?x-id=PutObject", @@ -10193,7 +10193,7 @@ } ], "traits": { - "smithy.api#documentation": "

Uses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.

\n

This action is not supported by Amazon S3 on Outposts.

\n

Depending on your application needs, you can choose to set\n the ACL on an object using either the request body or the headers. For example, if you have\n an existing application that updates a bucket ACL using the request body, you can continue\n to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

\n\n\n\n

\n Access Permissions\n

\n

You can set access permissions using one of the following methods:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.

    \n\n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an AWS\n account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an AWS account

      \n \n

      Using email addresses to specify a grantee is only supported in the following AWS Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants list\n objects permission to the two AWS accounts identified by their email\n addresses.

    \n

    \n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n

    \n\n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request.

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>lt;/Grantee>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.

    \n \n

    Using email addresses to specify a grantee is only supported in the following AWS Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.

    \n     \n
    • \n
\n

\n Versioning\n

\n

The ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.

\n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

Uses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.

\n

This action is not supported by Amazon S3 on Outposts.

\n

Depending on your application needs, you can choose to set\n the ACL on an object using either the request body or the headers. For example, if you have\n an existing application that updates a bucket ACL using the request body, you can continue\n to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

\n\n\n\n

\n Access Permissions\n

\n

You can set access permissions using one of the following methods:

\n
    \n
  • \n

    Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.

    \n
    • \n
  • \n

    Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.

    \n\n

    You specify each grantee as a type=value pair, where the type is one of the\n following:

    \n
      \n
    • \n

      \n id – if the value specified is the canonical user ID of an Amazon Web Services account

      \n
      • \n
    • \n

      \n uri – if you are granting permissions to a predefined\n group

      \n
      • \n
    • \n

      \n emailAddress – if the value specified is the email address of\n an Amazon Web Services account

      \n \n

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      \n
        \n
      • \n

        US East (N. Virginia)

        \n
        • \n
      • \n

        US West (N. California)

        \n
        • \n
      • \n

        US West (Oregon)

        \n
        • \n
      • \n

        Asia Pacific (Singapore)

        \n
        • \n
      • \n

        Asia Pacific (Sydney)

        \n
        • \n
      • \n

        Asia Pacific (Tokyo)

        \n
        • \n
      • \n

        Europe (Ireland)

        \n
        • \n
      • \n

        South America (São Paulo)

        \n
        • \n
      \n

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

      \n       \n
      • \n
    \n

    For example, the following x-amz-grant-read header grants list\n objects permission to the two Amazon Web Services accounts identified by their email\n addresses.

    \n

    \n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n

    \n\n
    • \n
\n

You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.

\n

\n Grantee Values\n

\n

You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:

\n
    \n
  • \n

    By the person's ID:

    \n

    \n <>ID<><>GranteesEmail<>\n \n

    \n

    DisplayName is optional and ignored in the request.

    \n
    • \n
  • \n

    By URI:

    \n

    \n <>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<>\n

    \n
    • \n
  • \n

    By Email address:

    \n

    \n <>Grantees@email.com<>lt;/Grantee>\n

    \n

    The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.

    \n \n

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    \n
      \n
    • \n

      US East (N. Virginia)

      \n
      • \n
    • \n

      US West (N. California)

      \n
      • \n
    • \n

      US West (Oregon)

      \n
      • \n
    • \n

      Asia Pacific (Singapore)

      \n
      • \n
    • \n

      Asia Pacific (Sydney)

      \n
      • \n
    • \n

      Asia Pacific (Tokyo)

      \n
      • \n
    • \n

      Europe (Ireland)

      \n
      • \n
    • \n

      South America (São Paulo)

      \n
      • \n
    \n

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    \n     \n
    • \n
\n

\n Versioning\n

\n

The ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.

\n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?acl", @@ -10226,7 +10226,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name that contains the object to which you want to attach the ACL.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name that contains the object to which you want to attach the ACL.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10234,7 +10234,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.>\n

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.>\n

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10276,7 +10276,7 @@ "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "

Key for which the PUT action was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

Key for which the PUT action was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10346,7 +10346,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object that you want to place a Legal Hold on.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object that you want to place a Legal Hold on.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10375,7 +10375,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10405,7 +10405,7 @@ "target": "com.amazonaws.s3#PutObjectLockConfigurationOutput" }, "traits": { - "smithy.api#documentation": "

Places an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket. For more information, see Locking Objects.\n

\n \n
    \n
  • \n

    The DefaultRetention settings require both a mode and a\n period.

    \n
    • \n
  • \n

    The DefaultRetention period can be either Days\n or Years but you must select one. You cannot specify Days\n and Years at the same time.

    \n
    • \n
  • \n

    You can only enable Object Lock for new buckets. If you want to turn on\n Object Lock for an existing bucket, contact AWS Support.

    \n
    • \n
\n ", + "smithy.api#documentation": "

Places an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket. For more information, see Locking Objects.\n

\n \n
    \n
  • \n

    The DefaultRetention settings require both a mode and a\n period.

    \n
    • \n
  • \n

    The DefaultRetention period can be either Days\n or Years but you must select one. You cannot specify Days\n and Years at the same time.

    \n
    • \n
  • \n

    You can only enable Object Lock for new buckets. If you want to turn on\n Object Lock for an existing bucket, contact Amazon Web Services Support.

    \n
    • \n
\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?object-lock", @@ -10452,7 +10452,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10493,7 +10493,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

If you specified server-side encryption either with an AWS KMS customer master key (CMK)\n or Amazon S3-managed encryption key in your PUT request, the response includes this header. It\n confirms the encryption algorithm that Amazon S3 used to encrypt the object.

", + "smithy.api#documentation": "

If you specified server-side encryption either with an Amazon Web Services KMS customer master key (CMK)\n or Amazon S3-managed encryption key in your PUT request, the response includes this header. It\n confirms the encryption algorithm that Amazon S3 used to encrypt the object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, @@ -10521,21 +10521,21 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the\n object.

", + "smithy.api#documentation": "

If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service\n (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for the\n object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", + "smithy.api#documentation": "

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#documentation": "

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -10567,7 +10567,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name to which the PUT action was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name to which the PUT action was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10716,14 +10716,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the\n object. If you specify x-amz-server-side-encryption:aws:kms, but do not\n provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS\n managed CMK in AWS to protect the data. If the KMS key does not exist in the same account\n issuing the command, you must use the full ARN and not just the ID.\n

", + "smithy.api#documentation": "

If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service\n (Amazon Web Services KMS) symmetrical customer managed customer master key (CMK) that was used for the\n object. If you specify x-amz-server-side-encryption:aws:kms, but do not\n provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services\n managed CMK in Amazon Web Services to protect the data. If the KMS key does not exist in the same account\n issuing the command, you must use the full ARN and not just the ID.\n

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", + "smithy.api#documentation": "

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, @@ -10786,7 +10786,7 @@ "target": "com.amazonaws.s3#PutObjectRetentionOutput" }, "traits": { - "smithy.api#documentation": "

Places an Object Retention configuration on an object. For more information, see Locking Objects.\n

\n

This action is not supported by Amazon S3 on Outposts.

", + "smithy.api#documentation": "

Places an Object Retention configuration on an object. For more information, see Locking Objects.\n Users or accounts require the s3:PutObjectRetention permission in order to place\n an Object Retention configuration on objects. Bypassing a Governance Retention configuration\n requires the s3:BypassGovernanceRetention permission.\n

\n

This action is not supported by Amazon S3 on Outposts.

\n\n

\n Permissions\n

\n

When the Object Lock retention mode is set to compliance, you need s3:PutObjectRetention and \n s3:BypassGovernanceRetention permissions. For other requests to PutObjectRetention, \n only s3:PutObjectRetention permissions are required.

", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?retention", @@ -10812,7 +10812,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name that contains the object you want to apply this Object Retention\n configuration to.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name that contains the object you want to apply this Object Retention\n configuration to.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10848,7 +10848,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10905,7 +10905,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10928,7 +10928,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The MD5 hash for the request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -10985,7 +10985,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The MD5 hash of the PutPublicAccessBlock request body.

\n

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

", + "smithy.api#documentation": "

The MD5 hash of the PutPublicAccessBlock request body.

\n

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

", "smithy.api#httpHeader": "Content-MD5" } }, @@ -11196,7 +11196,7 @@ "Role": { "target": "com.amazonaws.s3#Role", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n Amazon S3 assumes when replicating objects. For more information, see How to Set Up\n Replication in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that\n Amazon S3 assumes when replicating objects. For more information, see How to Set Up\n Replication in the Amazon S3 User Guide.

", "smithy.api#required": {} } }, @@ -11249,7 +11249,7 @@ "SourceSelectionCriteria": { "target": "com.amazonaws.s3#SourceSelectionCriteria", "traits": { - "smithy.api#documentation": "

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n Service (SSE-KMS).

" + "smithy.api#documentation": "

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in Amazon Web Services Key Management\n Service (SSE-KMS).

" } }, "ExistingObjectReplication": { @@ -11408,7 +11408,7 @@ "Minutes": { "target": "com.amazonaws.s3#Minutes", "traits": { - "smithy.api#documentation": "

Contains an integer specifying time in minutes.

\n

Valid values: 15 minutes.

" + "smithy.api#documentation": "

Contains an integer specifying time in minutes.

\n

Valid value: 15

" } } }, @@ -11513,7 +11513,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restores an archived copy of an object back into Amazon S3

\n

This action is not supported by Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n
    \n
  • \n

    \n select - Perform a select query on an archived object

    \n
    • \n
  • \n

    \n restore an archive - Restore an archived object

    \n
    • \n
\n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.

\n

\n Querying Archives with Select Requests\n

\n

You use a select type of request to perform SQL queries on archived objects. The\n archived objects that are being queried by the select request must be formatted as\n uncompressed comma-separated values (CSV) files. You can run queries and custom analytics\n on your archived data without having to restore your data to a hotter Amazon S3 tier. For an\n overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide.

\n

When making a select request, do the following:

\n
    \n
  • \n

    Define an output location for the select query's output. This must be an Amazon S3\n bucket in the same AWS Region as the bucket that contains the archive object that is\n being queried. The AWS account that initiates the job must have permissions to write\n to the S3 bucket. You can specify the storage class and encryption for the output\n objects stored in the bucket. For more information about output, see Querying Archived Objects\n in the Amazon S3 User Guide.

    \n

    For more information about the S3 structure in the request body, see\n the following:

    \n \n
    • \n
  • \n

    Define the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.

    \n
      \n
    • \n

      The following expression returns all records from the specified\n object.

      \n

      \n SELECT * FROM Object\n

      \n
      • \n
    • \n

      Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.

      \n

      \n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100\n

      \n
      • \n
    • \n

      If you have headers and you set the fileHeaderInfo in the\n CSV structure in the request body to USE, you can\n specify headers in the query. (If you set the fileHeaderInfo field\n to IGNORE, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.

      \n

      \n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s\n

      \n
      • \n
    \n
    • \n
\n

For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and\n S3 Glacier Select in the Amazon S3 User Guide.

\n

When making a select request, you can also do the following:

\n
    \n
  • \n

    To expedite your queries, specify the Expedited tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.

    \n
    • \n
  • \n

    Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.

    \n
    • \n
\n

The following are additional important facts about the select feature:

\n
    \n
  • \n

    The output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle policy.

    \n
    • \n
  • \n

    You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n deduplicate requests, so avoid issuing duplicate requests.

    \n
    • \n
  • \n

    Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409.

    \n
    • \n
\n

\n Restoring objects\n

\n

Objects that you archive to the S3 Glacier or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in\n Archive Access or Deep Archive Access tiers you must first initiate a restore request, and\n then wait until the object is moved into the Frequent Access tier. For objects in\n S3 Glacier or S3 Glacier Deep Archive storage classes you must\n first initiate a restore request, and then wait until a temporary copy of the object is\n available. To access an archived object, you must restore the object for the duration\n (number of days) that you specify.

\n

To restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object (or using a select request), you can specify one of\n the following data access tier options in the Tier element of the request\n body:

\n
    \n
  • \n

    \n \n Expedited\n - Expedited retrievals\n allow you to quickly access your data stored in the S3 Glacier\n storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a\n subset of archives are required. For all but the largest archived objects (250 MB+),\n data accessed using Expedited retrievals is typically made available within 1–5\n minutes. Provisioned capacity ensures that retrieval capacity for Expedited\n retrievals is available when you need it. Expedited retrievals and provisioned\n capacity are not available for objects stored in the S3 Glacier Deep Archive\n storage class or S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
  • \n

    \n \n Standard\n - Standard retrievals allow\n you to access any of your archived objects within several hours. This is the default\n option for retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3–5 hours for objects stored in the\n S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They\n typically finish within 12 hours for objects stored in the\n S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.\n Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

    \n
    • \n
  • \n

    \n \n Bulk\n - Bulk retrievals are the\n lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts,\n even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12\n hours for objects stored in the S3 Glacier storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored\n in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.\n Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.

    \n
    • \n
\n

For more information about archive retrieval options and provisioned capacity for\n Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see \n Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.

\n

To get the status of object restoration, you can send a HEAD request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in\n the Amazon S3 User Guide.

\n

After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in\n Amazon S3 User Guide.

\n

\n Responses\n

\n

A successful action returns either the 200 OK or 202\n Accepted status code.

\n
    \n
  • \n

    If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

    \n
    • \n
  • \n

    If the object is previously restored, Amazon S3 returns 200 OK in the\n response.

    \n
    • \n
\n

\n Special Errors\n

\n
    \n
  • \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress\n

      \n
      • \n
    • \n

      \n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client\n

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: GlacierExpeditedRetrievalNotAvailable\n

      \n
      • \n
    • \n

      \n Cause: expedited retrievals are currently not available. Try again\n later. (Returned if there is insufficient capacity to process the Expedited\n request. This error applies only to Expedited retrievals and not to\n S3 Standard or Bulk retrievals.)\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 503\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: N/A\n

      \n
      • \n
    \n
    • \n
\n \n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

Restores an archived copy of an object back into Amazon S3

\n

This action is not supported by Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n
    \n
  • \n

    \n select - Perform a select query on an archived object

    \n
    • \n
  • \n

    \n restore an archive - Restore an archived object

    \n
    • \n
\n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.

\n

\n Querying Archives with Select Requests\n

\n

You use a select type of request to perform SQL queries on archived objects. The\n archived objects that are being queried by the select request must be formatted as\n uncompressed comma-separated values (CSV) files. You can run queries and custom analytics\n on your archived data without having to restore your data to a hotter Amazon S3 tier. For an\n overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide.

\n

When making a select request, do the following:

\n
    \n
  • \n

    Define an output location for the select query's output. This must be an Amazon S3\n bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is\n being queried. The Amazon Web Services account that initiates the job must have permissions to write\n to the S3 bucket. You can specify the storage class and encryption for the output\n objects stored in the bucket. For more information about output, see Querying Archived Objects\n in the Amazon S3 User Guide.

    \n

    For more information about the S3 structure in the request body, see\n the following:

    \n \n
    • \n
  • \n

    Define the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.

    \n
      \n
    • \n

      The following expression returns all records from the specified\n object.

      \n

      \n SELECT * FROM Object\n

      \n
      • \n
    • \n

      Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.

      \n

      \n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100\n

      \n
      • \n
    • \n

      If you have headers and you set the fileHeaderInfo in the\n CSV structure in the request body to USE, you can\n specify headers in the query. (If you set the fileHeaderInfo field\n to IGNORE, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.

      \n

      \n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s\n

      \n
      • \n
    \n
    • \n
\n

For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and\n S3 Glacier Select in the Amazon S3 User Guide.

\n

When making a select request, you can also do the following:

\n
    \n
  • \n

    To expedite your queries, specify the Expedited tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.

    \n
    • \n
  • \n

    Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.

    \n
    • \n
\n

The following are additional important facts about the select feature:

\n
    \n
  • \n

    The output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle policy.

    \n
    • \n
  • \n

    You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n deduplicate requests, so avoid issuing duplicate requests.

    \n
    • \n
  • \n

    Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409.

    \n
    • \n
\n

\n Restoring objects\n

\n

Objects that you archive to the S3 Glacier or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in\n Archive Access or Deep Archive Access tiers you must first initiate a restore request, and\n then wait until the object is moved into the Frequent Access tier. For objects in\n S3 Glacier or S3 Glacier Deep Archive storage classes you must\n first initiate a restore request, and then wait until a temporary copy of the object is\n available. To access an archived object, you must restore the object for the duration\n (number of days) that you specify.

\n

To restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object (or using a select request), you can specify one of\n the following data access tier options in the Tier element of the request\n body:

\n
    \n
  • \n

    \n \n Expedited\n - Expedited retrievals\n allow you to quickly access your data stored in the S3 Glacier\n storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for a\n subset of archives are required. For all but the largest archived objects (250 MB+),\n data accessed using Expedited retrievals is typically made available within 1–5\n minutes. Provisioned capacity ensures that retrieval capacity for Expedited\n retrievals is available when you need it. Expedited retrievals and provisioned\n capacity are not available for objects stored in the S3 Glacier Deep Archive\n storage class or S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
  • \n

    \n \n Standard\n - Standard retrievals allow\n you to access any of your archived objects within several hours. This is the default\n option for retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3–5 hours for objects stored in the\n S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They\n typically finish within 12 hours for objects stored in the\n S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.\n Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

    \n
    • \n
  • \n

    \n \n Bulk\n - Bulk retrievals are the\n lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts,\n even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12\n hours for objects stored in the S3 Glacier storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 48 hours for objects stored\n in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.\n Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.

    \n
    • \n
\n

For more information about archive retrieval options and provisioned capacity for\n Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see \n Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.

\n

To get the status of object restoration, you can send a HEAD request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in\n the Amazon S3 User Guide.

\n

After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in\n Amazon S3 User Guide.

\n

\n Responses\n

\n

A successful action returns either the 200 OK or 202\n Accepted status code.

\n
    \n
  • \n

    If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

    \n
    • \n
  • \n

    If the object is previously restored, Amazon S3 returns 200 OK in the\n response.

    \n
    • \n
\n

\n Special Errors\n

\n
    \n
  • \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress\n

      \n
      • \n
    • \n

      \n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client\n

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: GlacierExpeditedRetrievalNotAvailable\n

      \n
      • \n
    • \n

      \n Cause: expedited retrievals are currently not available. Try again\n later. (Returned if there is insufficient capacity to process the Expedited\n request. This error applies only to Expedited retrievals and not to\n S3 Standard or Bulk retrievals.)\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 503\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: N/A\n

      \n
      • \n
    \n
    • \n
\n \n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?restore&x-id=RestoreObject", @@ -11545,7 +11545,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name containing the object to restore.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name containing the object to restore.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11772,7 +11772,7 @@ "KeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed\n customer master key (CMK) to use for encrypting inventory reports.

", + "smithy.api#documentation": "

Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed\n customer master key (CMK) to use for encrypting inventory reports.

", "smithy.api#required": {} } } @@ -11831,7 +11831,7 @@ "target": "com.amazonaws.s3#SelectObjectContentOutput" }, "traits": { - "smithy.api#documentation": "

This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This action is not supported by Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select,\n see Selecting Content from\n Objects in the Amazon S3 User Guide.

\n

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon S3 User Guide.

\n

\n

\n Permissions\n

\n

You must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon S3 User Guide.

\n

\n

\n Object Data Formats\n

\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n
    \n
  • \n

    \n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.

    \n
    • \n
  • \n

    \n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.

    \n
    • \n
  • \n

    \n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.

    \n
    • \n
  • \n

    \n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.

    \n

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

    \n

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and\n customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS),\n server-side encryption is handled transparently, so you don't need to specify\n anything. For more information about server-side encryption, including SSE-S3 and\n SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.

    \n
    • \n
\n\n

\n Working with the Response Body\n

\n

Given the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response\n .

\n\n

\n

\n GetObject Support\n

\n

The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.

\n
    \n
  • \n

    \n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.

    \n
    • \n
  • \n

    GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage Classes\n in the Amazon S3 User Guide.

    \n
    • \n
\n

\n

\n Special Errors\n

\n\n

For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n

\n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This action is not supported by Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select,\n see Selecting Content from\n Objects in the Amazon S3 User Guide.

\n

For more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon S3 User Guide.

\n

\n

\n Permissions\n

\n

You must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon S3 User Guide.

\n

\n

\n Object Data Formats\n

\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n
    \n
  • \n

    \n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.

    \n
    • \n
  • \n

    \n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.

    \n
    • \n
  • \n

    \n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.

    \n
    • \n
  • \n

    \n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.

    \n

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.

    \n

    For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and\n customer master keys (CMKs) stored in Amazon Web Services Key Management Service (SSE-KMS),\n server-side encryption is handled transparently, so you don't need to specify\n anything. For more information about server-side encryption, including SSE-S3 and\n SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.

    \n
    • \n
\n\n

\n Working with the Response Body\n

\n

Given the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.

\n\n

\n

\n GetObject Support\n

\n

The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.

\n
    \n
  • \n

    \n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.

    \n
    • \n
  • \n

    GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage Classes\n in the Amazon S3 User Guide.

    \n
    • \n
\n

\n

\n Special Errors\n

\n\n

For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n

\n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?select&select-type=2&x-id=SelectObjectContent", @@ -12046,7 +12046,7 @@ "KMSMasterKeyID": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.

\n

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you\n are using encryption with cross-account operations, you must use a fully qualified KMS key ARN.\n For more information, see Using encryption for cross-account operations.

\n

\n For example:\n

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
\n \n

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see\n Using symmetric and\n asymmetric keys in the AWS Key Management Service Developer Guide.

\n " + "smithy.api#documentation": "

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.

\n

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you\n are using encryption with cross-account operations, you must use a fully qualified KMS key ARN.\n For more information, see Using encryption for cross-account operations.

\n

\n For example:\n

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
\n \n

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see\n Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

\n " } } }, @@ -12109,7 +12109,7 @@ "SseKmsEncryptedObjects": { "target": "com.amazonaws.s3#SseKmsEncryptedObjects", "traits": { - "smithy.api#documentation": "

A container for filter information for the selection of Amazon S3 objects encrypted with AWS\n KMS. If you include SourceSelectionCriteria in the replication configuration,\n this element is required.

" + "smithy.api#documentation": "

A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services\n KMS. If you include SourceSelectionCriteria in the replication configuration,\n this element is required.

" } }, "ReplicaModifications": { @@ -12120,7 +12120,7 @@ } }, "traits": { - "smithy.api#documentation": "

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n Service (SSE-KMS).

" + "smithy.api#documentation": "

A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in Amazon Web Services Key Management\n Service (SSE-KMS).

" } }, "com.amazonaws.s3#SseKmsEncryptedObjects": { @@ -12129,13 +12129,13 @@ "Status": { "target": "com.amazonaws.s3#SseKmsEncryptedObjectsStatus", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 replicates objects created with server-side encryption using an\n AWS KMS key stored in AWS Key Management Service.

", + "smithy.api#documentation": "

Specifies whether Amazon S3 replicates objects created with server-side encryption using an\n Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A container for filter information for the selection of S3 objects encrypted with AWS\n KMS.

" + "smithy.api#documentation": "

A container for filter information for the selection of S3 objects encrypted with Amazon Web Services\n KMS.

" } }, "com.amazonaws.s3#SseKmsEncryptedObjectsStatus": { @@ -12584,7 +12584,7 @@ "target": "com.amazonaws.s3#UploadPartOutput" }, "traits": { - "smithy.api#documentation": "

Uploads a part in a multipart upload.

\n \n

In this operation, you provide part data in your request. However, you have an option\n to specify your existing Amazon S3 object as a data source for the part you are uploading. To\n upload a part from an existing object, you use the UploadPartCopy operation.\n

\n \n\n

You must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier, that you must include in your upload part request.

\n

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten. Each part must be at least 5 MB in size, except\n the last part. There is no size limit on the last part of your multipart upload.

\n

To ensure that data is not corrupted when traversing the network, specify the\n Content-MD5 header in the upload part request. Amazon S3 checks the part data\n against the provided MD5 value. If they do not match, Amazon S3 returns an error.

\n\n

If the upload request is signed with Signature Version 4, then AWS S3 uses the\n x-amz-content-sha256 header as a checksum instead of\n Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (AWS Signature Version\n 4).

\n\n\n\n

\n Note: After you initiate multipart upload and upload\n one or more parts, you must either complete or abort multipart upload in order to stop\n getting charged for storage of the uploaded parts. Only after you either complete or abort\n multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts\n storage.

\n\n

For more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon S3 User Guide .

\n

For information on the permissions required to use the multipart upload API, go to\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.

\n\n

You can optionally request server-side encryption where Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it for you when you access it. You have\n the option of providing your own encryption key, or you can use the AWS managed encryption\n keys. If you choose to provide your own encryption key, the request headers you provide in\n the request must match the headers you used in the request to initiate the upload by using\n CreateMultipartUpload. For more information, go to Using Server-Side Encryption in\n the Amazon S3 User Guide.

\n\n

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are\n using a customer-provided encryption key, you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.

\n\n

If you requested server-side encryption using a customer-provided encryption key in your\n initiate multipart upload request, you must provide identical encryption information in\n each part upload using the following headers.

\n\n\n
    \n
  • \n

    x-amz-server-side-encryption-customer-algorithm

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key-MD5

    \n
    • \n
\n\n

\n Special Errors\n

\n
    \n
  • \n
      \n
    • \n

      \n Code: NoSuchUpload\n

      \n
      • \n
    • \n

      \n Cause: The specified multipart upload does not exist. The upload\n ID might be invalid, or the multipart upload might have been aborted or\n completed.\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found \n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client\n

      \n
      • \n
    \n
    • \n
\n\n \n\n\n\n\n

\n Related Resources\n

\n ", + "smithy.api#documentation": "

Uploads a part in a multipart upload.

\n \n

In this operation, you provide part data in your request. However, you have an option\n to specify your existing Amazon S3 object as a data source for the part you are uploading. To\n upload a part from an existing object, you use the UploadPartCopy operation.\n

\n \n\n

You must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier, that you must include in your upload part request.

\n

Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten. Each part must be at least 5 MB in size, except\n the last part. There is no size limit on the last part of your multipart upload.

\n

To ensure that data is not corrupted when traversing the network, specify the\n Content-MD5 header in the upload part request. Amazon S3 checks the part data\n against the provided MD5 value. If they do not match, Amazon S3 returns an error.

\n\n

If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the\n x-amz-content-sha256 header as a checksum instead of\n Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version\n 4).

\n\n\n\n

\n Note: After you initiate multipart upload and upload\n one or more parts, you must either complete or abort multipart upload in order to stop\n getting charged for storage of the uploaded parts. Only after you either complete or abort\n multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts\n storage.

\n\n

For more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon S3 User Guide .

\n

For information on the permissions required to use the multipart upload API, go to\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.

\n\n

You can optionally request server-side encryption where Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it for you when you access it. You have\n the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption\n keys. If you choose to provide your own encryption key, the request headers you provide in\n the request must match the headers you used in the request to initiate the upload by using\n CreateMultipartUpload. For more information, go to Using Server-Side Encryption in\n the Amazon S3 User Guide.

\n\n

Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are\n using a customer-provided encryption key, you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.

\n\n

If you requested server-side encryption using a customer-provided encryption key in your\n initiate multipart upload request, you must provide identical encryption information in\n each part upload using the following headers.

\n\n\n
    \n
  • \n

    x-amz-server-side-encryption-customer-algorithm

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key

    \n
    • \n
  • \n

    x-amz-server-side-encryption-customer-key-MD5

    \n
    • \n
\n\n

\n Special Errors\n

\n
    \n
  • \n
      \n
    • \n

      \n Code: NoSuchUpload\n

      \n
      • \n
    • \n

      \n Cause: The specified multipart upload does not exist. The upload\n ID might be invalid, or the multipart upload might have been aborted or\n completed.\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 404 Not Found \n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client\n

      \n
      • \n
    \n
    • \n
\n\n \n\n\n\n\n

\n Related Resources\n

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?x-id=UploadPart", @@ -12650,14 +12650,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", + "smithy.api#documentation": "

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -12675,7 +12675,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The bucket name.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12683,7 +12683,7 @@ "CopySource": { "target": "com.amazonaws.s3#CopySource", "traits": { - "smithy.api#documentation": "

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access point:

\n
    \n
  • \n

    For objects not accessed through an access point, specify the name of the source\n bucket and key of the source object, separated by a slash (/). For example, to copy\n the object reports/january.pdf from the bucket\n awsexamplebucket, use\n awsexamplebucket/reports/january.pdf. The value must be URL\n encoded.

    \n
    • \n
  • \n

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    \n \n

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    \n     \n

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

    \n
    • \n
\n

To copy a specific version of an object, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

", + "smithy.api#documentation": "

Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access point:

\n
    \n
  • \n

    For objects not accessed through an access point, specify the name of the source\n bucket and key of the source object, separated by a slash (/). For example, to copy\n the object reports/january.pdf from the bucket\n awsexamplebucket, use\n awsexamplebucket/reports/january.pdf. The value must be URL\n encoded.

    \n
    • \n
  • \n

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    \n \n

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

    \n     \n

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

    \n
    • \n
\n

To copy a specific version of an object, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

", "smithy.api#httpHeader": "x-amz-copy-source", "smithy.api#required": {} } @@ -12845,14 +12845,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) was used for the object.

", + "smithy.api#documentation": "

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed customer master key (CMK) was used for the object.

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

", + "smithy.api#documentation": "

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -12877,7 +12877,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The name of the bucket to which the multipart upload was initiated.

\n

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

\n

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13037,7 +13037,7 @@ "smithy.api#auth": [ "aws.auth#sigv4" ], - "smithy.api#documentation": "

Passes transformed\n objects to a GetObject operation when using Object Lambda Access Points. For information about\n Object Lambda Access Points, see Transforming objects with\n Object Lambda Access Points in the Amazon S3 User Guide.

\n

This operation supports metadata that can be returned by GetObject, in addition to\n RequestRoute, RequestToken, StatusCode,\n ErrorCode, and ErrorMessage. The GetObject\n response metadata is supported so that the WriteGetObjectResponse caller,\n typically an AWS Lambda function, can provide the same metadata when it internally invokes\n GetObject. When WriteGetObjectResponse is called by a\n customer-owned Lambda function, the metadata returned to the end user\n GetObject call might differ from what Amazon S3 would normally return.

\n

AWS provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact\n personally identifiable information (PII) and decompress S3 objects. These Lambda functions\n are available in the AWS Serverless Application Repository, and can be selected through the AWS Management Console when you create your\n Object Lambda Access Point.

\n

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

\n

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

\n

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

\n

For information on how to view and use these functions, see Using AWS built Lambda functions in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

Passes transformed\n objects to a GetObject operation when using Object Lambda Access Points. For information about\n Object Lambda Access Points, see Transforming objects with\n Object Lambda Access Points in the Amazon S3 User Guide.

\n

This operation supports metadata that can be returned by GetObject, in addition to\n RequestRoute, RequestToken, StatusCode,\n ErrorCode, and ErrorMessage. The GetObject\n response metadata is supported so that the WriteGetObjectResponse caller,\n typically an Lambda function, can provide the same metadata when it internally invokes\n GetObject. When WriteGetObjectResponse is called by a\n customer-owned Lambda function, the metadata returned to the end user\n GetObject call might differ from what Amazon S3 would normally return.

\n

You can include any number of metadata headers. When including a metadata header, it should be\n prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue.\n The primary use case for this is to forward GetObject metadata.

\n

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact\n personally identifiable information (PII) and decompress S3 objects. These Lambda functions\n are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your\n Object Lambda Access Point.

\n

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

\n

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

\n

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

\n

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

", "smithy.api#endpoint": { "hostPrefix": "{RequestRoute}." }, @@ -13266,7 +13266,7 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for stored in Amazon S3 object.

", + "smithy.api#documentation": "

If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for stored in Amazon S3 object.

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -13301,7 +13301,7 @@ "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side\n encryption with AWS KMS (SSE-KMS).

", + "smithy.api#documentation": "

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side\n encryption with Amazon Web Services KMS (SSE-KMS).

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled" } } diff --git a/aws/sdk/aws-models/sagemaker.json b/aws/sdk/aws-models/sagemaker.json index 79ddb44444..e1ba3b5ead 100644 --- a/aws/sdk/aws-models/sagemaker.json +++ b/aws/sdk/aws-models/sagemaker.json @@ -620,7 +620,7 @@ "AnnotationConsolidationLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

\n

This parameter is required for all labeling jobs. For built-in task types, use one\n of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n AnnotationConsolidationLambdaArn. For custom labeling workflows, see\n Post-annotation Lambda.

\n\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image\n as a multi-class classification and treats pixel annotations from workers as \"votes\" for\n the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n rn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections\n and calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition\n

    \n
    • \n
\n \n \n \n \n \n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking\n

    \n
    • \n
\n \n \n

\n 3D Point Cloud Object Detection - Use this task type\n when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids\n around objects. For example, you can use this task type to ask workers to identify\n different types of objects in a point cloud, such as cars, bikes, and\n pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - Use this task type\n when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D\n point cloud frames. For example, you can use this task type to ask workers to track the\n movement of vehicles across multiple point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - Use this task\n type when you want workers to create a point-level semantic segmentation masks by\n painting objects in a 3D point cloud using different colors where each color is assigned\n to one of the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n \n \n\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n \n

\n Semantic Segmentation Adjustment - Treats each pixel\n in an image as a multi-class classification and treats pixel adjusted annotations from\n workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n \n

\n Semantic Segmentation Verification - Uses a variant\n of the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
\n \n

\n Bounding Box Adjustment - Finds the most similar\n boxes from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Bounding Box Verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification judgement\n for bounding box labels based on annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox\n

    \n
    • \n
\n \n \n \n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n \n \n \n

\n 3D Point Cloud Object Detection Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects that appear in a\n sequence of 3D point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation Adjustment - Use this task\n type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

\n

This parameter is required for all labeling jobs. For built-in task types, use one\n of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n AnnotationConsolidationLambdaArn. For custom labeling workflows, see\n Post-annotation Lambda.

\n\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image\n as a multi-class classification and treats pixel annotations from workers as \"votes\" for\n the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of\n the Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections\n and calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition\n

    \n
    • \n
\n \n \n \n \n \n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking\n

    \n
    • \n
\n \n \n

\n 3D Point Cloud Object Detection - Use this task type\n when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids\n around objects. For example, you can use this task type to ask workers to identify\n different types of objects in a point cloud, such as cars, bikes, and\n pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - Use this task type\n when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D\n point cloud frames. For example, you can use this task type to ask workers to track the\n movement of vehicles across multiple point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - Use this task\n type when you want workers to create a point-level semantic segmentation masks by\n painting objects in a 3D point cloud using different colors where each color is assigned\n to one of the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n \n \n\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n \n

\n Semantic Segmentation Adjustment - Treats each pixel\n in an image as a multi-class classification and treats pixel adjusted annotations from\n workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n \n

\n Semantic Segmentation Verification - Uses a variant\n of the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation\n

    \n
    • \n
\n \n

\n Bounding Box Adjustment - Finds the most similar\n boxes from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Bounding Box Verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification judgement\n for bounding box labels based on annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox\n

    \n
    • \n
\n \n \n \n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n \n \n \n

\n 3D Point Cloud Object Detection Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking Adjustment - Use this\n task type when you want workers to adjust 3D cuboids around objects that appear in a\n sequence of 3D point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation Adjustment - Use this task\n type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
", "smithy.api#required": {} } } @@ -1414,6 +1414,88 @@ "smithy.api#documentation": "

Lists a summary of the properties of an association. An association is an entity that\n links other lineage or experiment entities. An example would be an association between a\n training job and a model.

" } }, + "com.amazonaws.sagemaker#AsyncInferenceClientConfig": { + "type": "structure", + "members": { + "MaxConcurrentInvocationsPerInstance": { + "target": "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance", + "traits": { + "smithy.api#documentation": "

The maximum number of concurrent requests sent by the SageMaker client to the \n model container. If no value is provided, Amazon SageMaker will choose an optimal value for you.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the behavior of the client used by Amazon SageMaker to interact with the \n model container during asynchronous inference.

" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceConfig": { + "type": "structure", + "members": { + "ClientConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceClientConfig", + "traits": { + "smithy.api#documentation": "

Configures the behavior of the client used by Amazon SageMaker to interact \n with the model container during asynchronous inference.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceOutputConfig", + "traits": { + "smithy.api#documentation": "

Specifies the configuration for asynchronous inference invocation outputs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies configuration for how an endpoint performs asynchronous inference.

" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig": { + "type": "structure", + "members": { + "SuccessTopic": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#documentation": "

Amazon SNS topic to post a notification to when inference completes successfully. \n If no topic is provided, no notification is sent on success.

" + } + }, + "ErrorTopic": { + "target": "com.amazonaws.sagemaker#SnsTopicArn", + "traits": { + "smithy.api#documentation": "

Amazon SNS topic to post a notification to when inference fails. \n If no topic is provided, no notification is sent on failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration for notifications of inference results for asynchronous inference.

" + } + }, + "com.amazonaws.sagemaker#AsyncInferenceOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that\n Amazon SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

\n

" + } + }, + "S3OutputPath": { + "target": "com.amazonaws.sagemaker#DestinationS3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location to upload inference responses to.

", + "smithy.api#required": {} + } + }, + "NotificationConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceNotificationConfig", + "traits": { + "smithy.api#documentation": "

Specifies the configuration for notifications of inference results for asynchronous inference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the configuration for asynchronous inference invocation outputs.

" + } + }, "com.amazonaws.sagemaker#AthenaCatalog": { "type": "string", "traits": { @@ -1666,12 +1748,12 @@ "CandidateProperties": { "target": "com.amazonaws.sagemaker#CandidateProperties", "traits": { - "smithy.api#documentation": "

The AutoML candidate's properties.

" + "smithy.api#documentation": "

The properties of an AutoML candidate job.

" } } }, "traits": { - "smithy.api#documentation": "

An Autopilot job returns recommendations, or candidates. Each candidate has futher details\n about the steps involved and the status.

" + "smithy.api#documentation": "

Information about a candidate produced by an AutoML training job, including its status,\n steps, and other properties.

" } }, "com.amazonaws.sagemaker#AutoMLCandidateStep": { @@ -1743,7 +1825,7 @@ "Image": { "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { - "smithy.api#documentation": "

The ECR path of the container. For more information, see .

", + "smithy.api#documentation": "

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more\n information, see .

", "smithy.api#required": {} } }, @@ -1855,7 +1937,7 @@ "MaxRuntimePerTrainingJobInSeconds": { "target": "com.amazonaws.sagemaker#MaxRuntimePerTrainingJobInSeconds", "traits": { - "smithy.api#documentation": "

The maximum time, in seconds, a training job is allowed to run as part of an AutoML job.

" + "smithy.api#documentation": "

The maximum time, in seconds, a training job is allowed to run as part of an AutoML\n job.

" } }, "MaxAutoMLJobRuntimeInSeconds": { @@ -1905,7 +1987,7 @@ "MetricName": { "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", "traits": { - "smithy.api#documentation": "

The name of the objective metric used to measure the predictive quality of a machine\n learning system. This metric is optimized during training to provide the best estimate for\n model parameter values from data.

\n

Here are the options:

\n
    \n
  • \n

    \n MSE: The mean squared error (MSE) is the average of the squared\n differences between the predicted and actual values. It is used for regression. MSE\n values are always positive: the better a model is at predicting the actual values,\n the smaller the MSE value. When the data contains outliers, they tend to dominate the\n MSE, which might cause subpar prediction performance.

    \n
    • \n
  • \n

    \n Accuracy: The ratio of the number of correctly classified items to\n the total number of (correctly and incorrectly) classified items. It is used for\n binary and multiclass classification. It measures how close the predicted class\n values are to the actual values. Accuracy values vary between zero and one: one\n indicates perfect accuracy and zero indicates perfect inaccuracy.

    \n
    • \n
  • \n

    \n F1: The F1 score is the harmonic mean of the precision and recall. It\n is used for binary classification into classes traditionally referred to as positive\n and negative. Predictions are said to be true when they match their actual (correct)\n class and false when they do not. Precision is the ratio of the true positive\n predictions to all positive predictions (including the false positives) in a data set\n and measures the quality of the prediction when it predicts the positive class.\n Recall (or sensitivity) is the ratio of the true positive predictions to all actual\n positive instances and measures how completely a model predicts the actual class\n members in a data set. The standard F1 score weighs precision and recall equally. But\n which metric is paramount typically depends on specific aspects of a problem. F1\n scores vary between zero and one: one indicates the best possible performance and\n zero the worst.

    \n
    • \n
  • \n

    \n AUC: The area under the curve (AUC) metric is used to compare and\n evaluate binary classification by algorithms such as logistic regression that return\n probabilities. A threshold is needed to map the probabilities into classifications.\n The relevant curve is the receiver operating characteristic curve that plots the true\n positive rate (TPR) of predictions (or recall) against the false positive rate (FPR)\n as a function of the threshold value, above which a prediction is considered\n positive. Increasing the threshold results in fewer false positives but more false\n negatives. AUC is the area under this receiver operating characteristic curve and so\n provides an aggregated measure of the model performance across all possible\n classification thresholds. The AUC score can also be interpreted as the probability\n that a randomly selected positive data point is more likely to be predicted positive\n than a randomly selected negative example. AUC scores vary between zero and one: a\n score of one indicates perfect accuracy and a score of one half indicates that the\n prediction is not better than a random classifier. Values under one half predict less\n accurately than a random predictor. But such consistently bad predictors can simply\n be inverted to obtain better than random predictors.

    \n
    • \n
  • \n

    \n F1macro: The F1macro score applies F1 scoring to multiclass\n classification. In this context, you have multiple classes to predict. You just\n calculate the precision and recall for each class as you did for the positive class\n in binary classification. Then, use these values to calculate the F1 score for each\n class and average them to obtain the F1macro score. F1macro scores vary between zero\n and one: one indicates the best possible performance and zero the worst.

    \n
    • \n
\n

If you do not specify a metric explicitly, the default behavior is to automatically\n use:

\n
    \n
  • \n

    \n MSE: for regression.

    \n
    • \n
  • \n

    \n F1: for binary classification

    \n
    • \n
  • \n

    \n Accuracy: for multiclass classification.

    \n
    • \n
", + "smithy.api#documentation": "

The name of the objective metric used to measure the predictive quality of a machine\n learning system. This metric is optimized during training to provide the best estimate for\n model parameter values from data.

\n

Here are the options:

\n
    \n
  • \n

    \n MSE: The mean squared error (MSE) is the average of the squared\n differences between the predicted and actual values. It is used for regression. MSE\n values are always positive: the better a model is at predicting the actual values,\n the smaller the MSE value is. When the data contains outliers, they tend to dominate\n the MSE, which might cause subpar prediction performance.

    \n
    • \n
  • \n

    \n Accuracy: The ratio of the number of correctly classified items to\n the total number of (correctly and incorrectly) classified items. It is used for\n binary and multiclass classification. It measures how close the predicted class\n values are to the actual values. Accuracy values vary between zero and one: one\n indicates perfect accuracy and zero indicates perfect inaccuracy.

    \n
    • \n
  • \n

    \n F1: The F1 score is the harmonic mean of the precision and recall. It\n is used for binary classification into classes traditionally referred to as positive\n and negative. Predictions are said to be true when they match their actual (correct)\n class and false when they do not. Precision is the ratio of the true positive\n predictions to all positive predictions (including the false positives) in a data set\n and measures the quality of the prediction when it predicts the positive class.\n Recall (or sensitivity) is the ratio of the true positive predictions to all actual\n positive instances and measures how completely a model predicts the actual class\n members in a data set. The standard F1 score weighs precision and recall equally. But\n which metric is paramount typically depends on specific aspects of a problem. F1\n scores vary between zero and one: one indicates the best possible performance and\n zero the worst.

    \n
    • \n
  • \n

    \n AUC: The area under the curve (AUC) metric is used to compare and\n evaluate binary classification by algorithms such as logistic regression that return\n probabilities. A threshold is needed to map the probabilities into classifications.\n The relevant curve is the receiver operating characteristic curve that plots the true\n positive rate (TPR) of predictions (or recall) against the false positive rate (FPR)\n as a function of the threshold value, above which a prediction is considered\n positive. Increasing the threshold results in fewer false positives but more false\n negatives. AUC is the area under this receiver operating characteristic curve and so\n provides an aggregated measure of the model performance across all possible\n classification thresholds. The AUC score can also be interpreted as the probability\n that a randomly selected positive data point is more likely to be predicted positive\n than a randomly selected negative example. AUC scores vary between zero and one: a\n score of one indicates perfect accuracy and a score of one half indicates that the\n prediction is not better than a random classifier. Values under one half predict less\n accurately than a random predictor. But such consistently bad predictors can simply\n be inverted to obtain better than random predictors.

    \n
    • \n
  • \n

    \n F1macro: The F1macro score applies F1 scoring to multiclass\n classification. In this context, you have multiple classes to predict. You just\n calculate the precision and recall for each class as you did for the positive class\n in binary classification. Then, use these values to calculate the F1 score for each\n class and average them to obtain the F1macro score. F1macro scores vary between zero\n and one: one indicates the best possible performance and zero the worst.

    \n
    • \n
\n

If you do not specify a metric explicitly, the default behavior is to automatically\n use:

\n
    \n
  • \n

    \n MSE: for regression.

    \n
    • \n
  • \n

    \n F1: for binary classification

    \n
    • \n
  • \n

    \n Accuracy: for multiclass classification.

    \n
    • \n
", "smithy.api#required": {} } } @@ -2035,7 +2117,7 @@ "AutoMLJobName": { "target": "com.amazonaws.sagemaker#AutoMLJobName", "traits": { - "smithy.api#documentation": "

The name of the AutoML you are requesting.

", + "smithy.api#documentation": "

The name of the AutoML job you are requesting.

", "smithy.api#required": {} } }, @@ -2508,6 +2590,12 @@ "traits": { "smithy.api#documentation": "

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

" } + }, + "CandidateMetrics": { + "target": "com.amazonaws.sagemaker#MetricDataList", + "traits": { + "smithy.api#documentation": "

Information about the candidate metrics for an AutoML job.

" + } } }, "traits": { @@ -3540,7 +3628,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 5 + "max": 15 } } }, @@ -4177,7 +4265,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Autopilot job.

\n

Find the best performing model after you run an Autopilot job by calling .

\n

For information about how to use Autopilot, see Automate Model\n Development with Amazon SageMaker Autopilot.

" + "smithy.api#documentation": "

Creates an Autopilot job.

\n

Find the best-performing model after you run an Autopilot job by calling .

\n

For information about how to use Autopilot, see Automate Model\n Development with Amazon SageMaker Autopilot.

" } }, "com.amazonaws.sagemaker#CreateAutoMLJobRequest": { @@ -4200,7 +4288,7 @@ "OutputDataConfig": { "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", "traits": { - "smithy.api#documentation": "

Provides information about encryption and the Amazon S3 output path needed to store\n artifacts from an AutoML job. Format(s) supported: CSV.

", + "smithy.api#documentation": "

Provides information about encryption and the Amazon S3 output path needed to store artifacts\n from an AutoML job. Format(s) supported: CSV.

", "smithy.api#required": {} } }, @@ -4213,7 +4301,7 @@ "AutoMLJobObjective": { "target": "com.amazonaws.sagemaker#AutoMLJobObjective", "traits": { - "smithy.api#documentation": "

Defines the objective metric used to measure the predictive quality of an AutoML job.\n You provide an AutoMLJobObjective$MetricName and Autopilot infers whether to\n minimize or maximize it.

" + "smithy.api#documentation": "

Defines the objective metric used to measure the predictive quality of an AutoML job. You\n provide an AutoMLJobObjective$MetricName and Autopilot infers whether to\n minimize or maximize it.

" } }, "AutoMLJobConfig": { @@ -4255,7 +4343,7 @@ "AutoMLJobArn": { "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "

The unique ARN that is assigned to the AutoML job when it is created.

", + "smithy.api#documentation": "

The unique ARN assigned to the AutoML job when it is created.

", "smithy.api#required": {} } } @@ -4866,6 +4954,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt data on\n the storage volume attached to the ML compute instance that hosts the endpoint.

\n

The KmsKeyId can be any of the following formats:

\n
    \n
  • \n

    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Key ARN:\n arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

    \n
    • \n
  • \n

    Alias name: alias/ExampleAlias\n

    \n
    • \n
  • \n

    Alias name ARN:\n arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\n

    \n
    • \n
\n

The KMS key policy must grant permission to the IAM role that you specify in your\n CreateEndpoint, UpdateEndpoint requests. For more\n information, refer to the Amazon Web Services Key Management Service section Using Key\n Policies in Amazon Web Services KMS \n

\n \n

Certain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a KmsKeyId when using an instance type with local\n storage. If any of the models that you specify in the\n ProductionVariants parameter use nitro-based instances with local\n storage, do not specify a value for the KmsKeyId parameter. If you\n specify a value for KmsKeyId when using any nitro-based instances with\n local storage, the call to CreateEndpointConfig fails.

\n

For a list of instance types that support local instance storage, see Instance Store Volumes.

\n

For more information about local instance storage encryption, see SSD\n Instance Store Volumes.

\n " } + }, + "AsyncInferenceConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", + "traits": { + "smithy.api#documentation": "

Specifies configuration for how an endpoint performs asynchronous inference. \n This is a required field in order for your Endpoint to be invoked using \n \n InvokeEndpointAsync\n .

" + } } } }, @@ -5475,7 +5569,7 @@ "LabelCategoryConfigS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

The S3 URI of the file, referred to as a label category configuration\n file, that defines the categories used to label the data objects.

\n

For 3D point cloud and video frame task types, you can add label category attributes\n and frame attributes to your label category configuration file. To learn how, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

\n

For all other built-in task types and custom\n tasks, your label category configuration file must be a JSON file in the\n following format. Identify the labels you want to use by replacing label_1,\n label_2,...,label_n with your label\n categories.

\n

\n { \n

\n

\n \"document-version\": \"2018-11-28\",\n

\n

\n \"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\":\n \"label_n\"}]\n

\n

\n }\n

\n

Note the following about the label category configuration file:

\n
    \n
  • \n

    For image classification and text classification (single and multi-label) you\n must specify at least two label categories. For all other task types, the\n minimum number of label categories required is one.

    \n
    • \n
  • \n

    Each label category must be unique, you cannot specify duplicate label\n categories.

    \n
    • \n
  • \n

    If you create a 3D point cloud or video frame adjustment or verification\n labeling job, you must include auditLabelAttributeName in the label\n category configuration. Use this parameter to enter the \n LabelAttributeName\n of the labeling job you want to\n adjust or verify annotations of.

    \n
    • \n
" + "smithy.api#documentation": "

The S3 URI of the file, referred to as a label category configuration\n file, that defines the categories used to label the data objects.

\n

For 3D point cloud and video frame task types, you can add label category attributes\n and frame attributes to your label category configuration file. To learn how, see Create a\n Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

\n

For named entity recognition jobs, in addition to \"labels\", you must\n provide worker instructions in the label category configuration file using the\n \"instructions\" parameter: \"instructions\":\n {\"shortInstruction\":\"

Add header

Add Instructions

\",\n \"fullInstruction\":\"

Add additional instructions.

\"}. For details\n and an example, see Create a\n Named Entity Recognition Labeling Job (API) .

\n

For all other built-in task types and custom\n tasks, your label category configuration file must be a JSON file in the\n following format. Identify the labels you want to use by replacing label_1,\n label_2,...,label_n with your label\n categories.

\n

\n { \n

\n

\n \"document-version\": \"2018-11-28\",\n

\n

\n \"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\":\n \"label_n\"}]\n

\n

\n }\n

\n

Note the following about the label category configuration file:

\n
    \n
  • \n

    For image classification and text classification (single and multi-label) you\n must specify at least two label categories. For all other task types, the\n minimum number of label categories required is one.

    \n
    • \n
  • \n

    Each label category must be unique, you cannot specify duplicate label\n categories.

    \n
    • \n
  • \n

    If you create a 3D point cloud or video frame adjustment or verification\n labeling job, you must include auditLabelAttributeName in the label\n category configuration. Use this parameter to enter the \n LabelAttributeName\n of the labeling job you want to\n adjust or verify annotations of.

    \n
    • \n
" } }, "StoppingConditions": { @@ -6218,6 +6312,12 @@ "traits": { "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance. The\n default value is Enabled.

\n \n

Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

\n " } + }, + "PlatformIdentifier": { + "target": "com.amazonaws.sagemaker#PlatformIdentifier", + "traits": { + "smithy.api#documentation": "

The platform identifier of the notebook instance runtime environment.

" + } } } }, @@ -9624,7 +9724,7 @@ "RoleArn": { "target": "com.amazonaws.sagemaker#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to\n the input data location and write permission to the output data location in Amazon S3.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that\n has read permission to the input data location and write permission to the output data\n location in Amazon S3.

", "smithy.api#required": {} } }, @@ -9713,7 +9813,7 @@ "ResolvedAttributes": { "target": "com.amazonaws.sagemaker#ResolvedAttributes", "traits": { - "smithy.api#documentation": "

This contains ProblemType, AutoMLJobObjective and\n CompletionCriteria. If you do not provide these values, they are\n auto-inferred. If you do provide them, the values used are the ones you provide.

" + "smithy.api#documentation": "

This contains ProblemType, AutoMLJobObjective, and\n CompletionCriteria. If you do not provide these values, they are\n auto-inferred. If you do provide them, the values used are the ones you provide.

" } }, "ModelDeployConfig": { @@ -10720,6 +10820,12 @@ "smithy.api#documentation": "

A timestamp that shows when the endpoint configuration was created.

", "smithy.api#required": {} } + }, + "AsyncInferenceConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", + "traits": { + "smithy.api#documentation": "

Returns the description of an endpoint configuration created using the \n \n CreateEndpointConfig\n API.

" + } } } }, @@ -10800,6 +10906,12 @@ "traits": { "smithy.api#documentation": "

The most recent deployment configuration for the endpoint.

" } + }, + "AsyncInferenceConfig": { + "target": "com.amazonaws.sagemaker#AsyncInferenceConfig", + "traits": { + "smithy.api#documentation": "

Returns the description of an endpoint configuration created \n using the \n CreateEndpointConfig\n API.

" + } } } }, @@ -12804,6 +12916,12 @@ "traits": { "smithy.api#documentation": "

Whether root access is enabled or disabled for users of the notebook instance.

\n \n

Lifecycle configurations need root access to be able to set up a notebook\n instance. Because of this, lifecycle configurations associated with a notebook\n instance always run with root access even if you disable root access for\n users.

\n " } + }, + "PlatformIdentifier": { + "target": "com.amazonaws.sagemaker#PlatformIdentifier", + "traits": { + "smithy.api#documentation": "

The platform identifier of the notebook instance runtime environment.

" + } } } }, @@ -18378,6 +18496,15 @@ "smithy.api#documentation": "

Defines how to perform inference generation after a training job is run.

" } }, + "com.amazonaws.sagemaker#InitialTaskCount": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#InputConfig": { "type": "structure", "members": { @@ -18527,6 +18654,38 @@ "value": "ml.m5.24xlarge", "name": "ML_M5_24XLARGE" }, + { + "value": "ml.m5d.large", + "name": "ML_M5D_LARGE" + }, + { + "value": "ml.m5d.xlarge", + "name": "ML_M5D_XLARGE" + }, + { + "value": "ml.m5d.2xlarge", + "name": "ML_M5D_2XLARGE" + }, + { + "value": "ml.m5d.4xlarge", + "name": "ML_M5D_4XLARGE" + }, + { + "value": "ml.m5d.8xlarge", + "name": "ML_M5D_8XLARGE" + }, + { + "value": "ml.m5d.12xlarge", + "name": "ML_M5D_12XLARGE" + }, + { + "value": "ml.m5d.16xlarge", + "name": "ML_M5D_16XLARGE" + }, + { + "value": "ml.m5d.24xlarge", + "name": "ML_M5D_24XLARGE" + }, { "value": "ml.c4.xlarge", "name": "ML_C4_XLARGE" @@ -18606,6 +18765,66 @@ { "value": "ml.p3.16xlarge", "name": "ML_P3_16XLARGE" + }, + { + "value": "ml.p3dn.24xlarge", + "name": "ML_P3DN_24XLARGE" + }, + { + "value": "ml.g4dn.xlarge", + "name": "ML_G4DN_XLARGE" + }, + { + "value": "ml.g4dn.2xlarge", + "name": "ML_G4DN_2XLARGE" + }, + { + "value": "ml.g4dn.4xlarge", + "name": "ML_G4DN_4XLARGE" + }, + { + "value": "ml.g4dn.8xlarge", + "name": "ML_G4DN_8XLARGE" + }, + { + "value": "ml.g4dn.12xlarge", + "name": "ML_G4DN_12XLARGE" + }, + { + "value": "ml.g4dn.16xlarge", + "name": "ML_G4DN_16XLARGE" + }, + { + "value": "ml.r5.large", + "name": "ML_R5_LARGE" + }, + { + "value": "ml.r5.xlarge", + "name": "ML_R5_XLARGE" + }, + { + "value": "ml.r5.2xlarge", + "name": "ML_R5_2XLARGE" + }, + { + "value": "ml.r5.4xlarge", + "name": "ML_R5_4XLARGE" + }, + { + "value": "ml.r5.8xlarge", + "name": "ML_R5_8XLARGE" + }, + { + "value": "ml.r5.12xlarge", + "name": "ML_R5_12XLARGE" + }, + { + "value": "ml.r5.16xlarge", + "name": "ML_R5_16XLARGE" + }, + { + "value": "ml.r5.24xlarge", + "name": "ML_R5_24XLARGE" } ] } @@ -24261,6 +24480,16 @@ } } }, + "com.amazonaws.sagemaker#MaxConcurrentInvocationsPerInstance": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.sagemaker#MaxConcurrentTaskCount": { "type": "integer", "traits": { @@ -24489,6 +24718,44 @@ "smithy.api#documentation": "

The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

" } }, + "com.amazonaws.sagemaker#MetricDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#MetricDatum" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.sagemaker#MetricDatum": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#Float", + "traits": { + "smithy.api#documentation": "

The value of the metric.

" + } + }, + "Set": { + "target": "com.amazonaws.sagemaker#MetricSetSource", + "traits": { + "smithy.api#documentation": "

The dataset split from which the AutoML job produced the metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the metric for a candidate produced by an AutoML job.

" + } + }, "com.amazonaws.sagemaker#MetricDefinition": { "type": "structure", "members": { @@ -24543,6 +24810,25 @@ "smithy.api#pattern": "^.+$" } }, + "com.amazonaws.sagemaker#MetricSetSource": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Train", + "name": "TRAIN" + }, + { + "value": "Validation", + "name": "VALIDATION" + }, + { + "value": "Test", + "name": "TEST" + } + ] + } + }, "com.amazonaws.sagemaker#MetricValue": { "type": "float" }, @@ -24751,7 +25037,7 @@ "EndpointName": { "target": "com.amazonaws.sagemaker#EndpointName", "traits": { - "smithy.api#documentation": "

Specifies the endpoint name to use for a one-click Autopilot model deployment if the\n endpoint name is not generated automatically.

\n \n

Specify the EndpointName if and only if you set\n AutoGenerateEndpointName to False; otherwise a 400 error\n is thrown.

\n " + "smithy.api#documentation": "

Specifies the endpoint name to use for a one-click Autopilot model deployment if the\n endpoint name is not generated automatically.

\n \n

Specify the EndpointName if and only if you set\n AutoGenerateEndpointName to False; otherwise a 400 error is\n thrown.

\n " } } }, @@ -25068,7 +25354,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5 + "max": 15 } } }, @@ -27047,12 +27333,12 @@ "NotificationTopicArn": { "target": "com.amazonaws.sagemaker#NotificationTopicArn", "traits": { - "smithy.api#documentation": "

The ARN for the SNS topic to which notifications should be published.

" + "smithy.api#documentation": "

The ARN for the Amazon SNS topic to which notifications should be published.

" } } }, "traits": { - "smithy.api#documentation": "

Configures SNS notifications of available or expiring work items for work\n teams.

" + "smithy.api#documentation": "

Configures Amazon SNS notifications of available or expiring work items for work\n teams.

" } }, "com.amazonaws.sagemaker#NotificationTopicArn": { @@ -28288,6 +28574,16 @@ } } }, + "com.amazonaws.sagemaker#PlatformIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + }, + "smithy.api#pattern": "^(notebook-al1-v1|notebook-al2-v1)$" + } + }, "com.amazonaws.sagemaker#PolicyString": { "type": "string", "traits": { @@ -29207,7 +29503,7 @@ } }, "InitialInstanceCount": { - "target": "com.amazonaws.sagemaker#TaskCount", + "target": "com.amazonaws.sagemaker#InitialTaskCount", "traits": { "smithy.api#documentation": "

Number of instances to launch initially.

", "smithy.api#required": {} @@ -33006,7 +33302,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a pipeline execution.

\n

A pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".

\n

You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.

\n

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

" + "smithy.api#documentation": "

Stops a pipeline execution.

\n\n

\n Callback Step\n

\n

A pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".

\n

You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.

\n

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

\n\n

\n Lambda Step\n

\n

A pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.

" } }, "com.amazonaws.sagemaker#StopPipelineExecutionRequest": { @@ -33611,7 +33907,7 @@ "traits": { "smithy.api#box": {}, "smithy.api#range": { - "min": 1 + "min": 0 } } }, @@ -35933,12 +36229,12 @@ "HumanTaskUiArn": { "target": "com.amazonaws.sagemaker#HumanTaskUiArn", "traits": { - "smithy.api#documentation": "

The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

\n

Use this parameter when you are creating a labeling job for 3D point cloud and video\n fram labeling jobs. Use your labeling job task type to select one of the following ARNs\n and use it with this parameter when you create a labeling job. Replace\n aws-region with the Amazon Web Services region you are creating your labeling job\n in.

\n\n

\n 3D Point Cloud HumanTaskUiArns\n

\n\n

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n

    \n
    • \n
\n\n

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n

    \n
    • \n
\n\n

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n

    \n
    • \n
\n\n

\n Video Frame HumanTaskUiArns\n

\n\n

Use this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n

    \n
    • \n
\n\n

Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n

    \n
    • \n
" + "smithy.api#documentation": "

The ARN of the worker task template used to render the worker UI and tools for\n labeling job tasks.

\n

Use this parameter when you are creating a labeling job for named entity recognition,\n 3D point cloud and video frame labeling jobs. Use your labeling job task type to select\n one of the following ARNs and use it with this parameter when you create a labeling job.\n Replace aws-region with the Amazon Web Services Region you are creating your labeling job\n in. For example, replace aws-region with us-west-1 if you\n create a labeling job in US West (N. California).

\n

\n Named Entity Recognition\n

\n

Use the following HumanTaskUiArn for named entity recognition labeling\n jobs:

\n

\n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition\n

\n \n

\n 3D Point Cloud HumanTaskUiArns\n

\n \n

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point\n cloud object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection\n

    \n
    • \n
\n \n

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point\n cloud object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking\n

    \n
    • \n
\n \n

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D\n point cloud semantic segmentation adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation\n

    \n
    • \n
\n \n

\n Video Frame HumanTaskUiArns\n

\n \n

Use this HumanTaskUiArn for video frame object detection and video frame\n object detection adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection\n

    \n
    • \n
\n \n

Use this HumanTaskUiArn for video frame object tracking and video frame\n object tracking adjustment labeling jobs.

\n
    \n
  • \n

    \n arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking\n

    \n
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

Provided configuration information for the worker UI for a labeling job.

" + "smithy.api#documentation": "

Provided configuration information for the worker UI for a labeling job. Provide\n either HumanTaskUiArn or UiTemplateS3Uri.

\n

For named entity recognition, 3D point cloud and video frame labeling jobs, use\n HumanTaskUiArn.

\n

For all other Ground Truth built-in task types and custom task types, use\n UiTemplateS3Uri to specify the location of a worker task template in\n Amazon S3.

" } }, "com.amazonaws.sagemaker#UiTemplate": { diff --git a/aws/sdk/aws-models/snow-device-management.json b/aws/sdk/aws-models/snow-device-management.json new file mode 100644 index 0000000000..c59efab647 --- /dev/null +++ b/aws/sdk/aws-models/snow-device-management.json @@ -0,0 +1,2093 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.snowdevicemanagement#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.snowdevicemanagement#AttachmentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ATTACHING", + "name": "ATTACHING" + }, + { + "value": "ATTACHED", + "name": "ATTACHED" + }, + { + "value": "DETACHING", + "name": "DETACHING" + }, + { + "value": "DETACHED", + "name": "DETACHED" + } + ] + } + }, + "com.amazonaws.snowdevicemanagement#CancelTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#CancelTaskInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#CancelTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends a cancel request for a specified task. You can cancel a task only if it's still in a\n QUEUED state. Tasks that are already running can't be cancelled.

\n \n

A task might still run if it's processed from the queue before the\n CancelTask operation changes the task's state.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/task/{taskId}/cancel", + "code": 200 + } + } + }, + "com.amazonaws.snowdevicemanagement#CancelTaskInput": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId", + "traits": { + "smithy.api#documentation": "

The ID of the task that you are attempting to cancel. You can retrieve a task ID by using\n the ListTasks operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#CancelTaskOutput": { + "type": "structure", + "members": { + "taskId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the task that you are attempting to cancel.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#Capacity": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the type of capacity, such as memory.

", + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "unit": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unit of measure for the type of capacity.

", + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "total": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The total capacity on the device.

" + } + }, + "used": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The amount of capacity used on the device.

" + } + }, + "available": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The amount of capacity available for use on the device.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The physical capacity of the Amazon Web Services Snow Family device.

" + } + }, + "com.amazonaws.snowdevicemanagement#CapacityList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#Capacity" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.snowdevicemanagement#Command": { + "type": "union", + "members": { + "unlock": { + "target": "com.amazonaws.snowdevicemanagement#Unlock", + "traits": { + "smithy.api#documentation": "

Unlocks the device.

" + } + }, + "reboot": { + "target": "com.amazonaws.snowdevicemanagement#Reboot", + "traits": { + "smithy.api#documentation": "

Reboots the device.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The command given to the device to execute.

" + } + }, + "com.amazonaws.snowdevicemanagement#CpuOptions": { + "type": "structure", + "members": { + "coreCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of cores that the CPU can use.

" + } + }, + "threadsPerCore": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of threads per core in the CPU.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for how a device's CPU is configured.

" + } + }, + "com.amazonaws.snowdevicemanagement#CreateTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#CreateTaskInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#CreateTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Instructs one or more devices to start a task, such as unlocking or rebooting.

", + "smithy.api#http": { + "method": "POST", + "uri": "/task", + "code": 200 + } + } + }, + "com.amazonaws.snowdevicemanagement#CreateTaskInput": { + "type": "structure", + "members": { + "targets": { + "target": "com.amazonaws.snowdevicemanagement#TargetList", + "traits": { + "smithy.api#documentation": "

A list of managed device IDs.

", + "smithy.api#required": {} + } + }, + "command": { + "target": "com.amazonaws.snowdevicemanagement#Command", + "traits": { + "smithy.api#documentation": "

The task to be performed. Only one task is executed on a device at a time.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.snowdevicemanagement#TaskDescriptionString", + "traits": { + "smithy.api#documentation": "

A description of the task and its targets.

" + } + }, + "tags": { + "target": "com.amazonaws.snowdevicemanagement#TagMap", + "traits": { + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can use tags to categorize a resource\n in different ways, such as by purpose, owner, or environment.

" + } + }, + "clientToken": { + "target": "com.amazonaws.snowdevicemanagement#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A token ensuring that the action is called only once with the specified details.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#CreateTaskOutput": { + "type": "structure", + "members": { + "taskId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the task that you created.

" + } + }, + "taskArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task that you created.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DescribeDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#DescribeDeviceInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#DescribeDeviceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Checks device-specific information, such as the device type, software version, IP\n addresses, and lock status.

", + "smithy.api#http": { + "method": "POST", + "uri": "/managed-device/{managedDeviceId}/describe", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#DescribeDeviceEc2Input": { + "type": "structure", + "members": { + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the managed device.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "instanceIds": { + "target": "com.amazonaws.snowdevicemanagement#InstanceIdsList", + "traits": { + "smithy.api#documentation": "

A list of instance IDs associated with the managed device.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DescribeDeviceEc2Instances": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#DescribeDeviceEc2Input" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#DescribeDeviceEc2Output" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Checks the current state of the Amazon EC2 instances. The output is similar to\n describeDevice, but the results are sourced from the device cache in the\n Amazon Web Services Cloud and include a subset of the available fields.

", + "smithy.api#http": { + "method": "POST", + "uri": "/managed-device/{managedDeviceId}/resources/ec2/describe", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#DescribeDeviceEc2Output": { + "type": "structure", + "members": { + "instances": { + "target": "com.amazonaws.snowdevicemanagement#InstanceSummaryList", + "traits": { + "smithy.api#documentation": "

A list of structures containing information about each instance.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DescribeDeviceInput": { + "type": "structure", + "members": { + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the device that you are checking the information of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DescribeDeviceOutput": { + "type": "structure", + "members": { + "lastReachedOutAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the device last contacted the Amazon Web Services Cloud. Indicates that the device is\n online.

" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache\n was refreshed.

" + } + }, + "tags": { + "target": "com.amazonaws.snowdevicemanagement#TagMap", + "traits": { + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can use tags to categorize a resource\n in different ways, such as by purpose, owner, or environment.

" + } + }, + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the device that you checked the information for.

" + } + }, + "managedDeviceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device.

" + } + }, + "deviceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of Amazon Web Services Snow Family device.

" + } + }, + "associatedWithJob": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the job used when ordering the device.

" + } + }, + "deviceState": { + "target": "com.amazonaws.snowdevicemanagement#UnlockState", + "traits": { + "smithy.api#documentation": "

The current state of the device.

" + } + }, + "physicalNetworkInterfaces": { + "target": "com.amazonaws.snowdevicemanagement#PhysicalNetworkInterfaceList", + "traits": { + "smithy.api#documentation": "

The network interfaces available on the device.

" + } + }, + "deviceCapacities": { + "target": "com.amazonaws.snowdevicemanagement#CapacityList", + "traits": { + "smithy.api#documentation": "

The hardware specifications of the device.

" + } + }, + "software": { + "target": "com.amazonaws.snowdevicemanagement#SoftwareInformation", + "traits": { + "smithy.api#documentation": "

The software installed on the device.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DescribeExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#DescribeExecutionInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#DescribeExecutionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Checks the status of a remote task running on one or more target devices.

", + "smithy.api#http": { + "method": "POST", + "uri": "/task/{taskId}/execution/{managedDeviceId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#DescribeExecutionInput": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId", + "traits": { + "smithy.api#documentation": "

The ID of the task that the action is describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the managed device.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DescribeExecutionOutput": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId", + "traits": { + "smithy.api#documentation": "

The ID of the task being executed on the device.

" + } + }, + "executionId": { + "target": "com.amazonaws.snowdevicemanagement#ExecutionId", + "traits": { + "smithy.api#documentation": "

The ID of the execution.

" + } + }, + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the managed device that the task is being executed on.

" + } + }, + "state": { + "target": "com.amazonaws.snowdevicemanagement#ExecutionState", + "traits": { + "smithy.api#documentation": "

The current state of the execution.

" + } + }, + "startedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the execution began.

" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the status of the execution was last updated.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DescribeTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#DescribeTaskInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#DescribeTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Checks the metadata for a given task on a device.

", + "smithy.api#http": { + "method": "POST", + "uri": "/task/{taskId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#DescribeTaskInput": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId", + "traits": { + "smithy.api#documentation": "

The ID of the task to be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DescribeTaskOutput": { + "type": "structure", + "members": { + "taskId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the task.

" + } + }, + "taskArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task.

" + } + }, + "targets": { + "target": "com.amazonaws.snowdevicemanagement#TargetList", + "traits": { + "smithy.api#documentation": "

The managed devices that the task was sent to.

" + } + }, + "state": { + "target": "com.amazonaws.snowdevicemanagement#TaskState", + "traits": { + "smithy.api#documentation": "

The current state of the task.

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the CreateTask operation was called.

" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the state of the task was last updated.

" + } + }, + "completedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the task was completed.

" + } + }, + "description": { + "target": "com.amazonaws.snowdevicemanagement#TaskDescriptionString", + "traits": { + "smithy.api#documentation": "

The description provided of the task and managed devices.

" + } + }, + "tags": { + "target": "com.amazonaws.snowdevicemanagement#TagMap", + "traits": { + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can use tags to categorize a resource\n in different ways, such as by purpose, owner, or environment.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#DeviceSummary": { + "type": "structure", + "members": { + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the device.

" + } + }, + "managedDeviceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device.

" + } + }, + "associatedWithJob": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the job used to order the device.

" + } + }, + "tags": { + "target": "com.amazonaws.snowdevicemanagement#TagMap", + "traits": { + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can use tags to categorize a resource\n in different ways, such as by purpose, owner, or environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Identifying information about the device.

" + } + }, + "com.amazonaws.snowdevicemanagement#DeviceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#DeviceSummary" + } + }, + "com.amazonaws.snowdevicemanagement#EbsInstanceBlockDevice": { + "type": "structure", + "members": { + "attachTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the attachment was initiated.

" + } + }, + "deleteOnTermination": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

A value that indicates whether the volume is deleted on instance termination.

" + } + }, + "status": { + "target": "com.amazonaws.snowdevicemanagement#AttachmentStatus", + "traits": { + "smithy.api#documentation": "

The attachment state.

" + } + }, + "volumeId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon EBS volume.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a parameter used to set up an Amazon Elastic Block Store (Amazon EBS) volume\n in a block device mapping.

" + } + }, + "com.amazonaws.snowdevicemanagement#Execution": { + "type": "resource", + "identifiers": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId" + }, + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId" + } + }, + "read": { + "target": "com.amazonaws.snowdevicemanagement#DescribeExecution" + }, + "list": { + "target": "com.amazonaws.snowdevicemanagement#ListExecutions" + } + }, + "com.amazonaws.snowdevicemanagement#ExecutionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.snowdevicemanagement#ExecutionState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUEUED", + "name": "QUEUED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "CANCELED", + "name": "CANCELED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "REJECTED", + "name": "REJECTED" + }, + { + "value": "TIMED_OUT", + "name": "TIMED_OUT" + } + ] + } + }, + "com.amazonaws.snowdevicemanagement#ExecutionSummary": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId", + "traits": { + "smithy.api#documentation": "

The ID of the task.

" + } + }, + "executionId": { + "target": "com.amazonaws.snowdevicemanagement#ExecutionId", + "traits": { + "smithy.api#documentation": "

The ID of the execution.

" + } + }, + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the managed device that the task is being executed on.

" + } + }, + "state": { + "target": "com.amazonaws.snowdevicemanagement#ExecutionState", + "traits": { + "smithy.api#documentation": "

The state of the execution.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of a task execution on a specified device.

" + } + }, + "com.amazonaws.snowdevicemanagement#ExecutionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#ExecutionSummary" + } + }, + "com.amazonaws.snowdevicemanagement#IdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "[!-~]+" + } + }, + "com.amazonaws.snowdevicemanagement#Instance": { + "type": "structure", + "members": { + "imageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the AMI used to launch the instance.

" + } + }, + "amiLaunchIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The Amazon Machine Image (AMI) launch index, which you can use to find this instance in\n the launch group.

" + } + }, + "instanceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the instance.

" + } + }, + "state": { + "target": "com.amazonaws.snowdevicemanagement#InstanceState" + }, + "instanceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The instance type.

" + } + }, + "privateIpAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The private IPv4 address assigned to the instance.

" + } + }, + "publicIpAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The public IPv4 address assigned to the instance.

" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the instance was created.

" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the instance was last updated.

" + } + }, + "blockDeviceMappings": { + "target": "com.amazonaws.snowdevicemanagement#InstanceBlockDeviceMappingList", + "traits": { + "smithy.api#documentation": "

Any block device mapping entries for the instance.

" + } + }, + "securityGroups": { + "target": "com.amazonaws.snowdevicemanagement#SecurityGroupIdentifierList", + "traits": { + "smithy.api#documentation": "

The security groups for the instance.

" + } + }, + "cpuOptions": { + "target": "com.amazonaws.snowdevicemanagement#CpuOptions", + "traits": { + "smithy.api#documentation": "

The CPU options for the instance.

" + } + }, + "rootDeviceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The device name of the root device volume (for example, /dev/sda1).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The description of an\n instance.\n Currently, Amazon EC2 instances are the only supported instance type.

" + } + }, + "com.amazonaws.snowdevicemanagement#InstanceBlockDeviceMapping": { + "type": "structure", + "members": { + "deviceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The block device name.

" + } + }, + "ebs": { + "target": "com.amazonaws.snowdevicemanagement#EbsInstanceBlockDevice", + "traits": { + "smithy.api#documentation": "

The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS)\n volumes when the instance is launched.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The description of a block device mapping.

" + } + }, + "com.amazonaws.snowdevicemanagement#InstanceBlockDeviceMappingList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#InstanceBlockDeviceMapping" + } + }, + "com.amazonaws.snowdevicemanagement#InstanceIdsList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.snowdevicemanagement#InstanceState": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The state of the instance as a 16-bit unsigned integer.

\n

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values\n between 256 and 65,535. These numerical values are used for internal purposes and should be\n ignored.

\n

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values\n between 0 and 255.

\n

The valid values for the instance state code are all in the range of the low byte. These\n values are:

\n
    \n
  • \n

    \n 0 : pending\n

    \n
    • \n
  • \n

    \n 16 : running\n

    \n
    • \n
  • \n

    \n 32 : shutting-down\n

    \n
    • \n
  • \n

    \n 48 : terminated\n

    \n
    • \n
  • \n

    \n 64 : stopping\n

    \n
    • \n
  • \n

    \n 80 : stopped\n

    \n
    • \n
\n

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in\n decimal.

" + } + }, + "name": { + "target": "com.amazonaws.snowdevicemanagement#InstanceStateName", + "traits": { + "smithy.api#documentation": "

The current\n state\n of the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The description of the current state of an instance.

" + } + }, + "com.amazonaws.snowdevicemanagement#InstanceStateName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "SHUTTING_DOWN", + "name": "SHUTTING_DOWN" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + } + ] + } + }, + "com.amazonaws.snowdevicemanagement#InstanceSummary": { + "type": "structure", + "members": { + "instance": { + "target": "com.amazonaws.snowdevicemanagement#Instance", + "traits": { + "smithy.api#documentation": "

A structure containing details about the instance.

" + } + }, + "lastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

When the instance summary was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details about the instance.

" + } + }, + "com.amazonaws.snowdevicemanagement#InstanceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#InstanceSummary" + } + }, + "com.amazonaws.snowdevicemanagement#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An unexpected error occurred while processing the request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.snowdevicemanagement#IpAddressAssignment": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DHCP", + "name": "DHCP" + }, + { + "value": "STATIC", + "name": "STATIC" + } + ] + } + }, + "com.amazonaws.snowdevicemanagement#JobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.snowdevicemanagement#ListDeviceResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#ListDeviceResourcesInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#ListDeviceResourcesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

", + "smithy.api#http": { + "method": "GET", + "uri": "/managed-device/{managedDeviceId}/resources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "resources", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#ListDeviceResourcesInput": { + "type": "structure", + "members": { + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId", + "traits": { + "smithy.api#documentation": "

The ID of the managed device that you are listing the resources of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A structure used to filter the results by type of resource.

", + "smithy.api#httpQuery": "type", + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "maxResults": { + "target": "com.amazonaws.snowdevicemanagement#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of resources per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.snowdevicemanagement#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to continue to the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListDeviceResourcesOutput": { + "type": "structure", + "members": { + "resources": { + "target": "com.amazonaws.snowdevicemanagement#ResourceSummaryList", + "traits": { + "smithy.api#documentation": "

A structure defining the resource's type, Amazon Resource Name (ARN), and ID.

" + } + }, + "nextToken": { + "target": "com.amazonaws.snowdevicemanagement#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to continue to the next page of results.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#ListDevicesInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#ListDevicesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management\n enabled in the Amazon Web Services Region where the command is run.

", + "smithy.api#http": { + "method": "GET", + "uri": "/managed-devices", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "devices", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#ListDevicesInput": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.snowdevicemanagement#JobId", + "traits": { + "smithy.api#documentation": "

The ID of the job used to order the device.

", + "smithy.api#httpQuery": "jobId" + } + }, + "maxResults": { + "target": "com.amazonaws.snowdevicemanagement#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of devices to list per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.snowdevicemanagement#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to continue to the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListDevicesOutput": { + "type": "structure", + "members": { + "devices": { + "target": "com.amazonaws.snowdevicemanagement#DeviceSummaryList", + "traits": { + "smithy.api#documentation": "

A list of device structures that contain information about the device.

" + } + }, + "nextToken": { + "target": "com.amazonaws.snowdevicemanagement#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to continue to the next page of devices.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#ListExecutionsInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#ListExecutionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the status of tasks for one or more target devices.

", + "smithy.api#http": { + "method": "GET", + "uri": "/executions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "executions", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#ListExecutionsInput": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId", + "traits": { + "smithy.api#documentation": "

The ID of the task.

", + "smithy.api#httpQuery": "taskId", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.snowdevicemanagement#ExecutionState", + "traits": { + "smithy.api#documentation": "

A structure used to filter the tasks by their current state.

", + "smithy.api#httpQuery": "state" + } + }, + "maxResults": { + "target": "com.amazonaws.snowdevicemanagement#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of tasks to list per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.snowdevicemanagement#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to continue to the next page of tasks.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListExecutionsOutput": { + "type": "structure", + "members": { + "executions": { + "target": "com.amazonaws.snowdevicemanagement#ExecutionSummaryList", + "traits": { + "smithy.api#documentation": "

A list of executions. Each execution contains the task ID, the device that the task is\n executing on, the execution ID, and the status of the execution.

" + } + }, + "nextToken": { + "target": "com.amazonaws.snowdevicemanagement#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to continue to the next page of executions.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of tags for a managed device or task.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device or task.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.snowdevicemanagement#TagMap", + "traits": { + "smithy.api#documentation": "

The list of tags for the device or task.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#ListTasksInput" + }, + "output": { + "target": "com.amazonaws.snowdevicemanagement#ListTasksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#AccessDeniedException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ThrottlingException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of tasks that can be filtered by state.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tasks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "tasks", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.snowdevicemanagement#ListTasksInput": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.snowdevicemanagement#TaskState", + "traits": { + "smithy.api#documentation": "

A structure used to filter the list of tasks.

", + "smithy.api#httpQuery": "state" + } + }, + "maxResults": { + "target": "com.amazonaws.snowdevicemanagement#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of tasks per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.snowdevicemanagement#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to continue to the next page of tasks.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ListTasksOutput": { + "type": "structure", + "members": { + "tasks": { + "target": "com.amazonaws.snowdevicemanagement#TaskSummaryList", + "traits": { + "smithy.api#documentation": "

A list of task structures containing details about each task.

" + } + }, + "nextToken": { + "target": "com.amazonaws.snowdevicemanagement#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to continue to the next page of tasks.

" + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ManagedDevice": { + "type": "resource", + "identifiers": { + "managedDeviceId": { + "target": "com.amazonaws.snowdevicemanagement#ManagedDeviceId" + } + }, + "read": { + "target": "com.amazonaws.snowdevicemanagement#DescribeDevice" + }, + "list": { + "target": "com.amazonaws.snowdevicemanagement#ListDevices" + }, + "operations": [ + { + "target": "com.amazonaws.snowdevicemanagement#DescribeDeviceEc2Instances" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ListDeviceResources" + } + ], + "traits": { + "aws.api#arn": { + "template": "managed-device/{managedDeviceId}", + "absolute": false, + "noAccount": false, + "noRegion": false + } + } + }, + "com.amazonaws.snowdevicemanagement#ManagedDeviceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.snowdevicemanagement#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.snowdevicemanagement#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "[a-zA-Z0-9+/=]*" + } + }, + "com.amazonaws.snowdevicemanagement#PhysicalConnectorType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RJ45", + "name": "RJ45" + }, + { + "value": "SFP_PLUS", + "name": "SFP_PLUS" + }, + { + "value": "QSFP", + "name": "QSFP" + }, + { + "value": "RJ45_2", + "name": "RJ45_2" + }, + { + "value": "WIFI", + "name": "WIFI" + } + ] + } + }, + "com.amazonaws.snowdevicemanagement#PhysicalNetworkInterface": { + "type": "structure", + "members": { + "physicalNetworkInterfaceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The physical network interface ID.

" + } + }, + "physicalConnectorType": { + "target": "com.amazonaws.snowdevicemanagement#PhysicalConnectorType", + "traits": { + "smithy.api#documentation": "

The\n physical\n connector type.

" + } + }, + "ipAddressAssignment": { + "target": "com.amazonaws.snowdevicemanagement#IpAddressAssignment", + "traits": { + "smithy.api#documentation": "

A value that describes whether the IP address is dynamic or persistent.

" + } + }, + "ipAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The IP address of the device.

" + } + }, + "netmask": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The netmask used to divide the IP address into subnets.

" + } + }, + "defaultGateway": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The default gateway of the device.

" + } + }, + "macAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The MAC address of the device.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details about the physical network interface for the device.

" + } + }, + "com.amazonaws.snowdevicemanagement#PhysicalNetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#PhysicalNetworkInterface" + } + }, + "com.amazonaws.snowdevicemanagement#Reboot": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A structure used to reboot the device.

" + } + }, + "com.amazonaws.snowdevicemanagement#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request references a resource that doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.snowdevicemanagement#ResourceSummary": { + "type": "structure", + "members": { + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource type.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of a resource available on the device.

" + } + }, + "com.amazonaws.snowdevicemanagement#ResourceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#ResourceSummary" + } + }, + "com.amazonaws.snowdevicemanagement#SecurityGroupIdentifier": { + "type": "structure", + "members": { + "groupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The security group ID.

" + } + }, + "groupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The security group name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the device's security group.

" + } + }, + "com.amazonaws.snowdevicemanagement#SecurityGroupIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#SecurityGroupIdentifier" + } + }, + "com.amazonaws.snowdevicemanagement#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request would cause a service quota to be exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.snowdevicemanagement#SnowDeviceManagement": { + "type": "service", + "version": "2021-08-04", + "operations": [ + { + "target": "com.amazonaws.snowdevicemanagement#ListTagsForResource" + }, + { + "target": "com.amazonaws.snowdevicemanagement#TagResource" + }, + { + "target": "com.amazonaws.snowdevicemanagement#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.snowdevicemanagement#ManagedDevice" + }, + { + "target": "com.amazonaws.snowdevicemanagement#Task" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Snow Device Management", + "arnNamespace": "snow-device-management", + "cloudFormationName": "SnowDeviceManagement", + "cloudTrailEventSource": "snow-device-management.amazonaws.com", + "endpointPrefix": "snow-device-management" + }, + "aws.auth#sigv4": { + "name": "snow-device-management" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

Amazon Web Services Snow Device Management documentation.

", + "smithy.api#title": "AWS Snow Device Management" + } + }, + "com.amazonaws.snowdevicemanagement#SoftwareInformation": { + "type": "structure", + "members": { + "installedVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The version of the software currently installed on the device.

" + } + }, + "installingVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The version of the software being installed on the device.

" + } + }, + "installState": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The state of the software that is installed or that is being installed on the\n device.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the software on the device.

" + } + }, + "com.amazonaws.snowdevicemanagement#TagKeys": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.snowdevicemanagement#TagMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.snowdevicemanagement#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#TagResourceInput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or replaces tags on a device or task.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.snowdevicemanagement#TagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device or task.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.snowdevicemanagement#TagMap", + "traits": { + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can use tags to categorize a resource\n in different ways, such as by purpose, owner, or environment.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#TargetList": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.snowdevicemanagement#Task": { + "type": "resource", + "identifiers": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId" + } + }, + "create": { + "target": "com.amazonaws.snowdevicemanagement#CreateTask" + }, + "read": { + "target": "com.amazonaws.snowdevicemanagement#DescribeTask" + }, + "list": { + "target": "com.amazonaws.snowdevicemanagement#ListTasks" + }, + "operations": [ + { + "target": "com.amazonaws.snowdevicemanagement#CancelTask" + } + ], + "resources": [ + { + "target": "com.amazonaws.snowdevicemanagement#Execution" + } + ], + "traits": { + "aws.api#arn": { + "template": "task/{taskId}", + "absolute": false, + "noAccount": false, + "noRegion": false + } + } + }, + "com.amazonaws.snowdevicemanagement#TaskDescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "[A-Za-z0-9 _.,!#]*" + } + }, + "com.amazonaws.snowdevicemanagement#TaskId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.snowdevicemanagement#TaskState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "CANCELED", + "name": "CANCELED" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + } + ] + } + }, + "com.amazonaws.snowdevicemanagement#TaskSummary": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.snowdevicemanagement#TaskId", + "traits": { + "smithy.api#documentation": "

The task ID.

", + "smithy.api#required": {} + } + }, + "taskArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task.

" + } + }, + "state": { + "target": "com.amazonaws.snowdevicemanagement#TaskState", + "traits": { + "smithy.api#documentation": "

The state of the task assigned to one or many devices.

" + } + }, + "tags": { + "target": "com.amazonaws.snowdevicemanagement#TagMap", + "traits": { + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can use tags to categorize a resource\n in different ways, such as by purpose, owner, or environment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the task assigned to one or many devices.

" + } + }, + "com.amazonaws.snowdevicemanagement#TaskSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.snowdevicemanagement#TaskSummary" + } + }, + "com.amazonaws.snowdevicemanagement#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.snowdevicemanagement#Unlock": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

A structure used to unlock a device.

" + } + }, + "com.amazonaws.snowdevicemanagement#UnlockState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNLOCKED", + "name": "UNLOCKED" + }, + { + "value": "LOCKED", + "name": "LOCKED" + }, + { + "value": "UNLOCKING", + "name": "UNLOCKING" + } + ] + } + }, + "com.amazonaws.snowdevicemanagement#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.snowdevicemanagement#UntagResourceInput" + }, + "errors": [ + { + "target": "com.amazonaws.snowdevicemanagement#InternalServerException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.snowdevicemanagement#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag from a device or task.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.snowdevicemanagement#UntagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device or task.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.snowdevicemanagement#TagKeys", + "traits": { + "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can use tags to categorize a resource\n in different ways, such as by purpose, owner, or environment.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.snowdevicemanagement#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} diff --git a/aws/sdk/aws-models/ssm-incidents.json b/aws/sdk/aws-models/ssm-incidents.json index 20f4f25d93..e69198da48 100644 --- a/aws/sdk/aws-models/ssm-incidents.json +++ b/aws/sdk/aws-models/ssm-incidents.json @@ -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": "

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.

\n

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.

", - "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": "

A token ensuring that the action is called only once with the specified details.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#idempotencyToken": {} } }, "incidentRecordArn": { @@ -574,7 +457,7 @@ "eventData": { "target": "com.amazonaws.ssmincidents#EventData", "traits": { - "smithy.api#documentation": "

A short description of the event.

", + "smithy.api#documentation": "

A valid JSON string. There is no other schema imposed. A short description of the event.

", "smithy.api#required": {} } } @@ -1555,7 +1438,7 @@ "notificationTargets": { "target": "com.amazonaws.ssmincidents#NotificationTargetSet", "traits": { - "smithy.api#documentation": "

The SNS targets that\n AWS Chatbot uses\n to notify the chat channels and perform actions on the incident record.

" + "smithy.api#documentation": "

The SNS targets that are notified when updates are made to an incident.

" } } }, @@ -1727,7 +1610,7 @@ "notificationTargets": { "target": "com.amazonaws.ssmincidents#NotificationTargetSet", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

The SNS targets that are notified when updates are made to an incident.

" } } }, @@ -2349,7 +2232,7 @@ } }, "traits": { - "smithy.api#documentation": "

The SNS topic that's used by\n AWS\n Chatbot to notify the incidents chat channel.

" + "smithy.api#documentation": "

The SNS targets that are notified when updates are made to an incident.

" } }, "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": "

The Amazon Resource Name (ARN) of the replication set.

" + } + }, "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": "

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.

\n

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.

", + "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": "

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.

\n

Using multiple SNS topics creates redundancy in the case that a Region is down during\n the incident.

" + "smithy.api#documentation": "

The SNS targets that are notified when updates are made to an incident.

\n

Using multiple SNS topics creates redundancy in the case that a Region is down during\n the incident.

" } } } @@ -3902,13 +3907,13 @@ "incidentTemplateNotificationTargets": { "target": "com.amazonaws.ssmincidents#NotificationTargetSet", "traits": { - "smithy.api#documentation": "

The SNS targets that\n AWS\n Chatbot uses to notify the chat channels and perform actions on the\n incident record.

" + "smithy.api#documentation": "

The SNS targets that are notified when updates are made to an incident.

" } }, "chatChannel": { "target": "com.amazonaws.ssmincidents#ChatChannel", "traits": { - "smithy.api#documentation": "

The\n AWS\n Chatbot chat channel used for collaboration during an\n incident.

" + "smithy.api#documentation": "

The\n AWS\n Chatbot chat channel used for collaboration during an\n incident.

\n

Use the empty structure to remove the chat channel from the response plan.

" } }, "engagements": { @@ -3974,8 +3979,7 @@ "target": "com.amazonaws.ssmincidents#ClientToken", "traits": { "smithy.api#documentation": "

A token ensuring that the action is called only once with the specified details.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} + "smithy.api#idempotencyToken": {} } }, "incidentRecordArn": { diff --git a/aws/sdk/aws-models/ssm.json b/aws/sdk/aws-models/ssm.json index da6e88dda4..3d391396bc 100644 --- a/aws/sdk/aws-models/ssm.json +++ b/aws/sdk/aws-models/ssm.json @@ -59,7 +59,7 @@ "AccountId": { "target": "com.amazonaws.ssm#AccountId", "traits": { - "smithy.api#documentation": "

The account ID where the current document is shared.

" + "smithy.api#documentation": "

The Amazon Web Services account ID where the current document is shared.

" } }, "SharedDocumentVersion": { @@ -70,7 +70,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information includes the account ID where the current document is shared and the\n version shared with that account.

" + "smithy.api#documentation": "

Information includes the Amazon Web Services account ID where the current document is shared and the\n version shared with that account.

" } }, "com.amazonaws.ssm#AccountSharingInfoList": { @@ -82,7 +82,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of of accounts where the current document is shared and the version shared with\n each account.

" + "smithy.api#documentation": "

A list of of Amazon Web Services accounts where the current document is shared and the version shared with\n each account.

" } }, "com.amazonaws.ssm#Accounts": { @@ -829,7 +829,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of the instance.

" + "smithy.api#documentation": "

The instance ID.

" } }, "AssociationId": { @@ -936,7 +936,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of the instance.

" + "smithy.api#documentation": "

The instance ID.

" } }, "AssociationVersion": { @@ -1068,7 +1068,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

The combination of Regions and accounts where you want to run the\n association.

" + "smithy.api#documentation": "

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association.

" } } }, @@ -1769,7 +1769,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

The combination of Regions and accounts where you wanted to run the association\n when this association version was created.

" + "smithy.api#documentation": "

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association\n when this association version was created.

" } } }, @@ -2203,7 +2203,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

The combination of Regions and/or accounts where you want to run the\n Automation.

" + "smithy.api#documentation": "

The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the\n Automation.

" } }, "ProgressCounters": { @@ -2520,7 +2520,7 @@ "AutomationType": { "target": "com.amazonaws.ssm#AutomationType", "traits": { - "smithy.api#documentation": "

Use this filter with DescribeAutomationExecutions. Specify either Local or\n CrossAccount. CrossAccount is an Automation that runs in multiple Regions and\n accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

Use this filter with DescribeAutomationExecutions. 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 Running Automation workflows in multiple Amazon Web Services Regions and accounts in the\n Amazon Web Services Systems Manager User Guide.

" } }, "AutomationSubtype": { @@ -3104,7 +3104,7 @@ "OutputS3Region": { "target": "com.amazonaws.ssm#S3Region", "traits": { - "smithy.api#documentation": "

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.

" + "smithy.api#documentation": "

(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.

" } }, "OutputS3BucketName": { @@ -4142,7 +4142,7 @@ "IamRole": { "target": "com.amazonaws.ssm#IamRole", "traits": { - "smithy.api#documentation": "

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 ssm.amazonaws.com. For more information, see Create an\n IAM service role for a hybrid environment in the\n Amazon Web Services Systems Manager User Guide.

", + "smithy.api#documentation": "

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 ssm.amazonaws.com. For more information, see Create an\n IAM service role for a hybrid environment in the\n Amazon Web Services Systems Manager User Guide.

", "smithy.api#required": {} } }, @@ -4310,14 +4310,14 @@ "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

The name of the SSM document that contains the configuration information for the instance.\n You can specify Command or Automation runbooks.

\n

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.

\n

For SSM documents that are shared with you from other accounts, you must specify the\n complete SSM document ARN, in the following format:

\n

\n arn:aws:ssm:region:account-id:document/document-name\n \n

\n

For example:

\n

\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n

\n

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, AWS-ApplyPatchBaseline or\n My-Document.

", + "smithy.api#documentation": "

The name of the SSM document that contains the configuration information for the instance.\n You can specify Command or Automation runbooks.

\n

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.

\n

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:

\n

\n arn:aws:ssm:region:account-id:document/document-name\n \n

\n

For example:

\n

\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n

\n

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, AWS-ApplyPatchBaseline or\n My-Document.

", "smithy.api#required": {} } }, "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of the instance.

" + "smithy.api#documentation": "

The instance ID.

\n \n

\n InstanceId has been deprecated. To specify an instance ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID 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 InstanceId, you can't use the parameters AssociationName,\n DocumentVersion, MaxErrors, MaxConcurrency,\n OutputLocation, or ScheduleExpression. To use these parameters, you\n must use the Targets parameter.

\n " } }, "Parameters": { @@ -4432,7 +4432,7 @@ "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.

\n

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.

\n

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:

\n

\n arn:partition:ssm:region:account-id:document/document-name\n \n

\n

For example:

\n

\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n

\n

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, AWS-ApplyPatchBaseline or\n My-Document.

", + "smithy.api#documentation": "

The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.

\n

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.

\n

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:

\n

\n arn:partition:ssm:region:account-id:document/document-name\n \n

\n

For example:

\n

\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n

\n

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, AWS-ApplyPatchBaseline or\n My-Document.

", "smithy.api#required": {} } }, @@ -4457,7 +4457,7 @@ "Targets": { "target": "com.amazonaws.ssm#Targets", "traits": { - "smithy.api#documentation": "

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 Using targets and rate controls with State Manager associations in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

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 Using targets and rate controls with State Manager associations in the\n Amazon Web Services Systems Manager User Guide.

" } }, "ScheduleExpression": { @@ -4523,7 +4523,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to create an association in multiple Regions and multiple\n accounts.

" } } } @@ -4950,7 +4950,7 @@ "Tags": { "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n an 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:

\n
    \n
  • \n

    \n Key=Environment,Value=Production\n

    \n
    • \n
  • \n

    \n Key=Region,Value=us-east-2\n

    \n
    • \n
" + "smithy.api#documentation": "

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:

\n
    \n
  • \n

    \n Key=Environment,Value=Production\n

    \n
    • \n
  • \n

    \n Key=Region,Value=us-east-2\n

    \n
    • \n
" } } } @@ -5109,7 +5109,7 @@ } ], "traits": { - "smithy.api#documentation": "

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: SyncToDestination and\n SyncFromSource.

\n

You can configure Systems Manager Inventory to use the SyncToDestination type to\n synchronize Inventory data from multiple Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data\n sync for Inventory in the Amazon Web Services Systems Manager User Guide.

\n

You can configure Systems Manager Explorer to use the SyncFromSource 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 EntireOrganization by using Organizations. For more\n information, see Setting up Systems Manager\n Explorer to display data from multiple accounts and Regions in the\n Amazon Web Services Systems Manager User Guide.

\n

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 ListResourceDataSync.

\n \n

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.

\n " + "smithy.api#documentation": "

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: SyncToDestination and\n SyncFromSource.

\n

You can configure Systems Manager Inventory to use the SyncToDestination 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 Configuring resource data\n sync for Inventory in the Amazon Web Services Systems Manager User Guide.

\n

You can configure Systems Manager Explorer to use the SyncFromSource 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 EntireOrganization by using Organizations. For more\n information, see Setting up Systems Manager\n Explorer to display data from multiple accounts and Regions in the\n Amazon Web Services Systems Manager User Guide.

\n

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 ListResourceDataSync.

\n \n

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.

\n " } }, "com.amazonaws.ssm#CreateResourceDataSyncRequest": { @@ -5131,7 +5131,7 @@ "SyncType": { "target": "com.amazonaws.ssm#ResourceDataSyncType", "traits": { - "smithy.api#documentation": "

Specify SyncToDestination to create a resource data sync that synchronizes data\n to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a\n value for S3Destination. Specify SyncFromSource 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 SyncFromSource, you must provide a\n value for SyncSource. The default value is SyncToDestination.

" + "smithy.api#documentation": "

Specify SyncToDestination to create a resource data sync that synchronizes data\n to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a\n value for S3Destination. Specify SyncFromSource 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 SyncFromSource, you must provide a\n value for SyncSource. The default value is SyncToDestination.

" } }, "SyncSource": { @@ -5249,7 +5249,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified\n instance.

\n

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.

" + "smithy.api#documentation": "

Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified instance.\n If you created the association by using the Targets parameter, then you must delete\n the association by using the association ID.

\n

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.

" } }, "com.amazonaws.ssm#DeleteAssociationRequest": { @@ -5264,7 +5264,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of the instance.

" + "smithy.api#documentation": "

The instance ID.

\n \n

\n InstanceId has been deprecated. To specify an instance ID for an association,\n use the Targets parameter. Requests that include the\n parameter InstanceID 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 InstanceId, you can't use the parameters AssociationName,\n DocumentVersion, MaxErrors, MaxConcurrency,\n OutputLocation, or ScheduleExpression. To use these parameters, you\n must use the Targets parameter.

\n " } }, "AssociationId": { @@ -5518,7 +5518,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete a parameter from the system.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.ssm#DeleteParameterRequest": { @@ -5551,7 +5551,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete a list of parameters.

" + "smithy.api#documentation": "

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to\n create a parameter with the same name.

" } }, "com.amazonaws.ssm#DeleteParametersRequest": { @@ -5560,7 +5560,7 @@ "Names": { "target": "com.amazonaws.ssm#ParameterNameList", "traits": { - "smithy.api#documentation": "

The names of the parameters to delete.

", + "smithy.api#documentation": "

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.

", "smithy.api#required": {} } } @@ -5992,7 +5992,7 @@ "ActivationList": { "target": "com.amazonaws.ssm#ActivationList", "traits": { - "smithy.api#documentation": "

A list of activations for your account.

" + "smithy.api#documentation": "

A list of activations for your Amazon Web Services account.

" } }, "NextToken": { @@ -6029,7 +6029,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the association for the specified target or instance. If you created the\n association by using the Targets 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.

" + "smithy.api#documentation": "

Describes the association for the specified target or instance. If you created the\n association by using the Targets parameter, then you must retrieve the association\n by using the association ID.

" } }, "com.amazonaws.ssm#DescribeAssociationExecutionTargets": { @@ -6512,7 +6512,7 @@ } ], "traits": { - "smithy.api#documentation": "

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 (All).

" + "smithy.api#documentation": "

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 (All).

" } }, "com.amazonaws.ssm#DescribeDocumentPermissionRequest": { @@ -6553,13 +6553,13 @@ "AccountIds": { "target": "com.amazonaws.ssm#AccountIdList", "traits": { - "smithy.api#documentation": "

The account IDs that have permission to use this document. The ID can be either an\n account or All.

" + "smithy.api#documentation": "

The account IDs that have permission to use this document. The ID can be either an\n Amazon Web Services account or All.

" } }, "AccountSharingInfoList": { "target": "com.amazonaws.ssm#AccountSharingInfoList", "traits": { - "smithy.api#documentation": "

A list of accounts where the current document is shared and the version shared with\n each account.

" + "smithy.api#documentation": "

A list of Amazon Web Services accounts where the current document is shared and the version shared with\n each account.

" } }, "NextToken": { @@ -7671,7 +7671,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the maintenance windows in an account.

", + "smithy.api#documentation": "

Retrieves the maintenance windows in an Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7951,7 +7951,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the patch baselines in your account.

", + "smithy.api#documentation": "

Lists the patch baselines in your Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -10043,7 +10043,7 @@ "Target": { "target": "com.amazonaws.ssm#SessionTarget", "traits": { - "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#documentation": "

The instance ID.

", "smithy.api#required": {} } } @@ -10131,7 +10131,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the current snapshot for the patch baseline the instance uses. This API is\n primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

\n \n

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 AWS-RunShellScript document or the\n AWS-RunPowerShellScript document.

\n " + "smithy.api#documentation": "

Retrieves the current snapshot for the patch baseline the instance uses. This API is\n primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

\n \n

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 AWS-RunShellScript document or the\n AWS-RunPowerShellScript document.

\n " } }, "com.amazonaws.ssm#GetDeployablePatchSnapshotForInstanceRequest": { @@ -10165,7 +10165,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of the instance.

" + "smithy.api#documentation": "

The instance ID.

" } }, "SnapshotId": { @@ -10356,7 +10356,7 @@ } ], "traits": { - "smithy.api#documentation": "

Query inventory information.

", + "smithy.api#documentation": "

Query inventory information. This includes instance status, such as Stopped or\n Terminated.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -11293,7 +11293,7 @@ "Entities": { "target": "com.amazonaws.ssm#OpsEntityList", "traits": { - "smithy.api#documentation": "

The list of aggregated and filtered OpsData.

" + "smithy.api#documentation": "

The list of aggregated details and filtered OpsData.

" } }, "NextToken": { @@ -11327,7 +11327,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get information about a parameter by using the parameter name. Don't confuse this API\n operation with the GetParameters API operation.

" + "smithy.api#documentation": "

Get information about a single parameter by specifying the parameter name.

\n \n

To get information about more than one parameter at a time, use the GetParameters operation.

\n " } }, "com.amazonaws.ssm#GetParameterHistory": { @@ -11416,7 +11416,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

The name of the parameter you want to query.

", + "smithy.api#documentation": "

The name of the parameter you want to query.

\n

To query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".

", "smithy.api#required": {} } }, @@ -11457,7 +11457,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get details of a parameter. Don't confuse this API operation with the GetParameter API operation.

" + "smithy.api#documentation": "

Get information about one or more parameters by specifying multiple parameter names.

\n \n

To get information about a single parameter, you can use the GetParameter\n operation instead.

\n " } }, "com.amazonaws.ssm#GetParametersByPath": { @@ -11574,7 +11574,7 @@ "Names": { "target": "com.amazonaws.ssm#ParameterNameList", "traits": { - "smithy.api#documentation": "

Names of the parameters for which you want to query information.

", + "smithy.api#documentation": "

Names of the parameters for which you want to query information.

\n

To query by parameter label, use \"Name\": \"name:label\". To query by parameter\n version, use \"Name\": \"name:version\".

", "smithy.api#required": {} } }, @@ -11691,7 +11691,7 @@ "BaselineId": { "target": "com.amazonaws.ssm#BaselineId", "traits": { - "smithy.api#documentation": "

The ID of the patch baseline to retrieve.

", + "smithy.api#documentation": "

The ID of the patch baseline to retrieve.

\n \n

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 AWS-AmazonLinuxDefaultPatchBaseline, specify\n arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0e392de35e7c563b7 instead of\n pb-0e392de35e7c563b7.

\n ", "smithy.api#required": {} } } @@ -11810,7 +11810,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n ServiceSetting 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 false. This means the user can't use\n this feature unless they change the setting to true and intentionally opt in for a\n paid feature.

\n

Services map a SettingId object to a setting value. Amazon Web Services services teams define\n the default value for a SettingId. You can't create a new SettingId,\n but you can overwrite the default value if you have the ssm:UpdateServiceSetting\n permission for the setting. Use the UpdateServiceSetting API operation to\n change the default setting. Or use the ResetServiceSetting to change the value\n back to the original value defined by the Amazon Web Services service team.

\n

Query the current service setting for the account.

" + "smithy.api#documentation": "

\n ServiceSetting 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 false. This means the user can't use\n this feature unless they change the setting to true and intentionally opt in for a\n paid feature.

\n

Services map a SettingId object to a setting value. Amazon Web Services services teams define\n the default value for a SettingId. You can't create a new SettingId,\n but you can overwrite the default value if you have the ssm:UpdateServiceSetting\n permission for the setting. Use the UpdateServiceSetting API operation to\n change the default setting. Or use the ResetServiceSetting to change the value\n back to the original value defined by the Amazon Web Services service team.

\n

Query the current service setting for the Amazon Web Services account.

" } }, "com.amazonaws.ssm#GetServiceSettingRequest": { @@ -14399,7 +14399,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

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.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -14569,7 +14569,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the commands requested by users of the account.

", + "smithy.api#documentation": "

Lists the commands requested by users of the Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -14812,7 +14812,7 @@ } ], "traits": { - "smithy.api#documentation": "

Information about approval reviews for a version of an SSM document.

" + "smithy.api#documentation": "

Information about approval reviews for a version of a change template in Change Manager.

" } }, "com.amazonaws.ssm#ListDocumentMetadataHistoryRequest": { @@ -14821,14 +14821,14 @@ "Name": { "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

The name of the document.

", + "smithy.api#documentation": "

The name of the change template.

", "smithy.api#required": {} } }, "DocumentVersion": { "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

The version of the document.

" + "smithy.api#documentation": "

The version of the change template.

" } }, "Metadata": { @@ -14859,25 +14859,25 @@ "Name": { "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

The name of the document.

" + "smithy.api#documentation": "

The name of the change template.

" } }, "DocumentVersion": { "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

The version of the document.

" + "smithy.api#documentation": "

The version of the change template.

" } }, "Author": { "target": "com.amazonaws.ssm#DocumentAuthor", "traits": { - "smithy.api#documentation": "

The user ID of the person in the organization who requested the document review.

" + "smithy.api#documentation": "

The user ID of the person in the organization who requested the review of the\n change template.

" } }, "Metadata": { "target": "com.amazonaws.ssm#DocumentMetadataResponseInfo", "traits": { - "smithy.api#documentation": "

Information about the response to the document approval request.

" + "smithy.api#documentation": "

Information about the response to the change template approval request.

" } }, "NextToken": { @@ -14979,7 +14979,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

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.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -15166,7 +15166,7 @@ } ], "traits": { - "smithy.api#documentation": "

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.

", + "smithy.api#documentation": "

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.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -15468,7 +15468,7 @@ "SyncType": { "target": "com.amazonaws.ssm#ResourceDataSyncType", "traits": { - "smithy.api#documentation": "

View a list of resource data syncs according to the sync type. Specify\n SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from Organizations\n or from multiple Regions.

" + "smithy.api#documentation": "

View a list of resource data syncs according to the sync type. Specify\n SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from Organizations\n or from multiple Amazon Web Services Regions.

" } }, "NextToken": { @@ -15575,7 +15575,7 @@ "S3Region": { "target": "com.amazonaws.ssm#S3Region", "traits": { - "smithy.api#documentation": "

The Region where the S3 bucket is located.

", + "smithy.api#documentation": "

The Amazon Web Services Region where the S3 bucket is located.

", "smithy.api#required": {} } } @@ -17336,7 +17336,7 @@ "CreatedBy": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

The ARN of the account that created the OpsItem.

" + "smithy.api#documentation": "

The ARN of the Amazon Web Services account that created the OpsItem.

" } }, "OpsItemType": { @@ -17360,7 +17360,7 @@ "LastModifiedBy": { "target": "com.amazonaws.ssm#String", "traits": { - "smithy.api#documentation": "

The ARN of the account that last updated the OpsItem.

" + "smithy.api#documentation": "

The ARN of the Amazon Web Services account that last updated the OpsItem.

" } }, "LastModifiedTime": { @@ -17461,7 +17461,7 @@ } }, "traits": { - "smithy.api#documentation": "

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 OpsCenter in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

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.

\n

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 OpsCenter in the Amazon Web Services Systems Manager User Guide.

" } }, "com.amazonaws.ssm#OpsItemAlreadyExistsException": { @@ -19027,7 +19027,7 @@ "code": "ParameterLimitExceeded", "httpResponseCode": 429 }, - "smithy.api#documentation": "

You have exceeded the number of parameters for this account. Delete one or more\n parameters and try again.

", + "smithy.api#documentation": "

You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more\n parameters and try again.

", "smithy.api#error": "client" } }, @@ -20521,31 +20521,31 @@ "TotalSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

The total number of steps run in all specified Regions and accounts for the\n current Automation execution.

" + "smithy.api#documentation": "

The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the\n current Automation execution.

" } }, "SuccessSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

The total number of steps that successfully completed in all specified Regions and\n accounts for the current Automation execution.

" + "smithy.api#documentation": "

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.

" } }, "FailedSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

The total number of steps that failed to run in all specified Regions and\n accounts for the current Automation execution.

" + "smithy.api#documentation": "

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.

" } }, "CancelledSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

The total number of steps that the system cancelled in all specified Regions and\n accounts for the current Automation execution.

" + "smithy.api#documentation": "

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.

" } }, "TimedOutSteps": { "target": "com.amazonaws.ssm#Integer", "traits": { - "smithy.api#documentation": "

The total number of steps that timed out in all specified Regions and accounts\n for the current Automation execution.

" + "smithy.api#documentation": "

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.

" } } }, @@ -20792,7 +20792,7 @@ "Name": { "target": "com.amazonaws.ssm#PSParameterName", "traits": { - "smithy.api#documentation": "

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: /Dev/DBServer/MySQL/db-string13\n

\n

Naming Constraints:

\n
    \n
  • \n

    Parameter names are case sensitive.

    \n
    • \n
  • \n

    A parameter name must be unique within an Region

    \n
    • \n
  • \n

    A parameter name can't be prefixed with \"aws\" or \"ssm\"\n (case-insensitive).

    \n
    • \n
  • \n

    Parameter names can include only the following symbols and letters:\n a-zA-Z0-9_.-\n

    \n

    In addition, the slash character ( / ) is used to delineate hierarchies in parameter\n names. For example: /Dev/Production/East/Project-ABC/MyParameter\n

    \n
    • \n
  • \n

    A parameter name can't include spaces.

    \n
    • \n
  • \n

    Parameter hierarchies are limited to a maximum depth of fifteen levels.

    \n
    • \n
\n

For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

\n \n

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:

\n

\n arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName\n

\n ", + "smithy.api#documentation": "

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: /Dev/DBServer/MySQL/db-string13\n

\n

Naming Constraints:

\n
    \n
  • \n

    Parameter names are case sensitive.

    \n
    • \n
  • \n

    A parameter name must be unique within an Amazon Web Services Region

    \n
    • \n
  • \n

    A parameter name can't be prefixed with \"aws\" or \"ssm\"\n (case-insensitive).

    \n
    • \n
  • \n

    Parameter names can include only the following symbols and letters:\n a-zA-Z0-9_.-\n

    \n

    In addition, the slash character ( / ) is used to delineate hierarchies in parameter\n names. For example: /Dev/Production/East/Project-ABC/MyParameter\n

    \n
    • \n
  • \n

    A parameter name can't include spaces.

    \n
    • \n
  • \n

    Parameter hierarchies are limited to a maximum depth of fifteen levels.

    \n
    • \n
\n

For additional information about valid values for parameter names, see Creating Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

\n \n

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:

\n

\n arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName\n

\n ", "smithy.api#required": {} } }, @@ -20818,7 +20818,7 @@ "KeyId": { "target": "com.amazonaws.ssm#ParameterKeyId", "traits": { - "smithy.api#documentation": "

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 SecureString\n data type.

\n

If you don't specify a key ID, the system uses the default key associated with your\n account.

\n
    \n
  • \n

    To use your default KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates\n Key ID with your default KMS key.

    \n
    • \n
  • \n

    To use a custom KMS key, choose the SecureString\n data type with the Key ID parameter.

    \n
    • \n
" + "smithy.api#documentation": "

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 SecureString\n data type.

\n

If you don't specify a key ID, the system uses the default key associated with your\n Amazon Web Services account.

\n
    \n
  • \n

    To use your default KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates\n Key ID with your default KMS key.

    \n
    • \n
  • \n

    To use a custom KMS key, choose the SecureString\n data type with the Key ID parameter.

    \n
    • \n
" } }, "Overwrite": { @@ -20843,7 +20843,7 @@ "Tier": { "target": "com.amazonaws.ssm#ParameterTier", "traits": { - "smithy.api#documentation": "

The parameter tier to assign to a parameter.

\n

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.

\n

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 Standard and\n advanced parameter tiers in the Amazon Web Services Systems Manager User Guide.

\n

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.

\n

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.

\n

\n Using the Default Tier Configuration\n

\n

In PutParameter 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.

\n

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:

\n
    \n
  • \n

    \n Advanced: With this option, Parameter Store evaluates all\n requests as advanced parameters.

    \n
    • \n
  • \n

    \n Intelligent-Tiering: With this option, Parameter Store\n evaluates each request to determine if the parameter is standard or advanced.

    \n

    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.

    \n

    This approach helps control your parameter-related costs by always creating standard\n parameters unless an advanced parameter is necessary.

    \n
    • \n
\n

Options that require an advanced parameter include the following:

\n
    \n
  • \n

    The content size of the parameter is more than 4 KB.

    \n
    • \n
  • \n

    The parameter uses a parameter policy.

    \n
    • \n
  • \n

    More than 10,000 parameters already exist in your account in the current\n Region.

    \n
    • \n
\n

For more information about configuring the default tier option, see Specifying a\n default parameter tier in the Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

The parameter tier to assign to a parameter.

\n

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.

\n

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 Standard and\n advanced parameter tiers in the Amazon Web Services Systems Manager User Guide.

\n

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.

\n

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.

\n

\n Using the Default Tier Configuration\n

\n

In PutParameter 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.

\n

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:

\n
    \n
  • \n

    \n Advanced: With this option, Parameter Store evaluates all\n requests as advanced parameters.

    \n
    • \n
  • \n

    \n Intelligent-Tiering: With this option, Parameter Store\n evaluates each request to determine if the parameter is standard or advanced.

    \n

    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.

    \n

    This approach helps control your parameter-related costs by always creating standard\n parameters unless an advanced parameter is necessary.

    \n
    • \n
\n

Options that require an advanced parameter include the following:

\n
    \n
  • \n

    The content size of the parameter is more than 4 KB.

    \n
    • \n
  • \n

    The parameter uses a parameter policy.

    \n
    • \n
  • \n

    More than 10,000 parameters already exist in your Amazon Web Services account in the current\n Amazon Web Services Region.

    \n
    • \n
\n

For more information about configuring the default tier option, see Specifying a\n default parameter tier in the Amazon Web Services Systems Manager User Guide.

" } }, "Policies": { @@ -20855,7 +20855,7 @@ "DataType": { "target": "com.amazonaws.ssm#ParameterDataType", "traits": { - "smithy.api#documentation": "

The data type for a String parameter. Supported data types include plain text\n and Amazon Machine Image (AMI) IDs.

\n

\n The following data type values are supported.\n

\n
    \n
  • \n

    \n text\n

    \n
    • \n
  • \n

    \n aws:ec2:image\n

    \n
    • \n
\n

When you create a String parameter and specify aws:ec2:image,\n Amazon Web Services Systems Manager validates the parameter value is in the required format, such as\n ami-12345abcdeEXAMPLE, and that the specified AMI is available in your\n account. For more information, see Native parameter support\n for Amazon Machine Image (AMI) IDs in the Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

The data type for a String parameter. Supported data types include plain text\n and Amazon Machine Image (AMI) IDs.

\n

\n The following data type values are supported.\n

\n
    \n
  • \n

    \n text\n

    \n
    • \n
  • \n

    \n aws:ec2:image\n

    \n
    • \n
\n

When you create a String parameter and specify aws:ec2:image,\n Amazon Web Services Systems Manager validates the parameter value is in the required format, such as\n ami-12345abcdeEXAMPLE, and that the specified AMI is available in your\n Amazon Web Services account. For more information, see Native parameter support\n for Amazon Machine Image (AMI) IDs in the Amazon Web Services Systems Manager User Guide.

" } } } @@ -21525,7 +21525,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the AwsOrganizationsSource 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.

" + "smithy.api#documentation": "

Information about the AwsOrganizationsSource 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.

" } }, "com.amazonaws.ssm#ResourceDataSyncConflictException": { @@ -21574,7 +21574,7 @@ } }, "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "com.amazonaws.ssm#ResourceDataSyncDestinationDataSharingType": { @@ -21620,7 +21620,7 @@ "SyncType": { "target": "com.amazonaws.ssm#ResourceDataSyncType", "traits": { - "smithy.api#documentation": "

The type of resource data sync. If SyncType is SyncToDestination,\n then the resource data sync synchronizes data to an S3 bucket. If the SyncType is\n SyncFromSource then the resource data sync synchronizes data from Organizations or from\n multiple Regions.

" + "smithy.api#documentation": "

The type of resource data sync. If SyncType is SyncToDestination,\n then the resource data sync synchronizes data to an S3 bucket. If the SyncType is\n SyncFromSource then the resource data sync synchronizes data from Organizations or from\n multiple Amazon Web Services Regions.

" } }, "SyncSource": { @@ -21796,7 +21796,7 @@ "Region": { "target": "com.amazonaws.ssm#ResourceDataSyncS3Region", "traits": { - "smithy.api#documentation": "

The Region with the S3 bucket targeted by the resource data sync.

", + "smithy.api#documentation": "

The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.

", "smithy.api#required": {} } }, @@ -21865,20 +21865,20 @@ "SourceRegions": { "target": "com.amazonaws.ssm#ResourceDataSyncSourceRegionList", "traits": { - "smithy.api#documentation": "

The SyncSource Regions included in the resource data sync.

", + "smithy.api#documentation": "

The SyncSource Amazon Web Services Regions included in the resource data sync.

", "smithy.api#required": {} } }, "IncludeFutureRegions": { "target": "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions", "traits": { - "smithy.api#documentation": "

Whether to automatically synchronize and aggregate data from new Regions when those\n Regions come online.

" + "smithy.api#documentation": "

Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those\n Regions come online.

" } }, "EnableAllOpsDataSources": { "target": "com.amazonaws.ssm#ResourceDataSyncEnableAllOpsDataSources", "traits": { - "smithy.api#documentation": "

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 About multiple account and Region resource data syncs in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

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 About multiple account and Region resource data syncs in the\n Amazon Web Services Systems Manager User Guide.

" } } }, @@ -21928,13 +21928,13 @@ "SourceRegions": { "target": "com.amazonaws.ssm#ResourceDataSyncSourceRegionList", "traits": { - "smithy.api#documentation": "

The SyncSource Regions included in the resource data sync.

" + "smithy.api#documentation": "

The SyncSource Amazon Web Services Regions included in the resource data sync.

" } }, "IncludeFutureRegions": { "target": "com.amazonaws.ssm#ResourceDataSyncIncludeFutureRegions", "traits": { - "smithy.api#documentation": "

Whether to automatically synchronize and aggregate data from new Regions when those\n Regions come online.

" + "smithy.api#documentation": "

Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those\n Regions come online.

" } }, "State": { @@ -21946,7 +21946,7 @@ "EnableAllOpsDataSources": { "target": "com.amazonaws.ssm#ResourceDataSyncEnableAllOpsDataSources", "traits": { - "smithy.api#documentation": "

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 About multiple account and Region resource data syncs in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

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 About multiple account and Region resource data syncs in the\n Amazon Web Services Systems Manager User Guide.

" } } }, @@ -22144,7 +22144,7 @@ "StreamUrl": { "target": "com.amazonaws.ssm#StreamUrl", "traits": { - "smithy.api#documentation": "

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: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

\n

\n region represents the Region identifier for an\n\t\t\t\t\t\tRegion supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n Amazon Web Services General Reference.

\n

\n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.

" + "smithy.api#documentation": "

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: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

\n

\n region 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 us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n Amazon Web Services General Reference.

\n

\n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.

" } } } @@ -22271,7 +22271,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

Information about the Regions and accounts targeted by the current Runbook\n operation.

" + "smithy.api#documentation": "

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook\n operation.

" } } }, @@ -22563,7 +22563,7 @@ "OutputS3Region": { "target": "com.amazonaws.ssm#S3Region", "traits": { - "smithy.api#documentation": "

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager\n automatically determines the Region of the S3 bucket.

" + "smithy.api#documentation": "

(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.

" } }, "OutputS3BucketName": { @@ -23257,7 +23257,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

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 Running Automation workflows in multiple Regions and accounts in the\n Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

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 Running Automation workflows in multiple Amazon Web Services Regions and Amazon Web Services accounts in the\n Amazon Web Services Systems Manager User Guide.

" } }, "Tags": { @@ -23364,7 +23364,7 @@ "Tags": { "target": "com.amazonaws.ssm#TagList", "traits": { - "smithy.api#documentation": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for\n 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:

\n
    \n
  • \n

    \n Key=Environment,Value=Production\n

    \n
    • \n
  • \n

    \n Key=Region,Value=us-east-2\n

    \n
    • \n
" + "smithy.api#documentation": "

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:

\n
    \n
  • \n

    \n Key=Environment,Value=Production\n

    \n
    • \n
  • \n

    \n Key=Region,Value=us-east-2\n

    \n
    • \n
" } }, "ScheduledEndTime": { @@ -23457,7 +23457,7 @@ "StreamUrl": { "target": "com.amazonaws.ssm#StreamUrl", "traits": { - "smithy.api#documentation": "

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: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)\n

\n

\n region represents the Region identifier for an\n\t\t\t\t\t\tRegion supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n Amazon Web Services General Reference.

\n

\n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.

" + "smithy.api#documentation": "

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: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)\n

\n

\n region 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 us-east-2 for the US East (Ohio) Region.\n\t\t\t\t\t\tFor a list of supported region values, see the Region column in Systems Manager service endpoints in the\n Amazon Web Services General Reference.

\n

\n session-id represents the ID of a Session Manager session, such as\n 1a2b3c4dEXAMPLE.

" } } } @@ -23640,7 +23640,7 @@ "TargetLocation": { "target": "com.amazonaws.ssm#TargetLocation", "traits": { - "smithy.api#documentation": "

The combination of Regions and accounts targeted by the current Automation\n execution.

" + "smithy.api#documentation": "

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation\n execution.

" } } }, @@ -23905,7 +23905,7 @@ } }, "traits": { - "smithy.api#documentation": "

An array of search criteria that targets instances using a key-value pair that you\n specify.

\n \n

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 Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.

\n \n

Supported formats include the following.

\n
    \n
  • \n

    \n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n \n

    \n
    • \n
  • \n

    \n Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2\n \n

    \n
    • \n
  • \n

    \n Key=tag-key,Values=my-tag-key-1,my-tag-key-2\n \n

    \n
    • \n
  • \n

    \n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=resource-group-name\n \n

    \n
    • \n
  • \n

    \n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2\n \n

    \n
    • \n
  • \n

    \n Automation targets only:\n Key=ResourceGroup;Values=resource-group-name\n \n

    \n
    • \n
\n

For example:

\n
    \n
  • \n

    \n Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE\n

    \n
    • \n
  • \n

    \n Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3\n

    \n
    • \n
  • \n

    \n Key=tag-key,Values=Name,Instance-Type,CostCenter\n

    \n
    • \n
  • \n

    \n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=ProductionResourceGroup\n

    \n

    This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

    \n
    • \n
  • \n

    \n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n \n

    \n

    This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2)\n instances and VPCs in your maintenance window.

    \n
    • \n
  • \n

    \n Automation targets only:\n Key=ResourceGroup,Values=MyResourceGroup\n

    \n
    • \n
  • \n

    \n State Manager association targets only:\n Key=InstanceIds,Values=*\n \n

    \n

    This example demonstrates how to target all managed instances in the Region where\n the association was created.

    \n
    • \n
\n

For more information about how to send commands that target instances using\n Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.

" + "smithy.api#documentation": "

An array of search criteria that targets instances using a key-value pair that you\n specify.

\n \n

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 Registering\n maintenance window tasks without targets in the\n Amazon Web Services Systems Manager User Guide.

\n \n

Supported formats include the following.

\n
    \n
  • \n

    \n Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3\n \n

    \n
    • \n
  • \n

    \n Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2\n \n

    \n
    • \n
  • \n

    \n Key=tag-key,Values=my-tag-key-1,my-tag-key-2\n \n

    \n
    • \n
  • \n

    \n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=resource-group-name\n \n

    \n
    • \n
  • \n

    \n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2\n \n

    \n
    • \n
  • \n

    \n Automation targets only:\n Key=ResourceGroup;Values=resource-group-name\n \n

    \n
    • \n
\n

For example:

\n
    \n
  • \n

    \n Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE\n

    \n
    • \n
  • \n

    \n Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3\n

    \n
    • \n
  • \n

    \n Key=tag-key,Values=Name,Instance-Type,CostCenter\n

    \n
    • \n
  • \n

    \n Run Command and Maintenance window targets only:\n Key=resource-groups:Name,Values=ProductionResourceGroup\n

    \n

    This example demonstrates how to target all resources in the resource group ProductionResourceGroup in your maintenance window.

    \n
    • \n
  • \n

    \n Maintenance window targets only:\n Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC\n \n

    \n

    This example demonstrates how to target only Amazon Elastic Compute Cloud (Amazon EC2)\n instances and VPCs in your maintenance window.

    \n
    • \n
  • \n

    \n Automation targets only:\n Key=ResourceGroup,Values=MyResourceGroup\n

    \n
    • \n
  • \n

    \n State Manager association targets only:\n Key=InstanceIds,Values=*\n \n

    \n

    This example demonstrates how to target all managed instances in the Amazon Web Services Region where\n the association was created.

    \n
    • \n
\n

For more information about how to send commands that target instances using\n Key,Value parameters, see Targeting multiple instances in the Amazon Web Services Systems Manager User Guide.

" } }, "com.amazonaws.ssm#TargetCount": { @@ -23943,19 +23943,19 @@ "Accounts": { "target": "com.amazonaws.ssm#Accounts", "traits": { - "smithy.api#documentation": "

The accounts targeted by the current Automation execution.

" + "smithy.api#documentation": "

The Amazon Web Services accounts targeted by the current Automation execution.

" } }, "Regions": { "target": "com.amazonaws.ssm#Regions", "traits": { - "smithy.api#documentation": "

The Regions targeted by the current Automation execution.

" + "smithy.api#documentation": "

The Amazon Web Services Regions targeted by the current Automation execution.

" } }, "TargetLocationMaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { - "smithy.api#documentation": "

The maximum number of Regions and accounts allowed to run the Automation\n concurrently.

" + "smithy.api#documentation": "

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation\n concurrently.

" } }, "TargetLocationMaxErrors": { @@ -23972,7 +23972,7 @@ } }, "traits": { - "smithy.api#documentation": "

The combination of Regions and accounts targeted by the current Automation\n execution.

" + "smithy.api#documentation": "

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation\n execution.

" } }, "com.amazonaws.ssm#TargetLocations": { @@ -24489,7 +24489,7 @@ "Name": { "target": "com.amazonaws.ssm#DocumentARN", "traits": { - "smithy.api#documentation": "

The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.

\n

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.

\n

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:

\n

\n arn:aws:ssm:region:account-id:document/document-name\n \n

\n

For example:

\n

\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n

\n

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, AWS-ApplyPatchBaseline or\n My-Document.

" + "smithy.api#documentation": "

The name of the SSM Command document or Automation runbook that contains the configuration\n information for the instance.

\n

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is\n shared with you from another account.

\n

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:

\n

\n arn:aws:ssm:region:account-id:document/document-name\n \n

\n

For example:

\n

\n arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document\n

\n

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, AWS-ApplyPatchBaseline or\n My-Document.

" } }, "Targets": { @@ -24555,7 +24555,7 @@ "TargetLocations": { "target": "com.amazonaws.ssm#TargetLocations", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the\n association. Use this action to update an association in multiple Regions and multiple\n accounts.

" } } } @@ -24600,7 +24600,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified\n instance.

" + "smithy.api#documentation": "

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified\n instance.

\n

\n UpdateAssociationStatus 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 InstanceId legacy parameter.

" } }, "com.amazonaws.ssm#UpdateAssociationStatusRequest": { @@ -24616,7 +24616,7 @@ "InstanceId": { "target": "com.amazonaws.ssm#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#documentation": "

The instance ID.

", "smithy.api#required": {} } }, @@ -24763,7 +24763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates information related to approval reviews for a specific version of a document.

" + "smithy.api#documentation": "

Updates information related to approval reviews for a specific version of a change template\n in Change Manager.

" } }, "com.amazonaws.ssm#UpdateDocumentMetadataRequest": { @@ -24772,20 +24772,20 @@ "Name": { "target": "com.amazonaws.ssm#DocumentName", "traits": { - "smithy.api#documentation": "

The name of the document for which a version is to be updated.

", + "smithy.api#documentation": "

The name of the change template for which a version's metadata is to be updated.

", "smithy.api#required": {} } }, "DocumentVersion": { "target": "com.amazonaws.ssm#DocumentVersion", "traits": { - "smithy.api#documentation": "

The version of a document to update.

" + "smithy.api#documentation": "

The version of a change template in which to update approval metadata.

" } }, "DocumentReviews": { "target": "com.amazonaws.ssm#DocumentReviews", "traits": { - "smithy.api#documentation": "

The document review details to update.

", + "smithy.api#documentation": "

The change template review details to update.

", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/synthetics.json b/aws/sdk/aws-models/synthetics.json index 71b2a2d8f1..032966ac4c 100644 --- a/aws/sdk/aws-models/synthetics.json +++ b/aws/sdk/aws-models/synthetics.json @@ -35,12 +35,19 @@ "ScreenshotName": { "target": "com.amazonaws.synthetics#String", "traits": { + "smithy.api#documentation": "

The name of the screenshot. This is generated the first time the canary is run after the UpdateCanary operation that\n specified for this canary to perform visual monitoring.

", "smithy.api#required": {} } }, "IgnoreCoordinates": { - "target": "com.amazonaws.synthetics#BaseScreenshotIgnoreCoordinates" + "target": "com.amazonaws.synthetics#BaseScreenshotIgnoreCoordinates", + "traits": { + "smithy.api#documentation": "

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}

" + } } + }, + "traits": { + "smithy.api#documentation": "

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

" } }, "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": "

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.

" + } }, "Tags": { "target": "com.amazonaws.synthetics#TagMap", @@ -214,7 +224,7 @@ "ZipFile": { "target": "com.amazonaws.synthetics#Blob", "traits": { - "smithy.api#documentation": "

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.

" + "smithy.api#documentation": "

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.

" } }, "Handler": { @@ -1782,7 +1792,10 @@ } }, "VisualReference": { - "target": "com.amazonaws.synthetics#VisualReferenceInput" + "target": "com.amazonaws.synthetics#VisualReferenceInput", + "traits": { + "smithy.api#documentation": "

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.

\n

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2\n runtime or later. For more information, see \n Visual monitoring and \n Visual monitoring blueprint\n

" + } } } }, @@ -1807,25 +1820,41 @@ "type": "structure", "members": { "BaseScreenshots": { - "target": "com.amazonaws.synthetics#BaseScreenshots" + "target": "com.amazonaws.synthetics#BaseScreenshots", + "traits": { + "smithy.api#documentation": "

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.

" + } }, "BaseCanaryRunId": { "target": "com.amazonaws.synthetics#String", "traits": { + "smithy.api#documentation": "

Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are \n nextrun to use the screenshots from the next run after this update is made, lastrun to use the screenshots from the most recent run \n before this update was made, or the value of Id in the \n CanaryRun from any past run of this canary.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

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.

\n \n

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2\n runtime or later. For more information, see \n Visual monitoring and \n Visual monitoring blueprint\n

" } }, "com.amazonaws.synthetics#VisualReferenceOutput": { "type": "structure", "members": { "BaseScreenshots": { - "target": "com.amazonaws.synthetics#BaseScreenshots" + "target": "com.amazonaws.synthetics#BaseScreenshots", + "traits": { + "smithy.api#documentation": "

An array of screenshots that are used as the baseline for comparisons during visual monitoring.

" + } }, "BaseCanaryRunId": { - "target": "com.amazonaws.synthetics#String" + "target": "com.amazonaws.synthetics#String", + "traits": { + "smithy.api#documentation": "

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.

" + } } + }, + "traits": { + "smithy.api#documentation": "

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.

\n

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later.

" } }, "com.amazonaws.synthetics#VpcConfigInput": { diff --git a/aws/sdk/aws-models/transcribe.json b/aws/sdk/aws-models/transcribe.json index b879788048..47116aaba3 100644 --- a/aws/sdk/aws-models/transcribe.json +++ b/aws/sdk/aws-models/transcribe.json @@ -29,6 +29,38 @@ ] }, "shapes": { + "com.amazonaws.transcribe#AbsoluteTimeRange": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.transcribe#TimestampMilliseconds", + "traits": { + "smithy.api#documentation": "

A value that indicates the beginning of the time range in seconds. To set absolute time\n range, you must specify a start time and an end time. For example, if you specify the\n following values:

\n
    \n
  • \n

    StartTime - 10000

    \n
    • \n
  • \n

    Endtime - 50000

    \n
    • \n
\n

The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.

" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribe#TimestampMilliseconds", + "traits": { + "smithy.api#documentation": "

A value that indicates the end of the time range in milliseconds. To set absolute time\n range, you must specify a start time and an end time. For example, if you specify the\n following values:

\n
    \n
  • \n

    StartTime - 10000

    \n
    • \n
  • \n

    Endtime - 50000

    \n
    • \n
\n

The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.

" + } + }, + "First": { + "target": "com.amazonaws.transcribe#TimestampMilliseconds", + "traits": { + "smithy.api#documentation": "

A time range from the beginning of the call to the value that you've specified. For\n example, if you specify 100000, the time range is set to the first 100,000 milliseconds of\n the call.

" + } + }, + "Last": { + "target": "com.amazonaws.transcribe#TimestampMilliseconds", + "traits": { + "smithy.api#documentation": "

A time range from the value that you've specified to the end of the call. For example, if\n you specify 100000, the time range is set to the last 100,000 milliseconds of the call.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A time range, set in seconds, between two points in the call.

" + } + }, "com.amazonaws.transcribe#BadRequestException": { "type": "structure", "members": { @@ -90,6 +122,317 @@ ] } }, + "com.amazonaws.transcribe#CallAnalyticsJob": { + "type": "structure", + "members": { + "CallAnalyticsJobName": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobName", + "traits": { + "smithy.api#documentation": "

The name of the call analytics job.

" + } + }, + "CallAnalyticsJobStatus": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the analytics job.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", + "traits": { + "smithy.api#documentation": "

If you know the language spoken between the customer and the agent, specify a language\n code for this field.

\n

If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine \n learning to automatically identify the language. To improve the accuracy of language identification, \n you can provide an array containing the possible language codes for the language spoken in your \n audio.

\n

The following list shows the supported languages and corresponding language codes for\n call analytics jobs:

\n
    \n
  • \n

    Gulf Arabic (ar-AE)

    \n
    • \n
  • \n

    Mandarin Chinese, Mainland (zh-CN)

    \n
    • \n
  • \n

    Australian English (en-AU)

    \n
    • \n
  • \n

    British English (en-GB)

    \n
    • \n
  • \n

    Indian English (en-IN)

    \n
    • \n
  • \n

    Irish English (en-IE)

    \n
    • \n
  • \n

    Scottish English (en-AB)

    \n
    • \n
  • \n

    US English (en-US)

    \n
    • \n
  • \n

    Welsh English (en-WL)

    \n
    • \n
  • \n

    Spanish (es-ES)

    \n
    • \n
  • \n

    US Spanish (es-US)

    \n
    • \n
  • \n

    French (fr-FR)

    \n
    • \n
  • \n

    Canadian French (fr-CA)

    \n
    • \n
  • \n

    German (de-DE)

    \n
    • \n
  • \n

    Swiss German (de-CH)

    \n
    • \n
  • \n

    Indian Hindi (hi-IN)

    \n
    • \n
  • \n

    Italian (it-IT)

    \n
    • \n
  • \n

    Japanese (ja-JP)

    \n
    • \n
  • \n

    Korean (ko-KR)

    \n
    • \n
  • \n

    Portuguese (pt-PT)

    \n
    • \n
  • \n

    Brazilian Portuguese (pt-BR)

    \n
    • \n
" + } + }, + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribe#MediaSampleRateHertz", + "traits": { + "smithy.api#documentation": "

The sample rate, in Hertz, of the audio.

" + } + }, + "MediaFormat": { + "target": "com.amazonaws.transcribe#MediaFormat", + "traits": { + "smithy.api#documentation": "

The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.

" + } + }, + "Media": { + "target": "com.amazonaws.transcribe#Media" + }, + "Transcript": { + "target": "com.amazonaws.transcribe#Transcript" + }, + "StartTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the analytics job started processing.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the analytics job was created.

" + } + }, + "CompletionTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the analytics job was completed.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", + "traits": { + "smithy.api#documentation": "

If the AnalyticsJobStatus is FAILED, this field contains\n information about why the job failed.

\n

The FailureReason field can contain one of the following values:

\n
    \n
  • \n

    \n Unsupported media format: The media format \n specified in the MediaFormat field of the request isn't valid. See the \n description of the MediaFormat field for a list of valid values.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media\n format: The media format of the audio file doesn't match the format specified in\n the MediaFormat field in the request. Check the media format of your media file\n and make sure the two values match.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file: The sample rate specified in the\n MediaSampleRateHertz of the request isn't valid. The sample rate must be\n between 8000 and 48000 Hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample rate:\n The sample rate in the audio file doesn't match the sample rate specified in the\n MediaSampleRateHertz field in the request. Check the sample rate of your media\n file and make sure that the two values match.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large: The size of your audio file is\n larger than what Amazon Transcribe Medical can process. For more information,\n see Guidelines and Quotas in the Amazon Transcribe Medical Guide

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large:\n Your audio contains more channels than Amazon Transcribe Medical is configured to\n process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the \n Amazon Web \n Services General Reference.

    \n
    • \n
" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.transcribe#DataAccessRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) that you use to get access to the analytics job.

" + } + }, + "IdentifiedLanguageScore": { + "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", + "traits": { + "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language that it\n identified in the source audio. This value appears only when you don't provide a single\n language code. Larger values indicate that Amazon Transcribe has higher confidence in the language \n that it identified

" + } + }, + "Settings": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobSettings", + "traits": { + "smithy.api#documentation": "

Provides information about the settings used to run a transcription job.

" + } + }, + "ChannelDefinitions": { + "target": "com.amazonaws.transcribe#ChannelDefinitions", + "traits": { + "smithy.api#documentation": "

Shows numeric values to indicate the channel assigned to the agent's audio and the\n channel assigned to the customer's audio.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an asynchronous analytics job that was created with the StartAnalyticsJob\n operation.

" + } + }, + "com.amazonaws.transcribe#CallAnalyticsJobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.transcribe#CallAnalyticsJobSettings": { + "type": "structure", + "members": { + "VocabularyName": { + "target": "com.amazonaws.transcribe#VocabularyName", + "traits": { + "smithy.api#documentation": "

The name of a vocabulary to use when processing the call analytics job.

" + } + }, + "VocabularyFilterName": { + "target": "com.amazonaws.transcribe#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "

The name of the vocabulary filter to use when running a call analytics job. The filter that\n you specify must have the same language code as the analytics job.

" + } + }, + "VocabularyFilterMethod": { + "target": "com.amazonaws.transcribe#VocabularyFilterMethod", + "traits": { + "smithy.api#documentation": "

Set to mask to remove filtered text from the transcript and replace it with three asterisks\n (\"***\") as placeholder text. Set to remove to remove filtered text from the transcript\n without using placeholder text. Set to tag to mark the word in the transcription output\n that matches the vocabulary filter. When you set the filter method to tag, the words\n matching your vocabulary filter are not masked or removed.

" + } + }, + "LanguageModelName": { + "target": "com.amazonaws.transcribe#ModelName", + "traits": { + "smithy.api#documentation": "

The structure used to describe a custom language model.

" + } + }, + "ContentRedaction": { + "target": "com.amazonaws.transcribe#ContentRedaction" + }, + "LanguageOptions": { + "target": "com.amazonaws.transcribe#LanguageOptions", + "traits": { + "smithy.api#documentation": "

When you run a call analytics job, you can specify the language spoken in the audio, or\n you can have Amazon Transcribe identify the language for you.

\n

To specify a language, specify an array with one language code. If you don't know the \n language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the \n language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can \n provide an array of the languages that can be present in the audio.

\n

The following list shows the supported languages and corresponding language codes for\n call analytics jobs:

\n
    \n
  • \n

    Gulf Arabic (ar-AE)

    \n
    • \n
  • \n

    Mandarin Chinese, Mainland (zh-CN)

    \n
    • \n
  • \n

    Australian English (en-AU)

    \n
    • \n
  • \n

    British English (en-GB)

    \n
    • \n
  • \n

    Indian English (en-IN)

    \n
    • \n
  • \n

    Irish English (en-IE)

    \n
    • \n
  • \n

    Scottish English (en-AB)

    \n
    • \n
  • \n

    US English (en-US)

    \n
    • \n
  • \n

    Welsh English (en-WL)

    \n
    • \n
  • \n

    Spanish (es-ES)

    \n
    • \n
  • \n

    US Spanish (es-US)

    \n
    • \n
  • \n

    French (fr-FR)

    \n
    • \n
  • \n

    Canadian French (fr-CA)

    \n
    • \n
  • \n

    German (de-DE)

    \n
    • \n
  • \n

    Swiss German (de-CH)

    \n
    • \n
  • \n

    Indian Hindi (hi-IN)

    \n
    • \n
  • \n

    Italian (it-IT)

    \n
    • \n
  • \n

    Japanese (ja-JP)

    \n
    • \n
  • \n

    Korean (ko-KR)

    \n
    • \n
  • \n

    Portuguese (pt-PT)

    \n
    • \n
  • \n

    Brazilian Portuguese (pt-BR)

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides optional settings for the CallAnalyticsJob operation.

" + } + }, + "com.amazonaws.transcribe#CallAnalyticsJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUEUED", + "name": "QUEUED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + } + ] + } + }, + "com.amazonaws.transcribe#CallAnalyticsJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobSummary" + } + }, + "com.amazonaws.transcribe#CallAnalyticsJobSummary": { + "type": "structure", + "members": { + "CallAnalyticsJobName": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobName", + "traits": { + "smithy.api#documentation": "

The name of the call analytics job.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the call analytics job was created.

" + } + }, + "StartTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the job began processing.

" + } + }, + "CompletionTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the job was completed.

" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", + "traits": { + "smithy.api#documentation": "

The language of the transcript in the source audio file.

" + } + }, + "CallAnalyticsJobStatus": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", + "traits": { + "smithy.api#documentation": "

The status of the call analytics job.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.transcribe#FailureReason", + "traits": { + "smithy.api#documentation": "

If the CallAnalyticsJobStatus is FAILED, a description of \n the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides summary information about a call analytics job.

" + } + }, + "com.amazonaws.transcribe#CategoryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.transcribe#CategoryProperties": { + "type": "structure", + "members": { + "CategoryName": { + "target": "com.amazonaws.transcribe#CategoryName", + "traits": { + "smithy.api#documentation": "

The name of the call analytics category.

" + } + }, + "Rules": { + "target": "com.amazonaws.transcribe#RuleList", + "traits": { + "smithy.api#documentation": "

The rules used to create a call analytics category.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the call analytics category was created.

" + } + }, + "LastUpdateTime": { + "target": "com.amazonaws.transcribe#DateTime", + "traits": { + "smithy.api#documentation": "

A timestamp that shows when the call analytics category was most recently updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains the rules and additional information about a call analytics category.

" + } + }, + "com.amazonaws.transcribe#CategoryPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#CategoryProperties" + } + }, + "com.amazonaws.transcribe#ChannelDefinition": { + "type": "structure", + "members": { + "ChannelId": { + "target": "com.amazonaws.transcribe#ChannelId", + "traits": { + "smithy.api#documentation": "

A value that indicates the audio channel.

" + } + }, + "ParticipantRole": { + "target": "com.amazonaws.transcribe#ParticipantRole", + "traits": { + "smithy.api#documentation": "

Indicates whether the person speaking on the audio channel is the agent or customer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

For a call analytics job, an object that indicates the audio channel that belongs to the agent and\n the audio channel that belongs to the customer.

" + } + }, + "com.amazonaws.transcribe#ChannelDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#ChannelDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.transcribe#ChannelId": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.transcribe#ConflictException": { "type": "structure", "members": { @@ -125,6 +468,68 @@ "smithy.api#documentation": "

Settings for content redaction within a transcription job.

" } }, + "com.amazonaws.transcribe#CreateCallAnalyticsCategory": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#CreateCallAnalyticsCategoryRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#CreateCallAnalyticsCategoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#ConflictException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an analytics category. Amazon Transcribe applies the conditions specified by your\n analytics categories to your call analytics jobs. For each analytics category, you specify one or\n more rules. For example, you can specify a rule that the customer sentiment was neutral or\n negative within that category. If you start a call analytics job, Amazon Transcribe applies the\n category to the analytics job that you've specified.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/callanalyticscategories/{CategoryName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#CreateCallAnalyticsCategoryRequest": { + "type": "structure", + "members": { + "CategoryName": { + "target": "com.amazonaws.transcribe#CategoryName", + "traits": { + "smithy.api#documentation": "

The name that you choose for your category when you create it.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Rules": { + "target": "com.amazonaws.transcribe#RuleList", + "traits": { + "smithy.api#documentation": "

To create a category, you must specify between 1 and 20 rules. For each rule, you specify a\n filter to be applied to the attributes of the call. For example, you can specify a sentiment\n filter to detect if the customer's sentiment was negative or neutral.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#CreateCallAnalyticsCategoryResponse": { + "type": "structure", + "members": { + "CategoryProperties": { + "target": "com.amazonaws.transcribe#CategoryProperties", + "traits": { + "smithy.api#documentation": "

The rules and associated metadata used to create a category.

" + } + } + } + }, "com.amazonaws.transcribe#CreateLanguageModel": { "type": "operation", "input": { @@ -262,7 +667,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary. This case-sensitive name must be unique within an\n AWS account. If you try to create a vocabulary with the same name as a previous\n vocabulary, you get a ConflictException error.

", + "smithy.api#documentation": "

The name of the custom vocabulary. This case-sensitive name must be unique within an\n Amazon Web Services account. If you try to create a vocabulary with the same name as\n a previous vocabulary, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -277,7 +682,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 of the text file you use to define your custom vocabulary. The\n URI must be in the same AWS Region as the\n resource\n that you're calling. Enter information about your\n VocabularyFileUri in the following format:

\n

\n \n https://s3..amazonaws.com///\n \n

\n

The following is an example URI for a vocabulary file that is stored in Amazon S3:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Medical Custom Vocabularies.

", + "smithy.api#documentation": "

The location in Amazon S3 of the text file you use to define your custom vocabulary. The\n URI must be in the same Amazon Web Services Region as the\n resource\n that you're calling. Enter information about your\n VocabularyFileUri in the following format:

\n

\n \n https://s3..amazonaws.com///\n \n

\n

The following is an example URI for a vocabulary file that is stored in Amazon S3:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Medical Custom Vocabularies.

", "smithy.api#required": {} } } @@ -289,7 +694,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary. The name must be unique within an AWS account and is case\n sensitive.

" + "smithy.api#documentation": "

The name of the vocabulary. The name must be unique within an Amazon Web Services account and is case\n sensitive.

" } }, "LanguageCode": { @@ -441,7 +846,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary. The name must be unique within an AWS account. The name is\n case sensitive. If you try to create a vocabulary with the same name as a previous\n vocabulary you will receive a ConflictException error.

", + "smithy.api#documentation": "

The name of the vocabulary. The name must be unique within an Amazon Web Services\n account. The name is case sensitive. If you try to create a vocabulary with the same\n name as a previous vocabulary you will receive a ConflictException\n error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -462,7 +867,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom\n vocabulary. The URI must be in the same region as the API endpoint that you are calling.\n The general form is

\n \n \n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom\n Vocabularies.

" + "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom\n vocabulary. The URI must be in the same region as the API endpoint that you are calling.\n The general form is

\n \n \n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom\n Vocabularies.

" } } } @@ -515,6 +920,99 @@ "com.amazonaws.transcribe#DateTime": { "type": "timestamp" }, + "com.amazonaws.transcribe#DeleteCallAnalyticsCategory": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#DeleteCallAnalyticsCategoryRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#DeleteCallAnalyticsCategoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a call analytics category using its name.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/callanalyticscategories/{CategoryName}", + "code": 204 + } + } + }, + "com.amazonaws.transcribe#DeleteCallAnalyticsCategoryRequest": { + "type": "structure", + "members": { + "CategoryName": { + "target": "com.amazonaws.transcribe#CategoryName", + "traits": { + "smithy.api#documentation": "

The name of the call analytics category that you're choosing to delete. The value is case\n sensitive.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#DeleteCallAnalyticsCategoryResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.transcribe#DeleteCallAnalyticsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#DeleteCallAnalyticsJobRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#DeleteCallAnalyticsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a call analytics job using its name.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", + "code": 204 + } + } + }, + "com.amazonaws.transcribe#DeleteCallAnalyticsJobRequest": { + "type": "structure", + "members": { + "CallAnalyticsJobName": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobName", + "traits": { + "smithy.api#documentation": "

The name of the call analytics job you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#DeleteCallAnalyticsJobResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.transcribe#DeleteLanguageModel": { "type": "operation", "input": { @@ -775,7 +1273,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a single custom language model. Use this information to see\n details about the language model in your AWS account. You can also see whether the base\n language model used to create your custom language model has been updated. If Amazon Transcribe has\n updated the base model, you can create a new custom language model using the updated\n base model. If the language model wasn't created, you can use this operation to\n understand why Amazon Transcribe couldn't create it.

", + "smithy.api#documentation": "

Gets information about a single custom language model. Use this information to see\n details about the language model in your Amazon Web Services account. You can also see\n whether the base language model used to create your custom language model has been\n updated. If Amazon Transcribe has updated the base model, you can create a new custom language model\n using the updated base model. If the language model wasn't created, you can use this\n operation to understand why Amazon Transcribe couldn't create it.

", "smithy.api#http": { "method": "GET", "uri": "/languagemodels/{ModelName}", @@ -810,6 +1308,116 @@ "com.amazonaws.transcribe#FailureReason": { "type": "string" }, + "com.amazonaws.transcribe#GetCallAnalyticsCategory": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#GetCallAnalyticsCategoryRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#GetCallAnalyticsCategoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a call analytics category.

", + "smithy.api#http": { + "method": "GET", + "uri": "/callanalyticscategories/{CategoryName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#GetCallAnalyticsCategoryRequest": { + "type": "structure", + "members": { + "CategoryName": { + "target": "com.amazonaws.transcribe#CategoryName", + "traits": { + "smithy.api#documentation": "

The name of the category you want information about. This value is case sensitive.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#GetCallAnalyticsCategoryResponse": { + "type": "structure", + "members": { + "CategoryProperties": { + "target": "com.amazonaws.transcribe#CategoryProperties", + "traits": { + "smithy.api#documentation": "

The rules you've defined for a category.

" + } + } + } + }, + "com.amazonaws.transcribe#GetCallAnalyticsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#GetCallAnalyticsJobRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#GetCallAnalyticsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a call analytics job. To see the status of the job, check the\n CallAnalyticsJobStatus field. If the status is COMPLETED, the job\n is finished and you can find the results at the location specified in the TranscriptFileUri \n field. If you enable personally identifiable information (PII) redaction, the redacted transcript appears\n in the RedactedTranscriptFileUri field.

", + "smithy.api#http": { + "method": "GET", + "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#GetCallAnalyticsJobRequest": { + "type": "structure", + "members": { + "CallAnalyticsJobName": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobName", + "traits": { + "smithy.api#documentation": "

The name of the analytics job you want information about. This value is case\n sensitive.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#GetCallAnalyticsJobResponse": { + "type": "structure", + "members": { + "CallAnalyticsJob": { + "target": "com.amazonaws.transcribe#CallAnalyticsJob", + "traits": { + "smithy.api#documentation": "

An object that contains the results of your call analytics job.

" + } + } + } + }, "com.amazonaws.transcribe#GetMedicalTranscriptionJob": { "type": "operation", "input": { @@ -1210,6 +1818,44 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.transcribe#InterruptionFilter": { + "type": "structure", + "members": { + "Threshold": { + "target": "com.amazonaws.transcribe#TimestampMilliseconds", + "traits": { + "smithy.api#documentation": "

The duration of the interruption.

" + } + }, + "ParticipantRole": { + "target": "com.amazonaws.transcribe#ParticipantRole", + "traits": { + "smithy.api#documentation": "

Indicates whether the caller or customer was interrupting.

" + } + }, + "AbsoluteTimeRange": { + "target": "com.amazonaws.transcribe#AbsoluteTimeRange", + "traits": { + "smithy.api#documentation": "

An object you can use to specify a time range (in milliseconds) for when you'd want to find\n the interruption. For example, you could search for an interruption between the 30,000\n millisecond mark and the 45,000 millisecond mark. You could also specify the time\n period as the first 15,000 milliseconds or the last 15,000 milliseconds.

" + } + }, + "RelativeTimeRange": { + "target": "com.amazonaws.transcribe#RelativeTimeRange", + "traits": { + "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where there\n was a interruption. For example, you can specify the first half of the call. You can also\n specify the period of time between halfway through to three-quarters of the way through\n the call. Because the length of conversation can vary between calls, you can apply\n relative time ranges across all calls.

" + } + }, + "Negate": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Set to TRUE to look for a time period where there was no interruption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that enables you to configure your category to be applied to call analytics jobs where\n either the customer or agent was interrupted.

" + } + }, "com.amazonaws.transcribe#JobExecutionSettings": { "type": "structure", "members": { @@ -1460,7 +2106,7 @@ }, "traits": { "smithy.api#length": { - "min": 2 + "min": 1 } } }, @@ -1477,6 +2123,164 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.transcribe#ListCallAnalyticsCategories": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#ListCallAnalyticsCategoriesRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#ListCallAnalyticsCategoriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides more information about the call analytics categories that you've created. You \n can use the information in this list to find a specific category. You can then use the\n operation to get more information about it.

", + "smithy.api#http": { + "method": "GET", + "uri": "/callanalyticscategories", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transcribe#ListCallAnalyticsCategoriesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

When included, NextTokenfetches the next set of categories if the result \n of the previous request was truncated.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.transcribe#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of categories to return in the response. If there are fewer results in\n the list, the response contains only the actual results.

", + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.transcribe#ListCallAnalyticsCategoriesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

The operation returns a page of jobs at a time. The\n maximum size of the list is set by the MaxResults parameter. If there are \n more categories in the list than the page size, Amazon Transcribe returns the NextPage \n token. Include the token in the next request to the \n operation to return the next page of analytics categories.

" + } + }, + "Categories": { + "target": "com.amazonaws.transcribe#CategoryPropertiesList", + "traits": { + "smithy.api#documentation": "

A list of objects containing information about analytics categories.

" + } + } + } + }, + "com.amazonaws.transcribe#ListCallAnalyticsJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#ListCallAnalyticsJobsRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#ListCallAnalyticsJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

List call analytics jobs with a specified status or substring that matches their names.

", + "smithy.api#http": { + "method": "GET", + "uri": "/callanalyticsjobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transcribe#ListCallAnalyticsJobsRequest": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", + "traits": { + "smithy.api#documentation": "

When specified, returns only call analytics jobs with the specified status. Jobs are ordered\n by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe \n returns all analytics jobs ordered by creation date.

", + "smithy.api#httpQuery": "Status" + } + }, + "JobNameContains": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobName", + "traits": { + "smithy.api#documentation": "

When specified, the jobs returned in the list are limited to jobs whose name contains the\n specified string.

", + "smithy.api#httpQuery": "JobNameContains" + } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

If you receive a truncated result in the previous request of \n , \n include NextToken to fetch the next set of jobs.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.transcribe#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of call analytics jobs to return in the response. If there are fewer\n results in the list, this response contains only the actual results.

", + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.transcribe#ListCallAnalyticsJobsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", + "traits": { + "smithy.api#documentation": "

When specified, returns only call analytics jobs with that status. Jobs are ordered\n by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe\n returns all transcription jobs ordered by creation date.

" + } + }, + "NextToken": { + "target": "com.amazonaws.transcribe#NextToken", + "traits": { + "smithy.api#documentation": "

The operation returns a page of jobs at a time. The \n maximum size of the page is set by the MaxResults parameter. If there are more\n jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the \n token in your next request to the operation to return next page of jobs.

" + } + }, + "CallAnalyticsJobSummaries": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobSummaries", + "traits": { + "smithy.api#documentation": "

A list of objects containing summary information for a transcription job.

" + } + } + } + }, "com.amazonaws.transcribe#ListLanguageModels": { "type": "operation", "input": { @@ -2028,7 +2832,13 @@ "MediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the input media file. The URI must be in the same region as\n the API endpoint that you are calling. The general form is:

\n \n

For example:

\n \n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

" + "smithy.api#documentation": "

The S3 object location of the input media file. The URI must be in the same region as\n the API endpoint that you are calling. The general form is:

\n \n

For example:

\n \n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

" + } + }, + "RedactedMediaFileUri": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

The S3 object location for your redacted output media file. This is only supported for call analytics jobs.

" } } }, @@ -2130,7 +2940,7 @@ "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz, of the source audio containing medical information.

\n

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to\n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample\n rate.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the source audio containing medical information.

\n

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to\n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample\n rate.

" } }, "MediaFormat": { @@ -2193,7 +3003,7 @@ "Type": { "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "

The type of speech in the transcription job. CONVERSATION is generally\n used for patient-physician dialogues. DICTATION is the setting for\n physicians speaking their notes after seeing a patient. For more information, see how-it-works-med\n

" + "smithy.api#documentation": "

The type of speech in the transcription job. CONVERSATION is generally\n used for patient-physician dialogues. DICTATION is the setting for\n physicians speaking their notes after seeing a patient. For more information, see What is\n Amazon Transcribe Medical?.

" } } }, @@ -2267,7 +3077,7 @@ "ContentIdentificationType": { "target": "com.amazonaws.transcribe#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription\n job. If the value is PHI, you've configured the transcription job to identify\n personal health information (PHI).

" + "smithy.api#documentation": "

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription\n job. If the value is PHI, you've configured the transcription job to\n identify personal health information (PHI).

" } }, "Type": { @@ -2332,7 +3142,7 @@ "min": 1, "max": 200 }, - "smithy.api#pattern": "^[0-9a-zA-Z._-]+" + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" } }, "com.amazonaws.transcribe#ModelSettings": { @@ -2381,7 +3191,49 @@ "min": 0, "max": 8192 }, - "smithy.api#pattern": ".+" + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.transcribe#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.transcribe#NonTalkTimeFilter": { + "type": "structure", + "members": { + "Threshold": { + "target": "com.amazonaws.transcribe#TimestampMilliseconds", + "traits": { + "smithy.api#documentation": "

The duration of the period when neither the customer nor agent was talking.

" + } + }, + "AbsoluteTimeRange": { + "target": "com.amazonaws.transcribe#AbsoluteTimeRange", + "traits": { + "smithy.api#documentation": "

An object you can use to specify a time range (in milliseconds) for when no one is talking.\n For example, you could specify a time period between the 30,000 millisecond mark and\n the 45,000 millisecond mark. You could also specify the time period as the first 15,000\n milliseconds or the last 15,000 milliseconds.

" + } + }, + "RelativeTimeRange": { + "target": "com.amazonaws.transcribe#RelativeTimeRange", + "traits": { + "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where there\n was silence. For example, you can specify the first half of the call. You can also\n specify the period of time between halfway through to three-quarters of the way through\n the call. Because the length of conversation can vary between calls, you can apply\n relative time ranges across all calls.

" + } + }, + "Negate": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Set to TRUE to look for a time period when people were talking.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that enables you to configure your category to be applied to call analytics jobs where\n either the customer or agent was interrupted.

" } }, "com.amazonaws.transcribe#NotFoundException": { @@ -2404,7 +3256,7 @@ "min": 0, "max": 64 }, - "smithy.api#pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" } }, "com.amazonaws.transcribe#OutputKey": { @@ -2414,7 +3266,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "[a-zA-Z0-9-_.!*'()/]{1,1024}$" + "smithy.api#pattern": "^[a-zA-Z0-9-_.!*'()/]{1,1024}$" } }, "com.amazonaws.transcribe#OutputLocationType": { @@ -2432,6 +3284,31 @@ ] } }, + "com.amazonaws.transcribe#ParticipantRole": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGENT", + "name": "AGENT" + }, + { + "value": "CUSTOMER", + "name": "CUSTOMER" + } + ] + } + }, + "com.amazonaws.transcribe#Percentage": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.transcribe#Phrase": { "type": "string", "traits": { @@ -2439,7 +3316,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": ".+" + "smithy.api#pattern": "^.+$" } }, "com.amazonaws.transcribe#Phrases": { @@ -2474,6 +3351,155 @@ ] } }, + "com.amazonaws.transcribe#RelativeTimeRange": { + "type": "structure", + "members": { + "StartPercentage": { + "target": "com.amazonaws.transcribe#Percentage", + "traits": { + "smithy.api#documentation": "

A value that indicates the percentage of the beginning of the time range. To set a relative\n time range, you must specify a start percentage and an end percentage. For example, if\n you specify the following values:

\n
    \n
  • \n

    StartPercentage - 10

    \n
    • \n
  • \n

    EndPercentage - 50

    \n
    • \n
\n

This looks at the time range starting from 10% of the way into the call to 50% of the way\n through the call. For a call that lasts 100,000 milliseconds, this example range would\n apply from the 10,000 millisecond mark to the 50,000 millisecond mark.

" + } + }, + "EndPercentage": { + "target": "com.amazonaws.transcribe#Percentage", + "traits": { + "smithy.api#documentation": "

A value that indicates the percentage of the end of the time range. To set a relative time\n range, you must specify a start percentage and an end percentage. For example, if you\n specify the following values:

\n
    \n
  • \n

    StartPercentage - 10

    \n
    • \n
  • \n

    EndPercentage - 50

    \n
    • \n
\n

This looks at the time range starting from 10% of the way into the call to 50% of the way\n through the call. For a call that lasts 100,000 milliseconds, this example range would\n apply from the 10,000 millisecond mark to the 50,000 millisecond mark.

" + } + }, + "First": { + "target": "com.amazonaws.transcribe#Percentage", + "traits": { + "smithy.api#documentation": "

A range that takes the portion of the call up to the time in milliseconds set by the value\n that you've specified. For example, if you specify 120000, the time range is set for the\n first 120,000 milliseconds of the call.

" + } + }, + "Last": { + "target": "com.amazonaws.transcribe#Percentage", + "traits": { + "smithy.api#documentation": "

A range that takes the portion of the call from the time in milliseconds set by the value\n that you've specified to the end of the call. For example, if you specify 120000, the time\n range is set for the last 120,000 milliseconds of the call.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where you would like\n to apply a filter. For example, you can specify the first half of the call. You can also specify the\n period of time between halfway through to three-quarters of the way through the call. Because\n the length of conversation can vary between calls, you can apply relative time ranges across all\n calls.

" + } + }, + "com.amazonaws.transcribe#Rule": { + "type": "union", + "members": { + "NonTalkTimeFilter": { + "target": "com.amazonaws.transcribe#NonTalkTimeFilter", + "traits": { + "smithy.api#documentation": "

A condition for a time period when neither the customer nor the agent was talking.

" + } + }, + "InterruptionFilter": { + "target": "com.amazonaws.transcribe#InterruptionFilter", + "traits": { + "smithy.api#documentation": "

A condition for a time period when either the customer or agent was interrupting the\n other person.

" + } + }, + "TranscriptFilter": { + "target": "com.amazonaws.transcribe#TranscriptFilter", + "traits": { + "smithy.api#documentation": "

A condition that catches particular words or phrases based on a exact match. For example, \n if you set the phrase \"I want to speak to the manager\", only that exact phrase will be returned.

" + } + }, + "SentimentFilter": { + "target": "com.amazonaws.transcribe#SentimentFilter", + "traits": { + "smithy.api#documentation": "

A condition that is applied to a particular customer sentiment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A condition in the call between the customer and the agent that you want to filter for.

" + } + }, + "com.amazonaws.transcribe#RuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#Rule" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.transcribe#SentimentFilter": { + "type": "structure", + "members": { + "Sentiments": { + "target": "com.amazonaws.transcribe#SentimentValueList", + "traits": { + "smithy.api#documentation": "

An array that enables you to specify sentiments for the customer or agent. You can\n specify one or more values.

", + "smithy.api#required": {} + } + }, + "AbsoluteTimeRange": { + "target": "com.amazonaws.transcribe#AbsoluteTimeRange", + "traits": { + "smithy.api#documentation": "

The time range, measured in seconds, of the sentiment.

" + } + }, + "RelativeTimeRange": { + "target": "com.amazonaws.transcribe#RelativeTimeRange", + "traits": { + "smithy.api#documentation": "

The time range, set in percentages, that correspond to proportion of the call.

" + } + }, + "ParticipantRole": { + "target": "com.amazonaws.transcribe#ParticipantRole", + "traits": { + "smithy.api#documentation": "

A value that determines whether the sentiment belongs to the customer or the agent.

" + } + }, + "Negate": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Set to TRUE to look for sentiments that weren't specified in the request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that enables you to specify a particular customer or agent sentiment. If at least \n 50 percent of the conversation turns (the back-and-forth between two speakers) in a specified\n time period match the specified sentiment, Amazon Transcribe will consider the sentiment a match.

" + } + }, + "com.amazonaws.transcribe#SentimentValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "POSITIVE", + "name": "POSITIVE" + }, + { + "value": "NEGATIVE", + "name": "NEGATIVE" + }, + { + "value": "NEUTRAL", + "name": "NEUTRAL" + }, + { + "value": "MIXED", + "name": "MIXED" + } + ] + } + }, + "com.amazonaws.transcribe#SentimentValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#SentimentValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.transcribe#Settings": { "type": "structure", "members": { @@ -2541,6 +3567,98 @@ ] } }, + "com.amazonaws.transcribe#StartCallAnalyticsJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#StartCallAnalyticsJobRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#StartCallAnalyticsJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#ConflictException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and\n agent, but also returns additional insights. These insights include how quickly or loudly the caller\n or agent was speaking. To retrieve additional insights with your analytics jobs, create\n categories. A category is a way to classify analytics jobs based on attributes, such as a customer's\n sentiment or a particular phrase being used during the call. For more information, see the\n operation.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#StartCallAnalyticsJobRequest": { + "type": "structure", + "members": { + "CallAnalyticsJobName": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobName", + "traits": { + "smithy.api#documentation": "

The name of the call analytics job. You can't use the string \".\" or \"..\" by themselves as the\n job name. The name must also be unique within an AWS account. If you try to create a\n call analytics job with the same name as a previous call analytics job, you get a\n ConflictException error.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Media": { + "target": "com.amazonaws.transcribe#Media", + "traits": { + "smithy.api#required": {} + } + }, + "OutputLocation": { + "target": "com.amazonaws.transcribe#Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location where the output of the call analytics job is stored.\n You can provide the following location types to store the output of call analytics job:

\n
    \n
  • \n

    s3://DOC-EXAMPLE-BUCKET1

    \n

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job\n as a JSON file at the root level of the bucket.

    \n
    • \n
  • \n

    s3://DOC-EXAMPLE-BUCKET1/folder/

    \n

    f you specify a path, Amazon Transcribe saves the output of the analytics job as\n s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

    \n

    If you specify a folder, you must provide a trailing slash.

    \n
    • \n
  • \n

    s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

    \n

    If you provide a path that has the filename specified, Amazon Transcribe saves\n the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json

    \n
    • \n
\n

You can specify an AWS Key Management Service key to encrypt the output of our\n analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a\n KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption\n of the analytics job output that is placed in your S3 bucket.

" + } + }, + "OutputEncryptionKMSKeyId": { + "target": "com.amazonaws.transcribe#KMSKeyId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service key used to\n encrypt the output of the call analytics job. The user calling the \n operation must have permission to use the specified KMS key.

\n

You use either of the following to identify an AWS KMS key in the current account:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"

    \n
    • \n
\n

You can use either of the following to identify a KMS key in the current account or\n another account:

\n
    \n
  • \n

    Amazon Resource Name (ARN) of a KMS key in the current account or another\n account: \"arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab\"

    \n
    • \n
  • \n

    ARN of a KMS Key Alias: \"arn:aws:kms:region:account ID:alias/ExampleAlias\"

    \n
    • \n
\n

If you don't specify an encryption key, the output of the call analytics job is encrypted\n with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputLocation parameter.

" + } + }, + "DataAccessRoleArn": { + "target": "com.amazonaws.transcribe#DataAccessRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that\n contains your input files. Amazon Transcribe assumes this role to read queued audio files.\n If you have specified an output S3 bucket for your transcription results, this role should\n have access to the output bucket as well.

", + "smithy.api#required": {} + } + }, + "Settings": { + "target": "com.amazonaws.transcribe#CallAnalyticsJobSettings", + "traits": { + "smithy.api#documentation": "

A Settings object that provides optional settings for a call analytics job.

" + } + }, + "ChannelDefinitions": { + "target": "com.amazonaws.transcribe#ChannelDefinitions", + "traits": { + "smithy.api#documentation": "

When you start a call analytics job, you must pass an array that maps the agent and the\n customer to specific audio channels. The values you can assign to a channel are 0\n and 1. The agent and the customer must each have their own channel. You can't assign more\n than one channel to an agent or customer.

" + } + } + } + }, + "com.amazonaws.transcribe#StartCallAnalyticsJobResponse": { + "type": "structure", + "members": { + "CallAnalyticsJob": { + "target": "com.amazonaws.transcribe#CallAnalyticsJob", + "traits": { + "smithy.api#documentation": "

An object containing the details of the asynchronous call analytics job.

" + } + } + } + }, "com.amazonaws.transcribe#StartMedicalTranscriptionJob": { "type": "operation", "input": { @@ -2578,7 +3696,7 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the medical transcription job. You can't use the strings \".\"\n or \"..\" by themselves as the job name. The name must also be unique within\n an AWS account. If you try to create a medical transcription job with the same name as a\n previous medical transcription job, you get a ConflictException\n error.

", + "smithy.api#documentation": "

The name of the medical transcription job. You can't use the strings \".\"\n or \"..\" by themselves as the job name. The name must also be unique within\n an Amazon Web Services account. If you try to create a medical transcription job with the\n same name as a previous medical transcription job, you get a\n ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2611,7 +3729,7 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The Amazon S3 location where the transcription is stored.

\n

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription\n results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the\n TranscriptFileUri field. The S3 bucket must have permissions that allow\n Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

\n

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your\n transcription using the OutputEncryptionKMSKeyId parameter. If you don't\n specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of\n transcripts that are placed in your S3 bucket.

", + "smithy.api#documentation": "

The Amazon S3 location where the transcription is stored.

\n

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription\n results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the\n TranscriptFileUri field. The S3 bucket must have permissions that allow\n Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the\n output of your transcription using the OutputEncryptionKMSKeyId parameter.\n If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side\n encryption of transcripts that are placed in your S3 bucket.

", "smithy.api#required": {} } }, @@ -2624,7 +3742,7 @@ "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to\n encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the\n specified KMS key.

\n

You use either of the following to identify a KMS key in the current account:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"

    \n
    • \n
\n

You can use either of the following to identify a KMS key in the current account or\n another account:

\n
    \n
  • \n

    Amazon Resource Name (ARN) of a KMS key in the current account or another\n account: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    ARN of a KMS Key Alias: \"arn:aws:kms:region:account\n ID:alias/ExampleAlias\"

    \n
    • \n
\n

If you don't specify an encryption key, the output of the medical transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS)\n key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the\n specified KMS key.

\n

You use either of the following to identify a KMS key in the current account:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"

    \n
    • \n
\n

You can use either of the following to identify a KMS key in the current account or\n another account:

\n
    \n
  • \n

    Amazon Resource Name (ARN) of a KMS key in the current account or another\n account: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    ARN of a KMS Key Alias: \"arn:aws:kms:region:account\n ID:alias/ExampleAlias\"

    \n
    • \n
\n

If you don't specify an encryption key, the output of the medical transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

" } }, "Settings": { @@ -2636,7 +3754,7 @@ "ContentIdentificationType": { "target": "com.amazonaws.transcribe#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "

You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify\n PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription\n output.

" + "smithy.api#documentation": "

You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify\n PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it\n identifies in the transcription output.

" } }, "Specialty": { @@ -2703,7 +3821,7 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the job. You can't use the strings \".\" or \"..\"\n by themselves as the job name. The name must also be unique within an AWS account. If\n you try to create a transcription job with the same name as a previous transcription\n job, you get a ConflictException error.

", + "smithy.api#documentation": "

The name of the job. You can't use the strings \".\" or \"..\"\n by themselves as the job name. The name must also be unique within an Amazon Web Services\n account. If you try to create a transcription job with the same name as a previous\n transcription job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2736,7 +3854,7 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The location where the transcription is stored.

\n

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the\n specified S3 bucket. When you call the GetTranscriptionJob operation,\n the operation returns this location in the TranscriptFileUri field. If you\n enable content redaction, the redacted transcript appears in\n RedactedTranscriptFileUri. If you enable content redaction and choose\n to output an unredacted transcript, that transcript's location still appears in the\n TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe\n to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

\n

You can specify an AWS Key Management Service (KMS) key to encrypt the output of your\n transcription using the OutputEncryptionKMSKeyId parameter. If you don't\n specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of\n transcripts that are placed in your S3 bucket.

\n

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL,\n a shareable URL that provides secure access to your transcription, and returns it in the\n TranscriptFileUri field. Use this URL to download the\n transcription.

" + "smithy.api#documentation": "

The location where the transcription is stored.

\n

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the\n specified S3 bucket. When you call the GetTranscriptionJob operation,\n the operation returns this location in the TranscriptFileUri field. If you\n enable content redaction, the redacted transcript appears in\n RedactedTranscriptFileUri. If you enable content redaction and choose\n to output an unredacted transcript, that transcript's location still appears in the\n TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe\n to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the\n output of your transcription using the OutputEncryptionKMSKeyId parameter.\n If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side\n encryption of transcripts that are placed in your S3 bucket.

\n

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL,\n a shareable URL that provides secure access to your transcription, and returns it in the\n TranscriptFileUri field. Use this URL to download the\n transcription.

" } }, "OutputKey": { @@ -2748,7 +3866,7 @@ "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to\n encrypt the output of the transcription job. The user calling the\n StartTranscriptionJob operation must have permission to use the\n specified KMS key.

\n

You can use either of the following to identify a KMS key in the current\n account:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"

    \n
    • \n
\n

You can use either of the following to identify a KMS key in the current account or\n another account:

\n
    \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    ARN of a KMS Key Alias: \"arn:aws:kms:region:account\n ID:alias/ExampleAlias\"

    \n
    • \n
\n

If you don't specify an encryption key, the output of the transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS)\n key used to encrypt the output of the transcription job. The user calling the\n StartTranscriptionJob operation must have permission to use the\n specified KMS key.

\n

You can use either of the following to identify a KMS key in the current\n account:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"

    \n
    • \n
\n

You can use either of the following to identify a KMS key in the current account or\n another account:

\n
    \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    ARN of a KMS Key Alias: \"arn:aws:kms:region:account\n ID:alias/ExampleAlias\"

    \n
    • \n
\n

If you don't specify an encryption key, the output of the transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

" } }, "Settings": { @@ -2784,7 +3902,7 @@ "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

An object containing a list of languages that might be present in your collection of\n audio files. Automatic language identification chooses a language that best matches the\n source audio from that list.

" + "smithy.api#documentation": "

An object containing a list of languages that might be present in your collection of\n audio files. Automatic language identification chooses a language that best matches the\n source audio from that list.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must\n be encoded at a sample rate of 16000 Hz or higher.

" } } } @@ -2803,10 +3921,34 @@ "com.amazonaws.transcribe#String": { "type": "string" }, + "com.amazonaws.transcribe#StringTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.transcribe#TimestampMilliseconds": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 14400000 + } + } + }, "com.amazonaws.transcribe#Transcribe": { "type": "service", "version": "2017-10-26", "operations": [ + { + "target": "com.amazonaws.transcribe#CreateCallAnalyticsCategory" + }, { "target": "com.amazonaws.transcribe#CreateLanguageModel" }, @@ -2819,6 +3961,12 @@ { "target": "com.amazonaws.transcribe#CreateVocabularyFilter" }, + { + "target": "com.amazonaws.transcribe#DeleteCallAnalyticsCategory" + }, + { + "target": "com.amazonaws.transcribe#DeleteCallAnalyticsJob" + }, { "target": "com.amazonaws.transcribe#DeleteLanguageModel" }, @@ -2840,6 +3988,12 @@ { "target": "com.amazonaws.transcribe#DescribeLanguageModel" }, + { + "target": "com.amazonaws.transcribe#GetCallAnalyticsCategory" + }, + { + "target": "com.amazonaws.transcribe#GetCallAnalyticsJob" + }, { "target": "com.amazonaws.transcribe#GetMedicalTranscriptionJob" }, @@ -2855,6 +4009,12 @@ { "target": "com.amazonaws.transcribe#GetVocabularyFilter" }, + { + "target": "com.amazonaws.transcribe#ListCallAnalyticsCategories" + }, + { + "target": "com.amazonaws.transcribe#ListCallAnalyticsJobs" + }, { "target": "com.amazonaws.transcribe#ListLanguageModels" }, @@ -2873,12 +4033,18 @@ { "target": "com.amazonaws.transcribe#ListVocabularyFilters" }, + { + "target": "com.amazonaws.transcribe#StartCallAnalyticsJob" + }, { "target": "com.amazonaws.transcribe#StartMedicalTranscriptionJob" }, { "target": "com.amazonaws.transcribe#StartTranscriptionJob" }, + { + "target": "com.amazonaws.transcribe#UpdateCallAnalyticsCategory" + }, { "target": "com.amazonaws.transcribe#UpdateMedicalVocabulary" }, @@ -2925,6 +4091,63 @@ "smithy.api#documentation": "

Identifies the location of a transcription.

" } }, + "com.amazonaws.transcribe#TranscriptFilter": { + "type": "structure", + "members": { + "TranscriptFilterType": { + "target": "com.amazonaws.transcribe#TranscriptFilterType", + "traits": { + "smithy.api#documentation": "

Matches the phrase to the transcription output in a word for word \n fashion. For example, if you specify the phrase \"I want to speak to the manager.\" Amazon Transcribe\n attempts to match that specific phrase to the transcription.

", + "smithy.api#required": {} + } + }, + "AbsoluteTimeRange": { + "target": "com.amazonaws.transcribe#AbsoluteTimeRange", + "traits": { + "smithy.api#documentation": "

A time range, set in seconds, between two points in the call.

" + } + }, + "RelativeTimeRange": { + "target": "com.amazonaws.transcribe#RelativeTimeRange", + "traits": { + "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where you\n would like to apply a filter. For example, you can specify the first half of the call. You\n can also specify the period of time between halfway through to three-quarters of the way\n through the call. Because the length of conversation can vary between calls, you can\n apply relative time ranges across all calls.

" + } + }, + "ParticipantRole": { + "target": "com.amazonaws.transcribe#ParticipantRole", + "traits": { + "smithy.api#documentation": "

Determines whether the customer or the agent is speaking the phrases that you've\n specified.

" + } + }, + "Negate": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

If TRUE, the rule that you specify is applied to everything except for the phrases that you\n specify.

" + } + }, + "Targets": { + "target": "com.amazonaws.transcribe#StringTargetList", + "traits": { + "smithy.api#documentation": "

The phrases that you're specifying for the transcript filter to match.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Matches the output of the transcription to either the specific phrases that you specify, or the\n intent of the phrases that you specify.

" + } + }, + "com.amazonaws.transcribe#TranscriptFilterType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EXACT", + "name": "EXACT" + } + ] + } + }, "com.amazonaws.transcribe#TranscriptionJob": { "type": "structure", "members": { @@ -3048,7 +4271,7 @@ "min": 1, "max": 200 }, - "smithy.api#pattern": "^[0-9a-zA-Z._-]+" + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" } }, "com.amazonaws.transcribe#TranscriptionJobStatus": { @@ -3172,6 +4395,71 @@ ] } }, + "com.amazonaws.transcribe#UpdateCallAnalyticsCategory": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#UpdateCallAnalyticsCategoryRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#UpdateCallAnalyticsCategoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#ConflictException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the call analytics category with new values. The UpdateCallAnalyticsCategory\n operation overwrites all of the existing information with the values that you provide in the\n request.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/callanalyticscategories/{CategoryName}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#UpdateCallAnalyticsCategoryRequest": { + "type": "structure", + "members": { + "CategoryName": { + "target": "com.amazonaws.transcribe#CategoryName", + "traits": { + "smithy.api#documentation": "

The name of the analytics category to update. The name is case sensitive. If you try to\n update a call analytics category with the same name as a previous category you will receive a\n ConflictException error.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Rules": { + "target": "com.amazonaws.transcribe#RuleList", + "traits": { + "smithy.api#documentation": "

The rules used for the updated analytics category. The rules that you provide in this field\n replace the ones that are currently being used.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#UpdateCallAnalyticsCategoryResponse": { + "type": "structure", + "members": { + "CategoryProperties": { + "target": "com.amazonaws.transcribe#CategoryProperties", + "traits": { + "smithy.api#documentation": "

The attributes describing the analytics category. You can see information such as the\n rules that you've used to update the category and when the category was originally\n created.

" + } + } + } + }, "com.amazonaws.transcribe#UpdateMedicalVocabulary": { "type": "operation", "input": { @@ -3227,7 +4515,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 of the text file that contains\n the\n you use for your custom vocabulary. The URI must be in the same AWS\n Region as the resource that you are calling. The following is the format for a\n URI:

\n

\n \n https://s3..amazonaws.com///\n \n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

" + "smithy.api#documentation": "

The location in Amazon S3 of the text file that contains\n the\n you use for your custom vocabulary. The URI must be in the same Amazon Web Services\n Region as the resource that you are calling. The following is the format for a\n URI:

\n

\n \n https://s3..amazonaws.com///\n \n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

" } } } @@ -3401,7 +4689,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom\n vocabulary. The URI must be in the same region as the API endpoint that you are calling.\n The general form is

\n \n

For example:

\n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom Vocabularies.

" + "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom\n vocabulary. The URI must be in the same region as the API endpoint that you are calling.\n The general form is

\n \n

For example:

\n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom Vocabularies.

" } } } @@ -3442,7 +4730,7 @@ "min": 1, "max": 2000 }, - "smithy.api#pattern": "(s3://|http(s*)://).+" + "smithy.api#pattern": "^(s3://|http(s*)://).+$" } }, "com.amazonaws.transcribe#Vocabularies": { @@ -3503,7 +4791,7 @@ "min": 1, "max": 200 }, - "smithy.api#pattern": "^[0-9a-zA-Z._-]+" + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" } }, "com.amazonaws.transcribe#VocabularyFilters": { @@ -3551,7 +4839,7 @@ "min": 1, "max": 200 }, - "smithy.api#pattern": "^[0-9a-zA-Z._-]+" + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" } }, "com.amazonaws.transcribe#VocabularyState": { diff --git a/aws/sdk/aws-models/wafv2.json b/aws/sdk/aws-models/wafv2.json index 698407b28a..e0e1e56964 100644 --- a/aws/sdk/aws-models/wafv2.json +++ b/aws/sdk/aws-models/wafv2.json @@ -84,6 +84,9 @@ { "target": "com.amazonaws.wafv2#GetLoggingConfiguration" }, + { + "target": "com.amazonaws.wafv2#GetManagedRuleSet" + }, { "target": "com.amazonaws.wafv2#GetPermissionPolicy" }, @@ -108,12 +111,18 @@ { "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroups" }, + { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions" + }, { "target": "com.amazonaws.wafv2#ListIPSets" }, { "target": "com.amazonaws.wafv2#ListLoggingConfigurations" }, + { + "target": "com.amazonaws.wafv2#ListManagedRuleSets" + }, { "target": "com.amazonaws.wafv2#ListRegexPatternSets" }, @@ -132,6 +141,9 @@ { "target": "com.amazonaws.wafv2#PutLoggingConfiguration" }, + { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersions" + }, { "target": "com.amazonaws.wafv2#PutPermissionPolicy" }, @@ -144,6 +156,9 @@ { "target": "com.amazonaws.wafv2#UpdateIPSet" }, + { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDate" + }, { "target": "com.amazonaws.wafv2#UpdateRegexPatternSet" }, @@ -166,7 +181,7 @@ "name": "wafv2" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API, released in\n November, 2019. The names of the entities that you use to access this API, like\n endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\",\n to distinguish from the prior version. We recommend migrating your resources to this\n version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access\n any WAF resources that you created before. You can access your old rules, web ACLs,\n and other WAF resources only through the WAF Classic APIs. The WAF Classic\n APIs have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your WAF resources to this version, see the WAF\n Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests\n that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API. WAF also lets you control access to your content. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, \n or the AppSync GraphQL API responds to requests\n either with the requested content or with an HTTP 403 status code (Forbidden). You also can\n configure CloudFront to return a custom error page when a request is blocked.

\n

This API guide is for developers who need detailed information about WAF API\n actions, data types, and errors. For detailed information about WAF features and an\n overview of how to use WAF, see the WAF Developer Guide.

\n

You can make calls using the endpoints listed in Amazon Web Services Service Endpoints for WAF.

\n
    \n
  • \n

    For regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

    \n
    • \n
  • \n

    For Amazon CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.

    \n
    • \n
\n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

\n

We currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older\n versions, with the following major improvements:

\n
    \n
  • \n

    You use one API for both global and regional applications. Where you need to\n distinguish the scope, you specify a Scope parameter and set it to\n CLOUDFRONT or REGIONAL.

    \n
    • \n
  • \n

    You can define a web ACL or rule group with a single call, and update it with a\n single call. You define all rule specifications in JSON format, and pass them to your\n rule group or web ACL calls.

    \n
    • \n
  • \n

    The limits WAF places on the use of rules more closely reflects the cost of\n running each type of rule. Rule groups include capacity settings, so you know the\n maximum cost of a rule group when you use it.

    \n
    • \n
", + "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. You can access your old rules, web ACLs, and\n other WAF resources only through the WAF Classic APIs. The WAF Classic APIs\n have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your WAF resources to this version,\n see the WAF Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync\n GraphQL API. WAF also lets you control access to your content. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AppSync GraphQL\n API responds to requests either with the requested content or with an HTTP 403 status code\n (Forbidden). You also can configure CloudFront to return a custom error page when a request is\n blocked.

\n

This API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and an overview of\n how to use WAF, see the WAF Developer\n Guide.

\n

You can make calls using the endpoints listed in WAF endpoints and quotas.

\n
    \n
  • \n

    For regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

    \n
    • \n
  • \n

    For Amazon CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.

    \n
    • \n
\n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

\n

We currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older versions,\n with the following major improvements:

\n
    \n
  • \n

    You use one API for both global and regional applications. Where you need to\n distinguish the scope, you specify a Scope parameter and set it to\n CLOUDFRONT or REGIONAL.

    \n
    • \n
  • \n

    You can define a web ACL or rule group with a single call, and update it with a\n single call. You define all rule specifications in JSON format, and pass them to your\n rule group or web ACL calls.

    \n
    • \n
  • \n

    The limits WAF places on the use of rules more closely reflects the cost of\n running each type of rule. Rule groups include capacity settings, so you know the\n maximum cost of a rule group when you use it.

    \n
    • \n
", "smithy.api#title": "AWS WAFV2", "smithy.api#xmlNamespace": { "uri": "http://waf.amazonaws.com/doc/2019-07-29/" @@ -182,7 +197,7 @@ "Action": { "target": "com.amazonaws.wafv2#ActionValue", "traits": { - "smithy.api#documentation": "

The action setting that a log record must contain in order to meet the condition.

", + "smithy.api#documentation": "

The action setting that a log record must contain in order to meet the condition.\n

", "smithy.api#required": {} } } @@ -214,14 +229,14 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request JSON body that are within the JsonBody \n MatchScope. This is used with the FieldToMatch option JsonBody.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request\n JSON body that are within the JsonBody\n MatchScope. This is used with the FieldToMatch option\n JsonBody.\n \n

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#AllQueryArguments": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

All query arguments of a web request.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

All query arguments of a web request.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#AllowAction": { @@ -235,7 +250,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies that WAF should allow the request and optionally defines additional custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + "smithy.api#documentation": "

Specifies that WAF should allow the request and optionally defines additional\n custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" } }, "com.amazonaws.wafv2#AndStatement": { @@ -244,7 +259,7 @@ "Statements": { "target": "com.amazonaws.wafv2#Statements", "traits": { - "smithy.api#documentation": "

The statements to combine with AND logic. You can use any statements that can be nested.

", + "smithy.api#documentation": "

The statements to combine with AND logic. You can use any statements that can be nested.\n

", "smithy.api#required": {} } } @@ -279,7 +294,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.

" + "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.

" } }, "com.amazonaws.wafv2#AssociateWebACLRequest": { @@ -288,7 +303,7 @@ "WebACLArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the\n resource.

", "smithy.api#required": {} } }, @@ -316,14 +331,14 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + "smithy.api#documentation": "

Specifies that WAF should block the request and optionally defines additional\n custom handling for the response to the web request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" } }, "com.amazonaws.wafv2#Body": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The body of a web request. This immediately follows the request headers.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

The body of a web request. This immediately follows the request headers.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#BodyParsingFallbackBehavior": { @@ -354,7 +369,7 @@ "SearchString": { "target": "com.amazonaws.wafv2#SearchString", "traits": { - "smithy.api#documentation": "

A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.

\n

Valid values depend on the component that you specify for inspection in FieldToMatch:

\t\t\n
    \n
  • \n

    \n Method: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request.

    \n
    • \n
  • \n

    \n UriPath: The value that you want WAF to search for in the URI path,\n for example, /images/daily-ad.jpg.

    \n
    • \n
\n \n

If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

\n

\n If you're using the WAF API\n

\n

Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

\n

For example, suppose the value of Type is HEADER and the\n value of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME\n base64-encoding\n and include the resulting value, QmFkQm90, in the value of\n SearchString.

\n

\n If you're using the CLI or one of the Amazon Web Services SDKs\n

\n

The value that you want WAF to search for. The SDK automatically base64 encodes the value.

", + "smithy.api#documentation": "

A string value that you want WAF to search for. WAF searches only in the part of\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 50 bytes.

\n

Valid values depend on the component that you specify for inspection in\n FieldToMatch:

\n
    \n
  • \n

    \n Method: The HTTP method that you want WAF to search for. This\n indicates the type of operation specified in the request.

    \n
    • \n
  • \n

    \n UriPath: The value that you want WAF to search for in the URI path,\n for example, /images/daily-ad.jpg.

    \n
    • \n
\n

If SearchString includes alphabetic characters A-Z and a-z, note that the\n value is case sensitive.

\n

\n If you're using the WAF API\n

\n

Specify a base64-encoded version of the value. The maximum length of the value before\n you base64-encode it is 50 bytes.

\n

For example, suppose the value of Type is HEADER and the value\n of Data is User-Agent. If you want to search the\n User-Agent header for the value BadBot, you base64-encode\n BadBot using MIME base64-encoding and include the resulting value,\n QmFkQm90, in the value of SearchString.

\n

\n If you're using the CLI or one of the Amazon Web Services SDKs\n

\n

The value that you want WAF to search for. The SDK automatically base64 encodes the\n value.

", "smithy.api#required": {} } }, @@ -375,7 +390,7 @@ "PositionalConstraint": { "target": "com.amazonaws.wafv2#PositionalConstraint", "traits": { - "smithy.api#documentation": "

The area within the portion of a web request that you want WAF to search for SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of SearchString, but the location doesn't matter.

\t\t\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of SearchString, and \n SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, \n SearchString must be a word, which means that both of the following are true:

\n
    \n
  • \n

    \n SearchString is at the beginning of the specified part of the web request or is \n preceded by a character other than an alphanumeric character or underscore (_). \n Examples include the value of a header and ;BadBot.

    \n
    • \n
  • \n

    \n SearchString is at the end of the specified part of the web request or is \n followed by a character other than an alphanumeric character or underscore (_), for example,\n BadBot; and -BadBot;.

    \n
    • \n
\n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified part of the web request.

\t\t\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of the web request.

", + "smithy.api#documentation": "

The area within the portion of a web request that you want WAF to search for\n SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of\n SearchString, but the location doesn't matter.

\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of\n SearchString, and SearchString must contain only alphanumeric\n characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must\n be a word, which means that both of the following are true:

\n
    \n
  • \n

    \n SearchString is at the beginning of the specified part of the web\n request or is preceded by a character other than an alphanumeric character or\n underscore (_). Examples include the value of a header and\n ;BadBot.

    \n
    • \n
  • \n

    \n SearchString is at the end of the specified part of the web request or\n is followed by a character other than an alphanumeric character or underscore (_),\n for example, BadBot; and -BadBot;.

    \n
    • \n
\n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of\n SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified\n part of the web request.

\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of\n the web request.

", "smithy.api#required": {} } } @@ -401,6 +416,9 @@ "target": "com.amazonaws.wafv2#CheckCapacityResponse" }, "errors": [ + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, { "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, @@ -440,7 +458,7 @@ "Rules": { "target": "com.amazonaws.wafv2#Rules", "traits": { - "smithy.api#documentation": "

An array of Rule that you're configuring to use in a rule group or web ACL.

", + "smithy.api#documentation": "

An array of Rule that you're configuring to use in a rule group or web\n ACL.

", "smithy.api#required": {} } } @@ -538,7 +556,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies that WAF should count the request. Optionally defines additional custom handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + "smithy.api#documentation": "

Specifies that WAF should count the request. Optionally defines additional custom\n handling for the request.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" } }, "com.amazonaws.wafv2#Country": { @@ -1593,7 +1611,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.

" + "smithy.api#documentation": "

Creates an IPSet, which you use to identify web requests that\n originate from specific IP addresses or ranges of IP addresses. For example, if you're\n receiving a lot of requests from a ranges of IP addresses, you can configure WAF to\n block them using an IPSet that lists those IP addresses.

" } }, "com.amazonaws.wafv2#CreateIPSetRequest": { @@ -1622,14 +1640,14 @@ "IPAddressVersion": { "target": "com.amazonaws.wafv2#IPAddressVersion", "traits": { - "smithy.api#documentation": "

Specify IPV4 or IPV6.

", + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

", "smithy.api#required": {} } }, "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", + "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

", "smithy.api#required": {} } }, @@ -1687,7 +1705,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

" + "smithy.api#documentation": "

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request\n component for the specified patterns.

" } }, "com.amazonaws.wafv2#CreateRegexPatternSetRequest": { @@ -1978,7 +1996,7 @@ "Name": { "target": "com.amazonaws.wafv2#CustomHTTPHeaderName", "traits": { - "smithy.api#documentation": "

The name of the custom header.

\n

For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample.

", + "smithy.api#documentation": "

The name of the custom header.

\n

For custom request header insertion, when WAF inserts the header into the request,\n it prefixes this name x-amzn-waf-, to avoid confusion with the headers that\n are already in the request. For example, for the header name sample, WAF\n inserts the header x-amzn-waf-sample.

", "smithy.api#required": {} } }, @@ -2037,7 +2055,7 @@ } }, "traits": { - "smithy.api#documentation": "

Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for the rule actions allow and count.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

" + "smithy.api#documentation": "

Custom request handling behavior that inserts custom headers into a web request. You can\n add custom request handling for the rule actions allow and count.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

" } }, "com.amazonaws.wafv2#CustomResponse": { @@ -2053,7 +2071,7 @@ "CustomResponseBodyKey": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first \n define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference\n the response body using this key.

" + "smithy.api#documentation": "

References the response body that you want WAF to return to the web request\n client. You can define a custom response for a rule action or a default web ACL action that\n is set to block. To do this, you first define the response body key and value in the\n CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL\n default action BlockAction setting, you reference the response body using this\n key.

" } }, "ResponseHeaders": { @@ -2064,7 +2082,7 @@ } }, "traits": { - "smithy.api#documentation": "

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

" + "smithy.api#documentation": "

A custom response to send to the client. You can define a custom response for rule\n actions and default web ACL actions that are set to BlockAction.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

" } }, "com.amazonaws.wafv2#CustomResponseBodies": { @@ -2087,20 +2105,20 @@ "ContentType": { "target": "com.amazonaws.wafv2#ResponseContentType", "traits": { - "smithy.api#documentation": "

The type of content in the payload that you are defining in the Content string.

", + "smithy.api#documentation": "

The type of content in the payload that you are defining in the Content\n string.

", "smithy.api#required": {} } }, "Content": { "target": "com.amazonaws.wafv2#ResponseContent", "traits": { - "smithy.api#documentation": "

The payload of the custom response.

\n

You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

", + "smithy.api#documentation": "

The payload of the custom response.

\n

You can use JSON escape strings in JSON content. To do this, you must specify JSON\n content in the ContentType setting.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The response body to use in a custom response to a web request. This is referenced by key from CustomResponse \n CustomResponseBodyKey.

" + "smithy.api#documentation": "

The response body to use in a custom response to a web request. This is referenced by\n key from CustomResponse\n CustomResponseBodyKey.

" } }, "com.amazonaws.wafv2#DefaultAction": { @@ -2120,7 +2138,7 @@ } }, "traits": { - "smithy.api#documentation": "

In a WebACL, this is the action that you want WAF \n to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so you can't use count.

" + "smithy.api#documentation": "

In a WebACL, this is the action that you want WAF to perform\n when a web request doesn't match any of the rules in the WebACL. The default\n action must be a terminating action, so you can't use count.

" } }, "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups": { @@ -2149,7 +2167,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

" + "smithy.api#documentation": "

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

" } }, "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest": { @@ -2165,7 +2183,7 @@ "WebACLLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2177,7 +2195,7 @@ "NextWebACLLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -2247,7 +2265,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2283,7 +2301,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the LoggingConfiguration from the specified web\n ACL.

" + "smithy.api#documentation": "

Deletes the LoggingConfiguration from the specified web ACL.

" } }, "com.amazonaws.wafv2#DeleteLoggingConfigurationRequest": { @@ -2322,7 +2340,7 @@ } ], "traits": { - "smithy.api#documentation": "

Permanently deletes an IAM policy from the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" + "smithy.api#documentation": "

Permanently deletes an IAM policy from the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" } }, "com.amazonaws.wafv2#DeletePermissionPolicyRequest": { @@ -2331,7 +2349,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.

\n

You must be the owner of the rule group to perform this operation.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group from which you want to delete the\n policy.

\n

You must be the owner of the rule group to perform this operation.

", "smithy.api#required": {} } } @@ -2406,7 +2424,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2481,7 +2499,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2526,7 +2544,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

" + "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

" } }, "com.amazonaws.wafv2#DeleteWebACLRequest": { @@ -2556,7 +2574,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -2575,6 +2593,9 @@ "target": "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse" }, "errors": [ + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, { "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, @@ -2592,7 +2613,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides high-level information for a managed rule group, including descriptions of the rules.

" + "smithy.api#documentation": "

Provides high-level information for a managed rule group, including descriptions of the\n rules.

" } }, "com.amazonaws.wafv2#DescribeManagedRuleGroupRequest": { @@ -2618,16 +2639,34 @@ "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", "smithy.api#required": {} } + }, + "VersionName": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the rule group. You can only use a version that is not \n scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.\n

" + } } } }, "com.amazonaws.wafv2#DescribeManagedRuleGroupResponse": { "type": "structure", "members": { + "VersionName": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The managed rule group's version.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes\n to the managed rule group. You can subscribe to the SNS topic to receive notifications when\n the managed rule group is modified, such as for new versions and for version expiration.\n For more information, see the Amazon Simple Notification Service Developer Guide.

" + } + }, "Capacity": { "target": "com.amazonaws.wafv2#CapacityUnit", "traits": { - "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group. \n WAF uses web ACL capacity units (WCU) to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect each rule's relative\n cost. Rule group capacity is fixed at creation, so users can plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL\n capacity units (WCU) to calculate and control the operating resources that are used to run\n your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule\n type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so\n users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web\n ACLs is 1,500.

" } }, "Rules": { @@ -2679,7 +2718,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.

" + "smithy.api#documentation": "

Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n disassociate a web ACL, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution.

" } }, "com.amazonaws.wafv2#DisassociateWebACLRequest": { @@ -2746,7 +2785,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a single rule to exclude from the rule group. Excluding a rule overrides \n its action setting for the rule group in the web ACL, setting it to COUNT. \n This effectively excludes the rule from acting on web requests.

" + "smithy.api#documentation": "

Specifies a single rule to exclude from the rule group. Excluding a rule overrides its\n action setting for the rule group in the web ACL, setting it to COUNT. This\n effectively excludes the rule from acting on web requests.

" } }, "com.amazonaws.wafv2#ExcludedRules": { @@ -2776,13 +2815,13 @@ "SingleHeader": { "target": "com.amazonaws.wafv2#SingleHeader", "traits": { - "smithy.api#documentation": "

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" + "smithy.api#documentation": "

Inspect a single header. Provide the name of the header to inspect, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" } }, "SingleQueryArgument": { "target": "com.amazonaws.wafv2#SingleQueryArgument", "traits": { - "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such\n as UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" } }, "AllQueryArguments": { @@ -2794,36 +2833,36 @@ "UriPath": { "target": "com.amazonaws.wafv2#UriPath", "traits": { - "smithy.api#documentation": "

Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

" + "smithy.api#documentation": "

Inspect the request URI path. This is the part of a web request that identifies a\n resource, for example, /images/daily-ad.jpg.

" } }, "QueryString": { "target": "com.amazonaws.wafv2#QueryString", "traits": { - "smithy.api#documentation": "

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

" + "smithy.api#documentation": "

Inspect the query string. This is the part of a URL that appears after a ?\n character, if any.

" } }, "Body": { "target": "com.amazonaws.wafv2#Body", "traits": { - "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any \n additional data that you want to send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

" + "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to\n WAF for inspection by the underlying host service. If you don't need to inspect more\n than 8 KB, you can guarantee that you don't allow additional bytes in by combining a\n statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement,\n with a SizeConstraintStatement that enforces an 8 KB size limit on the\n body of the request. WAF doesn't support inspecting the entire contents of web requests\n whose bodies exceed the 8 KB limit.

" } }, "Method": { "target": "com.amazonaws.wafv2#Method", "traits": { - "smithy.api#documentation": "

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

" + "smithy.api#documentation": "

Inspect the HTTP method. The method indicates the type of operation that the request is\n asking the origin to perform.

" } }, "JsonBody": { "target": "com.amazonaws.wafv2#JsonBody", "traits": { - "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any \n additional data that you want to send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

" + "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to\n WAF for inspection by the underlying host service. If you don't need to inspect more\n than 8 KB, you can guarantee that you don't allow additional bytes in by combining a\n statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement,\n with a SizeConstraintStatement that enforces an 8 KB size limit on the\n body of the request. WAF doesn't support inspecting the entire contents of web requests\n whose bodies exceed the 8 KB limit.

" } } }, "traits": { - "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.

" + "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. Include the single\n FieldToMatch type that you want to inspect, with additional specifications\n as needed, according to the type. You specify a single request component in\n FieldToMatch for each rule statement that requires it. To inspect more than\n one component of a web request, create a separate rule statement for each component.

" } }, "com.amazonaws.wafv2#FieldToMatchData": { @@ -2849,7 +2888,7 @@ "Requirement": { "target": "com.amazonaws.wafv2#FilterRequirement", "traits": { - "smithy.api#documentation": "

Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

", + "smithy.api#documentation": "

Logic to apply to the filtering conditions. You can specify that, in order to satisfy\n the filter, a log must match all conditions or must match at least one condition.

", "smithy.api#required": {} } }, @@ -2919,7 +2958,7 @@ "Priority": { "target": "com.amazonaws.wafv2#RulePriority", "traits": { - "smithy.api#documentation": "

If you define more than one rule group in the first or last Firewall Manager rule groups,\n WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. \n The priorities don't need to be consecutive, but they must all be different.

", + "smithy.api#documentation": "

If you define more than one rule group in the first or last Firewall Manager rule groups, WAF\n evaluates each request against the rule groups in order, starting from the lowest priority\n setting. The priorities don't need to be consecutive, but they must all be\n different.

", "smithy.api#required": {} } }, @@ -2994,7 +3033,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. \n For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

WAF only evaluates the first IP address found in the specified HTTP header.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

\n

WAF only evaluates the first IP address found in the specified HTTP header.\n

" } }, "com.amazonaws.wafv2#ForwardedIPHeaderName": { @@ -3032,7 +3071,7 @@ "CountryCodes": { "target": "com.amazonaws.wafv2#CountryCodes", "traits": { - "smithy.api#documentation": "

An array of two-character country codes, for example, [ \"US\", \"CN\" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

" + "smithy.api#documentation": "

An array of two-character country codes, for example, [ \"US\", \"CN\" ], from\n the alpha-2 country ISO codes of the ISO 3166 international standard.

" } }, "ForwardedIPConfig": { @@ -3110,7 +3149,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -3164,6 +3203,75 @@ } } }, + "com.amazonaws.wafv2#GetManagedRuleSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#GetManagedRuleSetRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#GetManagedRuleSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the specified managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#GetManagedRuleSetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wafv2#GetManagedRuleSetResponse": { + "type": "structure", + "members": { + "ManagedRuleSet": { + "target": "com.amazonaws.wafv2#ManagedRuleSet", + "traits": { + "smithy.api#documentation": "

The managed rule set that you requested.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + } + }, "com.amazonaws.wafv2#GetPermissionPolicy": { "type": "operation", "input": { @@ -3184,7 +3292,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the IAM policy that is attached to the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" + "smithy.api#documentation": "

Returns the IAM policy that is attached to the specified rule group.

\n

You must be the owner of the rule group to perform this operation.

" } }, "com.amazonaws.wafv2#GetPermissionPolicyRequest": { @@ -3193,7 +3301,7 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rule group for which you want to get the\n policy.

", "smithy.api#required": {} } } @@ -3233,7 +3341,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

" + "smithy.api#documentation": "

Retrieves the keys that are currently blocked by a rate-based rule. The maximum number\n of managed keys that can be blocked for a single rate-based rule is 10,000. If more than\n 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

" } }, "com.amazonaws.wafv2#GetRateBasedStatementManagedKeysRequest": { @@ -3350,7 +3458,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -3422,7 +3530,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -3447,7 +3555,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

\n

\n GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource \n (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests \n returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.

" + "smithy.api#documentation": "

Gets detailed information about a specified number of requests--a sample--that WAF\n randomly selects from among the first 5,000 requests that your Amazon Web Services resource received\n during a time range that you choose. You can specify a sample size of up to 500 requests,\n and you can specify any time range in the previous three hours.

\n

\n GetSampledRequests returns a time range, which is usually the time range that\n you specified. However, if your resource (such as a CloudFront distribution) received 5,000\n requests before the specified time range elapsed, GetSampledRequests returns\n an updated time range. This new time range indicates the actual period during which WAF\n selected the requests in the sample.

" } }, "com.amazonaws.wafv2#GetSampledRequestsRequest": { @@ -3456,14 +3564,14 @@ "WebAclArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

", + "smithy.api#documentation": "

The Amazon resource name (ARN) of the WebACL for which you want a sample of\n requests.

", "smithy.api#required": {} } }, "RuleMetricName": { "target": "com.amazonaws.wafv2#MetricName", "traits": { - "smithy.api#documentation": "

The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.

", + "smithy.api#documentation": "

The metric name assigned to the Rule or RuleGroup for which\n you want a sample of requests.

", "smithy.api#required": {} } }, @@ -3477,14 +3585,14 @@ "TimeWindow": { "target": "com.amazonaws.wafv2#TimeWindow", "traits": { - "smithy.api#documentation": "

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a \n sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.

", + "smithy.api#documentation": "

The start date and time and the end date and time of the range for which you want\n GetSampledRequests to return a sample of requests. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours. If you specify a start time that's earlier than\n three hours ago, WAF sets it to three hours ago.

", "smithy.api#required": {} } }, "MaxItems": { "target": "com.amazonaws.wafv2#ListMaxItems", "traits": { - "smithy.api#documentation": "

The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received\n during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests \n returns information about all of them.

", + "smithy.api#documentation": "

The number of requests that you want WAF to return from among the first 5,000\n requests that your Amazon Web Services resource received during the time range. If your resource received\n fewer requests than the value of MaxItems, GetSampledRequests\n returns information about all of them.

", "smithy.api#required": {} } } @@ -3496,19 +3604,19 @@ "SampledRequests": { "target": "com.amazonaws.wafv2#SampledHTTPRequests", "traits": { - "smithy.api#documentation": "

A complex type that contains detailed information about each of the requests in the sample.

" + "smithy.api#documentation": "

A complex type that contains detailed information about each of the requests in the\n sample.

" } }, "PopulationSize": { "target": "com.amazonaws.wafv2#PopulationSize", "traits": { - "smithy.api#documentation": "

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. \n If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource \n received during the specified time range.

" + "smithy.api#documentation": "

The total number of requests from which GetSampledRequests got a sample of\n MaxItems requests. If PopulationSize is less than\n MaxItems, the sample includes every request that your Amazon Web Services resource\n received during the specified time range.

" } }, "TimeWindow": { "target": "com.amazonaws.wafv2#TimeWindow", "traits": { - "smithy.api#documentation": "

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. \n However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, \n GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

" + "smithy.api#documentation": "

Usually, TimeWindow is the time range that you specified in the\n GetSampledRequests request. However, if your Amazon Web Services resource received more\n than 5,000 requests during the time range that you specified in the request,\n GetSampledRequests returns the time range for the first 5,000 requests.\n Times are in Coordinated Universal Time (UTC) format.

" } } } @@ -3586,7 +3694,7 @@ "WebACL": { "target": "com.amazonaws.wafv2#WebACL", "traits": { - "smithy.api#documentation": "

The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.

" + "smithy.api#documentation": "

The web ACL that is associated with the resource. If there is no associated resource,\n WAF returns a null web ACL.

" } } } @@ -3623,13 +3731,13 @@ "WebACL": { "target": "com.amazonaws.wafv2#WebACL", "traits": { - "smithy.api#documentation": "

The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.

" + "smithy.api#documentation": "

The web ACL specification. You can modify the settings in this web ACL and use it to\n update this web ACL or create a new one.

" } }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -3651,7 +3759,7 @@ } }, "traits": { - "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type that \n appears as Headers in the response syntax. HTTPHeader contains the names and values of \n all of the headers that appear in one of the web requests.

" + "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type\n that appears as Headers in the response syntax. HTTPHeader\n contains the names and values of all of the headers that appear in one of the web requests.\n

" } }, "com.amazonaws.wafv2#HTTPHeaders": { @@ -3669,19 +3777,19 @@ "ClientIP": { "target": "com.amazonaws.wafv2#IPString", "traits": { - "smithy.api#documentation": "

The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, \n this is the value of one of the following fields in CloudFront access logs:

\n
    \n
  • \n

    \n c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

    \n
    • \n
  • \n

    \n x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

    \n
    • \n
" + "smithy.api#documentation": "

The IP address that the request originated from. If the web ACL is associated with a\n CloudFront distribution, this is the value of one of the following fields in CloudFront access\n logs:

\n
    \n
  • \n

    \n c-ip, if the viewer did not use an HTTP proxy or a load balancer to send\n the request

    \n
    • \n
  • \n

    \n x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer\n to send the request

    \n
    • \n
" } }, "Country": { "target": "com.amazonaws.wafv2#Country", "traits": { - "smithy.api#documentation": "

The two-letter country code for the country that the request originated from. For a current list of country codes, \n see the Wikipedia entry ISO 3166-1 alpha-2.

" + "smithy.api#documentation": "

The two-letter country code for the country that the request originated from. For a\n current list of country codes, see the Wikipedia entry ISO 3166-1\n alpha-2.

" } }, "URI": { "target": "com.amazonaws.wafv2#URIString", "traits": { - "smithy.api#documentation": "

The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.

" + "smithy.api#documentation": "

The URI path of the request, which identifies the resource, for example,\n /images/daily-ad.jpg.

" } }, "Method": { @@ -3693,18 +3801,18 @@ "HTTPVersion": { "target": "com.amazonaws.wafv2#HTTPVersion", "traits": { - "smithy.api#documentation": "

The HTTP version specified in the sampled web request, for example, HTTP/1.1.

" + "smithy.api#documentation": "

The HTTP version specified in the sampled web request, for example,\n HTTP/1.1.

" } }, "Headers": { "target": "com.amazonaws.wafv2#HTTPHeaders", "traits": { - "smithy.api#documentation": "

A complex type that contains the name and value for each header in the sampled web request.

" + "smithy.api#documentation": "

A complex type that contains the name and value for each header in the sampled web\n request.

" } } }, "traits": { - "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type that \n appears as Request in the response syntax. HTTPRequest contains information about \n one of the web requests.

" + "smithy.api#documentation": "

Part of the response from GetSampledRequests. This is a complex type\n that appears as Request in the response syntax. HTTPRequest\n contains information about one of the web requests.

" } }, "com.amazonaws.wafv2#HTTPVersion": { @@ -3780,20 +3888,20 @@ "IPAddressVersion": { "target": "com.amazonaws.wafv2#IPAddressVersion", "traits": { - "smithy.api#documentation": "

Specify IPV4 or IPV6.

", + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

", "smithy.api#required": {} } }, "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", + "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

\n

WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

" + "smithy.api#documentation": "

Contains one or more IP addresses or blocks of IP addresses specified in Classless\n Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges\n except for /0. For information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

\n

WAF assigns an ARN to each IPSet that you create. To use an IP set in a\n rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

" } }, "com.amazonaws.wafv2#IPSetForwardedIPConfig": { @@ -3816,13 +3924,13 @@ "Position": { "target": "com.amazonaws.wafv2#ForwardedIPPosition", "traits": { - "smithy.api#documentation": "

The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

\n

The options for this setting are the following:

\n
    \n
  • \n

    FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

    \n
    • \n
  • \n

    LAST - Inspect the last IP address in the list of IP addresses in the header.

    \n
    • \n
  • \n

    ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.

    \n
    • \n
", + "smithy.api#documentation": "

The position in the header to search for the IP address. The header can contain IP\n addresses of the original client and also of proxies. For example, the header value could\n be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the\n original client and the rest identify proxies that the request went through.

\n

The options for this setting are the following:

\n
    \n
  • \n

    FIRST - Inspect the first IP address in the list of IP addresses in the\n header. This is usually the client's original IP.

    \n
    • \n
  • \n

    LAST - Inspect the last IP address in the list of IP addresses in the\n header.

    \n
    • \n
  • \n

    ANY - Inspect all IP addresses in the header for a match. If the header\n contains more than 10 IP addresses, WAF inspects the last 10.

    \n
    • \n
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" } }, "com.amazonaws.wafv2#IPSetReferenceStatement": { @@ -3831,7 +3939,7 @@ "ARN": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPSet that this statement references.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IPSet that this statement\n references.

", "smithy.api#required": {} } }, @@ -3876,7 +3984,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } }, "ARN": { @@ -3899,26 +4007,26 @@ "MatchPattern": { "target": "com.amazonaws.wafv2#JsonMatchPattern", "traits": { - "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.

", + "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria.

", "smithy.api#required": {} } }, "MatchScope": { "target": "com.amazonaws.wafv2#JsonMatchScope", "traits": { - "smithy.api#documentation": "

The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values.

", + "smithy.api#documentation": "

The parts of the JSON to match against using the MatchPattern. If you\n specify All, WAF matches against keys and values.

", "smithy.api#required": {} } }, "InvalidFallbackBehavior": { "target": "com.amazonaws.wafv2#BodyParsingFallbackBehavior", "traits": { - "smithy.api#documentation": "

What WAF should do if it fails to completely parse the JSON body. The options are the following:

\n
    \n
  • \n \t\t

    \n EVALUATE_AS_STRING - Inspect the body as\n \t\t\tplain text. WAF applies the text transformations and\n \t\t\tinspection criteria that you defined for the JSON inspection to\n \t\t\tthe body text string.

    \n \t
    • \n
  • \n \t\t

    \n MATCH - Treat the web request as matching\n \t\t\tthe rule statement. WAF applies the rule action to the\n \t\t\trequest.

    \n \t
    • \n
  • \n \t\t

    \n NO_MATCH - Treat the web request as not\n \t\t\tmatching the rule statement.

    \n \t
    • \n
\n

If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.

\n

WAF does its best to parse the entire JSON body, but might be forced\n \tto stop for reasons such as characters that aren't valid, duplicate keys,\n \ttruncation, and any content whose root node isn't an object or an array.

\n

WAF parses the JSON in the following examples as two valid key,\n \tvalue pairs:

\n
    \n
  • \n \t\t

    Missing comma:\n \t\t\t{\"key1\":\"value1\"\"key2\":\"value2\"}\n

    \n \t
    • \n
  • \n \t\t

    Missing colon:\n \t\t\t{\"key1\":\"value1\",\"key2\"\"value2\"}\n

    \n \t
    • \n
  • \n \t\t

    Extra colons:\n \t\t\t{\"key1\"::\"value1\",\"key2\"\"value2\"}\n

    \n \t
    • \n
" + "smithy.api#documentation": "

What WAF should do if it fails to completely parse the JSON body. The options are\n the following:

\n
    \n
  • \n

    \n EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies\n the text transformations and inspection criteria that you defined for the JSON\n inspection to the body text string.

    \n
    • \n
  • \n

    \n MATCH - Treat the web request as matching the rule statement. WAF\n applies the rule action to the request.

    \n
    • \n
  • \n

    \n NO_MATCH - Treat the web request as not matching the rule\n statement.

    \n
    • \n
\n

If you don't provide this setting, WAF parses and evaluates the content only up to the\n first parsing failure that it encounters.

\n

WAF does its best to parse the entire JSON body, but might be forced to stop for\n reasons such as invalid characters, duplicate keys, truncation, and any content whose root\n node isn't an object or an array.

\n

WAF parses the JSON in the following examples as two valid key, value pairs:

\n
    \n
  • \n

    Missing comma: {\"key1\":\"value1\"\"key2\":\"value2\"}\n

    \n
    • \n
  • \n

    Missing colon: {\"key1\":\"value1\",\"key2\"\"value2\"}\n

    \n
    • \n
  • \n

    Extra colons: {\"key1\"::\"value1\",\"key2\"\"value2\"}\n

    \n
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

The body of a web request, inspected as JSON. The body immediately follows the request headers. This is used in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.

" + "smithy.api#documentation": "

The body of a web request, inspected as JSON. The body immediately follows the request\n headers. This is used in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you\n indicate.\n

" } }, "com.amazonaws.wafv2#JsonMatchPattern": { @@ -3927,18 +4035,18 @@ "All": { "target": "com.amazonaws.wafv2#All", "traits": { - "smithy.api#documentation": "

Match all of the elements. See also MatchScope in JsonBody.

\n

You must specify either this setting or the IncludedPaths setting, but not both.

" + "smithy.api#documentation": "

Match all of the elements. See also\n MatchScope\n in JsonBody.

\n

You must specify either this setting or the IncludedPaths setting, but not\n both.

" } }, "IncludedPaths": { "target": "com.amazonaws.wafv2#JsonPointerPaths", "traits": { - "smithy.api#documentation": "

Match only the specified include paths. See also MatchScope in JsonBody.

\n

Provide the include paths using JSON Pointer syntax. For example, \"IncludedPaths\": [\"/dogs/0/name\", \"/dogs/1/name\"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation \n JavaScript Object Notation (JSON) Pointer.

\n

You must specify either this setting or the All setting, but not both.

\n \n

Don't use this option to include all paths. Instead, use the All setting.

\n " + "smithy.api#documentation": "

Match only the specified include paths. See also\n MatchScope\n in JsonBody.

\n

Provide the include paths using JSON Pointer syntax. For example, \"IncludedPaths\":\n [\"/dogs/0/name\", \"/dogs/1/name\"]. For information about this syntax, see the\n Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON)\n Pointer.

\n

You must specify either this setting or the All setting, but not\n both.

\n \n

Don't use this option to include all paths. Instead, use the All\n setting.

\n " } } }, "traits": { - "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

" + "smithy.api#documentation": "

The patterns to look for in the JSON body. WAF inspects the results of these\n pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

" } }, "com.amazonaws.wafv2#JsonMatchScope": { @@ -3993,7 +4101,7 @@ } }, "traits": { - "smithy.api#documentation": "

A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest.

" + "smithy.api#documentation": "

A single label container. This is used as an element of a label array in multiple\n contexts, for example, in RuleLabels inside a Rule and in\n Labels inside a SampledHTTPRequest.

" } }, "com.amazonaws.wafv2#LabelMatchKey": { @@ -4034,7 +4142,7 @@ "Key": { "target": "com.amazonaws.wafv2#LabelMatchKey", "traits": { - "smithy.api#documentation": "

The string to match against. The setting you provide for this depends on the match statement's Scope setting:

\n
    \n
  • \n

    If the Scope indicates LABEL, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.

    \n
    • \n
  • \n

    If the Scope indicates NAMESPACE, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.

    \n
    • \n
\n

Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.

", + "smithy.api#documentation": "

The string to match against. The setting you provide for this depends on the match\n statement's Scope setting:

\n
    \n
  • \n

    If the Scope indicates LABEL, then this specification\n must include the name and can include any number of preceding namespace\n specifications and prefix up to providing the fully qualified label name.

    \n
    • \n
  • \n

    If the Scope indicates NAMESPACE, then this\n specification can include any number of contiguous namespace strings, and can include\n the entire label namespace prefix from the rule group or web ACL where the label\n originates.

    \n
    • \n
\n

Labels are case sensitive and components of a label must be separated by colon, for\n example NS1:NS2:name.

", "smithy.api#required": {} } } @@ -4059,13 +4167,13 @@ "LabelName": { "target": "com.amazonaws.wafv2#LabelName", "traits": { - "smithy.api#documentation": "

The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

", + "smithy.api#documentation": "

The label name that a log record must contain in order to meet the condition. This must\n be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A single label name condition for a Condition in a logging filter.

" + "smithy.api#documentation": "

A single label name condition for a Condition in a logging\n filter.

" } }, "com.amazonaws.wafv2#LabelSummaries": { @@ -4085,7 +4193,7 @@ } }, "traits": { - "smithy.api#documentation": "

List of labels used by one or more of the rules of a RuleGroup. This summary object is used for the following rule group lists:

\n
    \n
  • \n

    \n AvailableLabels - Labels that rules add to matching requests. These labels are defined in the RuleLabels for a Rule.

    \n
    • \n
  • \n

    \n ConsumedLabels - Labels that rules match against. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

    \n
    • \n
" + "smithy.api#documentation": "

List of labels used by one or more of the rules of a RuleGroup. This\n summary object is used for the following rule group lists:

\n
    \n
  • \n

    \n AvailableLabels - Labels that rules add to matching requests.\n These labels are defined in the RuleLabels for a Rule.

    \n
    • \n
  • \n

    \n ConsumedLabels - Labels that rules match against.\n These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.

    \n
    • \n
" } }, "com.amazonaws.wafv2#Labels": { @@ -4094,6 +4202,84 @@ "target": "com.amazonaws.wafv2#Label" } }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the available versions for the specified managed rule group.

" + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsRequest": { + "type": "structure", + "members": { + "VendorName": { + "target": "com.amazonaws.wafv2#VendorName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + } + }, + "com.amazonaws.wafv2#ListAvailableManagedRuleGroupVersionsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Versions": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupVersions", + "traits": { + "smithy.api#documentation": "

The versions that are currently available for the specified managed rule group.

" + } + } + } + }, "com.amazonaws.wafv2#ListAvailableManagedRuleGroups": { "type": "operation", "input": { @@ -4114,7 +4300,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and the Marketplace managed rule groups that you're subscribed to.

" + "smithy.api#documentation": "

Retrieves an array of managed rule groups that are available for you to use. This list\n includes all Amazon Web Services Managed Rules rule groups and all of the Marketplace managed rule groups that you're\n subscribed to.

" } }, "com.amazonaws.wafv2#ListAvailableManagedRuleGroupsRequest": { @@ -4178,7 +4364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

" + "smithy.api#documentation": "

Retrieves an array of IPSetSummary objects for the IP sets that you\n manage.

" } }, "com.amazonaws.wafv2#ListIPSetsRequest": { @@ -4217,7 +4403,7 @@ "IPSets": { "target": "com.amazonaws.wafv2#IPSetSummaries", "traits": { - "smithy.api#documentation": "

Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

" + "smithy.api#documentation": "

Array of IPSets. This may not be the full list of IPSets that you have defined. See the\n Limit specification for this request.

" } } } @@ -4285,6 +4471,70 @@ } } }, + "com.amazonaws.wafv2#ListManagedRuleSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#ListManagedRuleSetsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#ListManagedRuleSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the managed rule sets that you own.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ListManagedRuleSetsRequest": { + "type": "structure", + "members": { + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "Limit": { + "target": "com.amazonaws.wafv2#PaginationLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of objects that you want WAF to return for this request. If more \n objects are available, in the response, WAF provides a \n NextMarker value that you can use in a subsequent call to get the next batch of objects.

" + } + } + } + }, + "com.amazonaws.wafv2#ListManagedRuleSetsResponse": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.wafv2#NextMarker", + "traits": { + "smithy.api#documentation": "

When you request a list of objects with a Limit setting, if the number of objects that are still available\n for retrieval exceeds the limit, WAF returns a NextMarker \n value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + } + }, + "ManagedRuleSets": { + "target": "com.amazonaws.wafv2#ManagedRuleSetSummaries", + "traits": { + "smithy.api#documentation": "

Your managed rule sets.

" + } + } + } + }, "com.amazonaws.wafv2#ListMaxItems": { "type": "long", "traits": { @@ -4314,7 +4564,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

" + "smithy.api#documentation": "

Retrieves an array of RegexPatternSetSummary objects for the regex\n pattern sets that you manage.

" } }, "com.amazonaws.wafv2#ListRegexPatternSetsRequest": { @@ -4381,7 +4631,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use the CloudFront call ListDistributionsByWebACLId.

" + "smithy.api#documentation": "

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that\n are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use\n the CloudFront call ListDistributionsByWebACLId.

" } }, "com.amazonaws.wafv2#ListResourcesForWebACLRequest": { @@ -4397,7 +4647,7 @@ "ResourceType": { "target": "com.amazonaws.wafv2#ResourceType", "traits": { - "smithy.api#documentation": "

Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

" + "smithy.api#documentation": "

Used for web ACLs that are scoped for regional applications.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

" } } } @@ -4433,7 +4683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

" + "smithy.api#documentation": "

Retrieves an array of RuleGroupSummary objects for the rule groups\n that you manage.

" } }, "com.amazonaws.wafv2#ListRuleGroupsRequest": { @@ -4506,7 +4756,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the WAF console.

" + "smithy.api#documentation": "

Retrieves the TagInfoForResource for the specified resource. Tags are\n key:value pairs that you can use to categorize and manage your resources, for purposes like\n billing. For example, you might set the tag key to \"customer\" and the value to the customer\n name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags\n for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" } }, "com.amazonaws.wafv2#ListTagsForResourceRequest": { @@ -4570,7 +4820,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

" + "smithy.api#documentation": "

Retrieves an array of WebACLSummary objects for the web ACLs that you\n manage.

" } }, "com.amazonaws.wafv2#ListWebACLsRequest": { @@ -4642,38 +4892,38 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with\n LogDestinationConfigs.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with\n LogDestinationConfigs.

", "smithy.api#required": {} } }, "LogDestinationConfigs": { "target": "com.amazonaws.wafv2#LogDestinationConfigs", "traits": { - "smithy.api#documentation": "

The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.

", + "smithy.api#documentation": "

The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate\n with the web ACL.

", "smithy.api#required": {} } }, "RedactedFields": { "target": "com.amazonaws.wafv2#RedactedFields", "traits": { - "smithy.api#documentation": "

The parts of the request that you want to keep out of the logs. For\n example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

\n \n

You must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.

\n " + "smithy.api#documentation": "

The parts of the request that you want to keep out of the logs. For example, if you\n redact the HEADER field, the HEADER field in the firehose will be\n xxx.

\n \n

You must use one of the following values: URI,\n QUERY_STRING, HEADER, or METHOD.

\n " } }, "ManagedByFirewallManager": { "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only \n Firewall Manager can modify or delete the configuration.

" + "smithy.api#documentation": "

Indicates whether the logging configuration was created by Firewall Manager, as part of an\n WAF policy configuration. If true, only Firewall Manager can modify or delete the\n configuration.

" } }, "LoggingFilter": { "target": "com.amazonaws.wafv2#LoggingFilter", "traits": { - "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

" + "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped.\n You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.

" } } }, "traits": { - "smithy.api#documentation": "

Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for \n logging from WAF.\n As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you \n can specify filters so that you log only a subset of the logging records.

" + "smithy.api#documentation": "

Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL\n resource, for logging from WAF. As part of the association, you can specify parts of\n the standard logging fields to keep out of the logs and you can specify filters so that you\n log only a subset of the logging records.

" } }, "com.amazonaws.wafv2#LoggingConfigurations": { @@ -4695,13 +4945,13 @@ "DefaultBehavior": { "target": "com.amazonaws.wafv2#FilterBehavior", "traits": { - "smithy.api#documentation": "

Default handling for logs that don't match any of the specified filtering conditions.

", + "smithy.api#documentation": "

Default handling for logs that don't match any of the specified filtering conditions.\n

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL's LoggingConfiguration.

\n

You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

" + "smithy.api#documentation": "

Filtering that specifies which web requests are kept in the logs and which are dropped,\n defined for a web ACL's LoggingConfiguration.

\n

You can filter on the rule action and on the web request labels that were applied by\n matching rules during web ACL evaluation.

" } }, "com.amazonaws.wafv2#ManagedRuleGroupStatement": { @@ -4721,16 +4971,22 @@ "smithy.api#required": {} } }, + "Version": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the managed rule group to use. If you specify this, the version setting \n is fixed until you change it. \n If you don't specify this, WAF uses the vendor's default version, and then keeps the version \n at the vendor's default when the vendor updates the managed rule group settings.

" + } + }, "ExcludedRules": { "target": "com.amazonaws.wafv2#ExcludedRules", "traits": { - "smithy.api#documentation": "

The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

" + "smithy.api#documentation": "

The rules whose actions are set to COUNT by the web ACL, regardless of the\n action that is set on the rule. This effectively excludes the rule from acting on web\n requests.

" } }, "ScopeDownStatement": { "target": "com.amazonaws.wafv2#Statement", "traits": { - "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

" + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated by the managed rule group. Requests are only evaluated by the rule group if they\n match the scope-down statement. You can use any nestable Statement in the\n scope-down statement, and you can nest statements at any level, the same as you can for a\n rule statement.

" } } }, @@ -4770,11 +5026,184 @@ "smithy.api#documentation": "

High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Marketplace managed rule groups, which you can subscribe to through Marketplace.

" } }, + "com.amazonaws.wafv2#ManagedRuleGroupVersion": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version name.

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the managed rule group owner updated the rule group version\n information.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a single version of a managed rule group.

" + } + }, + "com.amazonaws.wafv2#ManagedRuleGroupVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleGroupVersion" + } + }, + "com.amazonaws.wafv2#ManagedRuleSet": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "PublishedVersions": { + "target": "com.amazonaws.wafv2#PublishedVersions", + "traits": { + "smithy.api#documentation": "

The versions of this managed rule set that are available for use by customers.

" + } + }, + "RecommendedVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that you would like your customers to use.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of rules that is managed by Amazon Web Services and Marketplace sellers to provide versioned managed\n rule groups for customers of WAF.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ManagedRuleSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#ManagedRuleSetSummary" + } + }, + "com.amazonaws.wafv2#ManagedRuleSetSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

" + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

" + } + }, + "Description": { + "target": "com.amazonaws.wafv2#EntityDescription", + "traits": { + "smithy.api#documentation": "

A description of the set that helps with identification.

" + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + }, + "ARN": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entity.

" + } + }, + "LabelNamespace": { + "target": "com.amazonaws.wafv2#LabelName", + "traits": { + "smithy.api#documentation": "

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

\n
    \n
  • \n

    The syntax for the label namespace prefix for a managed rule group is the following:

    \n

    \n awswaf:managed:::

    \n
    • \n
  • \n

    When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    \n

    \n \n

    \n \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

High-level information for a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#ManagedRuleSetVersion": { + "type": "structure", + "members": { + "AssociatedRuleGroupArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor rule group that's used to define the\n published version of your managed rule group.

" + } + }, + "Capacity": { + "target": "com.amazonaws.wafv2#CapacityUnit", + "traits": { + "smithy.api#documentation": "

The web ACL capacity units (WCUs) required for this rule group.

\n

WAF uses WCUs to calculate and control the operating\n resources that are used to run your rules, rule groups, and web ACLs. WAF\n calculates capacity differently for each rule type, to reflect the relative cost of each rule. \n Simple rules that cost little to run use fewer WCUs than more complex rules\n\t\t\t\tthat use more processing power. \n\t\t\t\tRule group capacity is fixed at creation, which helps users plan their \n web ACL WCU usage when they use a rule group. \n The WCU limit for web ACLs is 1,500.

" + } + }, + "ForecastedLifetime": { + "target": "com.amazonaws.wafv2#TimeWindowDay", + "traits": { + "smithy.api#documentation": "

The amount of time you expect this version of your managed rule group to last, in days.\n

" + } + }, + "PublishTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that you first published this version.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that you updated this version.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this version is set to expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information for a single version of a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, "com.amazonaws.wafv2#Method": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

The HTTP method of a web request. The method indicates the type of operation that the\n request is asking the origin to perform.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#MetricName": { @@ -4801,7 +5230,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Specifies that WAF should do nothing. This is generally used to try out a rule without performing any actions. You set the OverrideAction on the Rule.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + "smithy.api#documentation": "

Specifies that WAF should do nothing. This is generally used to try out a rule\n without performing any actions. You set the OverrideAction on the Rule.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" } }, "com.amazonaws.wafv2#NotStatement": { @@ -4825,7 +5254,7 @@ "Statements": { "target": "com.amazonaws.wafv2#Statements", "traits": { - "smithy.api#documentation": "

The statements to combine with OR logic. You can use any statements that can be nested.

", + "smithy.api#documentation": "

The statements to combine with OR logic. You can use any statements that can be\n nested.

", "smithy.api#required": {} } } @@ -5131,6 +5560,15 @@ ] } }, + "com.amazonaws.wafv2#PublishedVersions": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#VersionKeyString" + }, + "value": { + "target": "com.amazonaws.wafv2#ManagedRuleSetVersion" + } + }, "com.amazonaws.wafv2#PutLoggingConfiguration": { "type": "operation", "input": { @@ -5163,7 +5601,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

\n

You can access information about all traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create an Amazon Kinesis Data\n Firehose.

    \n

    Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    \n

    Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics.

    \n \n

    Do not create the data firehose using a Kinesis stream as your source.

    \n     \n
    2. \n
  2. \n

    Associate that firehose to your web ACL using a PutLoggingConfiguration request.

    \n
    3. \n
\n \n

When you successfully enable logging using a PutLoggingConfiguration request, WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the WAF Developer Guide.

\n \n

This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.

\n " + "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.

\n

You can access information about all traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create an Amazon Kinesis Data Firehose.

    \n

    Create the data firehose with a PUT source and in the Region that you are\n operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US\n East (N. Virginia).

    \n

    Give the data firehose a name that starts with the prefix\n aws-waf-logs-. For example,\n aws-waf-logs-us-east-2-analytics.

    \n \n

    Do not create the data firehose using a Kinesis stream as your\n source.

    \n     \n
    2. \n
  2. \n

    Associate that firehose to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF will create a service linked role with the necessary permissions to write\n logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL\n Traffic Information in the WAF Developer\n Guide.

\n \n

This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.

\n " } }, "com.amazonaws.wafv2#PutLoggingConfigurationRequest": { @@ -5189,6 +5627,91 @@ } } }, + "com.amazonaws.wafv2#PutManagedRuleSetVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#PutManagedRuleSetVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Defines the versions of your managed rule set that you are offering to the customers.\n Customers see your offerings as managed rule groups with versioning.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n \n

Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your\n managed rule set is the name the customer sees for the corresponding managed rule group.\n Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group\n specification for each version. For each managed rule set, you must specify a version that\n you recommend using.

\n

To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.

" + } + }, + "com.amazonaws.wafv2#PutManagedRuleSetVersionsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "RecommendedVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version of the named managed rule group that you'd like your customers to choose,\n from among your version offerings.

" + } + }, + "VersionsToPublish": { + "target": "com.amazonaws.wafv2#VersionsToPublish", + "traits": { + "smithy.api#documentation": "

The versions of the named managed rule group that you want to offer to your customers.\n

" + } + } + } + }, + "com.amazonaws.wafv2#PutManagedRuleSetVersionsResponse": { + "type": "structure", + "members": { + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + } + } + } + }, "com.amazonaws.wafv2#PutPermissionPolicy": { "type": "operation", "input": { @@ -5212,7 +5735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

\n

You must be the owner of the rule group to perform this operation.

\n

This action is subject to the following restrictions:

\n
    \n
  • \n

    You can attach only one policy with each PutPermissionPolicy request.

    \n
    • \n
  • \n

    The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.

    \n
    • \n
  • \n

    The user making the request must be the owner of the rule group.

    \n
    • \n
" + "smithy.api#documentation": "

Attaches an IAM policy to the specified resource. Use this to share a rule group across\n accounts.

\n

You must be the owner of the rule group to perform this operation.

\n

This action is subject to the following restrictions:

\n
    \n
  • \n

    You can attach only one policy with each PutPermissionPolicy\n request.

    \n
    • \n
  • \n

    The ARN in the request must be a valid WAF RuleGroup ARN and the\n rule group must exist in the same Region.

    \n
    • \n
  • \n

    The user making the request must be the owner of the rule group.

    \n
    • \n
" } }, "com.amazonaws.wafv2#PutPermissionPolicyRequest": { @@ -5221,14 +5744,14 @@ "ResourceArn": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RuleGroup to which you want to\n attach the policy.

", "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.wafv2#PolicyString", "traits": { - "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n \n

The policy specifications must conform to the following:

\n
    \n
  • \n

    The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.

    \n
    • \n
  • \n

    The policy must include specifications for Effect, Action, and Principal.

    \n
    • \n
  • \n

    \n Effect must specify Allow.

    \n
    • \n
  • \n

    \n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. WAF rejects any extra actions or wildcard actions in the policy.

    \n
    • \n
  • \n

    The policy must not include a Resource parameter.

    \n
    • \n
\n

For more information, see IAM Policies.

", + "smithy.api#documentation": "

The policy to attach to the specified rule group.

\n \n

The policy specifications must conform to the following:

\n
    \n
  • \n

    The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.

    \n
    • \n
  • \n

    The policy must include specifications for Effect, Action, and Principal.

    \n
    • \n
  • \n

    \n Effect must specify Allow.

    \n
    • \n
  • \n

    \n Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. WAF rejects any extra actions or wildcard actions in the policy.

    \n
    • \n
  • \n

    The policy must not include a Resource parameter.

    \n
    • \n
\n

For more information, see IAM Policies.

", "smithy.api#required": {} } } @@ -5242,7 +5765,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

The query string of a web request. This is the part of a URL that appears after a\n ? character, if any.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#RateBasedStatement": { @@ -5251,27 +5774,27 @@ "Limit": { "target": "com.amazonaws.wafv2#RateLimit", "traits": { - "smithy.api#documentation": "

The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

", + "smithy.api#documentation": "

The limit on requests per 5-minute period for a single originating IP address. If the\n statement includes a ScopeDownStatement, this limit is applied only to the\n requests that match the statement.

", "smithy.api#required": {} } }, "AggregateKeyType": { "target": "com.amazonaws.wafv2#RateBasedStatementAggregateKeyType", "traits": { - "smithy.api#documentation": "

Setting that indicates how to aggregate the request counts. The options are the following:

\n
    \n
  • \n

    IP - Aggregate the request counts on the IP address from the web request origin.

    \n
    • \n
  • \n

    FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

    \n
    • \n
", + "smithy.api#documentation": "

Setting that indicates how to aggregate the request counts. The options are the\n following:

\n
    \n
  • \n

    IP - Aggregate the request counts on the IP address from the web request\n origin.

    \n
    • \n
  • \n

    FORWARDED_IP - Aggregate the request counts on the first IP address in an\n HTTP header. If you use this, configure the ForwardedIPConfig, to\n specify the header to use.

    \n
    • \n
", "smithy.api#required": {} } }, "ScopeDownStatement": { "target": "com.amazonaws.wafv2#Statement", "traits": { - "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

" + "smithy.api#documentation": "

An optional nested statement that narrows the scope of the web requests that are\n evaluated by the rate-based statement. Requests are only tracked by the rate-based\n statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any\n level, the same as you can for a rule statement.

" } }, "ForwardedIPConfig": { "target": "com.amazonaws.wafv2#ForwardedIPConfig", "traits": { - "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This is required if AggregateKeyType is set to FORWARDED_IP.

" + "smithy.api#documentation": "

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

\n \n \n

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

\n \n \n \n

This is required if AggregateKeyType is set to\n FORWARDED_IP.

" } } }, @@ -5298,7 +5821,10 @@ "type": "structure", "members": { "IPAddressVersion": { - "target": "com.amazonaws.wafv2#IPAddressVersion" + "target": "com.amazonaws.wafv2#IPAddressVersion", + "traits": { + "smithy.api#documentation": "

The version of the IP addresses, either IPV4 or IPV6.

" + } }, "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", @@ -5381,7 +5907,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains one or more regular expressions.

\n

WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

" + "smithy.api#documentation": "

Contains one or more regular expressions.

\n

WAF assigns an ARN to each RegexPatternSet that you create. To use a\n set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.

" } }, "com.amazonaws.wafv2#RegexPatternSetReferenceStatement": { @@ -5390,7 +5916,7 @@ "ARN": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the RegexPatternSet that this\n statement references.

", "smithy.api#required": {} } }, @@ -5443,7 +5969,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } }, "ARN": { @@ -5553,14 +6079,14 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the rule. You can't change the name of a Rule after you create it.

", + "smithy.api#documentation": "

The name of the rule. You can't change the name of a Rule after you create\n it.

", "smithy.api#required": {} } }, "Priority": { "target": "com.amazonaws.wafv2#RulePriority", "traits": { - "smithy.api#documentation": "

If you define more than one Rule in a\n WebACL, WAF evaluates each request against the Rules\n in order based on the value of Priority. \n WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

", + "smithy.api#documentation": "

If you define more than one Rule in a WebACL, WAF\n evaluates each request against the Rules in order based on the value of\n Priority. WAF processes rules with lower priority first. The priorities\n don't need to be consecutive, but they must all be different.

", "smithy.api#required": {} } }, @@ -5586,7 +6112,7 @@ "RuleLabels": { "target": "com.amazonaws.wafv2#Labels", "traits": { - "smithy.api#documentation": "

Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement.

\n

For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:

\n
    \n
  • \n

    Separate each component of the label with a colon.

    \n
    • \n
  • \n

    Each namespace or name can have up to 128 characters.

    \n
    • \n
  • \n

    You can specify up to 5 namespaces in a label.

    \n
    • \n
  • \n

    Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset.

    \n
    • \n
\n

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.

" + "smithy.api#documentation": "

Labels to apply to web requests that match the rule match statement. WAF applies\n fully qualified labels to matching web requests. A fully qualified label is the\n concatenation of a label namespace and a rule label. The rule's rule group or web ACL\n defines the label namespace.

\n

Rules that run after this rule in the web ACL can match against these labels using a\n LabelMatchStatement.

\n

For each label, provide a case-sensitive string containing optional namespaces and a\n label name, according to the following guidelines:

\n
    \n
  • \n

    Separate each component of the label with a colon.

    \n
    • \n
  • \n

    Each namespace or name can have up to 128 characters.

    \n
    • \n
  • \n

    You can specify up to 5 namespaces in a label.

    \n
    • \n
  • \n

    Don't use the following reserved words in your label specification:\n aws, waf, managed, rulegroup,\n webacl, regexpatternset, or ipset.

    \n
    • \n
\n

For example, myLabelName or nameSpace1:nameSpace2:myLabelName.\n

" } }, "VisibilityConfig": { @@ -5598,7 +6124,7 @@ } }, "traits": { - "smithy.api#documentation": "

A single rule, which you can use in a WebACL or RuleGroup to identify \n web requests that you want to allow, block, or count. \n Each rule includes one top-level Statement that WAF uses to identify matching \n web requests, and parameters that govern how WAF handles them.

" + "smithy.api#documentation": "

A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count.\n Each rule includes one top-level Statement that WAF uses to\n identify matching web requests, and parameters that govern how WAF handles them.

" } }, "com.amazonaws.wafv2#RuleAction": { @@ -5624,7 +6150,7 @@ } }, "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

" + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's\n statement. Settings at the web ACL level can override the rule action setting.

" } }, "com.amazonaws.wafv2#RuleGroup": { @@ -5719,7 +6245,7 @@ "ExcludedRules": { "target": "com.amazonaws.wafv2#ExcludedRules", "traits": { - "smithy.api#documentation": "

The names of rules that are in the referenced rule group, but that you want WAF to exclude from processing for this rule statement.

" + "smithy.api#documentation": "

The names of rules that are in the referenced rule group, but that you want WAF to\n exclude from processing for this rule statement.

" } } }, @@ -5757,7 +6283,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } }, "ARN": { @@ -5797,7 +6323,7 @@ "Action": { "target": "com.amazonaws.wafv2#RuleAction", "traits": { - "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

" + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches a rule's\n statement. Settings at the web ACL level can override the rule action setting.

" } } }, @@ -5832,32 +6358,32 @@ "Weight": { "target": "com.amazonaws.wafv2#SampleWeight", "traits": { - "smithy.api#documentation": "

A value that indicates how one result in the response relates \n proportionally to other results in the response. \n For example, a result that has a weight of 2 represents roughly twice \n as many web requests as a result \n that has a weight of 1.

", + "smithy.api#documentation": "

A value that indicates how one result in the response relates proportionally to other\n results in the response. For example, a result that has a weight of 2\n represents roughly twice as many web requests as a result that has a weight of\n 1.

", "smithy.api#required": {} } }, "Timestamp": { "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).

" + "smithy.api#documentation": "

The time at which WAF received the request from your Amazon Web Services resource, in Unix time\n format (in seconds).

" } }, "Action": { "target": "com.amazonaws.wafv2#Action", "traits": { - "smithy.api#documentation": "

The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

" + "smithy.api#documentation": "

The action for the Rule that the request matched: ALLOW,\n BLOCK, or COUNT.

" } }, "RuleNameWithinRuleGroup": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the Rule that the request matched. For managed rule groups, the format for this name is ##. For your own rule\n groups, the format for this name is #. If the rule is not in a rule group, this field is absent.

" + "smithy.api#documentation": "

The name of the Rule that the request matched. For managed rule groups, the\n format for this name is ##. For your own rule groups, the format for this name is #. If the rule is not in a rule group, this field\n is absent.

" } }, "RequestHeadersInserted": { "target": "com.amazonaws.wafv2#HTTPHeaders", "traits": { - "smithy.api#documentation": "

Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.

" + "smithy.api#documentation": "

Custom request headers inserted by WAF into the request, according to the custom\n request configuration for the matching rule action.

" } }, "ResponseCodeSent": { @@ -5869,12 +6395,12 @@ "Labels": { "target": "com.amazonaws.wafv2#Labels", "traits": { - "smithy.api#documentation": "

Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" + "smithy.api#documentation": "

Labels applied to the web request by matching rules. WAF applies fully qualified\n labels to matching web requests. A fully qualified label is the concatenation of a label\n namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

For example,\n awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or\n awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" } } }, "traits": { - "smithy.api#documentation": "

Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that \n appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects.

" + "smithy.api#documentation": "

Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type\n that appears as SampledRequests in the response syntax.\n SampledHTTPRequests contains an array of SampledHTTPRequest\n objects.

" } }, "com.amazonaws.wafv2#SampledHTTPRequests": { @@ -5913,7 +6439,7 @@ } }, "traits": { - "smithy.api#documentation": "

One of the headers in a web request, identified by name, for example, User-Agent or Referer. This setting isn't case sensitive.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" + "smithy.api#documentation": "

One of the headers in a web request, identified by name, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#SingleQueryArgument": { @@ -5928,7 +6454,7 @@ } }, "traits": { - "smithy.api#documentation": "

One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

" + "smithy.api#documentation": "

One query argument in a web request, identified by name, for example\n UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.

" } }, "com.amazonaws.wafv2#Size": { @@ -6087,7 +6613,7 @@ } }, "traits": { - "smithy.api#documentation": "

The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.

" + "smithy.api#documentation": "

The processing guidance for a Rule, used by WAF to determine\n whether a web request matches the rule.

" } }, "com.amazonaws.wafv2#Statements": { @@ -6102,20 +6628,20 @@ "Key": { "target": "com.amazonaws.wafv2#TagKey", "traits": { - "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.

", + "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag key to describe a\n category of information, such as \"customer.\" Tag keys are case-sensitive.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.wafv2#TagValue", "traits": { - "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.

", + "smithy.api#documentation": "

Part of the key:value pair that defines a tag. You can use a tag value to describe a\n specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are\n case-sensitive.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a \n specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the WAF console.

" + "smithy.api#documentation": "

A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to\n categorize and manage your resources, for purposes like billing or other management.\n Typically, the tag key represents a category, such as \"environment\", and the tag value\n represents a specific value within that category, such as \"test,\" \"development,\" or\n \"production\". Or you might set the tag key to \"customer\" and the value to the customer name\n or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" } }, "com.amazonaws.wafv2#TagInfoForResource": { @@ -6135,7 +6661,7 @@ } }, "traits": { - "smithy.api#documentation": "

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a \n specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the WAF console.

" + "smithy.api#documentation": "

The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs\n that you can use to categorize and manage your resources, for purposes like billing or\n other management. Typically, the tag key represents a category, such as \"environment\", and\n the tag value represents a specific value within that category, such as \"test,\"\n \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to\n the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up\n to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" } }, "com.amazonaws.wafv2#TagKey": { @@ -6202,7 +6728,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP \n sets, and regex pattern sets. You can't manage or view tags through the WAF console.

" + "smithy.api#documentation": "

Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can\n use to categorize and manage your resources, for purposes like billing. For example, you\n might set the tag key to \"customer\" and the value to the customer name or ID. You can\n specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a\n resource.

\n

You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule\n groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF\n console.

" } }, "com.amazonaws.wafv2#TagResourceRequest": { @@ -6244,20 +6770,20 @@ "Priority": { "target": "com.amazonaws.wafv2#TextTransformationPriority", "traits": { - "smithy.api#documentation": "

Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all\n transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.

", + "smithy.api#documentation": "

Sets the relative processing order for multiple transformations that are defined for a\n rule statement. WAF processes all transformations, from lowest priority to highest,\n before inspecting the transformed content. The priorities don't need to be consecutive, but\n they must all be different.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.wafv2#TextTransformationType", "traits": { - "smithy.api#documentation": "

You can specify the following transformation types:

\n

\n BASE64_DECODE - Decode a Base64-encoded\n string.

\n

\n BASE64_DECODE_EXT - Decode a\n Base64-encoded string, but use a forgiving implementation that ignores\n characters that aren't valid.

\n

\n CMD_LINE - Command-line transformations. These are\n helpful in reducing effectiveness of attackers who inject an operating system command-line\n command and use unusual formatting to disguise some or all of the command.

\n
    \n
  • \n

    Delete the following characters: \\ \" ' ^\n

    \n
    • \n
  • \n

    Delete spaces before the following characters: / (\n

    \n
    • \n
  • \n

    Replace the following characters with a space: , ;\n

    \n
    • \n
  • \n

    Replace multiple spaces with one space

    \n
    • \n
  • \n

    Convert uppercase letters (A-Z) to lowercase (a-z)

    \n
    • \n
\n \n

\n COMPRESS_WHITE_SPACE - Replace these characters\n with a space character (decimal 32):

\n
    \n
  • \n

    \n \\f, formfeed, decimal 12

    \n
    • \n
  • \n

    \n \\t, tab, decimal 9

    \n
    • \n
  • \n

    \n \\n, newline, decimal 10

    \n
    • \n
  • \n

    \n \\r, carriage return, decimal 13

    \n
    • \n
  • \n

    \n \\v, vertical tab, decimal 11

    \n
    • \n
  • \n

    Non-breaking space, decimal 160

    \n
    • \n
\n

\n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

\t\t\n

\n CSS_DECODE - Decode characters that were encoded\n using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in\n the decoding process, so it can help to uncover ASCII characters that were encoded using\n CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion,\n which is a combination of a backslash and non-hexadecimal characters. For example,\n ja\\vascript for javascript.

\n

\n ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences:\n \\a, \\b, \\f, \\n, \\r, \\t, \\v, \\\\, \\?, \\', \\\", \\xHH (hexadecimal), \\0OOO (octal). Encodings\n that aren't valid remain in the output.

\n

\n HEX_DECODE - Decode a string of hexadecimal characters into a binary.

\n

\n HTML_ENTITY_DECODE - Replace HTML-encoded\n characters with unencoded characters. HTML_ENTITY_DECODE performs these\n operations:

\n
    \n
  • \n

    Replaces (ampersand)quot; with \"\n

    \n
    • \n
  • \n

    Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    \n
    • \n
  • \n

    Replaces (ampersand)lt; with a \"less than\" symbol

    \n
    • \n
  • \n

    Replaces (ampersand)gt; with >\n

    \n
    • \n
  • \n

    Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    \n
    • \n
  • \n

    Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n characters

    \n
    • \n
\t\t\n

\n JS_DECODE - Decode JavaScript escape sequences. If\n a \\\n u\n HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is\n used to detect and adjust the lower byte. If not, only the lower byte is used and the\n higher byte is zeroed, causing a possible loss of information.

\n

\n LOWERCASE - Convert uppercase letters (A-Z) to\n lowercase (a-z).

\n

\n MD5 - Calculate an MD5 hash from the data in the\n input. The computed hash is in a raw binary form.

\n

\n NONE - Specify NONE if you don't want any text transformations.\n

\n

\n NORMALIZE_PATH - Remove multiple slashes, directory\n self-references, and directory back-references that are not at the beginning of the input\n from an input string.

\n

\n NORMALIZE_PATH_WIN - This is the same as\n NORMALIZE_PATH, but first converts backslash characters to forward slashes.

\n

\n REMOVE_NULLS - Remove all NULL bytes\n from the input.

\n

\n REPLACE_COMMENTS - Replace each occurrence of a\n C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not\n compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a\n standalone termination of a comment (*/) is not acted upon.

\n

\n REPLACE_NULLS - Replace NULL bytes in the input\n with space characters (ASCII 0x20).

\n

\n SQL_HEX_DECODE - Decode the following ANSI C escape sequences:\n \\a, \\b, \\f, \\n, \\r, \\t, \\v, \\\\, \\?, \\', \\\", \\xHH (hexadecimal), \\0OOO (octal). Encodings\n that aren't valid remain in the output.

\n

\n URL_DECODE - Decode a URL-encoded value.

\n

\n URL_DECODE_UNI - Like URL_DECODE, but with support\n for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of\n FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the\n lower byte is used and the higher byte is zeroed.

\n

\n UTF8_TO_UNICODE - Convert all UTF-8 character\n sequences to Unicode. This helps input normalization, and minimizing false-positives and\n false-negatives for non-English languages.

", + "smithy.api#documentation": "

You can specify the following transformation types:

\n

\n BASE64_DECODE - Decode a Base64-encoded\n string.

\n

\n BASE64_DECODE_EXT - Decode a\n Base64-encoded string, but use a forgiving implementation that ignores\n characters that aren't valid.

\n

\n CMD_LINE - Command-line transformations. These are\n helpful in reducing effectiveness of attackers who inject an operating system command-line\n command and use unusual formatting to disguise some or all of the command.

\n
    \n
  • \n

    Delete the following characters: \\ \" ' ^\n

    \n
    • \n
  • \n

    Delete spaces before the following characters: / (\n

    \n
    • \n
  • \n

    Replace the following characters with a space: , ;\n

    \n
    • \n
  • \n

    Replace multiple spaces with one space

    \n
    • \n
  • \n

    Convert uppercase letters (A-Z) to lowercase (a-z)

    \n
    • \n
\n \n

\n COMPRESS_WHITE_SPACE - Replace these characters\n with a space character (decimal 32):

\n
    \n
  • \n

    \n \\f, formfeed, decimal 12

    \n
    • \n
  • \n

    \n \\t, tab, decimal 9

    \n
    • \n
  • \n

    \n \\n, newline, decimal 10

    \n
    • \n
  • \n

    \n \\r, carriage return, decimal 13

    \n
    • \n
  • \n

    \n \\v, vertical tab, decimal 11

    \n
    • \n
  • \n

    Non-breaking space, decimal 160

    \n
    • \n
\n

\n COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

\t\t\n

\n CSS_DECODE - Decode characters that were encoded\n using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in\n the decoding process, so it can help to uncover ASCII characters that were encoded using\n CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion,\n which is a combination of a backslash and non-hexadecimal characters. For example,\n ja\\vascript for javascript.

\n

\n ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences:\n \\a, \\b, \\f, \\n, \\r, \\t, \\v, \\\\, \\?, \\', \\\", \\xHH (hexadecimal), \\0OOO (octal). Encodings\n that aren't valid remain in the output.

\n

\n HEX_DECODE - Decode a string of hexadecimal characters into a binary.

\n

\n HTML_ENTITY_DECODE - Replace HTML-encoded\n characters with unencoded characters. HTML_ENTITY_DECODE performs these\n operations:

\n
    \n
  • \n

    Replaces (ampersand)quot; with \"\n

    \n
    • \n
  • \n

    Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    \n
    • \n
  • \n

    Replaces (ampersand)lt; with a \"less than\" symbol

    \n
    • \n
  • \n

    Replaces (ampersand)gt; with >\n

    \n
    • \n
  • \n

    Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    \n
    • \n
  • \n

    Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding \n characters

    \n
    • \n
\t\t\n

\n JS_DECODE - Decode JavaScript escape sequences. If\n a \\\n u\n HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is\n used to detect and adjust the lower byte. If not, only the lower byte is used and the\n higher byte is zeroed, causing a possible loss of information.

\n

\n LOWERCASE - Convert uppercase letters (A-Z) to\n lowercase (a-z).

\n

\n MD5 - Calculate an MD5 hash from the data in the\n input. The computed hash is in a raw binary form.

\n

\n NONE - Specify NONE if you don't want any text transformations.\n

\n

\n NORMALIZE_PATH - Remove multiple slashes, directory\n self-references, and directory back-references that are not at the beginning of the input\n from an input string.

\n

\n NORMALIZE_PATH_WIN - This is the same as\n NORMALIZE_PATH, but first converts backslash characters to forward slashes.

\n

\n REMOVE_NULLS - Remove all NULL bytes\n from the input.

\n

\n REPLACE_COMMENTS - Replace each occurrence of a\n C-style comment (/* ... */) with a single space. Multiple consecutive occurrences are not\n compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a\n standalone termination of a comment (*/) is not acted upon.

\n

\n REPLACE_NULLS - Replace NULL bytes in the input\n with space characters (ASCII 0x20).

\n

\n SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC).

\n

\n URL_DECODE - Decode a URL-encoded value.

\n

\n URL_DECODE_UNI - Like URL_DECODE, but with support\n for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of\n FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the\n lower byte is used and the higher byte is zeroed.

\n

\n UTF8_TO_UNICODE - Convert all UTF-8 character\n sequences to Unicode. This helps input normalization, and minimizing false-positives and\n false-negatives for non-English languages.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. \n

" + "smithy.api#documentation": "

Text transformations eliminate some of the unusual formatting that attackers use in web\n requests in an effort to bypass detection.

" } }, "com.amazonaws.wafv2#TextTransformationPriority": { @@ -6376,20 +6902,29 @@ "StartTime": { "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your \n Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

", + "smithy.api#documentation": "

The beginning of the time range from which you want GetSampledRequests to\n return a sample of the requests that your Amazon Web Services resource received. You must specify the\n times in Coordinated Universal Time (UTC) format. UTC format includes the special\n designator, Z. For example, \"2016-09-27T14:50Z\". You can specify\n any time range in the previous three hours.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.wafv2#Timestamp", "traits": { - "smithy.api#documentation": "

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your \n Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

", + "smithy.api#documentation": "

The end of the time range from which you want GetSampledRequests to return\n a sample of the requests that your Amazon Web Services resource received. You must specify the times in\n Coordinated Universal Time (UTC) format. UTC format includes the special designator,\n Z. For example, \"2016-09-27T14:50Z\". You can specify any time\n range in the previous three hours.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range \n for which you want WAF to return a sample of web requests.

\n

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

\n

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range \n for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first \n 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 \n requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime \n is the time that WAF received the 5,000th request.

" + "smithy.api#documentation": "

In a GetSampledRequests request, the StartTime and\n EndTime objects specify the time range for which you want WAF to\n return a sample of web requests.

\n

You must specify the times in Coordinated Universal Time (UTC) format. UTC format\n includes the special designator, Z. For example,\n \"2016-09-27T14:50Z\". You can specify any time range in the previous three\n hours.

\n

In a GetSampledRequests response, the StartTime and\n EndTime objects specify the time range for which WAF actually returned a\n sample of web requests. WAF gets the specified number of requests from among the first\n 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your\n resource receives more than 5,000 requests during that period, WAF stops sampling after\n the 5,000th request. In that case, EndTime is the time that WAF received the\n 5,000th request.

" + } + }, + "com.amazonaws.wafv2#TimeWindowDay": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } } }, "com.amazonaws.wafv2#Timestamp": { @@ -6427,7 +6962,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

" + "smithy.api#documentation": "

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can\n associate with Amazon Web Services resources. For example, the tag key might be \"customer\" and the tag\n value might be \"companyA.\" You can specify one or more tags to add to each container. You\n can add up to 50 tags to each Amazon Web Services resource.

" } }, "com.amazonaws.wafv2#UntagResourceRequest": { @@ -6521,14 +7056,14 @@ "Addresses": { "target": "com.amazonaws.wafv2#IPAddresses", "traits": { - "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless\n Inter-Domain Routing.

", + "smithy.api#documentation": "

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

\n

Examples:

\n
    \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify \n 192.0.2.0/24.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    \n
    • \n
  • \n

    To configure WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    \n
    • \n
\n

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

", "smithy.api#required": {} } }, "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -6540,7 +7075,106 @@ "NextLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + } + } + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDate": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.wafv2#WAFInternalErrorException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidOperationException" + }, + { + "target": "com.amazonaws.wafv2#WAFInvalidParameterException" + }, + { + "target": "com.amazonaws.wafv2#WAFNonexistentItemException" + }, + { + "target": "com.amazonaws.wafv2#WAFOptimisticLockException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the expiration information for your managed rule set. Use this to initiate the\n expiration of a managed rule group version. After you initiate expiration for a version,\n WAF excludes it from the reponse to ListAvailableManagedRuleGroupVersions for the managed rule group.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.wafv2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

\n

This name is assigned to the corresponding managed rule group, which your customers can access and use.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.wafv2#Scope", + "traits": { + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n
    \n
  • \n

    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

    \n
    • \n
  • \n

    API and SDKs - For all calls, use the Region endpoint us-east-1.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.wafv2#EntityId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

", + "smithy.api#required": {} + } + }, + "LockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#required": {} + } + }, + "VersionToExpire": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that you want to remove from your list of offerings for the named managed\n rule group.

", + "smithy.api#required": {} + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that you want the version to expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.wafv2#UpdateManagedRuleSetVersionExpiryDateResponse": { + "type": "structure", + "members": { + "ExpiringVersion": { + "target": "com.amazonaws.wafv2#VersionKeyString", + "traits": { + "smithy.api#documentation": "

The version that is set to expire.

" + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.wafv2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the version will expire.

\n

Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\".

" + } + }, + "NextLockToken": { + "target": "com.amazonaws.wafv2#LockToken", + "traits": { + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } } } @@ -6620,7 +7254,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } } @@ -6632,7 +7266,7 @@ "NextLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" } } } @@ -6724,7 +7358,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } }, @@ -6742,7 +7376,7 @@ "NextLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" } } } @@ -6759,6 +7393,9 @@ { "target": "com.amazonaws.wafv2#WAFDuplicateItemException" }, + { + "target": "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException" + }, { "target": "com.amazonaws.wafv2#WAFInternalErrorException" }, @@ -6844,7 +7481,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

", "smithy.api#required": {} } }, @@ -6862,7 +7499,7 @@ "NextLockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

" } } } @@ -6884,27 +7521,66 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.wafv2#VersionKeyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w#:\\.\\-/]+$" + } + }, + "com.amazonaws.wafv2#VersionToPublish": { + "type": "structure", + "members": { + "AssociatedRuleGroupArn": { + "target": "com.amazonaws.wafv2#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published\n managed rule group version.

" + } + }, + "ForecastedLifetime": { + "target": "com.amazonaws.wafv2#TimeWindowDay", + "traits": { + "smithy.api#documentation": "

The amount of time the vendor expects this version of the managed rule group to last, in\n days.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of the named managed rule group, that the rule group's vendor publishes for\n use by customers.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " + } + }, + "com.amazonaws.wafv2#VersionsToPublish": { + "type": "map", + "key": { + "target": "com.amazonaws.wafv2#VersionKeyString" + }, + "value": { + "target": "com.amazonaws.wafv2#VersionToPublish" + } + }, "com.amazonaws.wafv2#VisibilityConfig": { "type": "structure", "members": { "SampledRequestsEnabled": { "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

A boolean indicating whether WAF should store a sampling of the web \n requests that match the rules. You can view the sampled requests through the \n WAF console.

", + "smithy.api#documentation": "

A boolean indicating whether WAF should store a sampling of the web requests that\n match the rules. You can view the sampled requests through the WAF console.

", "smithy.api#required": {} } }, "CloudWatchMetricsEnabled": { "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.

", + "smithy.api#documentation": "

A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the\n list of available metrics, see WAF\n Metrics.

", "smithy.api#required": {} } }, "MetricName": { "target": "com.amazonaws.wafv2#MetricName", "traits": { - "smithy.api#documentation": "

A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain\n whitespace or metric names reserved for WAF, for example \"All\" and \"Default_Action.\"

", + "smithy.api#documentation": "

A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9,\n - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't\n contain whitespace or metric names reserved for WAF, for example \"All\" and\n \"Default_Action.\"

", "smithy.api#required": {} } } @@ -6921,7 +7597,7 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource is being used by another\n resource or it’s associated with another resource.

", "smithy.api#error": "client" } }, @@ -6933,7 +7609,19 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you tried to save is\n a duplicate of an existing one.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFExpiredManagedRuleGroupVersionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because the specified version for the managed rule group has\n expired. You can retrieve the available versions for the managed rule group by calling\n ListAvailableManagedRuleGroupVersions.

", "smithy.api#error": "client" } }, @@ -6945,7 +7633,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

", + "smithy.api#documentation": "

Your request is valid, but WAF couldn’t perform the operation because of a system\n problem. Retry your request.

", "smithy.api#error": "server" } }, @@ -6968,17 +7656,26 @@ "target": "com.amazonaws.wafv2#ErrorMessage" }, "Field": { - "target": "com.amazonaws.wafv2#ParameterExceptionField" + "target": "com.amazonaws.wafv2#ParameterExceptionField", + "traits": { + "smithy.api#documentation": "

The settings where the invalid parameter was found.

" + } }, "Parameter": { - "target": "com.amazonaws.wafv2#ParameterExceptionParameter" + "target": "com.amazonaws.wafv2#ParameterExceptionParameter", + "traits": { + "smithy.api#documentation": "

The invalid parameter that resulted in the exception.

" + } }, "Reason": { - "target": "com.amazonaws.wafv2#ErrorReason" + "target": "com.amazonaws.wafv2#ErrorReason", + "traits": { + "smithy.api#documentation": "

Additional information about the exception.

" + } } }, "traits": { - "smithy.api#documentation": "

The operation failed because WAF didn't recognize a parameter in the request. For example:

\n
    \n
  • \n

    You specified\n a\n parameter name or value that isn't valid.

    \n
    • \n
  • \n

    Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

    \n
    • \n
  • \n

    You tried to update a WebACL with a DefaultAction that isn't among the types\n available at DefaultAction.

    \n
    • \n
  • \n

    Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

    \n
    • \n
", + "smithy.api#documentation": "

The operation failed because WAF didn't recognize a parameter in the request. For\n example:

\n
    \n
  • \n

    You specified\n a\n parameter name or value that isn't valid.

    \n
    • \n
  • \n

    Your nested statement isn't valid. You might have tried to nest a statement that\n can’t be nested.

    \n
    • \n
  • \n

    You tried to update a WebACL with a DefaultAction that\n isn't among the types available at DefaultAction.

    \n
    • \n
  • \n

    Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

    \n
    • \n
", "smithy.api#error": "client" } }, @@ -7002,7 +7699,7 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because the resource that you requested isn’t\n valid. Check the resource, and try again.

", "smithy.api#error": "client" } }, @@ -7014,7 +7711,7 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create \n for an account. For more information, see \n Limits in the WAF Developer Guide.

", + "smithy.api#documentation": "

WAF couldn’t perform the operation because you exceeded your resource limit. For\n example, the maximum number of WebACL objects that you can create for an Amazon Web Services\n account. For more information, see WAF quotas in the\n WAF Developer Guide.

", "smithy.api#error": "client" } }, @@ -7038,7 +7735,7 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.

", + "smithy.api#documentation": "

WAF couldn’t save your changes because you tried to update or delete a resource\n that has changed since you last retrieved it. Get the resource again, make any changes you\n need to make to the new copy, and retry your operation.

", "smithy.api#error": "client" } }, @@ -7050,7 +7747,7 @@ } }, "traits": { - "smithy.api#documentation": "

WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

", + "smithy.api#documentation": "

WAF is not able to access the service linked role. This can be caused by a\n previous PutLoggingConfiguration request, which can lock the service linked\n role for about 20 seconds. Please try your request again. The service linked role can also\n be locked by a previous DeleteServiceLinkedRole request, which can lock the\n role for 15 minutes or more. If you recently made a call to\n DeleteServiceLinkedRole, wait at least 15 minutes and try the request\n again. If you receive this same exception again, you will have to wait additional time\n until the role is unlocked.

", "smithy.api#error": "client" } }, @@ -7062,7 +7759,7 @@ } }, "traits": { - "smithy.api#documentation": "

You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.

", + "smithy.api#documentation": "

You tried to use a managed rule group that's available by subscription, but you aren't\n subscribed to it yet.

", "smithy.api#error": "client" } }, @@ -7086,7 +7783,7 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

", + "smithy.api#documentation": "

WAF couldn’t perform your tagging operation because of an internal error. Retry\n your request.

", "smithy.api#error": "server" } }, @@ -7115,14 +7812,14 @@ "Id": { "target": "com.amazonaws.wafv2#EntityId", "traits": { - "smithy.api#documentation": "

A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

", + "smithy.api#documentation": "

A unique identifier for the WebACL. This ID is returned in the responses to\n create and list commands. You use this ID to do things like get, update, and delete a\n WebACL.

", "smithy.api#required": {} } }, "ARN": { "target": "com.amazonaws.wafv2#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL that you want to associate with the\n resource.

", "smithy.api#required": {} } }, @@ -7161,19 +7858,19 @@ "PreProcessFirewallManagerRuleGroups": { "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", "traits": { - "smithy.api#documentation": "

The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized after these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

" + "smithy.api#documentation": "

The first set of rules for WAF to process in the web ACL. This is defined in an\n Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any\n rules and rule groups that you define for the web ACL are prioritized after these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run\n first in the web ACL and a set of rule groups to run last. Within each set, the\n administrator prioritizes the rule groups, to determine their relative processing\n order.

" } }, "PostProcessFirewallManagerRuleGroups": { "target": "com.amazonaws.wafv2#FirewallManagerRuleGroups", "traits": { - "smithy.api#documentation": "

The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and \n contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are \n prioritized before these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL \n and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to\n determine their relative processing order.

" + "smithy.api#documentation": "

The last set of rules for WAF to process in the web ACL. This is defined in an\n Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any\n rules and rule groups that you define for the web ACL are prioritized before these.

\n

In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run\n first in the web ACL and a set of rule groups to run last. Within each set, the\n administrator prioritizes the rule groups, to determine their relative processing\n order.

" } }, "ManagedByFirewallManager": { "target": "com.amazonaws.wafv2#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

" + "smithy.api#documentation": "

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can\n delete the web ACL or any Firewall Manager rule groups in the web ACL.

" } }, "LabelNamespace": { @@ -7223,7 +7920,7 @@ "LockToken": { "target": "com.amazonaws.wafv2#LockToken", "traits": { - "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" + "smithy.api#documentation": "

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

" } }, "ARN": {