From 8d280d852895e628abd91e6a5bae11467eae5a70 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 5 Feb 2024 19:03:22 +0000 Subject: [PATCH 01/32] feat: update AWS API models --- codegen/sdk/aws-models/glue.json | 38 +++++++++++++++++++++++++- codegen/sdk/aws-models/workspaces.json | 2 +- 2 files changed, 38 insertions(+), 2 deletions(-) diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index 9b3c16db211..0867f7497da 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -4593,6 +4593,12 @@ "traits": { "smithy.api#enumValue": "SSE-KMS" } + }, + "SSEKMSWITHSERVICEROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSE-KMS-WITH-SERVICE-ROLE" + } } } }, @@ -6478,7 +6484,7 @@ "ConnectionProperties": { "target": "com.amazonaws.glue#ConnectionProperties", "traits": { - "smithy.api#documentation": "

These key-value pairs define parameters for the connection:

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

These key-value pairs define parameters for the connection:

\n " } }, "PhysicalConnectionRequirements": { @@ -6792,6 +6798,24 @@ "smithy.api#enumValue": "KAFKA_SASL_MECHANISM" } }, + "KAFKA_SASL_PLAIN_USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_PLAIN_USERNAME" + } + }, + "KAFKA_SASL_PLAIN_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KAFKA_SASL_PLAIN_PASSWORD" + } + }, + "ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD" + } + }, "KAFKA_SASL_SCRAM_USERNAME": { "target": "smithy.api#Unit", "traits": { @@ -13939,6 +13963,12 @@ "traits": { "smithy.api#documentation": "

The ID of the KMS key to use for encryption at rest.

" } + }, + "CatalogEncryptionServiceRole": { + "target": "com.amazonaws.glue#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The role that Glue assumes to encrypt and decrypt the Data Catalog objects on the caller's behalf.

" + } } }, "traits": { @@ -21029,6 +21059,12 @@ "target": "com.amazonaws.glue#HudiTarget" } }, + "com.amazonaws.glue#IAMRoleArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:iam::[0-9]{12}:role/.+$" + } + }, "com.amazonaws.glue#IcebergInput": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/workspaces.json b/codegen/sdk/aws-models/workspaces.json index 2aa51585578..ac276cc1149 100644 --- a/codegen/sdk/aws-models/workspaces.json +++ b/codegen/sdk/aws-models/workspaces.json @@ -7909,7 +7909,7 @@ "State": { "target": "com.amazonaws.workspaces#WorkspaceState", "traits": { - "smithy.api#documentation": "

The operational state of the WorkSpace.

\n \n

After a WorkSpace is terminated, the TERMINATED state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.

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

The operational state of the WorkSpace.

\n \n \n

After a WorkSpace is terminated, the TERMINATED state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.

\n " } }, "BundleId": { From 43dc0e22eafc198ac43022f1fe11cee3ad67a7c5 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 5 Feb 2024 19:04:45 +0000 Subject: [PATCH 02/32] chore: release 1.0.50 --- CHANGELOG.md | 8 ++++++++ gradle.properties | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d6b1373c59..675e86c41be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [1.0.50] - 02/05/2024 + +### Features +* (**glue**) Introduce Catalog Encryption Role within Glue Data Catalog Settings. Introduce SASL/PLAIN as an authentication method for Glue Kafka connections + +### Documentation +* (**workspaces**) Added definitions of various WorkSpace states + ## [1.0.49] - 02/02/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 578adfd582a..17d52fffcfd 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.50-SNAPSHOT +sdkVersion=1.0.50 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 39e34c82d435d551a3eed600bf367b1f0ac176ee Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 5 Feb 2024 19:04:46 +0000 Subject: [PATCH 03/32] chore: bump snapshot version to 1.0.51-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 17d52fffcfd..84b1660796d 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.50 +sdkVersion=1.0.51-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 39dbaa2a416ae4295b830092e245137f330d7f85 Mon Sep 17 00:00:00 2001 From: Ian Botsford <83236726+ianbotsf@users.noreply.github.com> Date: Mon, 5 Feb 2024 13:24:17 -0800 Subject: [PATCH 04/32] misc: add Maven Local as build-support repo to enable locally testing changes to Smithy protocol tests (#1201) --- build-support/build.gradle.kts | 1 + 1 file changed, 1 insertion(+) diff --git a/build-support/build.gradle.kts b/build-support/build.gradle.kts index ac9849affcd..a7d77f53acc 100644 --- a/build-support/build.gradle.kts +++ b/build-support/build.gradle.kts @@ -12,6 +12,7 @@ plugins { group = "aws.sdk.kotlin" repositories { + mavenLocal() mavenCentral() } From 982761ce44fae416fb26a93dfd206dacfc5a1661 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 6 Feb 2024 19:08:11 +0000 Subject: [PATCH 05/32] feat: update AWS API models --- codegen/sdk/aws-models/appsync.json | 178 +++++++++ codegen/sdk/aws-models/cloudwatch-logs.json | 16 +- codegen/sdk/aws-models/ecs.json | 16 +- .../sdk/aws-models/elasticsearch-service.json | 357 ++++++++++++++++++ codegen/sdk/aws-models/opensearch.json | 356 ++++++++++++++++- codegen/sdk/aws-models/wafv2.json | 91 ++++- 6 files changed, 985 insertions(+), 29 deletions(-) diff --git a/codegen/sdk/aws-models/appsync.json b/codegen/sdk/aws-models/appsync.json index bba309c2b2f..59b231d88ba 100644 --- a/codegen/sdk/aws-models/appsync.json +++ b/codegen/sdk/aws-models/appsync.json @@ -129,6 +129,9 @@ { "target": "com.amazonaws.appsync#GetGraphqlApi" }, + { + "target": "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariables" + }, { "target": "com.amazonaws.appsync#GetIntrospectionSchema" }, @@ -177,6 +180,9 @@ { "target": "com.amazonaws.appsync#ListTypesByAssociation" }, + { + "target": "com.amazonaws.appsync#PutGraphqlApiEnvironmentVariables" + }, { "target": "com.amazonaws.appsync#StartDataSourceIntrospection" }, @@ -4226,6 +4232,40 @@ "smithy.api#documentation": "

Describes an OpenSearch data source configuration.

\n

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.

" } }, + "com.amazonaws.appsync#EnvironmentVariableKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z]+\\w*$" + } + }, + "com.amazonaws.appsync#EnvironmentVariableMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appsync#EnvironmentVariableKey" + }, + "value": { + "target": "com.amazonaws.appsync#EnvironmentVariableValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.appsync#EnvironmentVariableValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, "com.amazonaws.appsync#ErrorDetail": { "type": "structure", "members": { @@ -5081,6 +5121,70 @@ } } }, + "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariables": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesRequest" + }, + "output": { + "target": "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

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

The ID of the API from which the environmental variable list will be retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#GetGraphqlApiEnvironmentVariablesResponse": { + "type": "structure", + "members": { + "environmentVariables": { + "target": "com.amazonaws.appsync#EnvironmentVariableMap", + "traits": { + "smithy.api#documentation": "

The payload containing each environmental variable in the \"key\" : \"value\" format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appsync#GetGraphqlApiRequest": { "type": "structure", "members": { @@ -6944,6 +7048,80 @@ "smithy.api#documentation": "

The pipeline configuration for a resolver of kind PIPELINE.

" } }, + "com.amazonaws.appsync#PutGraphqlApiEnvironmentVariables": { + "type": "operation", + "input": { + "target": "com.amazonaws.appsync#PutGraphqlApiEnvironmentVariablesRequest" + }, + "output": { + "target": "com.amazonaws.appsync#PutGraphqlApiEnvironmentVariablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appsync#AccessDeniedException" + }, + { + "target": "com.amazonaws.appsync#BadRequestException" + }, + { + "target": "com.amazonaws.appsync#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appsync#InternalFailureException" + }, + { + "target": "com.amazonaws.appsync#NotFoundException" + }, + { + "target": "com.amazonaws.appsync#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a list of environmental variables in an API by its ID value.

\n

When creating an environmental variable, it must follow the constraints below:

\n
    \n
  • \n

    Both JavaScript and VTL templates support environmental variables.

    \n
    • \n
  • \n

    Environmental variables are not evaluated before function invocation.

    \n
    • \n
  • \n

    Environmental variables only support string values.

    \n
    • \n
  • \n

    Any defined value in an environmental variable is considered a string literal and not\n expanded.

    \n
    • \n
  • \n

    Variable evaluations should ideally be performed in the function code.

    \n
    • \n
\n

When creating an environmental variable key-value pair, it must follow the additional constraints\n below:

\n
    \n
  • \n

    Keys must begin with a letter.

    \n
    • \n
  • \n

    Keys must be at least two characters long.

    \n
    • \n
  • \n

    Keys can only contain letters, numbers, and the underscore character (_).

    \n
    • \n
  • \n

    Values can be up to 512 characters long.

    \n
    • \n
  • \n

    You can configure up to 50 key-value pairs in a GraphQL API.

    \n
    • \n
\n

You can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.

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

The ID of the API to which the environmental variable list will be written.

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

The list of environmental variables to add to the API.

\n

When creating an environmental variable key-value pair, it must follow the additional constraints\n below:

\n
    \n
  • \n

    Keys must begin with a letter.

    \n
    • \n
  • \n

    Keys must be at least two characters long.

    \n
    • \n
  • \n

    Keys can only contain letters, numbers, and the underscore character (_).

    \n
    • \n
  • \n

    Values can be up to 512 characters long.

    \n
    • \n
  • \n

    You can configure up to 50 key-value pairs in a GraphQL API.

    \n
    • \n
\n

You can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appsync#PutGraphqlApiEnvironmentVariablesResponse": { + "type": "structure", + "members": { + "environmentVariables": { + "target": "com.amazonaws.appsync#EnvironmentVariableMap", + "traits": { + "smithy.api#documentation": "

The payload containing each environmental variable in the \"key\" : \"value\" format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appsync#QueryDepthLimit": { "type": "integer", "traits": { diff --git a/codegen/sdk/aws-models/cloudwatch-logs.json b/codegen/sdk/aws-models/cloudwatch-logs.json index dfda3144475..ce4c96b5bc3 100644 --- a/codegen/sdk/aws-models/cloudwatch-logs.json +++ b/codegen/sdk/aws-models/cloudwatch-logs.json @@ -851,7 +851,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region 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\n 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 do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n PutRetentionPolicy.

\n

If you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.

\n

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.

\n \n

CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see Using\n Symmetric and Asymmetric Keys.

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

Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region 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\n 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

    Log group names can't start with the string aws/\n

    \n
    • \n
\n

When you create a log group, by default the log events in the log group do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n PutRetentionPolicy.

\n

If you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.

\n

If you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.

\n \n

CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see Using\n Symmetric and Asymmetric Keys.

\n " } }, "com.amazonaws.cloudwatchlogs#CreateLogGroupRequest": { @@ -1980,7 +1980,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of the deliveries that have been created in the account.

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

Retrieves a list of the deliveries that have been created in the account.

\n

A delivery is a \n connection between a \n delivery source\n and a \n \n delivery destination\n .

\n

A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. \n The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. \n Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n in Enable logging from Amazon Web Services \n services.\n

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3618,7 +3618,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns complete information about one delivery. A delivery is a connection between a logical delivery source and a logical\n delivery destination\n

\n

You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the \n DescribeDeliveries operation.

" + "smithy.api#documentation": "

Returns complete information about one logical delivery. A delivery is a \n connection between a \n delivery source\n and a \n \n delivery destination\n .

\n

A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. \n The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose. \n Only some Amazon Web Services services support being configured as a delivery source. These services are listed\n in Enable logging from Amazon Web Services \n services.\n

\n

You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the \n DescribeDeliveries operation.

" } }, "com.amazonaws.cloudwatchlogs#GetDeliveryDestination": { @@ -4826,7 +4826,7 @@ "arn": { "target": "com.amazonaws.cloudwatchlogs#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group. This version of the ARN includes a trailing :* after the log group name.

\n

Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource. \n The permissions for those three actions require the ARN version that doesn't include a trailing :*.

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

This specifies the log group class for this log group. There are two classes:

\n
    \n
  • \n

    The Standard log class supports all CloudWatch Logs features.

    \n
    • \n
  • \n

    The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.

    \n
    • \n
\n

For details about the features supported by each class, see \n Log classes\n

" } + }, + "logGroupArn": { + "target": "com.amazonaws.cloudwatchlogs#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.

\n

Use this version to refer to the ARN in the following situations:

\n
    \n
  • \n

    In the logGroupIdentifier input field in many CloudWatch Logs APIs.

    \n
    • \n
  • \n

    In the resourceArn field in tagging APIs

    \n
    • \n
  • \n

    In IAM policies, when specifying permissions for TagResource, UntagResource, and \n ListTagsForResource.

    \n
    • \n
" + } } }, "traits": { @@ -7119,7 +7125,7 @@ "logType": { "target": "com.amazonaws.cloudwatchlogs#LogType", "traits": { - "smithy.api#documentation": "

Defines the type of log that the source is sending. For valid values for this parameter, see the documentation for\n the source service.

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

Defines the type of log that the source is sending. For Amazon CodeWhisperer, the valid value is \n EVENT_LOGS.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/ecs.json b/codegen/sdk/aws-models/ecs.json index 1b094ffb559..7222d5107ba 100644 --- a/codegen/sdk/aws-models/ecs.json +++ b/codegen/sdk/aws-models/ecs.json @@ -2490,7 +2490,7 @@ "systemControls": { "target": "com.amazonaws.ecs#SystemControls", "traits": { - "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.

\n \n

We don't recommended that you specify network-related systemControls\n\t\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t\tawsvpc or host network modes. For tasks that use the\n\t\t\t\t\tawsvpc network mode, the container that's started last determines\n\t\t\t\twhich systemControls parameters take effect. For tasks that use the\n\t\t\t\t\thost network mode, it changes the container instance's namespaced\n\t\t\t\tkernel parameters as well as the containers.

\n \n \n

This parameter is not supported for Windows containers.

\n \n \n

This parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.

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

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run. For example, you can configure\n\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.

" } }, "resourceRequirements": { @@ -3256,7 +3256,7 @@ "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The infrastructure that you run your service on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n \n

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n \n

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n

A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" + "smithy.api#documentation": "

The infrastructure that you run your service on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n \n

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n \n

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n

A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
    • \n
\n " } }, "com.amazonaws.ecs#ExecuteCommand": { @@ -7698,7 +7698,7 @@ "containerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the container (as it appears in a container definition) to associate with\n\t\t\tthe load balancer.

" + "smithy.api#documentation": "

The name of the container (as it appears in a container definition) to associate with\n\t\t\tthe load balancer.

\n

You need to specify the container name when configuring the target group for an Amazon ECS\n\t\t\tload balancer.

" } }, "containerPort": { @@ -9190,7 +9190,7 @@ "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { - "smithy.api#documentation": "

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
    • \n
\n " } }, "runtimePlatform": { @@ -9503,7 +9503,7 @@ "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The infrastructure to run your standalone task on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n \n

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n \n

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n

A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

\n

When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.

" + "smithy.api#documentation": "

The infrastructure to run your standalone task on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n \n

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS Developer Guide.

\n \n

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n

A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

\n

When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.

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

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n

We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task. This task also uses either the\n\t\t\t\tawsvpc or host network mode. It does it for the following\n\t\t\treasons.

\n
    \n
  • \n

    For tasks that use the awsvpc network mode, if you set\n\t\t\t\t\t\tsystemControls for any container, it applies to all containers\n\t\t\t\t\tin the task. If you set different systemControls for multiple\n\t\t\t\t\tcontainers in a single task, the container that's started last determines which\n\t\t\t\t\t\tsystemControls take effect.

    \n
    • \n
  • \n

    For tasks that use the host network mode, the\n\t\t\t\t\t\tsystemControls parameter applies to the container instance's\n\t\t\t\t\tkernel parameter and that of all containers of any tasks running on that\n\t\t\t\t\tcontainer instance.

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

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run. For example, you can configure\n\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.

\n

We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\tawsvpc or host network mode. Doing this has the following\n\t\t\tdisadvantages:

\n
    \n
  • \n

    For tasks that use the awsvpc network mode including Fargate,\n\t\t\t\t\tif you set systemControls for any container, it applies to all\n\t\t\t\t\tcontainers in the task. If you set different systemControls for\n\t\t\t\t\tmultiple containers in a single task, the container that's started last\n\t\t\t\t\tdetermines which systemControls take effect.

    \n
    • \n
  • \n

    For tasks that use the host network mode, the network namespace\n\t\t\t\t\tsystemControls aren't supported.

    \n
    • \n
\n

If you're setting an IPC resource namespace to use for the containers in the task, the\n\t\t\tfollowing conditions apply to your system controls. For more information, see IPC mode.

\n
    \n
  • \n

    For tasks that use the host IPC mode, IPC namespace\n\t\t\t\t\tsystemControls aren't supported.

    \n
    • \n
  • \n

    For tasks that use the task IPC mode, IPC namespace\n\t\t\t\t\tsystemControls values apply to all containers within a\n\t\t\t\t\ttask.

    \n
    • \n
\n \n

This parameter is not supported for Windows containers.

\n \n \n

This parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.

\n " } }, "com.amazonaws.ecs#SystemControls": { @@ -11368,7 +11368,7 @@ "stopCode": { "target": "com.amazonaws.ecs#TaskStopCode", "traits": { - "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

\n

For more information about stop code, see Stopped tasks error codes in the Amazon ECS User Guide.

" + "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

\n

For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

" } }, "stoppedAt": { diff --git a/codegen/sdk/aws-models/elasticsearch-service.json b/codegen/sdk/aws-models/elasticsearch-service.json index 68cefcf07c8..fbac60339c9 100644 --- a/codegen/sdk/aws-models/elasticsearch-service.json +++ b/codegen/sdk/aws-models/elasticsearch-service.json @@ -367,6 +367,9 @@ { "target": "com.amazonaws.elasticsearchservice#AuthorizeVpcEndpointAccess" }, + { + "target": "com.amazonaws.elasticsearchservice#CancelDomainConfigChange" + }, { "target": "com.amazonaws.elasticsearchservice#CancelElasticsearchServiceSoftwareUpdate" }, @@ -2111,6 +2114,90 @@ "com.amazonaws.elasticsearchservice#Boolean": { "type": "boolean" }, + "com.amazonaws.elasticsearchservice#CancelDomainConfigChange": { + "type": "operation", + "input": { + "target": "com.amazonaws.elasticsearchservice#CancelDomainConfigChangeRequest" + }, + "output": { + "target": "com.amazonaws.elasticsearchservice#CancelDomainConfigChangeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.elasticsearchservice#BaseException" + }, + { + "target": "com.amazonaws.elasticsearchservice#DisabledOperationException" + }, + { + "target": "com.amazonaws.elasticsearchservice#InternalException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.elasticsearchservice#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2015-01-01/es/domain/{DomainName}/config/cancel", + "code": 200 + } + } + }, + "com.amazonaws.elasticsearchservice#CancelDomainConfigChangeRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.elasticsearchservice#DomainName", + "traits": { + "smithy.api#documentation": "

Name of the OpenSearch Service domain configuration request to cancel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.elasticsearchservice#DryRun", + "traits": { + "smithy.api#documentation": "

When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

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

Container for parameters of the CancelDomainConfigChange operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.elasticsearchservice#CancelDomainConfigChangeResponse": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.elasticsearchservice#DryRun", + "traits": { + "smithy.api#documentation": "

Whether or not the request was a dry run. If True, the changes were not actually cancelled.

" + } + }, + "CancelledChangeIds": { + "target": "com.amazonaws.elasticsearchservice#GUIDList", + "traits": { + "smithy.api#documentation": "

The unique identifiers of the changes that were cancelled.

" + } + }, + "CancelledChangeProperties": { + "target": "com.amazonaws.elasticsearchservice#CancelledChangePropertyList", + "traits": { + "smithy.api#documentation": "

The domain change properties that were cancelled.

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

Contains the details of the cancelled domain config change.

", + "smithy.api#output": {} + } + }, "com.amazonaws.elasticsearchservice#CancelElasticsearchServiceSoftwareUpdate": { "type": "operation", "input": { @@ -2173,6 +2260,38 @@ "smithy.api#output": {} } }, + "com.amazonaws.elasticsearchservice#CancelledChangeProperty": { + "type": "structure", + "members": { + "PropertyName": { + "target": "com.amazonaws.elasticsearchservice#String", + "traits": { + "smithy.api#documentation": "

The name of the property whose change was cancelled.

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

The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.

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

The current value of the property, after the change was cancelled.

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

A property change that was cancelled for an Amazon OpenSearch Service domain.

" + } + }, + "com.amazonaws.elasticsearchservice#CancelledChangePropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#CancelledChangeProperty" + } + }, "com.amazonaws.elasticsearchservice#ChangeProgressDetails": { "type": "structure", "members": { @@ -2187,6 +2306,30 @@ "traits": { "smithy.api#documentation": "

Contains an optional message associated with the domain configuration change.

" } + }, + "ConfigChangeStatus": { + "target": "com.amazonaws.elasticsearchservice#ConfigChangeStatus", + "traits": { + "smithy.api#documentation": "

The current status of the configuration change.

" + } + }, + "StartTime": { + "target": "com.amazonaws.elasticsearchservice#UpdateTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.elasticsearchservice#UpdateTimestamp", + "traits": { + "smithy.api#documentation": "

The last time that the configuration change was updated.

" + } + }, + "InitiatedBy": { + "target": "com.amazonaws.elasticsearchservice#InitiatedBy", + "traits": { + "smithy.api#documentation": "

The IAM principal who initiated the configuration change.

" + } } }, "traits": { @@ -2297,6 +2440,24 @@ "traits": { "smithy.api#documentation": "

The specific stages that the domain is going through to perform the configuration change.

" } + }, + "ConfigChangeStatus": { + "target": "com.amazonaws.elasticsearchservice#ConfigChangeStatus", + "traits": { + "smithy.api#documentation": "

The current status of the configuration change.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.elasticsearchservice#UpdateTimestamp", + "traits": { + "smithy.api#documentation": "

The last time that the status of the configuration change was updated.

" + } + }, + "InitiatedBy": { + "target": "com.amazonaws.elasticsearchservice#InitiatedBy", + "traits": { + "smithy.api#documentation": "

The IAM principal who initiated the configuration change.

" + } } }, "traits": { @@ -2419,6 +2580,59 @@ "smithy.api#documentation": "

\n A map from an\n \n ElasticsearchVersion\n \n to a list of compatible\n \n ElasticsearchVersion\n \n s to which the domain can be upgraded.\n

" } }, + "com.amazonaws.elasticsearchservice#ConfigChangeStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Validating" + } + }, + "VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationFailed" + } + }, + "APPLYING_CHANGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApplyingChanges" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "PENDING_USER_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingUserInput" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + } + } + }, "com.amazonaws.elasticsearchservice#ConflictException": { "type": "structure", "members": { @@ -4607,6 +4821,53 @@ } } }, + "com.amazonaws.elasticsearchservice#DomainProcessingStatusType": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Modifying" + } + }, + "UPGRADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpgradingEngineVersion" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdatingServiceSoftware" + } + }, + "ISOLATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Isolated" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, "com.amazonaws.elasticsearchservice#Double": { "type": "double" }, @@ -5278,6 +5539,12 @@ "traits": { "smithy.api#documentation": "

Specifies change details of the domain configuration change.

" } + }, + "ModifyingProperties": { + "target": "com.amazonaws.elasticsearchservice#ModifyingPropertiesList", + "traits": { + "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

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

Specifies change details of the domain configuration change.

" } + }, + "DomainProcessingStatus": { + "target": "com.amazonaws.elasticsearchservice#DomainProcessingStatusType", + "traits": { + "smithy.api#documentation": "

The status of any changes that are currently in progress for the domain.

" + } + }, + "ModifyingProperties": { + "target": "com.amazonaws.elasticsearchservice#ModifyingPropertiesList", + "traits": { + "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

" + } } }, "traits": { @@ -5621,6 +5900,12 @@ "smithy.api#pattern": "^\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}$" } }, + "com.amazonaws.elasticsearchservice#GUIDList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#GUID" + } + }, "com.amazonaws.elasticsearchservice#GetCompatibleElasticsearchVersions": { "type": "operation", "input": { @@ -6052,6 +6337,23 @@ "target": "com.amazonaws.elasticsearchservice#InboundCrossClusterSearchConnection" } }, + "com.amazonaws.elasticsearchservice#InitiatedBy": { + "type": "enum", + "members": { + "CUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER" + } + }, + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + } + } + }, "com.amazonaws.elasticsearchservice#InstanceCount": { "type": "integer", "traits": { @@ -7066,6 +7368,44 @@ "smithy.api#documentation": "

\n Minimum number of Instances that can be instantiated for given InstanceType.\n

" } }, + "com.amazonaws.elasticsearchservice#ModifyingProperties": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.elasticsearchservice#String", + "traits": { + "smithy.api#documentation": "

The name of the property that is currently being modified.

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

The current value of the domain property that is being modified.

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

The value that the property that is currently being modified will eventually have.

" + } + }, + "ValueType": { + "target": "com.amazonaws.elasticsearchservice#PropertyValueType", + "traits": { + "smithy.api#documentation": "

The type of value that is currently being modified. Properties can have two types:

\n
    \n
  • PLAIN_TEXT: Contain direct values such as \"1\", \"True\", or \"c5.large.search\".
    • \n
  • STRINGIFIED_JSON: Contain content in JSON format, such as {\"Enabled\":\"True\"}\".
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

" + } + }, + "com.amazonaws.elasticsearchservice#ModifyingPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#ModifyingProperties" + } + }, "com.amazonaws.elasticsearchservice#NextToken": { "type": "string", "traits": { @@ -7580,6 +7920,23 @@ "smithy.api#documentation": "

Specifies the type of AWS account permitted to manage VPC endpoints.:\n

    \n
  • AWS_ACCOUNT: Indicates that the account is owned by an AWS user.
    • \n
  • AWS_SERVICE: Indicates the the account is owned by an AWS service.
    • \n
\n

" } }, + "com.amazonaws.elasticsearchservice#PropertyValueType": { + "type": "enum", + "members": { + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + }, + "STRINGIFIED_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRINGIFIED_JSON" + } + } + } + }, "com.amazonaws.elasticsearchservice#PurchaseReservedElasticsearchInstanceOffering": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/opensearch.json b/codegen/sdk/aws-models/opensearch.json index 3eee29d9da4..78b7c230fa0 100644 --- a/codegen/sdk/aws-models/opensearch.json +++ b/codegen/sdk/aws-models/opensearch.json @@ -581,6 +581,9 @@ { "target": "com.amazonaws.opensearch#AuthorizeVpcEndpointAccess" }, + { + "target": "com.amazonaws.opensearch#CancelDomainConfigChange" + }, { "target": "com.amazonaws.opensearch#CancelServiceSoftwareUpdate" }, @@ -2441,6 +2444,87 @@ "com.amazonaws.opensearch#Boolean": { "type": "boolean" }, + "com.amazonaws.opensearch#CancelDomainConfigChange": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#CancelDomainConfigChangeRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#CancelDomainConfigChangeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/config/cancel", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#CancelDomainConfigChangeRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.opensearch#DryRun", + "traits": { + "smithy.api#documentation": "

When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opensearch#CancelDomainConfigChangeResponse": { + "type": "structure", + "members": { + "CancelledChangeIds": { + "target": "com.amazonaws.opensearch#GUIDList", + "traits": { + "smithy.api#documentation": "

The unique identifiers of the changes that were cancelled.

" + } + }, + "CancelledChangeProperties": { + "target": "com.amazonaws.opensearch#CancelledChangePropertyList", + "traits": { + "smithy.api#documentation": "

The domain change properties that were cancelled.

" + } + }, + "DryRun": { + "target": "com.amazonaws.opensearch#DryRun", + "traits": { + "smithy.api#documentation": "

Whether or not the request was a dry run. If True, the changes were not actually cancelled.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.opensearch#CancelServiceSoftwareUpdate": { "type": "operation", "input": { @@ -2503,6 +2587,38 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#CancelledChangeProperty": { + "type": "structure", + "members": { + "PropertyName": { + "target": "com.amazonaws.opensearch#String", + "traits": { + "smithy.api#documentation": "

The name of the property whose change was cancelled.

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

The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.

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

The current value of the property, after the change was cancelled.

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

A property change that was cancelled for an Amazon OpenSearch Service domain.

" + } + }, + "com.amazonaws.opensearch#CancelledChangePropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#CancelledChangeProperty" + } + }, "com.amazonaws.opensearch#ChangeProgressDetails": { "type": "structure", "members": { @@ -2517,6 +2633,30 @@ "traits": { "smithy.api#documentation": "

A message corresponding to the status of the configuration change.

" } + }, + "ConfigChangeStatus": { + "target": "com.amazonaws.opensearch#ConfigChangeStatus", + "traits": { + "smithy.api#documentation": "

The current status of the configuration change.

" + } + }, + "InitiatedBy": { + "target": "com.amazonaws.opensearch#InitiatedBy", + "traits": { + "smithy.api#documentation": "

The IAM principal who initiated the configuration change.

" + } + }, + "StartTime": { + "target": "com.amazonaws.opensearch#UpdateTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.opensearch#UpdateTimestamp", + "traits": { + "smithy.api#documentation": "

The last time that the configuration change was updated.

" + } } }, "traits": { @@ -2627,6 +2767,24 @@ "traits": { "smithy.api#documentation": "

The specific stages that the domain is going through to perform the configuration change.

" } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.opensearch#UpdateTimestamp", + "traits": { + "smithy.api#documentation": "

The last time that the status of the configuration change was updated.

" + } + }, + "ConfigChangeStatus": { + "target": "com.amazonaws.opensearch#ConfigChangeStatus", + "traits": { + "smithy.api#documentation": "

The current status of the configuration change.

" + } + }, + "InitiatedBy": { + "target": "com.amazonaws.opensearch#InitiatedBy", + "traits": { + "smithy.api#documentation": "

The IAM principal who initiated the configuration change.

" + } } }, "traits": { @@ -2859,6 +3017,59 @@ "smithy.api#documentation": "

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them\n to.

" } }, + "com.amazonaws.opensearch#ConfigChangeStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "VALIDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Validating" + } + }, + "VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ValidationFailed" + } + }, + "APPLYING_CHANGES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApplyingChanges" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "PENDING_USER_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingUserInput" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + } + } + }, "com.amazonaws.opensearch#ConflictException": { "type": "structure", "members": { @@ -5458,6 +5669,12 @@ "traits": { "smithy.api#documentation": "

Software update options for the domain.

" } + }, + "ModifyingProperties": { + "target": "com.amazonaws.opensearch#ModifyingPropertiesList", + "traits": { + "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

" + } } }, "traits": { @@ -5866,6 +6083,53 @@ } } }, + "com.amazonaws.opensearch#DomainProcessingStatusType": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "MODIFYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Modifying" + } + }, + "UPGRADING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpgradingEngineVersion" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdatingServiceSoftware" + } + }, + "ISOLATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Isolated" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + } + } + }, "com.amazonaws.opensearch#DomainState": { "type": "enum", "members": { @@ -6069,6 +6333,18 @@ "traits": { "smithy.api#documentation": "

Service software update options for the domain.

" } + }, + "DomainProcessingStatus": { + "target": "com.amazonaws.opensearch#DomainProcessingStatusType", + "traits": { + "smithy.api#documentation": "

The status of any changes that are currently in progress for the domain.

" + } + }, + "ModifyingProperties": { + "target": "com.amazonaws.opensearch#ModifyingPropertiesList", + "traits": { + "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

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

Specifies whether the domain should encrypt data at rest, and if so, the Key Management\n Service (KMS) key to use. Can be used only to create a new domain, not update an existing\n one.

" + "smithy.api#documentation": "

Specifies whether the domain should encrypt data at rest, and if so, the Key Management\n Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest\n for the first time on an existing domain. You can't modify this parameter after it's already been\n specified.

" } }, "com.amazonaws.opensearch#EncryptionAtRestOptionsStatus": { @@ -6421,6 +6697,12 @@ "smithy.api#pattern": "^\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}$" } }, + "com.amazonaws.opensearch#GUIDList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#GUID" + } + }, "com.amazonaws.opensearch#GetCompatibleVersions": { "type": "operation", "input": { @@ -7112,6 +7394,23 @@ "target": "com.amazonaws.opensearch#InboundConnection" } }, + "com.amazonaws.opensearch#InitiatedBy": { + "type": "enum", + "members": { + "CUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER" + } + }, + "SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE" + } + } + } + }, "com.amazonaws.opensearch#InstanceCount": { "type": "integer", "traits": { @@ -8585,6 +8884,44 @@ "smithy.api#documentation": "

Minimum number of instances that can be instantiated for a given instance type.

" } }, + "com.amazonaws.opensearch#ModifyingProperties": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.opensearch#String", + "traits": { + "smithy.api#documentation": "

The name of the property that is currently being modified.

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

The current value of the domain property that is being modified.

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

The value that the property that is currently being modified will eventually have.

" + } + }, + "ValueType": { + "target": "com.amazonaws.opensearch#PropertyValueType", + "traits": { + "smithy.api#documentation": "

The type of value that is currently being modified. Properties can have two types:

\n
    \n
  • \n

    \n PLAIN_TEXT: Contain direct values such as \"1\", \"True\", or \"c5.large.search\".

    \n
    • \n
  • \n

    \n STRINGIFIED_JSON: Contain content in JSON format, such as {\"Enabled\":\"True\"}\".

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

Information about the domain properties that are currently being modified.

" + } + }, + "com.amazonaws.opensearch#ModifyingPropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#ModifyingProperties" + } + }, "com.amazonaws.opensearch#NextToken": { "type": "string", "traits": { @@ -9962,6 +10299,23 @@ } } }, + "com.amazonaws.opensearch#PropertyValueType": { + "type": "enum", + "members": { + "PLAIN_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAIN_TEXT" + } + }, + "STRINGIFIED_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRINGIFIED_JSON" + } + } + } + }, "com.amazonaws.opensearch#PurchaseReservedInstanceOffering": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/wafv2.json b/codegen/sdk/aws-models/wafv2.json index cf87a87ab3e..730e2ab2f99 100644 --- a/codegen/sdk/aws-models/wafv2.json +++ b/codegen/sdk/aws-models/wafv2.json @@ -221,6 +221,9 @@ { "target": "com.amazonaws.wafv2#CreateWebACL" }, + { + "target": "com.amazonaws.wafv2#DeleteAPIKey" + }, { "target": "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups" }, @@ -1754,7 +1757,7 @@ } ], "traits": { - "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, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\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 in the Amazon CloudFront Developer Guide.

\n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + "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, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\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 in the Amazon CloudFront Developer Guide.

\n

\n Required permissions for customer-managed IAM policies\n

\n

This call requires permissions that are specific to the protected resource type. \n For details, see Permissions for AssociateWebACL in the WAF Developer Guide.

\n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" } }, "com.amazonaws.wafv2#AssociateWebACLRequest": { @@ -1874,7 +1877,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\n web requests that you designate for inspection in FieldToMatch. The\n maximum length of the value is 200 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

    \n JA3Fingerprint: Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to \n EXACTLY.

    \n

    You can obtain the JA3 fingerprint for client requests from the web ACL logs. \n\t\t\t\t\t\tIf WAF is able to calculate the fingerprint, it includes it in the logs. \n\t\t\t\t\t\tFor information about the logging fields, \nsee Log fields in the WAF Developer Guide.

    \n
    • \n
  • \n

    \n HeaderOrder: The comma-separated list of header names to match for. WAF creates a \n string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.

    \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 200 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#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 200 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

    \n JA3Fingerprint: Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to \n EXACTLY.

    \n

    You can obtain the JA3 fingerprint for client requests from the web ACL logs. \n\t\t\t\t\t\tIf WAF is able to calculate the fingerprint, it includes it in the logs. \n\t\t\t\t\t\tFor information about the logging fields, \nsee Log fields in the WAF Developer Guide.

    \n
    • \n
  • \n

    \n HeaderOrder: The list of header names to match for. WAF creates a \n string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.

    \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 200 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": {} } }, @@ -2230,7 +2233,7 @@ "MatchScope": { "target": "com.amazonaws.wafv2#MapMatchScope", "traits": { - "smithy.api#documentation": "

The parts of the cookies to inspect with the rule inspection criteria. If you specify\n All, WAF inspects both keys and values.

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

The parts of the cookies to inspect with the rule inspection criteria. If you specify\n ALL, WAF inspects both keys and values.

\n

\n All does not require a match to be found in the keys\n and a match to be found in the values. It requires a match to be found in the keys \n or the values or both. To require a match in the keys and in the values, use a logical AND statement\n to combine two match rules, one that inspects the keys and another that inspects the values.

", "smithy.api#required": {} } }, @@ -3818,7 +3821,7 @@ "TokenDomains": { "target": "com.amazonaws.wafv2#APIKeyTokenDomains", "traits": { - "smithy.api#documentation": "

The client application domains that you want to use this API key for.

\n

Example JSON: \"TokenDomains\": [\"abc.com\", \"store.abc.com\"]\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

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

The client application domains that you want to use this API key for.

\n

Example JSON: \"TokenDomains\": [\"abc.com\", \"store.abc.com\"]\n

\n

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

", "smithy.api#required": {} } } @@ -4281,7 +4284,7 @@ "TokenDomains": { "target": "com.amazonaws.wafv2#TokenDomains", "traits": { - "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

" + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

" } }, "AssociationConfig": { @@ -4470,6 +4473,64 @@ "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.

" } }, + "com.amazonaws.wafv2#DeleteAPIKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.wafv2#DeleteAPIKeyRequest" + }, + "output": { + "target": "com.amazonaws.wafv2#DeleteAPIKeyResponse" + }, + "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": "

Deletes the specified API key.

\n

After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.

" + } + }, + "com.amazonaws.wafv2#DeleteAPIKeyRequest": { + "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, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\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": {} + } + }, + "APIKey": { + "target": "com.amazonaws.wafv2#APIKey", + "traits": { + "smithy.api#documentation": "

The encrypted API key that you want to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wafv2#DeleteAPIKeyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroups": { "type": "operation", "input": { @@ -5203,7 +5264,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates the specified regional application resource from any existing web ACL\n association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\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 in the Amazon CloudFront API Reference.

" + "smithy.api#documentation": "

Disassociates the specified regional application resource from any existing web ACL\n association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\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 in the Amazon CloudFront API Reference.

\n

\n Required permissions for customer-managed IAM policies\n

\n

This call requires permissions that are specific to the protected resource type. \n For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.

" } }, "com.amazonaws.wafv2#DisassociateWebACLRequest": { @@ -6532,7 +6593,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the WebACL for the specified resource.

" + "smithy.api#documentation": "

Retrieves the WebACL for the specified resource.

\n

This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. \n If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource, \n that error won't be included in your CloudTrail event history.

\n

For Amazon CloudFront, don't use this call. Instead, call the CloudFront action\n GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.

\n

\n Required permissions for customer-managed IAM policies\n

\n

This call requires permissions that are specific to the protected resource type. \n For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.

" } }, "com.amazonaws.wafv2#GetWebACLForResourceRequest": { @@ -6767,7 +6828,7 @@ "MatchScope": { "target": "com.amazonaws.wafv2#MapMatchScope", "traits": { - "smithy.api#documentation": "

The parts of the headers to match with the rule inspection criteria. If you specify\n All, WAF inspects both keys and values.

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

The parts of the headers to match with the rule inspection criteria. If you specify\n ALL, WAF inspects both keys and values.

\n

\n All does not require a match to be found in the keys\n and a match to be found in the values. It requires a match to be found in the keys \n or the values or both. To require a match in the keys and in the values, use a logical AND statement\n to combine two match rules, one that inspects the keys and another that inspects the values.

", "smithy.api#required": {} } }, @@ -7022,7 +7083,7 @@ "MatchScope": { "target": "com.amazonaws.wafv2#JsonMatchScope", "traits": { - "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#documentation": "

The parts of the JSON to match against using the MatchPattern. If you\n specify ALL, WAF matches against keys and values.

\n

\n All does not require a match to be found in the keys\n and a match to be found in the values. It requires a match to be found in the keys \n or the values or both. To require a match in the keys and in the values, use a logical AND statement\n to combine two match rules, one that inspects the keys and another that inspects the values.

", "smithy.api#required": {} } }, @@ -7856,7 +7917,7 @@ } ], "traits": { - "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.

" + "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.

\n

For Amazon CloudFront, don't use this call. Instead, use the CloudFront call\n ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId\n in the Amazon CloudFront API Reference.

\n

\n Required permissions for customer-managed IAM policies\n

\n

This call requires permissions that are specific to the protected resource type. \n For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.

" } }, "com.amazonaws.wafv2#ListResourcesForWebACLRequest": { @@ -11785,7 +11846,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

\n

To modify an IP set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetIPSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete IP set specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + "smithy.api#documentation": "

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.

\n

To modify an IP set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetIPSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete IP set specification to this call

    \n
    4. \n
\n \n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" } }, "com.amazonaws.wafv2#UpdateIPSetRequest": { @@ -11988,7 +12049,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

\n

To modify a regex pattern set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRegexPatternSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete regex pattern set specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

" + "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.

\n

To modify a regex pattern set, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRegexPatternSet\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete regex pattern set specification to this call

    \n
    4. \n
\n \n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" } }, "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { @@ -12095,7 +12156,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

\n

To modify a rule group, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRuleGroup\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete rule group specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

" + "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.

\n

To modify a rule group, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetRuleGroup\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete rule group specification to this call

    \n
    4. \n
\n \n

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

\n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" } }, "com.amazonaws.wafv2#UpdateRuleGroupRequest": { @@ -12220,7 +12281,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

\n

To modify a web ACL, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetWebACL\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete web ACL specification to this call

    \n
    4. \n
\n \n

When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.

\n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

" + "smithy.api#documentation": "

Updates the specified WebACL. While updating a web ACL, WAF provides\n continuous coverage to the resources that you have associated with the web ACL.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.

\n

To modify a web ACL, do the following:

\n
    \n
  1. \n

    Retrieve it by calling GetWebACL\n

    \n
    2. \n
  2. \n

    Update its settings as needed

    \n
    3. \n
  3. \n

    Provide the complete web ACL specification to this call

    \n
    4. \n
\n \n

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

\n

\n Temporary inconsistencies during updates\n

\n

When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

\n

The following are examples of the temporary inconsistencies that you might notice during change propagation:

\n
    \n
  • \n

    After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.

    \n
    • \n
  • \n

    After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.

    \n
    • \n
  • \n

    After you change a rule action setting, you might see the old action in some places and the new action in others.

    \n
    • \n
  • \n

    After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.

    \n
    • \n
" } }, "com.amazonaws.wafv2#UpdateWebACLRequest": { @@ -12301,7 +12362,7 @@ "TokenDomains": { "target": "com.amazonaws.wafv2#TokenDomains", "traits": { - "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

" + "smithy.api#documentation": "

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

\n

Example JSON: \"TokenDomains\": { \"mywebsite.com\", \"myotherwebsite.com\" }\n

\n

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

" } }, "AssociationConfig": { From 8507e3ce65de7198d113edd2200cb8f87b5cfabb Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 6 Feb 2024 19:09:36 +0000 Subject: [PATCH 06/32] chore: release 1.0.51 --- CHANGELOG.md | 12 ++++++++++++ gradle.properties | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 675e86c41be..42515f8735f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## [1.0.51] - 02/06/2024 + +### Features +* (**appsync**) Support for environment variables in AppSync GraphQL APIs +* (**cloudwatchlogs**) This release adds a new field, logGroupArn, to the response of the logs:DescribeLogGroups action. +* (**elasticsearchservice**) This release adds clear visibility to the customers on the changes that they make on the domain. +* (**opensearch**) This release adds clear visibility to the customers on the changes that they make on the domain. +* (**wafv2**) You can now delete an API key that you've created for use with your CAPTCHA JavaScript integration API. + +### Documentation +* (**ecs**) This release is a documentation only update to address customer issues. + ## [1.0.50] - 02/05/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 84b1660796d..4fb829d9f45 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.51-SNAPSHOT +sdkVersion=1.0.51 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 47c4f08cf63ea7d83ca90988bd408ac06201edef Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 6 Feb 2024 19:09:37 +0000 Subject: [PATCH 07/32] chore: bump snapshot version to 1.0.52-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 4fb829d9f45..128f55691e0 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.51 +sdkVersion=1.0.52-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 7beac1009bebdeb57ebf3fd5216db55def730538 Mon Sep 17 00:00:00 2001 From: Ian Botsford <83236726+ianbotsf@users.noreply.github.com> Date: Tue, 6 Feb 2024 13:07:06 -0800 Subject: [PATCH 08/32] chore: add @InternalSdkApi to binary compatibility checks; introduce new PR check to verify no API-breaking changes (#1204) --- .github/workflows/api-compat-verification.yml | 32 +++ aws-runtime/aws-config/api/aws-config.api | 174 +++++++++++++++ aws-runtime/aws-endpoint/api/aws-endpoint.api | 61 ++++++ aws-runtime/aws-http/api/aws-http.api | 202 ++++++++++++++++++ aws-runtime/build.gradle.kts | 4 - 5 files changed, 469 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/api-compat-verification.yml diff --git a/.github/workflows/api-compat-verification.yml b/.github/workflows/api-compat-verification.yml new file mode 100644 index 00000000000..26c7ef3901d --- /dev/null +++ b/.github/workflows/api-compat-verification.yml @@ -0,0 +1,32 @@ +name: API compatibility verification + +on: + pull_request: + types: [ opened, synchronize, reopened, labeled, unlabeled ] + branches: [ main ] + +jobs: + api-compat-verification: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Check for API compatibility + if: ${{ !contains(github.event.pull_request.labels.*.name, 'acknowledge-api-break') }} + run: | + git fetch origin ${{ github.base_ref }} --depth 1 && \ + git diff remotes/origin/${{ github.base_ref }} --numstat "*.api" | awk ' + BEGIN { s = 0 } + + # git diff numstat shows lines deleted in field 2, hence sum up field 2 across all items + { s += $2 } + + # exit with the number of lines deleted as the result code so that `if failure()` works below + END { exit s } + ' + - name: Error message + if: ${{ failure() }} + run: | + echo "::error ::This change modifies the public API in a way that may be backwards-incompatible. Carefully review this pull request and either:" + echo "::error ::* Revert the changes which caused the API incompatibility –or–" + echo "::error ::* Add the 'acknowledge-api-break' label to this PR (in rare cases warranting an API breakage)" + exit 1 diff --git a/aws-runtime/aws-config/api/aws-config.api b/aws-runtime/aws-config/api/aws-config.api index 70ba7dcb4a8..62be3ef2207 100644 --- a/aws-runtime/aws-config/api/aws-config.api +++ b/aws-runtime/aws-config/api/aws-config.api @@ -210,6 +210,7 @@ public final class aws/sdk/kotlin/runtime/auth/credentials/internal/ManagedBeare } public final class aws/sdk/kotlin/runtime/auth/credentials/internal/ManagedCredentialsProviderKt { + public static final fun manage (Laws/smithy/kotlin/runtime/auth/awscredentials/CloseableCredentialsProvider;)Laws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProvider; } public abstract class aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory : aws/smithy/kotlin/runtime/client/SdkClientFactory { @@ -220,7 +221,41 @@ public abstract class aws/sdk/kotlin/runtime/config/AbstractAwsSdkClientFactory public fun invoke (Lkotlin/jvm/functions/Function1;)Laws/smithy/kotlin/runtime/client/SdkClient; } +public final class aws/sdk/kotlin/runtime/config/AwsSdkSetting { + public static final field INSTANCE Laws/sdk/kotlin/runtime/config/AwsSdkSetting; + public final fun getAwsAccessKeyId ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsAccountId ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsAccountIdEndpointMode ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsAppId ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsConfigFile ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsContainerAuthorizationToken ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsContainerAuthorizationTokenFile ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsContainerCredentialsFullUri ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsContainerCredentialsRelativeUri ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsDisableRequestCompression ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsEc2MetadataDisabled ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsEc2MetadataServiceEndpoint ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsEc2MetadataServiceEndpointMode ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsEndpointUrl ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsExecutionEnv ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsIgnoreEndpointUrls ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsMaxAttempts ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsProfile ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsRegion ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsRequestMinCompressionSizeBytes ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsRetryMode ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsRoleArn ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsRoleSessionName ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsSecretAccessKey ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsSessionToken ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsSharedCredentialsFile ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsUseDualStackEndpoint ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsUseFipsEndpoint ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; + public final fun getAwsWebIdentityTokenFile ()Laws/smithy/kotlin/runtime/config/EnvironmentSetting; +} + public final class aws/sdk/kotlin/runtime/config/AwsSdkSettingKt { + public static final fun resolveEndpointUrl (Laws/sdk/kotlin/runtime/config/AwsSdkSetting;Laws/smithy/kotlin/runtime/util/PlatformProvider;Ljava/lang/String;Ljava/lang/String;)Laws/smithy/kotlin/runtime/net/url/Url; } public final class aws/sdk/kotlin/runtime/config/compression/RequestCompressionResolversKt { @@ -240,6 +275,15 @@ public final class aws/sdk/kotlin/runtime/config/endpoints/AccountIdEndpointMode } public final class aws/sdk/kotlin/runtime/config/endpoints/ResolversKt { + public static final fun resolveAccountId (Laws/sdk/kotlin/runtime/config/endpoints/AccountIdEndpointMode;Laws/smithy/kotlin/runtime/collections/Attributes;)Ljava/lang/String; + public static final fun resolveAccountIdEndpointMode (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun resolveAccountIdEndpointMode$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; + public static final fun resolveEndpointUrl (Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Laws/smithy/kotlin/runtime/util/PlatformProvider;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun resolveEndpointUrl$default (Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Laws/smithy/kotlin/runtime/util/PlatformProvider;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; + public static final fun resolveUseDualStack (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun resolveUseDualStack$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; + public static final fun resolveUseFips (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun resolveUseFips$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; } public final class aws/sdk/kotlin/runtime/config/imds/EC2MetadataError : aws/sdk/kotlin/runtime/AwsServiceException { @@ -318,23 +362,151 @@ public abstract interface class aws/sdk/kotlin/runtime/config/imds/InstanceMetad } public final class aws/sdk/kotlin/runtime/config/profile/AwsConfigLoaderKt { + public static final fun loadAwsSharedConfig (Laws/smithy/kotlin/runtime/util/PlatformProvider;Ljava/lang/String;Laws/sdk/kotlin/runtime/config/profile/AwsConfigurationSource;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun loadAwsSharedConfig$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Ljava/lang/String;Laws/sdk/kotlin/runtime/config/profile/AwsConfigurationSource;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; } public final class aws/sdk/kotlin/runtime/config/profile/AwsConfigParseException : aws/sdk/kotlin/runtime/ConfigurationException { public fun (Ljava/lang/String;I)V } +public abstract class aws/sdk/kotlin/runtime/config/profile/AwsConfigValue { +} + +public final class aws/sdk/kotlin/runtime/config/profile/AwsConfigValue$Map : aws/sdk/kotlin/runtime/config/profile/AwsConfigValue, java/util/Map, kotlin/jvm/internal/markers/KMappedMarker { + public fun (Ljava/util/Map;)V + public fun clear ()V + public final fun component1 ()Ljava/util/Map; + public synthetic fun compute (Ljava/lang/Object;Ljava/util/function/BiFunction;)Ljava/lang/Object; + public fun compute (Ljava/lang/String;Ljava/util/function/BiFunction;)Ljava/lang/String; + public synthetic fun computeIfAbsent (Ljava/lang/Object;Ljava/util/function/Function;)Ljava/lang/Object; + public fun computeIfAbsent (Ljava/lang/String;Ljava/util/function/Function;)Ljava/lang/String; + public synthetic fun computeIfPresent (Ljava/lang/Object;Ljava/util/function/BiFunction;)Ljava/lang/Object; + public fun computeIfPresent (Ljava/lang/String;Ljava/util/function/BiFunction;)Ljava/lang/String; + public final fun containsKey (Ljava/lang/Object;)Z + public fun containsKey (Ljava/lang/String;)Z + public final fun containsValue (Ljava/lang/Object;)Z + public fun containsValue (Ljava/lang/String;)Z + public final fun copy (Ljava/util/Map;)Laws/sdk/kotlin/runtime/config/profile/AwsConfigValue$Map; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/config/profile/AwsConfigValue$Map;Ljava/util/Map;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/config/profile/AwsConfigValue$Map; + public final fun entrySet ()Ljava/util/Set; + public fun equals (Ljava/lang/Object;)Z + public final synthetic fun get (Ljava/lang/Object;)Ljava/lang/Object; + public final fun get (Ljava/lang/Object;)Ljava/lang/String; + public fun get (Ljava/lang/String;)Ljava/lang/String; + public fun getEntries ()Ljava/util/Set; + public fun getKeys ()Ljava/util/Set; + public fun getSize ()I + public final fun getValue ()Ljava/util/Map; + public fun getValues ()Ljava/util/Collection; + public fun hashCode ()I + public fun isEmpty ()Z + public final fun keySet ()Ljava/util/Set; + public synthetic fun merge (Ljava/lang/Object;Ljava/lang/Object;Ljava/util/function/BiFunction;)Ljava/lang/Object; + public fun merge (Ljava/lang/String;Ljava/lang/String;Ljava/util/function/BiFunction;)Ljava/lang/String; + public synthetic fun put (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object; + public fun put (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String; + public fun putAll (Ljava/util/Map;)V + public synthetic fun putIfAbsent (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object; + public fun putIfAbsent (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String; + public synthetic fun remove (Ljava/lang/Object;)Ljava/lang/Object; + public fun remove (Ljava/lang/Object;)Ljava/lang/String; + public fun remove (Ljava/lang/Object;Ljava/lang/Object;)Z + public synthetic fun replace (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object; + public synthetic fun replace (Ljava/lang/Object;Ljava/lang/Object;Ljava/lang/Object;)Z + public fun replace (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String; + public fun replace (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Z + public fun replaceAll (Ljava/util/function/BiFunction;)V + public final fun size ()I + public fun toString ()Ljava/lang/String; + public final fun values ()Ljava/util/Collection; +} + +public final class aws/sdk/kotlin/runtime/config/profile/AwsConfigValue$String : aws/sdk/kotlin/runtime/config/profile/AwsConfigValue { + public fun (Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;)Laws/sdk/kotlin/runtime/config/profile/AwsConfigValue$String; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/config/profile/AwsConfigValue$String;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/config/profile/AwsConfigValue$String; + public fun equals (Ljava/lang/Object;)Z + public final fun getValue ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class aws/sdk/kotlin/runtime/config/profile/AwsConfigurationSource { + public fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/lang/String; + public final fun component3 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Laws/sdk/kotlin/runtime/config/profile/AwsConfigurationSource; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/config/profile/AwsConfigurationSource;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/config/profile/AwsConfigurationSource; + public fun equals (Ljava/lang/Object;)Z + public final fun getConfigPath ()Ljava/lang/String; + public final fun getCredentialsPath ()Ljava/lang/String; + public final fun getProfile ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + public final class aws/sdk/kotlin/runtime/config/profile/AwsProfileKt { + public static final fun getAccountIdEndpointMode (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Laws/sdk/kotlin/runtime/config/endpoints/AccountIdEndpointMode; + public static final fun getAwsAccessKeyId (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getAwsSecretAccessKey (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getAwsSessionToken (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getBooleanOrNull (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Boolean; + public static synthetic fun getBooleanOrNull$default (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Ljava/lang/Boolean; + public static final fun getCredentialProcess (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getDisableRequestCompression (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean; + public static final fun getEndpointUrl (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Laws/smithy/kotlin/runtime/net/url/Url; + public static final fun getIgnoreEndpointUrls (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean; + public static final fun getIntOrNull (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Integer; + public static synthetic fun getIntOrNull$default (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Ljava/lang/Integer; + public static final fun getLongOrNull (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Long; + public static synthetic fun getLongOrNull$default (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Ljava/lang/Long; + public static final fun getMaxAttempts (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Integer; + public static final fun getRegion (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getRequestMinCompressionSizeBytes (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Long; + public static final fun getRetryMode (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Laws/smithy/kotlin/runtime/client/config/RetryMode; + public static final fun getRoleArn (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getSdkUserAgentAppId (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getServicesSection (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getSourceProfile (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/String; + public static final fun getUseDualStack (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean; + public static final fun getUseFips (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;)Ljava/lang/Boolean; +} + +public final class aws/sdk/kotlin/runtime/config/profile/AwsSharedConfig { + public final fun getActiveProfile ()Laws/sdk/kotlin/runtime/config/profile/ConfigSection; + public final fun getProfiles ()Ljava/util/Map; + public final fun getServices ()Ljava/util/Map; + public final fun getSsoSessions ()Ljava/util/Map; } public final class aws/sdk/kotlin/runtime/config/profile/AwsSharedConfigKt { public static final fun resolveEndpointUrl (Laws/sdk/kotlin/runtime/config/profile/AwsSharedConfig;Ljava/lang/String;)Laws/smithy/kotlin/runtime/net/url/Url; } +public final class aws/sdk/kotlin/runtime/config/profile/ConfigSection { + public final fun component1 ()Ljava/lang/String; + public final fun contains (Ljava/lang/String;)Z + public final fun copy (Ljava/lang/String;Ljava/util/Map;Laws/sdk/kotlin/runtime/config/profile/ConfigSectionType;)Laws/sdk/kotlin/runtime/config/profile/ConfigSection; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/util/Map;Laws/sdk/kotlin/runtime/config/profile/ConfigSectionType;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/config/profile/ConfigSection; + public fun equals (Ljava/lang/Object;)Z + public final fun getName ()Ljava/lang/String; + public final fun getOrNull (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String; + public static synthetic fun getOrNull$default (Laws/sdk/kotlin/runtime/config/profile/ConfigSection;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + public final class aws/sdk/kotlin/runtime/config/retries/ResolveRetryStrategyKt { + public static final fun resolveRetryStrategy (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun resolveRetryStrategy$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; } public final class aws/sdk/kotlin/runtime/config/useragent/ResolveUserAgentKt { + public static final fun resolveUserAgentAppId (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun resolveUserAgentAppId$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; } public final class aws/sdk/kotlin/runtime/region/DefaultRegionProviderChain : aws/sdk/kotlin/runtime/region/RegionProviderChain, aws/sdk/kotlin/runtime/region/RegionProvider, java/io/Closeable { @@ -387,5 +559,7 @@ public class aws/sdk/kotlin/runtime/region/RegionProviderChain : aws/sdk/kotlin/ } public final class aws/sdk/kotlin/runtime/region/ResolveRegionKt { + public static final fun resolveRegion (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public static synthetic fun resolveRegion$default (Laws/smithy/kotlin/runtime/util/PlatformProvider;Laws/smithy/kotlin/runtime/util/LazyAsyncValue;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object; } diff --git a/aws-runtime/aws-endpoint/api/aws-endpoint.api b/aws-runtime/aws-endpoint/api/aws-endpoint.api index 72147729da2..54908bcc666 100644 --- a/aws-runtime/aws-endpoint/api/aws-endpoint.api +++ b/aws-runtime/aws-endpoint/api/aws-endpoint.api @@ -1,3 +1,64 @@ +public final class aws/sdk/kotlin/runtime/endpoint/functions/Arn { + public fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/lang/String; + public final fun component3 ()Ljava/lang/String; + public final fun component4 ()Ljava/lang/String; + public final fun component5 ()Ljava/util/List; + public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;)Laws/sdk/kotlin/runtime/endpoint/functions/Arn; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/endpoint/functions/Arn;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/util/List;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/endpoint/functions/Arn; + public fun equals (Ljava/lang/Object;)Z + public final fun getAccountId ()Ljava/lang/String; + public final fun getPartition ()Ljava/lang/String; + public final fun getRegion ()Ljava/lang/String; + public final fun getResourceId ()Ljava/util/List; + public final fun getService ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + public final class aws/sdk/kotlin/runtime/endpoint/functions/FunctionsKt { + public static final fun isVirtualHostableS3Bucket (Ljava/lang/String;Z)Z + public static final fun parseArn (Ljava/lang/String;)Laws/sdk/kotlin/runtime/endpoint/functions/Arn; + public static final fun partition (Ljava/util/List;Ljava/lang/String;)Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig; +} + +public final class aws/sdk/kotlin/runtime/endpoint/functions/Partition { + public fun (Ljava/lang/String;Ljava/util/Map;Lkotlin/text/Regex;Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/util/Map; + public final fun component3 ()Lkotlin/text/Regex; + public final fun component4 ()Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig; + public final fun copy (Ljava/lang/String;Ljava/util/Map;Lkotlin/text/Regex;Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig;)Laws/sdk/kotlin/runtime/endpoint/functions/Partition; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/endpoint/functions/Partition;Ljava/lang/String;Ljava/util/Map;Lkotlin/text/Regex;Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/endpoint/functions/Partition; + public fun equals (Ljava/lang/Object;)Z + public final fun getBaseConfig ()Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig; + public final fun getId ()Ljava/lang/String; + public final fun getRegionRegex ()Lkotlin/text/Regex; + public final fun getRegions ()Ljava/util/Map; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class aws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig { + public fun ()V + public fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;)V + public synthetic fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/lang/String; + public final fun component3 ()Ljava/lang/String; + public final fun component4 ()Ljava/lang/Boolean; + public final fun component5 ()Ljava/lang/Boolean; + public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;)Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig; + public fun equals (Ljava/lang/Object;)Z + public final fun getDnsSuffix ()Ljava/lang/String; + public final fun getDualStackDnsSuffix ()Ljava/lang/String; + public final fun getName ()Ljava/lang/String; + public final fun getSupportsDualStack ()Ljava/lang/Boolean; + public final fun getSupportsFIPS ()Ljava/lang/Boolean; + public fun hashCode ()I + public final fun mergeWith (Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig;)Laws/sdk/kotlin/runtime/endpoint/functions/PartitionConfig; + public fun toString ()Ljava/lang/String; } diff --git a/aws-runtime/aws-http/api/aws-http.api b/aws-runtime/aws-http/api/aws-http.api index 3e15d87841f..1be03dc3e03 100644 --- a/aws-runtime/aws-http/api/aws-http.api +++ b/aws-runtime/aws-http/api/aws-http.api @@ -1,3 +1,16 @@ +public final class aws/sdk/kotlin/runtime/http/ApiMetadata { + public fun (Ljava/lang/String;Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;Ljava/lang/String;)Laws/sdk/kotlin/runtime/http/ApiMetadata; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/http/ApiMetadata;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/http/ApiMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getServiceId ()Ljava/lang/String; + public final fun getVersion ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + public final class aws/sdk/kotlin/runtime/http/AwsUserAgentMetadata { public static final field Companion Laws/sdk/kotlin/runtime/http/AwsUserAgentMetadata$Companion; public fun (Laws/sdk/kotlin/runtime/http/SdkMetadata;Laws/sdk/kotlin/runtime/http/ApiMetadata;Laws/sdk/kotlin/runtime/http/OsMetadata;Laws/sdk/kotlin/runtime/http/LanguageMetadata;Laws/sdk/kotlin/runtime/http/ExecutionEnvMetadata;Laws/sdk/kotlin/runtime/http/FrameworkMetadata;Ljava/lang/String;Laws/sdk/kotlin/runtime/http/operation/CustomUserAgentMetadata;)V @@ -37,10 +50,182 @@ public final class aws/sdk/kotlin/runtime/http/AwsUserAgentMetadataKt { public static final field AWS_APP_ID_PROP Ljava/lang/String; } +public final class aws/sdk/kotlin/runtime/http/ExecutionEnvMetadata { + public fun (Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;)Laws/sdk/kotlin/runtime/http/ExecutionEnvMetadata; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/http/ExecutionEnvMetadata;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/http/ExecutionEnvMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getName ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class aws/sdk/kotlin/runtime/http/FrameworkMetadata { + public fun (Ljava/lang/String;Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;Ljava/lang/String;)Laws/sdk/kotlin/runtime/http/FrameworkMetadata; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/http/FrameworkMetadata;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/http/FrameworkMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getName ()Ljava/lang/String; + public final fun getVersion ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class aws/sdk/kotlin/runtime/http/LanguageMetadata { + public fun ()V + public fun (Ljava/lang/String;Ljava/util/Map;)V + public synthetic fun (Ljava/lang/String;Ljava/util/Map;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/util/Map; + public final fun copy (Ljava/lang/String;Ljava/util/Map;)Laws/sdk/kotlin/runtime/http/LanguageMetadata; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/http/LanguageMetadata;Ljava/lang/String;Ljava/util/Map;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/http/LanguageMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getExtras ()Ljava/util/Map; + public final fun getVersion ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class aws/sdk/kotlin/runtime/http/OsMetadata { + public fun (Laws/smithy/kotlin/runtime/util/OsFamily;Ljava/lang/String;)V + public synthetic fun (Laws/smithy/kotlin/runtime/util/OsFamily;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Laws/smithy/kotlin/runtime/util/OsFamily; + public final fun component2 ()Ljava/lang/String; + public final fun copy (Laws/smithy/kotlin/runtime/util/OsFamily;Ljava/lang/String;)Laws/sdk/kotlin/runtime/http/OsMetadata; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/http/OsMetadata;Laws/smithy/kotlin/runtime/util/OsFamily;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/http/OsMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getFamily ()Laws/smithy/kotlin/runtime/util/OsFamily; + public final fun getVersion ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class aws/sdk/kotlin/runtime/http/SdkMetadata { + public fun (Ljava/lang/String;Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;Ljava/lang/String;)Laws/sdk/kotlin/runtime/http/SdkMetadata; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/http/SdkMetadata;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/http/SdkMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getName ()Ljava/lang/String; + public final fun getVersion ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class aws/sdk/kotlin/runtime/http/interceptors/AddUserAgentMetadataInterceptor : aws/smithy/kotlin/runtime/client/Interceptor { + public fun (Ljava/util/Map;)V + public fun modifyBeforeAttemptCompletion-gIAlu-s (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeCompletion-gIAlu-s (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeDeserialization (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeRetryLoop (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeSerialization (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeTransmit (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun readAfterAttempt (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterDeserialization (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterExecution (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterSerialization (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readAfterSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readAfterTransmit (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)V + public fun readBeforeAttempt (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readBeforeDeserialization (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)V + public fun readBeforeExecution (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;)V + public fun readBeforeSerialization (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;)V + public fun readBeforeSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readBeforeTransmit (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V +} + +public final class aws/sdk/kotlin/runtime/http/interceptors/AwsSpanInterceptor : aws/smithy/kotlin/runtime/client/Interceptor { + public static final field INSTANCE Laws/sdk/kotlin/runtime/http/interceptors/AwsSpanInterceptor; + public fun modifyBeforeAttemptCompletion-gIAlu-s (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeCompletion-gIAlu-s (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeDeserialization (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeRetryLoop (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeSerialization (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeTransmit (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun readAfterAttempt (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterDeserialization (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterExecution (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterSerialization (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readAfterSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readAfterTransmit (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)V + public fun readBeforeAttempt (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readBeforeDeserialization (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)V + public fun readBeforeExecution (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;)V + public fun readBeforeSerialization (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;)V + public fun readBeforeSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readBeforeTransmit (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V +} + +public final class aws/sdk/kotlin/runtime/http/interceptors/UnsupportedSigningAlgorithmInterceptor : aws/smithy/kotlin/runtime/client/Interceptor { + public fun ()V + public fun modifyBeforeAttemptCompletion-gIAlu-s (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeCompletion-gIAlu-s (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeDeserialization (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeRetryLoop (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeSerialization (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun modifyBeforeTransmit (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun readAfterAttempt (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterDeserialization (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterExecution (Laws/smithy/kotlin/runtime/client/ResponseInterceptorContext;)V + public fun readAfterSerialization (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readAfterSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readAfterTransmit (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)V + public fun readBeforeAttempt (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readBeforeDeserialization (Laws/smithy/kotlin/runtime/client/ProtocolResponseInterceptorContext;)V + public fun readBeforeExecution (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;)V + public fun readBeforeSerialization (Laws/smithy/kotlin/runtime/client/RequestInterceptorContext;)V + public fun readBeforeSigning (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V + public fun readBeforeTransmit (Laws/smithy/kotlin/runtime/client/ProtocolRequestInterceptorContext;)V +} + +public final class aws/sdk/kotlin/runtime/http/middleware/AwsRetryHeaderMiddleware : aws/smithy/kotlin/runtime/http/operation/MutateMiddleware { + public fun ()V + public fun handle (Laws/smithy/kotlin/runtime/http/operation/OperationRequest;Laws/smithy/kotlin/runtime/io/Handler;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public synthetic fun handle (Ljava/lang/Object;Laws/smithy/kotlin/runtime/io/Handler;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun install (Laws/smithy/kotlin/runtime/http/operation/SdkHttpOperation;)V +} + +public final class aws/sdk/kotlin/runtime/http/middleware/RecursionDetection : aws/smithy/kotlin/runtime/http/operation/ModifyRequestMiddleware { + public fun ()V + public fun (Laws/smithy/kotlin/runtime/util/EnvironmentProvider;)V + public synthetic fun (Laws/smithy/kotlin/runtime/util/EnvironmentProvider;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public fun install (Laws/smithy/kotlin/runtime/http/operation/SdkHttpOperation;)V + public fun modifyRequest (Laws/smithy/kotlin/runtime/http/operation/OperationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public synthetic fun modifyRequest (Ljava/lang/Object;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; +} + +public final class aws/sdk/kotlin/runtime/http/middleware/UserAgent : aws/smithy/kotlin/runtime/http/operation/ModifyRequestMiddleware { + public fun (Laws/sdk/kotlin/runtime/http/AwsUserAgentMetadata;)V + public fun install (Laws/smithy/kotlin/runtime/http/operation/SdkHttpOperation;)V + public fun modifyRequest (Laws/smithy/kotlin/runtime/http/operation/OperationRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public synthetic fun modifyRequest (Ljava/lang/Object;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; +} + +public final class aws/sdk/kotlin/runtime/http/operation/ConfigMetadata : aws/sdk/kotlin/runtime/http/operation/TypedUserAgentMetadata { + public fun (Ljava/lang/String;Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;Ljava/lang/String;)Laws/sdk/kotlin/runtime/http/operation/ConfigMetadata; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/http/operation/ConfigMetadata;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/http/operation/ConfigMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getName ()Ljava/lang/String; + public final fun getValue ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + public final class aws/sdk/kotlin/runtime/http/operation/CustomUserAgentMetadata { public fun ()V public fun (Ljava/util/Map;Ljava/util/List;)V public synthetic fun (Ljava/util/Map;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun add (Laws/sdk/kotlin/runtime/http/operation/TypedUserAgentMetadata;)V public final fun add (Ljava/lang/String;Ljava/lang/String;)V public final fun plus (Laws/sdk/kotlin/runtime/http/operation/CustomUserAgentMetadata;)Laws/sdk/kotlin/runtime/http/operation/CustomUserAgentMetadata; } @@ -49,6 +234,23 @@ public final class aws/sdk/kotlin/runtime/http/operation/CustomUserAgentMetadata public static final fun getCustomUserAgentMetadata (Laws/smithy/kotlin/runtime/operation/ExecutionContext;)Laws/sdk/kotlin/runtime/http/operation/CustomUserAgentMetadata; } +public final class aws/sdk/kotlin/runtime/http/operation/FeatureMetadata : aws/sdk/kotlin/runtime/http/operation/TypedUserAgentMetadata { + public fun (Ljava/lang/String;Ljava/lang/String;)V + public synthetic fun (Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;Ljava/lang/String;)Laws/sdk/kotlin/runtime/http/operation/FeatureMetadata; + public static synthetic fun copy$default (Laws/sdk/kotlin/runtime/http/operation/FeatureMetadata;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Laws/sdk/kotlin/runtime/http/operation/FeatureMetadata; + public fun equals (Ljava/lang/Object;)Z + public final fun getName ()Ljava/lang/String; + public final fun getVersion ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public abstract interface class aws/sdk/kotlin/runtime/http/operation/TypedUserAgentMetadata { +} + public class aws/sdk/kotlin/runtime/http/retries/AwsRetryPolicy : aws/smithy/kotlin/runtime/retries/policy/StandardRetryPolicy { public static final field Companion Laws/sdk/kotlin/runtime/http/retries/AwsRetryPolicy$Companion; public fun ()V diff --git a/aws-runtime/build.gradle.kts b/aws-runtime/build.gradle.kts index c7241e3737c..97e9c335bd5 100644 --- a/aws-runtime/build.gradle.kts +++ b/aws-runtime/build.gradle.kts @@ -77,7 +77,3 @@ subprojects { } } } - -apiValidation { - nonPublicMarkers.add("aws.sdk.kotlin.runtime.InternalSdkApi") -} From fc8538e57e421f32e0560a7ce6acb2b3eb0acaf3 Mon Sep 17 00:00:00 2001 From: Aaron Todd Date: Tue, 6 Feb 2024 16:12:59 -0500 Subject: [PATCH 09/32] chore: add scaffolding task (#1202) --- .github/workflows/continuous-integration.yml | 1 + .../aws/sdk/kotlin/gradle/sdk/AwsService.kt | 21 +- .../aws/sdk/kotlin/gradle/sdk/Naming.kt | 13 + .../sdk/kotlin/gradle/sdk/PackageManifest.kt | 76 + .../gradle/sdk/tasks/UpdatePackageManifest.kt | 108 + .../sdk/kotlin/gradle/sdk/AwsServiceTest.kt | 36 +- .../kotlin/gradle/sdk/PackageManifestTest.kt | 33 + .../tasks/UpdatePackageManifestTaskTest.kt | 160 ++ codegen/sdk/build.gradle.kts | 15 +- codegen/sdk/packages.json | 2254 +++++++++++++++++ 10 files changed, 2699 insertions(+), 18 deletions(-) create mode 100644 build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/PackageManifest.kt create mode 100644 build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/tasks/UpdatePackageManifest.kt create mode 100644 build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/PackageManifestTest.kt create mode 100644 build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/tasks/UpdatePackageManifestTaskTest.kt create mode 100644 codegen/sdk/packages.json diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index e72098f0784..b8cb2e12035 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -67,6 +67,7 @@ jobs: shell: bash run: | pwd + ./gradlew :build-support:test ./gradlew publishToMavenLocal ./gradlew apiCheck ./gradlew test jvmTest diff --git a/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/AwsService.kt b/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/AwsService.kt index da4efcfface..cbeebdfbd25 100644 --- a/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/AwsService.kt +++ b/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/AwsService.kt @@ -49,20 +49,18 @@ data class AwsService( */ val version: String, + /** + * Get the artifact name to use for the service derived from the sdkId. This will be the `A` in the GAV coordinates + * and the directory name under `services/`. + */ + val artifactName: String, + /** * A description of the service (taken from the title trait) */ val description: String? = null, - ) -/** - * Get the artifact name to use for the service derived from the sdkId. This will be the `A` in the GAV coordinates - * and the directory name under `services/`. - */ -val AwsService.artifactName: String - get() = sdkIdToArtifactName(sdkId) - /** * Returns a lambda for a service model file that respects the given bootstrap config * @@ -72,6 +70,7 @@ val AwsService.artifactName: String fun fileToService( project: Project, bootstrap: BootstrapConfig, + pkgManifest: PackageManifest, ): (File) -> AwsService? = { file: File -> val sdkVersion = project.findProperty("sdkVersion") as? String ?: error("expected sdkVersion to be set on project ${project.name}") val filename = file.nameWithoutExtension @@ -111,14 +110,18 @@ fun fileToService( else -> { project.logger.info("discovered service: ${serviceTrait.sdkId}") + // FIXME - re-enable making this an error after migration is finished + // val pkgMetadata = pkgManifest.bySdkId[sdkId] ?: error("unable to find package metadata for sdkId: $sdkId") + val pkgMetadata = pkgManifest.bySdkId[sdkId] ?: PackageMetadata.from(sdkId) AwsService( serviceShapeId = service.id.toString(), - packageName = packageNamespaceForService(sdkId), + packageName = pkgMetadata.namespace, packageVersion = sdkVersion, modelFile = file, projectionName = filename, sdkId = sdkId, version = service.version, + artifactName = pkgMetadata.artifactName, description = packageDescription, ) } diff --git a/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/Naming.kt b/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/Naming.kt index 8471edd7d29..4c1ad284e51 100644 --- a/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/Naming.kt +++ b/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/Naming.kt @@ -37,3 +37,16 @@ internal fun sdkIdToArtifactName(sdkId: String): String = sdkId.replace(" ", "") * catapult! See AwsSdkCatapultWorkspaceTools:lib/source/merge/smithy-model-handler.ts */ fun sdkIdToModelFilename(sdkId: String): String = sdkId.trim().replace("""[\s]+""".toRegex(), "-").lowercase() + +// FIXME - replace with case utils from smithy-kotlin once we verify we can change the implementation +private fun String.lowercaseAndCapitalize() = lowercase().replaceFirstChar(Char::uppercaseChar) +private val wordBoundary = "[^a-zA-Z0-9]+".toRegex() +private fun String.pascalCase(): String = split(wordBoundary).pascalCase() +fun List.pascalCase() = joinToString(separator = "") { it.lowercaseAndCapitalize() } + +private const val BRAZIL_GROUP_NAME = "AwsSdkKotlin" + +/** + * Maps an sdkId from a model to the brazil package name to use + */ +fun sdkIdToBrazilName(sdkId: String): String = "${BRAZIL_GROUP_NAME}${sdkId.pascalCase()}" diff --git a/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/PackageManifest.kt b/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/PackageManifest.kt new file mode 100644 index 00000000000..ec455674d18 --- /dev/null +++ b/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/PackageManifest.kt @@ -0,0 +1,76 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.gradle.sdk + +import kotlinx.serialization.ExperimentalSerializationApi +import kotlinx.serialization.Serializable +import kotlinx.serialization.json.Json +import kotlinx.serialization.json.decodeFromStream +import java.io.File + +/** + * Manifest containing additional metadata about services. + */ +@OptIn(ExperimentalSerializationApi::class) +@Serializable +data class PackageManifest( + val packages: List, +) { + + val bySdkId: Map = packages.associateBy(PackageMetadata::sdkId) + companion object { + fun fromFile(file: File): PackageManifest = + file.inputStream().use { + Json.decodeFromStream(it) + } + } +} + +/** + * Validate the package manifest for errors throwing an exception if any exist. + */ +fun PackageManifest.validate() { + val distinct = mutableMapOf() + val errors = mutableListOf() + packages.forEach { + val existing = distinct[it.sdkId] + if (existing != null) { + errors.add("multiple packages with same sdkId `${it.sdkId}`: first: $existing; second: $it") + } + distinct[it.sdkId] = it + } + + check(errors.isEmpty()) { errors.joinToString(separator = "\n") } +} + +/** + * Per/package metadata stored with the repository. + * + * @param sdkId the unique SDK ID from the model this metadata applies to + * @param namespace the package namespace to use as the root namespace when generating code for this package + * @param artifactName the Maven artifact name (i.e. the 'A' in 'GAV' coordinates) + * @param brazilName the internal Brazil package name for this package + */ +@Serializable +data class PackageMetadata( + public val sdkId: String, + public val namespace: String, + public val artifactName: String, + public val brazilName: String, +) { + companion object { + + /** + * Create a new [PackageMetadata] from inferring values using the given sdkId + */ + fun from(sdkId: String): PackageMetadata = + PackageMetadata( + sdkId, + packageNamespaceForService(sdkId), + sdkIdToArtifactName(sdkId), + sdkIdToBrazilName(sdkId), + ) + } +} diff --git a/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/tasks/UpdatePackageManifest.kt b/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/tasks/UpdatePackageManifest.kt new file mode 100644 index 00000000000..55f76c1a07f --- /dev/null +++ b/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/sdk/tasks/UpdatePackageManifest.kt @@ -0,0 +1,108 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.gradle.sdk.tasks + +import aws.sdk.kotlin.gradle.sdk.PackageManifest +import aws.sdk.kotlin.gradle.sdk.PackageMetadata +import aws.sdk.kotlin.gradle.sdk.orNull +import aws.sdk.kotlin.gradle.sdk.validate +import kotlinx.serialization.ExperimentalSerializationApi +import kotlinx.serialization.encodeToString +import kotlinx.serialization.json.Json +import org.gradle.api.DefaultTask +import org.gradle.api.file.DirectoryProperty +import org.gradle.api.file.RegularFileProperty +import org.gradle.api.provider.Property +import org.gradle.api.tasks.* +import org.gradle.api.tasks.options.Option +import software.amazon.smithy.aws.traits.ServiceTrait +import software.amazon.smithy.model.Model +import software.amazon.smithy.model.shapes.ServiceShape +import kotlin.streams.toList + +/** + * Task to update the package manifest which is used by the bootstrap process to generate service clients. + * New services are required to be scaffolded + */ +abstract class UpdatePackageManifest : DefaultTask() { + + @get:Option(option = "model", description = "the path to a single model file to scaffold") + @get:Optional + @get:InputFile + public abstract val modelFile: RegularFileProperty + + @get:Optional + @get:Option(option = "model-dir", description = "the path to a directory of model files to scaffold") + @get:InputDirectory + public abstract val modelDir: DirectoryProperty + + @get:Optional + @get:Option( + option = "discover", + description = "Flag to discover and process only new packages not currently in the manifest. Only applicable when used in conjunction with `model-dir`", + ) + @get:Input + public abstract val discover: Property + + @OptIn(ExperimentalSerializationApi::class) + @TaskAction + fun updatePackageManifest() { + check(modelFile.isPresent != modelDir.isPresent) { "Exactly one of `model` or `model-dir` must be set" } + + val manifestFile = project.file("packages.json") + + val manifest = if (manifestFile.exists()) { + val manifest = PackageManifest.fromFile(manifestFile) + manifest.validate() + manifest + } else { + PackageManifest(emptyList()) + } + + val model = Model.assembler() + .discoverModels() + .apply { + val import = if (modelFile.isPresent) modelFile else modelDir + addImport(import.get().asFile.absolutePath) + } + .assemble() + .result + .get() + + val discoveredPackages = model + .shapes(ServiceShape::class.java) + .toList() + .mapNotNull { it.getTrait(ServiceTrait::class.java).orNull()?.sdkId } + .map { PackageMetadata.from(it) } + + val newPackages = validatedPackages(manifest, discoveredPackages) + + if (newPackages.isEmpty()) { + logger.lifecycle("no new packages to scaffold") + return + } + + logger.lifecycle("scaffolding ${newPackages.size} new service packages") + + val updatedPackages = manifest.packages + newPackages + val updatedManifest = manifest.copy(packages = updatedPackages.sortedBy { it.sdkId }) + + val json = Json { prettyPrint = true } + val contents = json.encodeToString(updatedManifest) + manifestFile.writeText(contents) + } + + private fun validatedPackages(manifest: PackageManifest, discovered: List): List = + if (modelDir.isPresent && discover.orNull == true) { + val bySdkId = manifest.packages.associateBy(PackageMetadata::sdkId) + discovered.filter { it.sdkId !in bySdkId } + } else { + discovered.forEach { pkg -> + val existing = manifest.packages.find { it.sdkId == pkg.sdkId } + check(existing == null) { "found existing package in manifest for sdkId `${pkg.sdkId}`: $existing" } + } + discovered + } +} diff --git a/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/AwsServiceTest.kt b/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/AwsServiceTest.kt index b014f8d091f..905357b58a0 100644 --- a/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/AwsServiceTest.kt +++ b/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/AwsServiceTest.kt @@ -8,14 +8,12 @@ import org.gradle.kotlin.dsl.extra import org.gradle.testfixtures.ProjectBuilder import org.junit.jupiter.api.io.TempDir import java.io.File -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertNull +import kotlin.test.* class AwsServiceTest { val modelContents = """ - ${"$"}version: "2.0" + ${"$"}version: "2" namespace gradle.test use aws.api#service @@ -23,7 +21,7 @@ class AwsServiceTest { @service(sdkId: "Test Gradle") @awsJson1_0 - service TestService{ + service TestService { operations: [], version: "1-alpha" } @@ -34,9 +32,23 @@ class AwsServiceTest { val actual: AwsService?, ) + private val defaultPackageManifest = PackageManifest( + listOf( + PackageMetadata( + "Test Gradle", + // namespace and artifact name intentionally don't match the sdkId derivations to verify we pull from + // the metadata rather than inferring again + "aws.sdk.kotlin.services.testgradle2", + "test-gradle", + "AwsSdkKotlinTestGradle", + ), + ), + ) + private fun testWith( tempDir: File, bootstrap: BootstrapConfig, + manifest: PackageManifest = defaultPackageManifest, ): TestResult { val project = ProjectBuilder.builder() .build() @@ -46,7 +58,7 @@ class AwsServiceTest { val model = tempDir.resolve("test-gradle.smithy") model.writeText(modelContents) - val lambda = fileToService(project, bootstrap) + val lambda = fileToService(project, bootstrap, manifest) val actual = lambda(model) return TestResult(model, actual) } @@ -69,12 +81,13 @@ class AwsServiceTest { val result = testWith(tempDir, bootstrap) val expected = AwsService( "gradle.test#TestService", - "aws.sdk.kotlin.services.testgradle", + "aws.sdk.kotlin.services.testgradle2", "1.2.3", result.model, "test-gradle", "Test Gradle", "1-alpha", + "test-gradle", "The AWS SDK for Kotlin client for Test Gradle", ) assertEquals(expected, result.actual) @@ -98,4 +111,13 @@ class AwsServiceTest { assertNull(result.actual, "expected null for bootstrap with $bootstrap") } } + + // FIXME - re-enable after migration + // @Test + // fun testFileToServiceMissingPackageMetadata(@TempDir tempDir: File) { + // val ex = assertFailsWith { + // testWith(tempDir, BootstrapConfig.ALL, PackageManifest(emptyList())) + // } + // assertContains(ex.message!!, "unable to find package metadata for sdkId: Test Gradle") + // } } diff --git a/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/PackageManifestTest.kt b/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/PackageManifestTest.kt new file mode 100644 index 00000000000..25f9e6b632c --- /dev/null +++ b/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/PackageManifestTest.kt @@ -0,0 +1,33 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.gradle.sdk + +import kotlin.test.Test +import kotlin.test.assertContains +import kotlin.test.assertFailsWith + +class PackageManifestTest { + @Test + fun testValidate() { + val manifest = PackageManifest( + listOf( + PackageMetadata("Package 1", "aws.sdk.kotlin.services.package1", "package1", "AwsSdkKotlinPackage1"), + PackageMetadata("Package 2", "aws.sdk.kotlin.services.package2", "package2", "AwsSdkKotlinPackage2"), + ), + ) + + manifest.validate() + + val badManifest = manifest.copy( + manifest.packages + listOf( + PackageMetadata("Package 2", "aws.sdk.kotlin.services.package2", "package2", "AwsSdkKotlinPackage2"), + ), + ) + + val ex = assertFailsWith { badManifest.validate() } + + assertContains(ex.message!!, "multiple packages with same sdkId `Package 2`") + } +} diff --git a/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/tasks/UpdatePackageManifestTaskTest.kt b/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/tasks/UpdatePackageManifestTaskTest.kt new file mode 100644 index 00000000000..29695159a5f --- /dev/null +++ b/build-support/src/test/kotlin/aws/sdk/kotlin/gradle/sdk/tasks/UpdatePackageManifestTaskTest.kt @@ -0,0 +1,160 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.gradle.sdk.tasks + +import aws.sdk.kotlin.gradle.sdk.PackageManifest +import aws.sdk.kotlin.gradle.sdk.PackageMetadata +import kotlinx.serialization.ExperimentalSerializationApi +import kotlinx.serialization.encodeToString +import kotlinx.serialization.json.Json +import org.gradle.kotlin.dsl.create +import org.gradle.testfixtures.ProjectBuilder +import org.junit.jupiter.api.io.TempDir +import java.io.File +import kotlin.test.* + +@OptIn(ExperimentalSerializationApi::class) +class UpdatePackageManifestTaskTest { + fun modelContents(sdkId: String, serviceName: String = "TestService"): String = """ + ${"$"}version: "2" + namespace gradle.test + + use aws.api#service + use aws.protocols#awsJson1_0 + + @service(sdkId: "$sdkId") + @awsJson1_0 + service $serviceName { + operations: [], + version: "1-alpha" + } + """.trimIndent() + + private val json = Json { prettyPrint = true } + + private val initialManifest = PackageManifest( + listOf( + PackageMetadata("Package 1", "aws.sdk.kotlin.services.package1", "package1", "AwsSdkKotlinPackage1"), + PackageMetadata("Package 2", "aws.sdk.kotlin.services.package2", "package2", "AwsSdkKotlinPackage2"), + ), + ) + + private fun setupTest(tempDir: File, sdkId: String, currentManifest: PackageManifest? = initialManifest): UpdatePackageManifest { + val project = ProjectBuilder.builder().withProjectDir(tempDir).build() + currentManifest?.let { + val currentManifestContents = json.encodeToString(it) + tempDir.resolve("packages.json").writeText(currentManifestContents) + } + val testModelFile = tempDir.resolve("model.smithy") + testModelFile.writeText(modelContents(sdkId)) + + return project.tasks.create("updatePackageManifest") { + modelFile.set(testModelFile) + } + } + + @Test + fun testNewPackage(@TempDir tempDir: File) { + val task = setupTest(tempDir, "Test Gradle") + task.updatePackageManifest() + + val updated = PackageManifest.fromFile(tempDir.resolve("packages.json")) + val expectedPackages = initialManifest.packages.toMutableList() + expectedPackages.add( + PackageMetadata("Test Gradle", "aws.sdk.kotlin.services.testgradle", "testgradle", "AwsSdkKotlinTestGradle"), + ) + val expected = initialManifest.copy(expectedPackages) + + assertEquals(expected, updated) + } + + @Test + fun testManifestNotExistYet(@TempDir tempDir: File) { + val task = setupTest(tempDir, "Test Gradle", null) + task.updatePackageManifest() + val updated = PackageManifest.fromFile(tempDir.resolve("packages.json")) + val expected = PackageManifest( + listOf( + PackageMetadata("Test Gradle", "aws.sdk.kotlin.services.testgradle", "testgradle", "AwsSdkKotlinTestGradle"), + ), + ) + assertEquals(expected, updated) + } + + @Test + fun testExistingPackage(@TempDir tempDir: File) { + val task = setupTest(tempDir, "Package 2") + val ex = assertFailsWith { + task.updatePackageManifest() + } + assertContains(ex.message!!, "found existing package in manifest for sdkId `Package 2`") + } + + @Test + fun testDirectory(@TempDir tempDir: File) { + val project = ProjectBuilder.builder().withProjectDir(tempDir).build() + val models = listOf( + "model1.smithy" to modelContents("Package 1", "Service1"), + "model2.smithy" to modelContents("Package 2", "Service2"), + // non AWS service (no sdkId) + "model3.smithy" to """ + ${"$"}version: "2" + namespace gradle.test + service Service3 { + operations: [], + version: "1-alpha" + } + """.trimIndent(), + ) + + val modelFolder = tempDir.resolve("models") + modelFolder.mkdirs() + models.forEach { (filename, contents) -> + val modelFile = modelFolder.resolve(filename) + modelFile.writeText(contents) + } + val task = project.tasks.create("updatePackageManifest") { + modelDir.set(modelFolder) + } + + task.updatePackageManifest() + val updated = PackageManifest.fromFile(tempDir.resolve("packages.json")) + assertEquals(initialManifest, updated) + } + + @Test + fun testDirectoryDiscover(@TempDir tempDir: File) { + val project = ProjectBuilder.builder().withProjectDir(tempDir).build() + val models = listOf( + "model1.smithy" to modelContents("Package 1", "Service1"), + "model2.smithy" to modelContents("Package 2", "Service2"), + "model3.smithy" to modelContents("Package 3", "Service3"), + ) + + val modelFolder = tempDir.resolve("models") + modelFolder.mkdirs() + models.forEach { (filename, contents) -> + val modelFile = modelFolder.resolve(filename) + modelFile.writeText(contents) + } + + val currentManifestContents = json.encodeToString(initialManifest) + tempDir.resolve("packages.json").writeText(currentManifestContents) + + val task = project.tasks.create("updatePackageManifest") { + modelDir.set(modelFolder) + discover.set(true) + } + + task.updatePackageManifest() + val updated = PackageManifest.fromFile(tempDir.resolve("packages.json")) + val expected = initialManifest.copy( + initialManifest.packages + listOf( + PackageMetadata("Package 3", "aws.sdk.kotlin.services.package3", "package3", "AwsSdkKotlinPackage3"), + ), + ) + assertEquals(expected, updated) + } +} diff --git a/codegen/sdk/build.gradle.kts b/codegen/sdk/build.gradle.kts index cf1e5bf8698..a47e0e3e2bb 100644 --- a/codegen/sdk/build.gradle.kts +++ b/codegen/sdk/build.gradle.kts @@ -8,11 +8,11 @@ import aws.sdk.kotlin.gradle.codegen.dsl.SmithyProjection import aws.sdk.kotlin.gradle.codegen.dsl.generateSmithyProjections import aws.sdk.kotlin.gradle.codegen.dsl.smithyKotlinPlugin import aws.sdk.kotlin.gradle.sdk.* +import aws.sdk.kotlin.gradle.sdk.tasks.UpdatePackageManifest import aws.sdk.kotlin.gradle.util.typedProp import software.amazon.smithy.model.Model import software.amazon.smithy.model.shapes.ServiceShape import java.nio.file.Paths -import java.util.* import kotlin.streams.toList plugins { @@ -102,7 +102,13 @@ fun discoverServices(applyFilters: Boolean = true): List { logger.info("discover services called") val modelsDir: String by project val bootstrapConfig = bootstrap.takeIf { applyFilters } ?: BootstrapConfig.ALL - return fileTree(project.file(modelsDir)).mapNotNull(fileToService(project, bootstrapConfig)).also { + val pkgManifest = PackageManifest + .fromFile(file("packages.json")) + .apply { + validate() + } + + return fileTree(project.file(modelsDir)).mapNotNull(fileToService(project, bootstrapConfig, pkgManifest)).also { logger.lifecycle("discovered ${it.size} services") } } @@ -185,6 +191,11 @@ tasks.register("bootstrap") { finalizedBy(stageSdks) } +tasks.register("updatePackageManifest") { + group = "codegen" + description = "Add (or update) one or more services to packages.json manifest" +} + /** * Represents a type for a model that is sourced from aws-models */ diff --git a/codegen/sdk/packages.json b/codegen/sdk/packages.json new file mode 100644 index 00000000000..79579cf7a49 --- /dev/null +++ b/codegen/sdk/packages.json @@ -0,0 +1,2254 @@ +{ + "packages": [ + { + "sdkId": "ACM", + "namespace": "aws.sdk.kotlin.services.acm", + "artifactName": "acm", + "brazilName": "AwsSdkKotlinAcm" + }, + { + "sdkId": "ACM PCA", + "namespace": "aws.sdk.kotlin.services.acmpca", + "artifactName": "acmpca", + "brazilName": "AwsSdkKotlinAcmPca" + }, + { + "sdkId": "API Gateway", + "namespace": "aws.sdk.kotlin.services.apigateway", + "artifactName": "apigateway", + "brazilName": "AwsSdkKotlinApiGateway" + }, + { + "sdkId": "ARC Zonal Shift", + "namespace": "aws.sdk.kotlin.services.arczonalshift", + "artifactName": "arczonalshift", + "brazilName": "AwsSdkKotlinArcZonalShift" + }, + { + "sdkId": "AccessAnalyzer", + "namespace": "aws.sdk.kotlin.services.accessanalyzer", + "artifactName": "accessanalyzer", + "brazilName": "AwsSdkKotlinAccessanalyzer" + }, + { + "sdkId": "Account", + "namespace": "aws.sdk.kotlin.services.account", + "artifactName": "account", + "brazilName": "AwsSdkKotlinAccount" + }, + { + "sdkId": "Alexa For Business", + "namespace": "aws.sdk.kotlin.services.alexaforbusiness", + "artifactName": "alexaforbusiness", + "brazilName": "AwsSdkKotlinAlexaForBusiness" + }, + { + "sdkId": "Amplify", + "namespace": "aws.sdk.kotlin.services.amplify", + "artifactName": "amplify", + "brazilName": "AwsSdkKotlinAmplify" + }, + { + "sdkId": "AmplifyBackend", + "namespace": "aws.sdk.kotlin.services.amplifybackend", + "artifactName": "amplifybackend", + "brazilName": "AwsSdkKotlinAmplifybackend" + }, + { + "sdkId": "AmplifyUIBuilder", + "namespace": "aws.sdk.kotlin.services.amplifyuibuilder", + "artifactName": "amplifyuibuilder", + "brazilName": "AwsSdkKotlinAmplifyuibuilder" + }, + { + "sdkId": "ApiGatewayManagementApi", + "namespace": "aws.sdk.kotlin.services.apigatewaymanagementapi", + "artifactName": "apigatewaymanagementapi", + "brazilName": "AwsSdkKotlinApigatewaymanagementapi" + }, + { + "sdkId": "ApiGatewayV2", + "namespace": "aws.sdk.kotlin.services.apigatewayv2", + "artifactName": "apigatewayv2", + "brazilName": "AwsSdkKotlinApigatewayv2" + }, + { + "sdkId": "App Mesh", + "namespace": "aws.sdk.kotlin.services.appmesh", + "artifactName": "appmesh", + "brazilName": "AwsSdkKotlinAppMesh" + }, + { + "sdkId": "AppConfig", + "namespace": "aws.sdk.kotlin.services.appconfig", + "artifactName": "appconfig", + "brazilName": "AwsSdkKotlinAppconfig" + }, + { + "sdkId": "AppConfigData", + "namespace": "aws.sdk.kotlin.services.appconfigdata", + "artifactName": "appconfigdata", + "brazilName": "AwsSdkKotlinAppconfigdata" + }, + { + "sdkId": "AppFabric", + "namespace": "aws.sdk.kotlin.services.appfabric", + "artifactName": "appfabric", + "brazilName": "AwsSdkKotlinAppfabric" + }, + { + "sdkId": "AppIntegrations", + "namespace": "aws.sdk.kotlin.services.appintegrations", + "artifactName": "appintegrations", + "brazilName": "AwsSdkKotlinAppintegrations" + }, + { + "sdkId": "AppRunner", + "namespace": "aws.sdk.kotlin.services.apprunner", + "artifactName": "apprunner", + "brazilName": "AwsSdkKotlinApprunner" + }, + { + "sdkId": "AppStream", + "namespace": "aws.sdk.kotlin.services.appstream", + "artifactName": "appstream", + "brazilName": "AwsSdkKotlinAppstream" + }, + { + "sdkId": "AppSync", + "namespace": "aws.sdk.kotlin.services.appsync", + "artifactName": "appsync", + "brazilName": "AwsSdkKotlinAppsync" + }, + { + "sdkId": "Appflow", + "namespace": "aws.sdk.kotlin.services.appflow", + "artifactName": "appflow", + "brazilName": "AwsSdkKotlinAppflow" + }, + { + "sdkId": "Application Auto Scaling", + "namespace": "aws.sdk.kotlin.services.applicationautoscaling", + "artifactName": "applicationautoscaling", + "brazilName": "AwsSdkKotlinApplicationAutoScaling" + }, + { + "sdkId": "Application Discovery Service", + "namespace": "aws.sdk.kotlin.services.applicationdiscoveryservice", + "artifactName": "applicationdiscoveryservice", + "brazilName": "AwsSdkKotlinApplicationDiscoveryService" + }, + { + "sdkId": "Application Insights", + "namespace": "aws.sdk.kotlin.services.applicationinsights", + "artifactName": "applicationinsights", + "brazilName": "AwsSdkKotlinApplicationInsights" + }, + { + "sdkId": "ApplicationCostProfiler", + "namespace": "aws.sdk.kotlin.services.applicationcostprofiler", + "artifactName": "applicationcostprofiler", + "brazilName": "AwsSdkKotlinApplicationcostprofiler" + }, + { + "sdkId": "Athena", + "namespace": "aws.sdk.kotlin.services.athena", + "artifactName": "athena", + "brazilName": "AwsSdkKotlinAthena" + }, + { + "sdkId": "AuditManager", + "namespace": "aws.sdk.kotlin.services.auditmanager", + "artifactName": "auditmanager", + "brazilName": "AwsSdkKotlinAuditmanager" + }, + { + "sdkId": "Auto Scaling", + "namespace": "aws.sdk.kotlin.services.autoscaling", + "artifactName": "autoscaling", + "brazilName": "AwsSdkKotlinAutoScaling" + }, + { + "sdkId": "Auto Scaling Plans", + "namespace": "aws.sdk.kotlin.services.autoscalingplans", + "artifactName": "autoscalingplans", + "brazilName": "AwsSdkKotlinAutoScalingPlans" + }, + { + "sdkId": "BCM Data Exports", + "namespace": "aws.sdk.kotlin.services.bcmdataexports", + "artifactName": "bcmdataexports", + "brazilName": "AwsSdkKotlinBcmDataExports" + }, + { + "sdkId": "Backup", + "namespace": "aws.sdk.kotlin.services.backup", + "artifactName": "backup", + "brazilName": "AwsSdkKotlinBackup" + }, + { + "sdkId": "Backup Gateway", + "namespace": "aws.sdk.kotlin.services.backupgateway", + "artifactName": "backupgateway", + "brazilName": "AwsSdkKotlinBackupGateway" + }, + { + "sdkId": "BackupStorage", + "namespace": "aws.sdk.kotlin.services.backupstorage", + "artifactName": "backupstorage", + "brazilName": "AwsSdkKotlinBackupstorage" + }, + { + "sdkId": "Batch", + "namespace": "aws.sdk.kotlin.services.batch", + "artifactName": "batch", + "brazilName": "AwsSdkKotlinBatch" + }, + { + "sdkId": "Bedrock", + "namespace": "aws.sdk.kotlin.services.bedrock", + "artifactName": "bedrock", + "brazilName": "AwsSdkKotlinBedrock" + }, + { + "sdkId": "Bedrock Agent", + "namespace": "aws.sdk.kotlin.services.bedrockagent", + "artifactName": "bedrockagent", + "brazilName": "AwsSdkKotlinBedrockAgent" + }, + { + "sdkId": "Bedrock Agent Runtime", + "namespace": "aws.sdk.kotlin.services.bedrockagentruntime", + "artifactName": "bedrockagentruntime", + "brazilName": "AwsSdkKotlinBedrockAgentRuntime" + }, + { + "sdkId": "Bedrock Runtime", + "namespace": "aws.sdk.kotlin.services.bedrockruntime", + "artifactName": "bedrockruntime", + "brazilName": "AwsSdkKotlinBedrockRuntime" + }, + { + "sdkId": "Braket", + "namespace": "aws.sdk.kotlin.services.braket", + "artifactName": "braket", + "brazilName": "AwsSdkKotlinBraket" + }, + { + "sdkId": "Budgets", + "namespace": "aws.sdk.kotlin.services.budgets", + "artifactName": "budgets", + "brazilName": "AwsSdkKotlinBudgets" + }, + { + "sdkId": "Chime", + "namespace": "aws.sdk.kotlin.services.chime", + "artifactName": "chime", + "brazilName": "AwsSdkKotlinChime" + }, + { + "sdkId": "Chime SDK Identity", + "namespace": "aws.sdk.kotlin.services.chimesdkidentity", + "artifactName": "chimesdkidentity", + "brazilName": "AwsSdkKotlinChimeSdkIdentity" + }, + { + "sdkId": "Chime SDK Media Pipelines", + "namespace": "aws.sdk.kotlin.services.chimesdkmediapipelines", + "artifactName": "chimesdkmediapipelines", + "brazilName": "AwsSdkKotlinChimeSdkMediaPipelines" + }, + { + "sdkId": "Chime SDK Meetings", + "namespace": "aws.sdk.kotlin.services.chimesdkmeetings", + "artifactName": "chimesdkmeetings", + "brazilName": "AwsSdkKotlinChimeSdkMeetings" + }, + { + "sdkId": "Chime SDK Messaging", + "namespace": "aws.sdk.kotlin.services.chimesdkmessaging", + "artifactName": "chimesdkmessaging", + "brazilName": "AwsSdkKotlinChimeSdkMessaging" + }, + { + "sdkId": "Chime SDK Voice", + "namespace": "aws.sdk.kotlin.services.chimesdkvoice", + "artifactName": "chimesdkvoice", + "brazilName": "AwsSdkKotlinChimeSdkVoice" + }, + { + "sdkId": "CleanRooms", + "namespace": "aws.sdk.kotlin.services.cleanrooms", + "artifactName": "cleanrooms", + "brazilName": "AwsSdkKotlinCleanrooms" + }, + { + "sdkId": "CleanRoomsML", + "namespace": "aws.sdk.kotlin.services.cleanroomsml", + "artifactName": "cleanroomsml", + "brazilName": "AwsSdkKotlinCleanroomsml" + }, + { + "sdkId": "Cloud9", + "namespace": "aws.sdk.kotlin.services.cloud9", + "artifactName": "cloud9", + "brazilName": "AwsSdkKotlinCloud9" + }, + { + "sdkId": "CloudControl", + "namespace": "aws.sdk.kotlin.services.cloudcontrol", + "artifactName": "cloudcontrol", + "brazilName": "AwsSdkKotlinCloudcontrol" + }, + { + "sdkId": "CloudDirectory", + "namespace": "aws.sdk.kotlin.services.clouddirectory", + "artifactName": "clouddirectory", + "brazilName": "AwsSdkKotlinClouddirectory" + }, + { + "sdkId": "CloudFormation", + "namespace": "aws.sdk.kotlin.services.cloudformation", + "artifactName": "cloudformation", + "brazilName": "AwsSdkKotlinCloudformation" + }, + { + "sdkId": "CloudFront", + "namespace": "aws.sdk.kotlin.services.cloudfront", + "artifactName": "cloudfront", + "brazilName": "AwsSdkKotlinCloudfront" + }, + { + "sdkId": "CloudFront KeyValueStore", + "namespace": "aws.sdk.kotlin.services.cloudfrontkeyvaluestore", + "artifactName": "cloudfrontkeyvaluestore", + "brazilName": "AwsSdkKotlinCloudfrontKeyvaluestore" + }, + { + "sdkId": "CloudHSM", + "namespace": "aws.sdk.kotlin.services.cloudhsm", + "artifactName": "cloudhsm", + "brazilName": "AwsSdkKotlinCloudhsm" + }, + { + "sdkId": "CloudHSM V2", + "namespace": "aws.sdk.kotlin.services.cloudhsmv2", + "artifactName": "cloudhsmv2", + "brazilName": "AwsSdkKotlinCloudhsmV2" + }, + { + "sdkId": "CloudSearch", + "namespace": "aws.sdk.kotlin.services.cloudsearch", + "artifactName": "cloudsearch", + "brazilName": "AwsSdkKotlinCloudsearch" + }, + { + "sdkId": "CloudSearch Domain", + "namespace": "aws.sdk.kotlin.services.cloudsearchdomain", + "artifactName": "cloudsearchdomain", + "brazilName": "AwsSdkKotlinCloudsearchDomain" + }, + { + "sdkId": "CloudTrail", + "namespace": "aws.sdk.kotlin.services.cloudtrail", + "artifactName": "cloudtrail", + "brazilName": "AwsSdkKotlinCloudtrail" + }, + { + "sdkId": "CloudTrail Data", + "namespace": "aws.sdk.kotlin.services.cloudtraildata", + "artifactName": "cloudtraildata", + "brazilName": "AwsSdkKotlinCloudtrailData" + }, + { + "sdkId": "CloudWatch", + "namespace": "aws.sdk.kotlin.services.cloudwatch", + "artifactName": "cloudwatch", + "brazilName": "AwsSdkKotlinCloudwatch" + }, + { + "sdkId": "CloudWatch Events", + "namespace": "aws.sdk.kotlin.services.cloudwatchevents", + "artifactName": "cloudwatchevents", + "brazilName": "AwsSdkKotlinCloudwatchEvents" + }, + { + "sdkId": "CloudWatch Logs", + "namespace": "aws.sdk.kotlin.services.cloudwatchlogs", + "artifactName": "cloudwatchlogs", + "brazilName": "AwsSdkKotlinCloudwatchLogs" + }, + { + "sdkId": "CodeBuild", + "namespace": "aws.sdk.kotlin.services.codebuild", + "artifactName": "codebuild", + "brazilName": "AwsSdkKotlinCodebuild" + }, + { + "sdkId": "CodeCatalyst", + "namespace": "aws.sdk.kotlin.services.codecatalyst", + "artifactName": "codecatalyst", + "brazilName": "AwsSdkKotlinCodecatalyst" + }, + { + "sdkId": "CodeCommit", + "namespace": "aws.sdk.kotlin.services.codecommit", + "artifactName": "codecommit", + "brazilName": "AwsSdkKotlinCodecommit" + }, + { + "sdkId": "CodeDeploy", + "namespace": "aws.sdk.kotlin.services.codedeploy", + "artifactName": "codedeploy", + "brazilName": "AwsSdkKotlinCodedeploy" + }, + { + "sdkId": "CodeGuru Reviewer", + "namespace": "aws.sdk.kotlin.services.codegurureviewer", + "artifactName": "codegurureviewer", + "brazilName": "AwsSdkKotlinCodeguruReviewer" + }, + { + "sdkId": "CodeGuru Security", + "namespace": "aws.sdk.kotlin.services.codegurusecurity", + "artifactName": "codegurusecurity", + "brazilName": "AwsSdkKotlinCodeguruSecurity" + }, + { + "sdkId": "CodeGuruProfiler", + "namespace": "aws.sdk.kotlin.services.codeguruprofiler", + "artifactName": "codeguruprofiler", + "brazilName": "AwsSdkKotlinCodeguruprofiler" + }, + { + "sdkId": "CodePipeline", + "namespace": "aws.sdk.kotlin.services.codepipeline", + "artifactName": "codepipeline", + "brazilName": "AwsSdkKotlinCodepipeline" + }, + { + "sdkId": "CodeStar", + "namespace": "aws.sdk.kotlin.services.codestar", + "artifactName": "codestar", + "brazilName": "AwsSdkKotlinCodestar" + }, + { + "sdkId": "CodeStar connections", + "namespace": "aws.sdk.kotlin.services.codestarconnections", + "artifactName": "codestarconnections", + "brazilName": "AwsSdkKotlinCodestarConnections" + }, + { + "sdkId": "Cognito Identity", + "namespace": "aws.sdk.kotlin.services.cognitoidentity", + "artifactName": "cognitoidentity", + "brazilName": "AwsSdkKotlinCognitoIdentity" + }, + { + "sdkId": "Cognito Identity Provider", + "namespace": "aws.sdk.kotlin.services.cognitoidentityprovider", + "artifactName": "cognitoidentityprovider", + "brazilName": "AwsSdkKotlinCognitoIdentityProvider" + }, + { + "sdkId": "Cognito Sync", + "namespace": "aws.sdk.kotlin.services.cognitosync", + "artifactName": "cognitosync", + "brazilName": "AwsSdkKotlinCognitoSync" + }, + { + "sdkId": "Comprehend", + "namespace": "aws.sdk.kotlin.services.comprehend", + "artifactName": "comprehend", + "brazilName": "AwsSdkKotlinComprehend" + }, + { + "sdkId": "ComprehendMedical", + "namespace": "aws.sdk.kotlin.services.comprehendmedical", + "artifactName": "comprehendmedical", + "brazilName": "AwsSdkKotlinComprehendmedical" + }, + { + "sdkId": "Compute Optimizer", + "namespace": "aws.sdk.kotlin.services.computeoptimizer", + "artifactName": "computeoptimizer", + "brazilName": "AwsSdkKotlinComputeOptimizer" + }, + { + "sdkId": "Config Service", + "namespace": "aws.sdk.kotlin.services.configservice", + "artifactName": "configservice", + "brazilName": "AwsSdkKotlinConfigService" + }, + { + "sdkId": "Connect", + "namespace": "aws.sdk.kotlin.services.connect", + "artifactName": "connect", + "brazilName": "AwsSdkKotlinConnect" + }, + { + "sdkId": "Connect Contact Lens", + "namespace": "aws.sdk.kotlin.services.connectcontactlens", + "artifactName": "connectcontactlens", + "brazilName": "AwsSdkKotlinConnectContactLens" + }, + { + "sdkId": "ConnectCampaigns", + "namespace": "aws.sdk.kotlin.services.connectcampaigns", + "artifactName": "connectcampaigns", + "brazilName": "AwsSdkKotlinConnectcampaigns" + }, + { + "sdkId": "ConnectCases", + "namespace": "aws.sdk.kotlin.services.connectcases", + "artifactName": "connectcases", + "brazilName": "AwsSdkKotlinConnectcases" + }, + { + "sdkId": "ConnectParticipant", + "namespace": "aws.sdk.kotlin.services.connectparticipant", + "artifactName": "connectparticipant", + "brazilName": "AwsSdkKotlinConnectparticipant" + }, + { + "sdkId": "ControlTower", + "namespace": "aws.sdk.kotlin.services.controltower", + "artifactName": "controltower", + "brazilName": "AwsSdkKotlinControltower" + }, + { + "sdkId": "Cost Explorer", + "namespace": "aws.sdk.kotlin.services.costexplorer", + "artifactName": "costexplorer", + "brazilName": "AwsSdkKotlinCostExplorer" + }, + { + "sdkId": "Cost Optimization Hub", + "namespace": "aws.sdk.kotlin.services.costoptimizationhub", + "artifactName": "costoptimizationhub", + "brazilName": "AwsSdkKotlinCostOptimizationHub" + }, + { + "sdkId": "Cost and Usage Report Service", + "namespace": "aws.sdk.kotlin.services.costandusagereportservice", + "artifactName": "costandusagereportservice", + "brazilName": "AwsSdkKotlinCostAndUsageReportService" + }, + { + "sdkId": "Customer Profiles", + "namespace": "aws.sdk.kotlin.services.customerprofiles", + "artifactName": "customerprofiles", + "brazilName": "AwsSdkKotlinCustomerProfiles" + }, + { + "sdkId": "DAX", + "namespace": "aws.sdk.kotlin.services.dax", + "artifactName": "dax", + "brazilName": "AwsSdkKotlinDax" + }, + { + "sdkId": "DLM", + "namespace": "aws.sdk.kotlin.services.dlm", + "artifactName": "dlm", + "brazilName": "AwsSdkKotlinDlm" + }, + { + "sdkId": "Data Pipeline", + "namespace": "aws.sdk.kotlin.services.datapipeline", + "artifactName": "datapipeline", + "brazilName": "AwsSdkKotlinDataPipeline" + }, + { + "sdkId": "DataBrew", + "namespace": "aws.sdk.kotlin.services.databrew", + "artifactName": "databrew", + "brazilName": "AwsSdkKotlinDatabrew" + }, + { + "sdkId": "DataExchange", + "namespace": "aws.sdk.kotlin.services.dataexchange", + "artifactName": "dataexchange", + "brazilName": "AwsSdkKotlinDataexchange" + }, + { + "sdkId": "DataSync", + "namespace": "aws.sdk.kotlin.services.datasync", + "artifactName": "datasync", + "brazilName": "AwsSdkKotlinDatasync" + }, + { + "sdkId": "DataZone", + "namespace": "aws.sdk.kotlin.services.datazone", + "artifactName": "datazone", + "brazilName": "AwsSdkKotlinDatazone" + }, + { + "sdkId": "Database Migration Service", + "namespace": "aws.sdk.kotlin.services.databasemigrationservice", + "artifactName": "databasemigrationservice", + "brazilName": "AwsSdkKotlinDatabaseMigrationService" + }, + { + "sdkId": "Detective", + "namespace": "aws.sdk.kotlin.services.detective", + "artifactName": "detective", + "brazilName": "AwsSdkKotlinDetective" + }, + { + "sdkId": "DevOps Guru", + "namespace": "aws.sdk.kotlin.services.devopsguru", + "artifactName": "devopsguru", + "brazilName": "AwsSdkKotlinDevopsGuru" + }, + { + "sdkId": "Device Farm", + "namespace": "aws.sdk.kotlin.services.devicefarm", + "artifactName": "devicefarm", + "brazilName": "AwsSdkKotlinDeviceFarm" + }, + { + "sdkId": "Direct Connect", + "namespace": "aws.sdk.kotlin.services.directconnect", + "artifactName": "directconnect", + "brazilName": "AwsSdkKotlinDirectConnect" + }, + { + "sdkId": "Directory Service", + "namespace": "aws.sdk.kotlin.services.directoryservice", + "artifactName": "directoryservice", + "brazilName": "AwsSdkKotlinDirectoryService" + }, + { + "sdkId": "DocDB", + "namespace": "aws.sdk.kotlin.services.docdb", + "artifactName": "docdb", + "brazilName": "AwsSdkKotlinDocdb" + }, + { + "sdkId": "DocDB Elastic", + "namespace": "aws.sdk.kotlin.services.docdbelastic", + "artifactName": "docdbelastic", + "brazilName": "AwsSdkKotlinDocdbElastic" + }, + { + "sdkId": "DynamoDB", + "namespace": "aws.sdk.kotlin.services.dynamodb", + "artifactName": "dynamodb", + "brazilName": "AwsSdkKotlinDynamodb" + }, + { + "sdkId": "DynamoDB Streams", + "namespace": "aws.sdk.kotlin.services.dynamodbstreams", + "artifactName": "dynamodbstreams", + "brazilName": "AwsSdkKotlinDynamodbStreams" + }, + { + "sdkId": "EBS", + "namespace": "aws.sdk.kotlin.services.ebs", + "artifactName": "ebs", + "brazilName": "AwsSdkKotlinEbs" + }, + { + "sdkId": "EC2", + "namespace": "aws.sdk.kotlin.services.ec2", + "artifactName": "ec2", + "brazilName": "AwsSdkKotlinEc2" + }, + { + "sdkId": "EC2 Instance Connect", + "namespace": "aws.sdk.kotlin.services.ec2instanceconnect", + "artifactName": "ec2instanceconnect", + "brazilName": "AwsSdkKotlinEc2InstanceConnect" + }, + { + "sdkId": "ECR", + "namespace": "aws.sdk.kotlin.services.ecr", + "artifactName": "ecr", + "brazilName": "AwsSdkKotlinEcr" + }, + { + "sdkId": "ECR PUBLIC", + "namespace": "aws.sdk.kotlin.services.ecrpublic", + "artifactName": "ecrpublic", + "brazilName": "AwsSdkKotlinEcrPublic" + }, + { + "sdkId": "ECS", + "namespace": "aws.sdk.kotlin.services.ecs", + "artifactName": "ecs", + "brazilName": "AwsSdkKotlinEcs" + }, + { + "sdkId": "EFS", + "namespace": "aws.sdk.kotlin.services.efs", + "artifactName": "efs", + "brazilName": "AwsSdkKotlinEfs" + }, + { + "sdkId": "EKS", + "namespace": "aws.sdk.kotlin.services.eks", + "artifactName": "eks", + "brazilName": "AwsSdkKotlinEks" + }, + { + "sdkId": "EKS Auth", + "namespace": "aws.sdk.kotlin.services.eksauth", + "artifactName": "eksauth", + "brazilName": "AwsSdkKotlinEksAuth" + }, + { + "sdkId": "EMR", + "namespace": "aws.sdk.kotlin.services.emr", + "artifactName": "emr", + "brazilName": "AwsSdkKotlinEmr" + }, + { + "sdkId": "EMR Serverless", + "namespace": "aws.sdk.kotlin.services.emrserverless", + "artifactName": "emrserverless", + "brazilName": "AwsSdkKotlinEmrServerless" + }, + { + "sdkId": "EMR containers", + "namespace": "aws.sdk.kotlin.services.emrcontainers", + "artifactName": "emrcontainers", + "brazilName": "AwsSdkKotlinEmrContainers" + }, + { + "sdkId": "ElastiCache", + "namespace": "aws.sdk.kotlin.services.elasticache", + "artifactName": "elasticache", + "brazilName": "AwsSdkKotlinElasticache" + }, + { + "sdkId": "Elastic Beanstalk", + "namespace": "aws.sdk.kotlin.services.elasticbeanstalk", + "artifactName": "elasticbeanstalk", + "brazilName": "AwsSdkKotlinElasticBeanstalk" + }, + { + "sdkId": "Elastic Inference", + "namespace": "aws.sdk.kotlin.services.elasticinference", + "artifactName": "elasticinference", + "brazilName": "AwsSdkKotlinElasticInference" + }, + { + "sdkId": "Elastic Load Balancing", + "namespace": "aws.sdk.kotlin.services.elasticloadbalancing", + "artifactName": "elasticloadbalancing", + "brazilName": "AwsSdkKotlinElasticLoadBalancing" + }, + { + "sdkId": "Elastic Load Balancing v2", + "namespace": "aws.sdk.kotlin.services.elasticloadbalancingv2", + "artifactName": "elasticloadbalancingv2", + "brazilName": "AwsSdkKotlinElasticLoadBalancingV2" + }, + { + "sdkId": "Elastic Transcoder", + "namespace": "aws.sdk.kotlin.services.elastictranscoder", + "artifactName": "elastictranscoder", + "brazilName": "AwsSdkKotlinElasticTranscoder" + }, + { + "sdkId": "Elasticsearch Service", + "namespace": "aws.sdk.kotlin.services.elasticsearchservice", + "artifactName": "elasticsearchservice", + "brazilName": "AwsSdkKotlinElasticsearchService" + }, + { + "sdkId": "EntityResolution", + "namespace": "aws.sdk.kotlin.services.entityresolution", + "artifactName": "entityresolution", + "brazilName": "AwsSdkKotlinEntityresolution" + }, + { + "sdkId": "EventBridge", + "namespace": "aws.sdk.kotlin.services.eventbridge", + "artifactName": "eventbridge", + "brazilName": "AwsSdkKotlinEventbridge" + }, + { + "sdkId": "Evidently", + "namespace": "aws.sdk.kotlin.services.evidently", + "artifactName": "evidently", + "brazilName": "AwsSdkKotlinEvidently" + }, + { + "sdkId": "FMS", + "namespace": "aws.sdk.kotlin.services.fms", + "artifactName": "fms", + "brazilName": "AwsSdkKotlinFms" + }, + { + "sdkId": "FSx", + "namespace": "aws.sdk.kotlin.services.fsx", + "artifactName": "fsx", + "brazilName": "AwsSdkKotlinFsx" + }, + { + "sdkId": "Firehose", + "namespace": "aws.sdk.kotlin.services.firehose", + "artifactName": "firehose", + "brazilName": "AwsSdkKotlinFirehose" + }, + { + "sdkId": "FraudDetector", + "namespace": "aws.sdk.kotlin.services.frauddetector", + "artifactName": "frauddetector", + "brazilName": "AwsSdkKotlinFrauddetector" + }, + { + "sdkId": "FreeTier", + "namespace": "aws.sdk.kotlin.services.freetier", + "artifactName": "freetier", + "brazilName": "AwsSdkKotlinFreetier" + }, + { + "sdkId": "GameLift", + "namespace": "aws.sdk.kotlin.services.gamelift", + "artifactName": "gamelift", + "brazilName": "AwsSdkKotlinGamelift" + }, + { + "sdkId": "Glacier", + "namespace": "aws.sdk.kotlin.services.glacier", + "artifactName": "glacier", + "brazilName": "AwsSdkKotlinGlacier" + }, + { + "sdkId": "Global Accelerator", + "namespace": "aws.sdk.kotlin.services.globalaccelerator", + "artifactName": "globalaccelerator", + "brazilName": "AwsSdkKotlinGlobalAccelerator" + }, + { + "sdkId": "Glue", + "namespace": "aws.sdk.kotlin.services.glue", + "artifactName": "glue", + "brazilName": "AwsSdkKotlinGlue" + }, + { + "sdkId": "Greengrass", + "namespace": "aws.sdk.kotlin.services.greengrass", + "artifactName": "greengrass", + "brazilName": "AwsSdkKotlinGreengrass" + }, + { + "sdkId": "GreengrassV2", + "namespace": "aws.sdk.kotlin.services.greengrassv2", + "artifactName": "greengrassv2", + "brazilName": "AwsSdkKotlinGreengrassv2" + }, + { + "sdkId": "GroundStation", + "namespace": "aws.sdk.kotlin.services.groundstation", + "artifactName": "groundstation", + "brazilName": "AwsSdkKotlinGroundstation" + }, + { + "sdkId": "GuardDuty", + "namespace": "aws.sdk.kotlin.services.guardduty", + "artifactName": "guardduty", + "brazilName": "AwsSdkKotlinGuardduty" + }, + { + "sdkId": "Health", + "namespace": "aws.sdk.kotlin.services.health", + "artifactName": "health", + "brazilName": "AwsSdkKotlinHealth" + }, + { + "sdkId": "HealthLake", + "namespace": "aws.sdk.kotlin.services.healthlake", + "artifactName": "healthlake", + "brazilName": "AwsSdkKotlinHealthlake" + }, + { + "sdkId": "Honeycode", + "namespace": "aws.sdk.kotlin.services.honeycode", + "artifactName": "honeycode", + "brazilName": "AwsSdkKotlinHoneycode" + }, + { + "sdkId": "IAM", + "namespace": "aws.sdk.kotlin.services.iam", + "artifactName": "iam", + "brazilName": "AwsSdkKotlinIam" + }, + { + "sdkId": "IVS RealTime", + "namespace": "aws.sdk.kotlin.services.ivsrealtime", + "artifactName": "ivsrealtime", + "brazilName": "AwsSdkKotlinIvsRealtime" + }, + { + "sdkId": "Inspector", + "namespace": "aws.sdk.kotlin.services.inspector", + "artifactName": "inspector", + "brazilName": "AwsSdkKotlinInspector" + }, + { + "sdkId": "Inspector Scan", + "namespace": "aws.sdk.kotlin.services.inspectorscan", + "artifactName": "inspectorscan", + "brazilName": "AwsSdkKotlinInspectorScan" + }, + { + "sdkId": "Inspector2", + "namespace": "aws.sdk.kotlin.services.inspector2", + "artifactName": "inspector2", + "brazilName": "AwsSdkKotlinInspector2" + }, + { + "sdkId": "InternetMonitor", + "namespace": "aws.sdk.kotlin.services.internetmonitor", + "artifactName": "internetmonitor", + "brazilName": "AwsSdkKotlinInternetmonitor" + }, + { + "sdkId": "IoT", + "namespace": "aws.sdk.kotlin.services.iot", + "artifactName": "iot", + "brazilName": "AwsSdkKotlinIot" + }, + { + "sdkId": "IoT 1Click Devices Service", + "namespace": "aws.sdk.kotlin.services.iot1clickdevicesservice", + "artifactName": "iot1clickdevicesservice", + "brazilName": "AwsSdkKotlinIot1clickDevicesService" + }, + { + "sdkId": "IoT 1Click Projects", + "namespace": "aws.sdk.kotlin.services.iot1clickprojects", + "artifactName": "iot1clickprojects", + "brazilName": "AwsSdkKotlinIot1clickProjects" + }, + { + "sdkId": "IoT Data Plane", + "namespace": "aws.sdk.kotlin.services.iotdataplane", + "artifactName": "iotdataplane", + "brazilName": "AwsSdkKotlinIotDataPlane" + }, + { + "sdkId": "IoT Events", + "namespace": "aws.sdk.kotlin.services.iotevents", + "artifactName": "iotevents", + "brazilName": "AwsSdkKotlinIotEvents" + }, + { + "sdkId": "IoT Events Data", + "namespace": "aws.sdk.kotlin.services.ioteventsdata", + "artifactName": "ioteventsdata", + "brazilName": "AwsSdkKotlinIotEventsData" + }, + { + "sdkId": "IoT Jobs Data Plane", + "namespace": "aws.sdk.kotlin.services.iotjobsdataplane", + "artifactName": "iotjobsdataplane", + "brazilName": "AwsSdkKotlinIotJobsDataPlane" + }, + { + "sdkId": "IoT RoboRunner", + "namespace": "aws.sdk.kotlin.services.iotroborunner", + "artifactName": "iotroborunner", + "brazilName": "AwsSdkKotlinIotRoborunner" + }, + { + "sdkId": "IoT Wireless", + "namespace": "aws.sdk.kotlin.services.iotwireless", + "artifactName": "iotwireless", + "brazilName": "AwsSdkKotlinIotWireless" + }, + { + "sdkId": "IoTAnalytics", + "namespace": "aws.sdk.kotlin.services.iotanalytics", + "artifactName": "iotanalytics", + "brazilName": "AwsSdkKotlinIotanalytics" + }, + { + "sdkId": "IoTFleetHub", + "namespace": "aws.sdk.kotlin.services.iotfleethub", + "artifactName": "iotfleethub", + "brazilName": "AwsSdkKotlinIotfleethub" + }, + { + "sdkId": "IoTFleetWise", + "namespace": "aws.sdk.kotlin.services.iotfleetwise", + "artifactName": "iotfleetwise", + "brazilName": "AwsSdkKotlinIotfleetwise" + }, + { + "sdkId": "IoTSecureTunneling", + "namespace": "aws.sdk.kotlin.services.iotsecuretunneling", + "artifactName": "iotsecuretunneling", + "brazilName": "AwsSdkKotlinIotsecuretunneling" + }, + { + "sdkId": "IoTSiteWise", + "namespace": "aws.sdk.kotlin.services.iotsitewise", + "artifactName": "iotsitewise", + "brazilName": "AwsSdkKotlinIotsitewise" + }, + { + "sdkId": "IoTThingsGraph", + "namespace": "aws.sdk.kotlin.services.iotthingsgraph", + "artifactName": "iotthingsgraph", + "brazilName": "AwsSdkKotlinIotthingsgraph" + }, + { + "sdkId": "IoTTwinMaker", + "namespace": "aws.sdk.kotlin.services.iottwinmaker", + "artifactName": "iottwinmaker", + "brazilName": "AwsSdkKotlinIottwinmaker" + }, + { + "sdkId": "IotDeviceAdvisor", + "namespace": "aws.sdk.kotlin.services.iotdeviceadvisor", + "artifactName": "iotdeviceadvisor", + "brazilName": "AwsSdkKotlinIotdeviceadvisor" + }, + { + "sdkId": "KMS", + "namespace": "aws.sdk.kotlin.services.kms", + "artifactName": "kms", + "brazilName": "AwsSdkKotlinKms" + }, + { + "sdkId": "Kafka", + "namespace": "aws.sdk.kotlin.services.kafka", + "artifactName": "kafka", + "brazilName": "AwsSdkKotlinKafka" + }, + { + "sdkId": "KafkaConnect", + "namespace": "aws.sdk.kotlin.services.kafkaconnect", + "artifactName": "kafkaconnect", + "brazilName": "AwsSdkKotlinKafkaconnect" + }, + { + "sdkId": "Kendra Ranking", + "namespace": "aws.sdk.kotlin.services.kendraranking", + "artifactName": "kendraranking", + "brazilName": "AwsSdkKotlinKendraRanking" + }, + { + "sdkId": "Keyspaces", + "namespace": "aws.sdk.kotlin.services.keyspaces", + "artifactName": "keyspaces", + "brazilName": "AwsSdkKotlinKeyspaces" + }, + { + "sdkId": "Kinesis", + "namespace": "aws.sdk.kotlin.services.kinesis", + "artifactName": "kinesis", + "brazilName": "AwsSdkKotlinKinesis" + }, + { + "sdkId": "Kinesis Analytics", + "namespace": "aws.sdk.kotlin.services.kinesisanalytics", + "artifactName": "kinesisanalytics", + "brazilName": "AwsSdkKotlinKinesisAnalytics" + }, + { + "sdkId": "Kinesis Analytics V2", + "namespace": "aws.sdk.kotlin.services.kinesisanalyticsv2", + "artifactName": "kinesisanalyticsv2", + "brazilName": "AwsSdkKotlinKinesisAnalyticsV2" + }, + { + "sdkId": "Kinesis Video", + "namespace": "aws.sdk.kotlin.services.kinesisvideo", + "artifactName": "kinesisvideo", + "brazilName": "AwsSdkKotlinKinesisVideo" + }, + { + "sdkId": "Kinesis Video Archived Media", + "namespace": "aws.sdk.kotlin.services.kinesisvideoarchivedmedia", + "artifactName": "kinesisvideoarchivedmedia", + "brazilName": "AwsSdkKotlinKinesisVideoArchivedMedia" + }, + { + "sdkId": "Kinesis Video Media", + "namespace": "aws.sdk.kotlin.services.kinesisvideomedia", + "artifactName": "kinesisvideomedia", + "brazilName": "AwsSdkKotlinKinesisVideoMedia" + }, + { + "sdkId": "Kinesis Video Signaling", + "namespace": "aws.sdk.kotlin.services.kinesisvideosignaling", + "artifactName": "kinesisvideosignaling", + "brazilName": "AwsSdkKotlinKinesisVideoSignaling" + }, + { + "sdkId": "Kinesis Video WebRTC Storage", + "namespace": "aws.sdk.kotlin.services.kinesisvideowebrtcstorage", + "artifactName": "kinesisvideowebrtcstorage", + "brazilName": "AwsSdkKotlinKinesisVideoWebrtcStorage" + }, + { + "sdkId": "LakeFormation", + "namespace": "aws.sdk.kotlin.services.lakeformation", + "artifactName": "lakeformation", + "brazilName": "AwsSdkKotlinLakeformation" + }, + { + "sdkId": "Lambda", + "namespace": "aws.sdk.kotlin.services.lambda", + "artifactName": "lambda", + "brazilName": "AwsSdkKotlinLambda" + }, + { + "sdkId": "Lex Model Building Service", + "namespace": "aws.sdk.kotlin.services.lexmodelbuildingservice", + "artifactName": "lexmodelbuildingservice", + "brazilName": "AwsSdkKotlinLexModelBuildingService" + }, + { + "sdkId": "Lex Models V2", + "namespace": "aws.sdk.kotlin.services.lexmodelsv2", + "artifactName": "lexmodelsv2", + "brazilName": "AwsSdkKotlinLexModelsV2" + }, + { + "sdkId": "Lex Runtime Service", + "namespace": "aws.sdk.kotlin.services.lexruntimeservice", + "artifactName": "lexruntimeservice", + "brazilName": "AwsSdkKotlinLexRuntimeService" + }, + { + "sdkId": "Lex Runtime V2", + "namespace": "aws.sdk.kotlin.services.lexruntimev2", + "artifactName": "lexruntimev2", + "brazilName": "AwsSdkKotlinLexRuntimeV2" + }, + { + "sdkId": "License Manager", + "namespace": "aws.sdk.kotlin.services.licensemanager", + "artifactName": "licensemanager", + "brazilName": "AwsSdkKotlinLicenseManager" + }, + { + "sdkId": "License Manager Linux Subscriptions", + "namespace": "aws.sdk.kotlin.services.licensemanagerlinuxsubscriptions", + "artifactName": "licensemanagerlinuxsubscriptions", + "brazilName": "AwsSdkKotlinLicenseManagerLinuxSubscriptions" + }, + { + "sdkId": "License Manager User Subscriptions", + "namespace": "aws.sdk.kotlin.services.licensemanagerusersubscriptions", + "artifactName": "licensemanagerusersubscriptions", + "brazilName": "AwsSdkKotlinLicenseManagerUserSubscriptions" + }, + { + "sdkId": "Lightsail", + "namespace": "aws.sdk.kotlin.services.lightsail", + "artifactName": "lightsail", + "brazilName": "AwsSdkKotlinLightsail" + }, + { + "sdkId": "Location", + "namespace": "aws.sdk.kotlin.services.location", + "artifactName": "location", + "brazilName": "AwsSdkKotlinLocation" + }, + { + "sdkId": "LookoutEquipment", + "namespace": "aws.sdk.kotlin.services.lookoutequipment", + "artifactName": "lookoutequipment", + "brazilName": "AwsSdkKotlinLookoutequipment" + }, + { + "sdkId": "LookoutMetrics", + "namespace": "aws.sdk.kotlin.services.lookoutmetrics", + "artifactName": "lookoutmetrics", + "brazilName": "AwsSdkKotlinLookoutmetrics" + }, + { + "sdkId": "LookoutVision", + "namespace": "aws.sdk.kotlin.services.lookoutvision", + "artifactName": "lookoutvision", + "brazilName": "AwsSdkKotlinLookoutvision" + }, + { + "sdkId": "MTurk", + "namespace": "aws.sdk.kotlin.services.mturk", + "artifactName": "mturk", + "brazilName": "AwsSdkKotlinMturk" + }, + { + "sdkId": "MWAA", + "namespace": "aws.sdk.kotlin.services.mwaa", + "artifactName": "mwaa", + "brazilName": "AwsSdkKotlinMwaa" + }, + { + "sdkId": "Machine Learning", + "namespace": "aws.sdk.kotlin.services.machinelearning", + "artifactName": "machinelearning", + "brazilName": "AwsSdkKotlinMachineLearning" + }, + { + "sdkId": "Macie2", + "namespace": "aws.sdk.kotlin.services.macie2", + "artifactName": "macie2", + "brazilName": "AwsSdkKotlinMacie2" + }, + { + "sdkId": "ManagedBlockchain", + "namespace": "aws.sdk.kotlin.services.managedblockchain", + "artifactName": "managedblockchain", + "brazilName": "AwsSdkKotlinManagedblockchain" + }, + { + "sdkId": "ManagedBlockchain Query", + "namespace": "aws.sdk.kotlin.services.managedblockchainquery", + "artifactName": "managedblockchainquery", + "brazilName": "AwsSdkKotlinManagedblockchainQuery" + }, + { + "sdkId": "Marketplace Agreement", + "namespace": "aws.sdk.kotlin.services.marketplaceagreement", + "artifactName": "marketplaceagreement", + "brazilName": "AwsSdkKotlinMarketplaceAgreement" + }, + { + "sdkId": "Marketplace Catalog", + "namespace": "aws.sdk.kotlin.services.marketplacecatalog", + "artifactName": "marketplacecatalog", + "brazilName": "AwsSdkKotlinMarketplaceCatalog" + }, + { + "sdkId": "Marketplace Commerce Analytics", + "namespace": "aws.sdk.kotlin.services.marketplacecommerceanalytics", + "artifactName": "marketplacecommerceanalytics", + "brazilName": "AwsSdkKotlinMarketplaceCommerceAnalytics" + }, + { + "sdkId": "Marketplace Deployment", + "namespace": "aws.sdk.kotlin.services.marketplacedeployment", + "artifactName": "marketplacedeployment", + "brazilName": "AwsSdkKotlinMarketplaceDeployment" + }, + { + "sdkId": "Marketplace Entitlement Service", + "namespace": "aws.sdk.kotlin.services.marketplaceentitlementservice", + "artifactName": "marketplaceentitlementservice", + "brazilName": "AwsSdkKotlinMarketplaceEntitlementService" + }, + { + "sdkId": "Marketplace Metering", + "namespace": "aws.sdk.kotlin.services.marketplacemetering", + "artifactName": "marketplacemetering", + "brazilName": "AwsSdkKotlinMarketplaceMetering" + }, + { + "sdkId": "MediaConnect", + "namespace": "aws.sdk.kotlin.services.mediaconnect", + "artifactName": "mediaconnect", + "brazilName": "AwsSdkKotlinMediaconnect" + }, + { + "sdkId": "MediaConvert", + "namespace": "aws.sdk.kotlin.services.mediaconvert", + "artifactName": "mediaconvert", + "brazilName": "AwsSdkKotlinMediaconvert" + }, + { + "sdkId": "MediaLive", + "namespace": "aws.sdk.kotlin.services.medialive", + "artifactName": "medialive", + "brazilName": "AwsSdkKotlinMedialive" + }, + { + "sdkId": "MediaPackage", + "namespace": "aws.sdk.kotlin.services.mediapackage", + "artifactName": "mediapackage", + "brazilName": "AwsSdkKotlinMediapackage" + }, + { + "sdkId": "MediaPackage Vod", + "namespace": "aws.sdk.kotlin.services.mediapackagevod", + "artifactName": "mediapackagevod", + "brazilName": "AwsSdkKotlinMediapackageVod" + }, + { + "sdkId": "MediaPackageV2", + "namespace": "aws.sdk.kotlin.services.mediapackagev2", + "artifactName": "mediapackagev2", + "brazilName": "AwsSdkKotlinMediapackagev2" + }, + { + "sdkId": "MediaStore", + "namespace": "aws.sdk.kotlin.services.mediastore", + "artifactName": "mediastore", + "brazilName": "AwsSdkKotlinMediastore" + }, + { + "sdkId": "MediaStore Data", + "namespace": "aws.sdk.kotlin.services.mediastoredata", + "artifactName": "mediastoredata", + "brazilName": "AwsSdkKotlinMediastoreData" + }, + { + "sdkId": "MediaTailor", + "namespace": "aws.sdk.kotlin.services.mediatailor", + "artifactName": "mediatailor", + "brazilName": "AwsSdkKotlinMediatailor" + }, + { + "sdkId": "Medical Imaging", + "namespace": "aws.sdk.kotlin.services.medicalimaging", + "artifactName": "medicalimaging", + "brazilName": "AwsSdkKotlinMedicalImaging" + }, + { + "sdkId": "MemoryDB", + "namespace": "aws.sdk.kotlin.services.memorydb", + "artifactName": "memorydb", + "brazilName": "AwsSdkKotlinMemorydb" + }, + { + "sdkId": "Migration Hub", + "namespace": "aws.sdk.kotlin.services.migrationhub", + "artifactName": "migrationhub", + "brazilName": "AwsSdkKotlinMigrationHub" + }, + { + "sdkId": "Migration Hub Refactor Spaces", + "namespace": "aws.sdk.kotlin.services.migrationhubrefactorspaces", + "artifactName": "migrationhubrefactorspaces", + "brazilName": "AwsSdkKotlinMigrationHubRefactorSpaces" + }, + { + "sdkId": "MigrationHub Config", + "namespace": "aws.sdk.kotlin.services.migrationhubconfig", + "artifactName": "migrationhubconfig", + "brazilName": "AwsSdkKotlinMigrationhubConfig" + }, + { + "sdkId": "MigrationHubOrchestrator", + "namespace": "aws.sdk.kotlin.services.migrationhuborchestrator", + "artifactName": "migrationhuborchestrator", + "brazilName": "AwsSdkKotlinMigrationhuborchestrator" + }, + { + "sdkId": "MigrationHubStrategy", + "namespace": "aws.sdk.kotlin.services.migrationhubstrategy", + "artifactName": "migrationhubstrategy", + "brazilName": "AwsSdkKotlinMigrationhubstrategy" + }, + { + "sdkId": "Mobile", + "namespace": "aws.sdk.kotlin.services.mobile", + "artifactName": "mobile", + "brazilName": "AwsSdkKotlinMobile" + }, + { + "sdkId": "Neptune", + "namespace": "aws.sdk.kotlin.services.neptune", + "artifactName": "neptune", + "brazilName": "AwsSdkKotlinNeptune" + }, + { + "sdkId": "Neptune Graph", + "namespace": "aws.sdk.kotlin.services.neptunegraph", + "artifactName": "neptunegraph", + "brazilName": "AwsSdkKotlinNeptuneGraph" + }, + { + "sdkId": "Network Firewall", + "namespace": "aws.sdk.kotlin.services.networkfirewall", + "artifactName": "networkfirewall", + "brazilName": "AwsSdkKotlinNetworkFirewall" + }, + { + "sdkId": "NetworkManager", + "namespace": "aws.sdk.kotlin.services.networkmanager", + "artifactName": "networkmanager", + "brazilName": "AwsSdkKotlinNetworkmanager" + }, + { + "sdkId": "NetworkMonitor", + "namespace": "aws.sdk.kotlin.services.networkmonitor", + "artifactName": "networkmonitor", + "brazilName": "AwsSdkKotlinNetworkmonitor" + }, + { + "sdkId": "OAM", + "namespace": "aws.sdk.kotlin.services.oam", + "artifactName": "oam", + "brazilName": "AwsSdkKotlinOam" + }, + { + "sdkId": "OSIS", + "namespace": "aws.sdk.kotlin.services.osis", + "artifactName": "osis", + "brazilName": "AwsSdkKotlinOsis" + }, + { + "sdkId": "Omics", + "namespace": "aws.sdk.kotlin.services.omics", + "artifactName": "omics", + "brazilName": "AwsSdkKotlinOmics" + }, + { + "sdkId": "OpenSearch", + "namespace": "aws.sdk.kotlin.services.opensearch", + "artifactName": "opensearch", + "brazilName": "AwsSdkKotlinOpensearch" + }, + { + "sdkId": "OpenSearchServerless", + "namespace": "aws.sdk.kotlin.services.opensearchserverless", + "artifactName": "opensearchserverless", + "brazilName": "AwsSdkKotlinOpensearchserverless" + }, + { + "sdkId": "OpsWorks", + "namespace": "aws.sdk.kotlin.services.opsworks", + "artifactName": "opsworks", + "brazilName": "AwsSdkKotlinOpsworks" + }, + { + "sdkId": "OpsWorksCM", + "namespace": "aws.sdk.kotlin.services.opsworkscm", + "artifactName": "opsworkscm", + "brazilName": "AwsSdkKotlinOpsworkscm" + }, + { + "sdkId": "Organizations", + "namespace": "aws.sdk.kotlin.services.organizations", + "artifactName": "organizations", + "brazilName": "AwsSdkKotlinOrganizations" + }, + { + "sdkId": "Outposts", + "namespace": "aws.sdk.kotlin.services.outposts", + "artifactName": "outposts", + "brazilName": "AwsSdkKotlinOutposts" + }, + { + "sdkId": "PI", + "namespace": "aws.sdk.kotlin.services.pi", + "artifactName": "pi", + "brazilName": "AwsSdkKotlinPi" + }, + { + "sdkId": "Panorama", + "namespace": "aws.sdk.kotlin.services.panorama", + "artifactName": "panorama", + "brazilName": "AwsSdkKotlinPanorama" + }, + { + "sdkId": "Payment Cryptography", + "namespace": "aws.sdk.kotlin.services.paymentcryptography", + "artifactName": "paymentcryptography", + "brazilName": "AwsSdkKotlinPaymentCryptography" + }, + { + "sdkId": "Payment Cryptography Data", + "namespace": "aws.sdk.kotlin.services.paymentcryptographydata", + "artifactName": "paymentcryptographydata", + "brazilName": "AwsSdkKotlinPaymentCryptographyData" + }, + { + "sdkId": "Pca Connector Ad", + "namespace": "aws.sdk.kotlin.services.pcaconnectorad", + "artifactName": "pcaconnectorad", + "brazilName": "AwsSdkKotlinPcaConnectorAd" + }, + { + "sdkId": "Personalize", + "namespace": "aws.sdk.kotlin.services.personalize", + "artifactName": "personalize", + "brazilName": "AwsSdkKotlinPersonalize" + }, + { + "sdkId": "Personalize Events", + "namespace": "aws.sdk.kotlin.services.personalizeevents", + "artifactName": "personalizeevents", + "brazilName": "AwsSdkKotlinPersonalizeEvents" + }, + { + "sdkId": "Personalize Runtime", + "namespace": "aws.sdk.kotlin.services.personalizeruntime", + "artifactName": "personalizeruntime", + "brazilName": "AwsSdkKotlinPersonalizeRuntime" + }, + { + "sdkId": "Pinpoint", + "namespace": "aws.sdk.kotlin.services.pinpoint", + "artifactName": "pinpoint", + "brazilName": "AwsSdkKotlinPinpoint" + }, + { + "sdkId": "Pinpoint Email", + "namespace": "aws.sdk.kotlin.services.pinpointemail", + "artifactName": "pinpointemail", + "brazilName": "AwsSdkKotlinPinpointEmail" + }, + { + "sdkId": "Pinpoint SMS Voice", + "namespace": "aws.sdk.kotlin.services.pinpointsmsvoice", + "artifactName": "pinpointsmsvoice", + "brazilName": "AwsSdkKotlinPinpointSmsVoice" + }, + { + "sdkId": "Pinpoint SMS Voice V2", + "namespace": "aws.sdk.kotlin.services.pinpointsmsvoicev2", + "artifactName": "pinpointsmsvoicev2", + "brazilName": "AwsSdkKotlinPinpointSmsVoiceV2" + }, + { + "sdkId": "Pipes", + "namespace": "aws.sdk.kotlin.services.pipes", + "artifactName": "pipes", + "brazilName": "AwsSdkKotlinPipes" + }, + { + "sdkId": "Polly", + "namespace": "aws.sdk.kotlin.services.polly", + "artifactName": "polly", + "brazilName": "AwsSdkKotlinPolly" + }, + { + "sdkId": "Pricing", + "namespace": "aws.sdk.kotlin.services.pricing", + "artifactName": "pricing", + "brazilName": "AwsSdkKotlinPricing" + }, + { + "sdkId": "PrivateNetworks", + "namespace": "aws.sdk.kotlin.services.privatenetworks", + "artifactName": "privatenetworks", + "brazilName": "AwsSdkKotlinPrivatenetworks" + }, + { + "sdkId": "Proton", + "namespace": "aws.sdk.kotlin.services.proton", + "artifactName": "proton", + "brazilName": "AwsSdkKotlinProton" + }, + { + "sdkId": "QBusiness", + "namespace": "aws.sdk.kotlin.services.qbusiness", + "artifactName": "qbusiness", + "brazilName": "AwsSdkKotlinQbusiness" + }, + { + "sdkId": "QConnect", + "namespace": "aws.sdk.kotlin.services.qconnect", + "artifactName": "qconnect", + "brazilName": "AwsSdkKotlinQconnect" + }, + { + "sdkId": "QLDB", + "namespace": "aws.sdk.kotlin.services.qldb", + "artifactName": "qldb", + "brazilName": "AwsSdkKotlinQldb" + }, + { + "sdkId": "QLDB Session", + "namespace": "aws.sdk.kotlin.services.qldbsession", + "artifactName": "qldbsession", + "brazilName": "AwsSdkKotlinQldbSession" + }, + { + "sdkId": "QuickSight", + "namespace": "aws.sdk.kotlin.services.quicksight", + "artifactName": "quicksight", + "brazilName": "AwsSdkKotlinQuicksight" + }, + { + "sdkId": "RAM", + "namespace": "aws.sdk.kotlin.services.ram", + "artifactName": "ram", + "brazilName": "AwsSdkKotlinRam" + }, + { + "sdkId": "RDS", + "namespace": "aws.sdk.kotlin.services.rds", + "artifactName": "rds", + "brazilName": "AwsSdkKotlinRds" + }, + { + "sdkId": "RDS Data", + "namespace": "aws.sdk.kotlin.services.rdsdata", + "artifactName": "rdsdata", + "brazilName": "AwsSdkKotlinRdsData" + }, + { + "sdkId": "RUM", + "namespace": "aws.sdk.kotlin.services.rum", + "artifactName": "rum", + "brazilName": "AwsSdkKotlinRum" + }, + { + "sdkId": "Redshift", + "namespace": "aws.sdk.kotlin.services.redshift", + "artifactName": "redshift", + "brazilName": "AwsSdkKotlinRedshift" + }, + { + "sdkId": "Redshift Data", + "namespace": "aws.sdk.kotlin.services.redshiftdata", + "artifactName": "redshiftdata", + "brazilName": "AwsSdkKotlinRedshiftData" + }, + { + "sdkId": "Redshift Serverless", + "namespace": "aws.sdk.kotlin.services.redshiftserverless", + "artifactName": "redshiftserverless", + "brazilName": "AwsSdkKotlinRedshiftServerless" + }, + { + "sdkId": "Rekognition", + "namespace": "aws.sdk.kotlin.services.rekognition", + "artifactName": "rekognition", + "brazilName": "AwsSdkKotlinRekognition" + }, + { + "sdkId": "Resource Explorer 2", + "namespace": "aws.sdk.kotlin.services.resourceexplorer2", + "artifactName": "resourceexplorer2", + "brazilName": "AwsSdkKotlinResourceExplorer2" + }, + { + "sdkId": "Resource Groups", + "namespace": "aws.sdk.kotlin.services.resourcegroups", + "artifactName": "resourcegroups", + "brazilName": "AwsSdkKotlinResourceGroups" + }, + { + "sdkId": "Resource Groups Tagging API", + "namespace": "aws.sdk.kotlin.services.resourcegroupstaggingapi", + "artifactName": "resourcegroupstaggingapi", + "brazilName": "AwsSdkKotlinResourceGroupsTaggingApi" + }, + { + "sdkId": "RoboMaker", + "namespace": "aws.sdk.kotlin.services.robomaker", + "artifactName": "robomaker", + "brazilName": "AwsSdkKotlinRobomaker" + }, + { + "sdkId": "RolesAnywhere", + "namespace": "aws.sdk.kotlin.services.rolesanywhere", + "artifactName": "rolesanywhere", + "brazilName": "AwsSdkKotlinRolesanywhere" + }, + { + "sdkId": "Route 53", + "namespace": "aws.sdk.kotlin.services.route53", + "artifactName": "route53", + "brazilName": "AwsSdkKotlinRoute53" + }, + { + "sdkId": "Route 53 Domains", + "namespace": "aws.sdk.kotlin.services.route53domains", + "artifactName": "route53domains", + "brazilName": "AwsSdkKotlinRoute53Domains" + }, + { + "sdkId": "Route53 Recovery Cluster", + "namespace": "aws.sdk.kotlin.services.route53recoverycluster", + "artifactName": "route53recoverycluster", + "brazilName": "AwsSdkKotlinRoute53RecoveryCluster" + }, + { + "sdkId": "Route53 Recovery Control Config", + "namespace": "aws.sdk.kotlin.services.route53recoverycontrolconfig", + "artifactName": "route53recoverycontrolconfig", + "brazilName": "AwsSdkKotlinRoute53RecoveryControlConfig" + }, + { + "sdkId": "Route53 Recovery Readiness", + "namespace": "aws.sdk.kotlin.services.route53recoveryreadiness", + "artifactName": "route53recoveryreadiness", + "brazilName": "AwsSdkKotlinRoute53RecoveryReadiness" + }, + { + "sdkId": "Route53Resolver", + "namespace": "aws.sdk.kotlin.services.route53resolver", + "artifactName": "route53resolver", + "brazilName": "AwsSdkKotlinRoute53resolver" + }, + { + "sdkId": "S3", + "namespace": "aws.sdk.kotlin.services.s3", + "artifactName": "s3", + "brazilName": "AwsSdkKotlinS3" + }, + { + "sdkId": "S3 Control", + "namespace": "aws.sdk.kotlin.services.s3control", + "artifactName": "s3control", + "brazilName": "AwsSdkKotlinS3Control" + }, + { + "sdkId": "S3Outposts", + "namespace": "aws.sdk.kotlin.services.s3outposts", + "artifactName": "s3outposts", + "brazilName": "AwsSdkKotlinS3outposts" + }, + { + "sdkId": "SES", + "namespace": "aws.sdk.kotlin.services.ses", + "artifactName": "ses", + "brazilName": "AwsSdkKotlinSes" + }, + { + "sdkId": "SESv2", + "namespace": "aws.sdk.kotlin.services.sesv2", + "artifactName": "sesv2", + "brazilName": "AwsSdkKotlinSesv2" + }, + { + "sdkId": "SFN", + "namespace": "aws.sdk.kotlin.services.sfn", + "artifactName": "sfn", + "brazilName": "AwsSdkKotlinSfn" + }, + { + "sdkId": "SMS", + "namespace": "aws.sdk.kotlin.services.sms", + "artifactName": "sms", + "brazilName": "AwsSdkKotlinSms" + }, + { + "sdkId": "SNS", + "namespace": "aws.sdk.kotlin.services.sns", + "artifactName": "sns", + "brazilName": "AwsSdkKotlinSns" + }, + { + "sdkId": "SQS", + "namespace": "aws.sdk.kotlin.services.sqs", + "artifactName": "sqs", + "brazilName": "AwsSdkKotlinSqs" + }, + { + "sdkId": "SSM", + "namespace": "aws.sdk.kotlin.services.ssm", + "artifactName": "ssm", + "brazilName": "AwsSdkKotlinSsm" + }, + { + "sdkId": "SSM Contacts", + "namespace": "aws.sdk.kotlin.services.ssmcontacts", + "artifactName": "ssmcontacts", + "brazilName": "AwsSdkKotlinSsmContacts" + }, + { + "sdkId": "SSM Incidents", + "namespace": "aws.sdk.kotlin.services.ssmincidents", + "artifactName": "ssmincidents", + "brazilName": "AwsSdkKotlinSsmIncidents" + }, + { + "sdkId": "SSO", + "namespace": "aws.sdk.kotlin.services.sso", + "artifactName": "sso", + "brazilName": "AwsSdkKotlinSso" + }, + { + "sdkId": "SSO Admin", + "namespace": "aws.sdk.kotlin.services.ssoadmin", + "artifactName": "ssoadmin", + "brazilName": "AwsSdkKotlinSsoAdmin" + }, + { + "sdkId": "SSO OIDC", + "namespace": "aws.sdk.kotlin.services.ssooidc", + "artifactName": "ssooidc", + "brazilName": "AwsSdkKotlinSsoOidc" + }, + { + "sdkId": "STS", + "namespace": "aws.sdk.kotlin.services.sts", + "artifactName": "sts", + "brazilName": "AwsSdkKotlinSts" + }, + { + "sdkId": "SWF", + "namespace": "aws.sdk.kotlin.services.swf", + "artifactName": "swf", + "brazilName": "AwsSdkKotlinSwf" + }, + { + "sdkId": "SageMaker", + "namespace": "aws.sdk.kotlin.services.sagemaker", + "artifactName": "sagemaker", + "brazilName": "AwsSdkKotlinSagemaker" + }, + { + "sdkId": "SageMaker A2I Runtime", + "namespace": "aws.sdk.kotlin.services.sagemakera2iruntime", + "artifactName": "sagemakera2iruntime", + "brazilName": "AwsSdkKotlinSagemakerA2iRuntime" + }, + { + "sdkId": "SageMaker FeatureStore Runtime", + "namespace": "aws.sdk.kotlin.services.sagemakerfeaturestoreruntime", + "artifactName": "sagemakerfeaturestoreruntime", + "brazilName": "AwsSdkKotlinSagemakerFeaturestoreRuntime" + }, + { + "sdkId": "SageMaker Geospatial", + "namespace": "aws.sdk.kotlin.services.sagemakergeospatial", + "artifactName": "sagemakergeospatial", + "brazilName": "AwsSdkKotlinSagemakerGeospatial" + }, + { + "sdkId": "SageMaker Metrics", + "namespace": "aws.sdk.kotlin.services.sagemakermetrics", + "artifactName": "sagemakermetrics", + "brazilName": "AwsSdkKotlinSagemakerMetrics" + }, + { + "sdkId": "SageMaker Runtime", + "namespace": "aws.sdk.kotlin.services.sagemakerruntime", + "artifactName": "sagemakerruntime", + "brazilName": "AwsSdkKotlinSagemakerRuntime" + }, + { + "sdkId": "Sagemaker Edge", + "namespace": "aws.sdk.kotlin.services.sagemakeredge", + "artifactName": "sagemakeredge", + "brazilName": "AwsSdkKotlinSagemakerEdge" + }, + { + "sdkId": "Scheduler", + "namespace": "aws.sdk.kotlin.services.scheduler", + "artifactName": "scheduler", + "brazilName": "AwsSdkKotlinScheduler" + }, + { + "sdkId": "Secrets Manager", + "namespace": "aws.sdk.kotlin.services.secretsmanager", + "artifactName": "secretsmanager", + "brazilName": "AwsSdkKotlinSecretsManager" + }, + { + "sdkId": "SecurityHub", + "namespace": "aws.sdk.kotlin.services.securityhub", + "artifactName": "securityhub", + "brazilName": "AwsSdkKotlinSecurityhub" + }, + { + "sdkId": "SecurityLake", + "namespace": "aws.sdk.kotlin.services.securitylake", + "artifactName": "securitylake", + "brazilName": "AwsSdkKotlinSecuritylake" + }, + { + "sdkId": "ServerlessApplicationRepository", + "namespace": "aws.sdk.kotlin.services.serverlessapplicationrepository", + "artifactName": "serverlessapplicationrepository", + "brazilName": "AwsSdkKotlinServerlessapplicationrepository" + }, + { + "sdkId": "Service Catalog", + "namespace": "aws.sdk.kotlin.services.servicecatalog", + "artifactName": "servicecatalog", + "brazilName": "AwsSdkKotlinServiceCatalog" + }, + { + "sdkId": "Service Catalog AppRegistry", + "namespace": "aws.sdk.kotlin.services.servicecatalogappregistry", + "artifactName": "servicecatalogappregistry", + "brazilName": "AwsSdkKotlinServiceCatalogAppregistry" + }, + { + "sdkId": "Service Quotas", + "namespace": "aws.sdk.kotlin.services.servicequotas", + "artifactName": "servicequotas", + "brazilName": "AwsSdkKotlinServiceQuotas" + }, + { + "sdkId": "ServiceDiscovery", + "namespace": "aws.sdk.kotlin.services.servicediscovery", + "artifactName": "servicediscovery", + "brazilName": "AwsSdkKotlinServicediscovery" + }, + { + "sdkId": "Shield", + "namespace": "aws.sdk.kotlin.services.shield", + "artifactName": "shield", + "brazilName": "AwsSdkKotlinShield" + }, + { + "sdkId": "SimSpaceWeaver", + "namespace": "aws.sdk.kotlin.services.simspaceweaver", + "artifactName": "simspaceweaver", + "brazilName": "AwsSdkKotlinSimspaceweaver" + }, + { + "sdkId": "Snow Device Management", + "namespace": "aws.sdk.kotlin.services.snowdevicemanagement", + "artifactName": "snowdevicemanagement", + "brazilName": "AwsSdkKotlinSnowDeviceManagement" + }, + { + "sdkId": "Snowball", + "namespace": "aws.sdk.kotlin.services.snowball", + "artifactName": "snowball", + "brazilName": "AwsSdkKotlinSnowball" + }, + { + "sdkId": "Ssm Sap", + "namespace": "aws.sdk.kotlin.services.ssmsap", + "artifactName": "ssmsap", + "brazilName": "AwsSdkKotlinSsmSap" + }, + { + "sdkId": "Storage Gateway", + "namespace": "aws.sdk.kotlin.services.storagegateway", + "artifactName": "storagegateway", + "brazilName": "AwsSdkKotlinStorageGateway" + }, + { + "sdkId": "SupplyChain", + "namespace": "aws.sdk.kotlin.services.supplychain", + "artifactName": "supplychain", + "brazilName": "AwsSdkKotlinSupplychain" + }, + { + "sdkId": "Support", + "namespace": "aws.sdk.kotlin.services.support", + "artifactName": "support", + "brazilName": "AwsSdkKotlinSupport" + }, + { + "sdkId": "Support App", + "namespace": "aws.sdk.kotlin.services.supportapp", + "artifactName": "supportapp", + "brazilName": "AwsSdkKotlinSupportApp" + }, + { + "sdkId": "Textract", + "namespace": "aws.sdk.kotlin.services.textract", + "artifactName": "textract", + "brazilName": "AwsSdkKotlinTextract" + }, + { + "sdkId": "Timestream Query", + "namespace": "aws.sdk.kotlin.services.timestreamquery", + "artifactName": "timestreamquery", + "brazilName": "AwsSdkKotlinTimestreamQuery" + }, + { + "sdkId": "Timestream Write", + "namespace": "aws.sdk.kotlin.services.timestreamwrite", + "artifactName": "timestreamwrite", + "brazilName": "AwsSdkKotlinTimestreamWrite" + }, + { + "sdkId": "Transcribe", + "namespace": "aws.sdk.kotlin.services.transcribe", + "artifactName": "transcribe", + "brazilName": "AwsSdkKotlinTranscribe" + }, + { + "sdkId": "Transcribe Streaming", + "namespace": "aws.sdk.kotlin.services.transcribestreaming", + "artifactName": "transcribestreaming", + "brazilName": "AwsSdkKotlinTranscribeStreaming" + }, + { + "sdkId": "Transfer", + "namespace": "aws.sdk.kotlin.services.transfer", + "artifactName": "transfer", + "brazilName": "AwsSdkKotlinTransfer" + }, + { + "sdkId": "Translate", + "namespace": "aws.sdk.kotlin.services.translate", + "artifactName": "translate", + "brazilName": "AwsSdkKotlinTranslate" + }, + { + "sdkId": "TrustedAdvisor", + "namespace": "aws.sdk.kotlin.services.trustedadvisor", + "artifactName": "trustedadvisor", + "brazilName": "AwsSdkKotlinTrustedadvisor" + }, + { + "sdkId": "VPC Lattice", + "namespace": "aws.sdk.kotlin.services.vpclattice", + "artifactName": "vpclattice", + "brazilName": "AwsSdkKotlinVpcLattice" + }, + { + "sdkId": "VerifiedPermissions", + "namespace": "aws.sdk.kotlin.services.verifiedpermissions", + "artifactName": "verifiedpermissions", + "brazilName": "AwsSdkKotlinVerifiedpermissions" + }, + { + "sdkId": "Voice ID", + "namespace": "aws.sdk.kotlin.services.voiceid", + "artifactName": "voiceid", + "brazilName": "AwsSdkKotlinVoiceId" + }, + { + "sdkId": "WAF", + "namespace": "aws.sdk.kotlin.services.waf", + "artifactName": "waf", + "brazilName": "AwsSdkKotlinWaf" + }, + { + "sdkId": "WAF Regional", + "namespace": "aws.sdk.kotlin.services.wafregional", + "artifactName": "wafregional", + "brazilName": "AwsSdkKotlinWafRegional" + }, + { + "sdkId": "WAFV2", + "namespace": "aws.sdk.kotlin.services.wafv2", + "artifactName": "wafv2", + "brazilName": "AwsSdkKotlinWafv2" + }, + { + "sdkId": "WellArchitected", + "namespace": "aws.sdk.kotlin.services.wellarchitected", + "artifactName": "wellarchitected", + "brazilName": "AwsSdkKotlinWellarchitected" + }, + { + "sdkId": "Wisdom", + "namespace": "aws.sdk.kotlin.services.wisdom", + "artifactName": "wisdom", + "brazilName": "AwsSdkKotlinWisdom" + }, + { + "sdkId": "WorkDocs", + "namespace": "aws.sdk.kotlin.services.workdocs", + "artifactName": "workdocs", + "brazilName": "AwsSdkKotlinWorkdocs" + }, + { + "sdkId": "WorkLink", + "namespace": "aws.sdk.kotlin.services.worklink", + "artifactName": "worklink", + "brazilName": "AwsSdkKotlinWorklink" + }, + { + "sdkId": "WorkMail", + "namespace": "aws.sdk.kotlin.services.workmail", + "artifactName": "workmail", + "brazilName": "AwsSdkKotlinWorkmail" + }, + { + "sdkId": "WorkMailMessageFlow", + "namespace": "aws.sdk.kotlin.services.workmailmessageflow", + "artifactName": "workmailmessageflow", + "brazilName": "AwsSdkKotlinWorkmailmessageflow" + }, + { + "sdkId": "WorkSpaces", + "namespace": "aws.sdk.kotlin.services.workspaces", + "artifactName": "workspaces", + "brazilName": "AwsSdkKotlinWorkspaces" + }, + { + "sdkId": "WorkSpaces Thin Client", + "namespace": "aws.sdk.kotlin.services.workspacesthinclient", + "artifactName": "workspacesthinclient", + "brazilName": "AwsSdkKotlinWorkspacesThinClient" + }, + { + "sdkId": "WorkSpaces Web", + "namespace": "aws.sdk.kotlin.services.workspacesweb", + "artifactName": "workspacesweb", + "brazilName": "AwsSdkKotlinWorkspacesWeb" + }, + { + "sdkId": "XRay", + "namespace": "aws.sdk.kotlin.services.xray", + "artifactName": "xray", + "brazilName": "AwsSdkKotlinXray" + }, + { + "sdkId": "amp", + "namespace": "aws.sdk.kotlin.services.amp", + "artifactName": "amp", + "brazilName": "AwsSdkKotlinAmp" + }, + { + "sdkId": "b2bi", + "namespace": "aws.sdk.kotlin.services.b2bi", + "artifactName": "b2bi", + "brazilName": "AwsSdkKotlinB2bi" + }, + { + "sdkId": "billingconductor", + "namespace": "aws.sdk.kotlin.services.billingconductor", + "artifactName": "billingconductor", + "brazilName": "AwsSdkKotlinBillingconductor" + }, + { + "sdkId": "codeartifact", + "namespace": "aws.sdk.kotlin.services.codeartifact", + "artifactName": "codeartifact", + "brazilName": "AwsSdkKotlinCodeartifact" + }, + { + "sdkId": "codestar notifications", + "namespace": "aws.sdk.kotlin.services.codestarnotifications", + "artifactName": "codestarnotifications", + "brazilName": "AwsSdkKotlinCodestarNotifications" + }, + { + "sdkId": "drs", + "namespace": "aws.sdk.kotlin.services.drs", + "artifactName": "drs", + "brazilName": "AwsSdkKotlinDrs" + }, + { + "sdkId": "finspace", + "namespace": "aws.sdk.kotlin.services.finspace", + "artifactName": "finspace", + "brazilName": "AwsSdkKotlinFinspace" + }, + { + "sdkId": "finspace data", + "namespace": "aws.sdk.kotlin.services.finspacedata", + "artifactName": "finspacedata", + "brazilName": "AwsSdkKotlinFinspaceData" + }, + { + "sdkId": "fis", + "namespace": "aws.sdk.kotlin.services.fis", + "artifactName": "fis", + "brazilName": "AwsSdkKotlinFis" + }, + { + "sdkId": "forecast", + "namespace": "aws.sdk.kotlin.services.forecast", + "artifactName": "forecast", + "brazilName": "AwsSdkKotlinForecast" + }, + { + "sdkId": "forecastquery", + "namespace": "aws.sdk.kotlin.services.forecastquery", + "artifactName": "forecastquery", + "brazilName": "AwsSdkKotlinForecastquery" + }, + { + "sdkId": "grafana", + "namespace": "aws.sdk.kotlin.services.grafana", + "artifactName": "grafana", + "brazilName": "AwsSdkKotlinGrafana" + }, + { + "sdkId": "identitystore", + "namespace": "aws.sdk.kotlin.services.identitystore", + "artifactName": "identitystore", + "brazilName": "AwsSdkKotlinIdentitystore" + }, + { + "sdkId": "imagebuilder", + "namespace": "aws.sdk.kotlin.services.imagebuilder", + "artifactName": "imagebuilder", + "brazilName": "AwsSdkKotlinImagebuilder" + }, + { + "sdkId": "ivs", + "namespace": "aws.sdk.kotlin.services.ivs", + "artifactName": "ivs", + "brazilName": "AwsSdkKotlinIvs" + }, + { + "sdkId": "ivschat", + "namespace": "aws.sdk.kotlin.services.ivschat", + "artifactName": "ivschat", + "brazilName": "AwsSdkKotlinIvschat" + }, + { + "sdkId": "kendra", + "namespace": "aws.sdk.kotlin.services.kendra", + "artifactName": "kendra", + "brazilName": "AwsSdkKotlinKendra" + }, + { + "sdkId": "m2", + "namespace": "aws.sdk.kotlin.services.m2", + "artifactName": "m2", + "brazilName": "AwsSdkKotlinM2" + }, + { + "sdkId": "mgn", + "namespace": "aws.sdk.kotlin.services.mgn", + "artifactName": "mgn", + "brazilName": "AwsSdkKotlinMgn" + }, + { + "sdkId": "mq", + "namespace": "aws.sdk.kotlin.services.mq", + "artifactName": "mq", + "brazilName": "AwsSdkKotlinMq" + }, + { + "sdkId": "neptunedata", + "namespace": "aws.sdk.kotlin.services.neptunedata", + "artifactName": "neptunedata", + "brazilName": "AwsSdkKotlinNeptunedata" + }, + { + "sdkId": "nimble", + "namespace": "aws.sdk.kotlin.services.nimble", + "artifactName": "nimble", + "brazilName": "AwsSdkKotlinNimble" + }, + { + "sdkId": "rbin", + "namespace": "aws.sdk.kotlin.services.rbin", + "artifactName": "rbin", + "brazilName": "AwsSdkKotlinRbin" + }, + { + "sdkId": "repostspace", + "namespace": "aws.sdk.kotlin.services.repostspace", + "artifactName": "repostspace", + "brazilName": "AwsSdkKotlinRepostspace" + }, + { + "sdkId": "resiliencehub", + "namespace": "aws.sdk.kotlin.services.resiliencehub", + "artifactName": "resiliencehub", + "brazilName": "AwsSdkKotlinResiliencehub" + }, + { + "sdkId": "savingsplans", + "namespace": "aws.sdk.kotlin.services.savingsplans", + "artifactName": "savingsplans", + "brazilName": "AwsSdkKotlinSavingsplans" + }, + { + "sdkId": "schemas", + "namespace": "aws.sdk.kotlin.services.schemas", + "artifactName": "schemas", + "brazilName": "AwsSdkKotlinSchemas" + }, + { + "sdkId": "signer", + "namespace": "aws.sdk.kotlin.services.signer", + "artifactName": "signer", + "brazilName": "AwsSdkKotlinSigner" + }, + { + "sdkId": "synthetics", + "namespace": "aws.sdk.kotlin.services.synthetics", + "artifactName": "synthetics", + "brazilName": "AwsSdkKotlinSynthetics" + }, + { + "sdkId": "tnb", + "namespace": "aws.sdk.kotlin.services.tnb", + "artifactName": "tnb", + "brazilName": "AwsSdkKotlinTnb" + } + ] +} \ No newline at end of file From 731fe6a3151218c993e95b88c827bcabde90a09d Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 7 Feb 2024 19:03:17 +0000 Subject: [PATCH 10/32] feat: update AWS API models --- codegen/sdk/aws-models/datasync.json | 350 ++++++--- codegen/sdk/aws-models/lex-models-v2.json | 877 +++++++++++++++++++++- codegen/sdk/aws-models/redshift.json | 280 +++++++ 3 files changed, 1400 insertions(+), 107 deletions(-) diff --git a/codegen/sdk/aws-models/datasync.json b/codegen/sdk/aws-models/datasync.json index b208bc4d152..5ff804f9ed6 100644 --- a/codegen/sdk/aws-models/datasync.json +++ b/codegen/sdk/aws-models/datasync.json @@ -524,7 +524,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.

\n

Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your\n container.

" + "smithy.api#documentation": "

Creates a transfer location for a Microsoft Azure Blob Storage\n container. DataSync can use this location as a transfer source or\n destination.

\n

Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your\n container.

" } }, "com.amazonaws.datasync#CreateLocationAzureBlobRequest": { @@ -617,7 +617,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for an Amazon EFS file system that DataSync\n can access for a transfer. For more information, see Creating a location for Amazon EFS.

" + "smithy.api#documentation": "

Creates a transfer location for an Amazon EFS file system.\n DataSync can use this location as a source or destination for transferring\n data.

\n

Before you begin, make sure that you understand how DataSync\n accesses\n Amazon EFS file systems.

" } }, "com.amazonaws.datasync#CreateLocationEfsRequest": { @@ -705,7 +705,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for an Amazon FSx for Lustre file system.

" + "smithy.api#documentation": "

Creates a transfer location for an Amazon FSx for Lustre file system.\n DataSync can use this location as a source or destination for transferring\n data.

\n

Before you begin, make sure that you understand how DataSync\n accesses FSx for Lustre file systems.

" } }, "com.amazonaws.datasync#CreateLocationFsxLustreRequest": { @@ -773,7 +773,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.

\n

Before you begin, make sure that you understand how DataSync\n accesses an FSx for ONTAP file system.

" + "smithy.api#documentation": "

Creates a transfer location for an Amazon FSx for NetApp ONTAP file\n system. DataSync can use this location as a source or destination for\n transferring data.

\n

Before you begin, make sure that you understand how DataSync\n accesses FSx for ONTAP file systems.

" } }, "com.amazonaws.datasync#CreateLocationFsxOntapRequest": { @@ -847,7 +847,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.

\n \n

Request parameters related to SMB aren't supported with the\n CreateLocationFsxOpenZfs operation.

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

Creates a transfer location for an Amazon FSx for OpenZFS file system.\n DataSync can use this location as a source or destination for transferring\n data.

\n

Before you begin, make sure that you understand how DataSync\n accesses FSx for OpenZFS file systems.

\n \n

Request parameters related to SMB aren't supported with the\n CreateLocationFsxOpenZfs operation.

\n " } }, "com.amazonaws.datasync#CreateLocationFsxOpenZfsRequest": { @@ -922,7 +922,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data transfer.

\n

Before you begin, make sure that you understand how DataSync accesses an FSx for Windows File Server.

" + "smithy.api#documentation": "

Creates a transfer location for an Amazon FSx for Windows File Server file\n system. DataSync can use this location as a source or destination for\n transferring data.

\n

Before you begin, make sure that you understand how DataSync\n accesses\n FSx for Windows File Server file systems.

" } }, "com.amazonaws.datasync#CreateLocationFsxWindowsRequest": { @@ -957,20 +957,20 @@ "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "

Specifies the user who has the permissions to access files, folders, and metadata in your\n file system.

\n

For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.

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

Specifies the user with the permissions to mount and access the files, folders, and file\n metadata in your FSx for Windows File Server file system.

\n

For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.

", "smithy.api#required": {} } }, "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "

Specifies the name of the Windows domain that the FSx for Windows File Server belongs\n to.

\n

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

\n

For more information, see required permissions for FSx for Windows File Server locations.

" + "smithy.api#documentation": "

Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.

\n

If you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right file system.

" } }, "Password": { "target": "com.amazonaws.datasync#SmbPassword", "traits": { - "smithy.api#documentation": "

Specifies the password of the user who has the permissions to access files and folders in\n the file system.

\n

For more information, see required permissions for FSx for Windows File Server locations.

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

Specifies the password of the user with the permissions to mount and access the files,\n folders, and file metadata in your FSx for Windows File Server file system.

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

Creates an endpoint for a Hadoop Distributed File System (HDFS).

" + "smithy.api#documentation": "

Creates a transfer location for a Hadoop Distributed File System\n (HDFS). DataSync can use this location as a source or destination for\n transferring data.

\n

Before you begin, make sure that you understand how DataSync\n accesses\n HDFS clusters.

" } }, "com.amazonaws.datasync#CreateLocationHdfsRequest": { @@ -1133,7 +1133,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.

\n

For more information, see Configuring transfers to or from an NFS file\n server.

\n \n

If you're copying data to or from an Snowcone device, you can also use\n CreateLocationNfs to create your transfer location. For more information, see\n Configuring transfers with Snowcone.

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

Creates a transfer location for a Network File System (NFS) file\n server. DataSync can use this location as a source or destination for\n transferring data.

\n

Before you begin, make sure that you understand how DataSync\n accesses\n NFS file servers.

\n \n

If you're copying data to or from an Snowcone device, you can also use\n CreateLocationNfs to create your transfer location. For more information, see\n Configuring transfers with Snowcone.

\n " } }, "com.amazonaws.datasync#CreateLocationNfsRequest": { @@ -1210,7 +1210,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an endpoint for an object storage system that DataSync can access\n for a transfer. For more information, see Creating a location for object\n storage.

" + "smithy.api#documentation": "

Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring\n data.

\n

Before you begin, make sure that you understand the prerequisites\n for DataSync to work with object storage systems.

" } }, "com.amazonaws.datasync#CreateLocationObjectStorageRequest": { @@ -1317,7 +1317,7 @@ } ], "traits": { - "smithy.api#documentation": "

A location is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.

\n \n

Before you create your location, make sure that you read the following sections:

\n \n \n

For more information, see Creating an Amazon S3 location.

" + "smithy.api#documentation": "

Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring\n data.

\n \n

Before you begin, make sure that you read the following topics:

\n \n \n

For more information, see Configuring transfers with Amazon S3.

" } }, "com.amazonaws.datasync#CreateLocationS3Request": { @@ -1326,20 +1326,20 @@ "Subdirectory": { "target": "com.amazonaws.datasync#S3Subdirectory", "traits": { - "smithy.api#documentation": "

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read\n data from the S3 source location or write data to the S3 destination.

" + "smithy.api#documentation": "

Specifies a prefix in the S3 bucket that DataSync reads from or writes to\n (depending on whether the bucket is a source or destination location).

\n \n

DataSync can't transfer objects with a prefix that begins with a slash\n (/) or includes //, /./, or\n /../ patterns. For example:

\n
    \n
  • \n

    \n /photos\n

    \n
    • \n
  • \n

    \n photos//2006/January\n

    \n
    • \n
  • \n

    \n photos/./2006/February\n

    \n
    • \n
  • \n

    \n photos/../2006/March\n

    \n
    • \n
\n " } }, "S3BucketArn": { "target": "com.amazonaws.datasync#S3BucketArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost,\n this must be an access point ARN.

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

Specifies the ARN of the S3 bucket that you want to use as a location. (When creating\n your DataSync task later, you specify whether this location is a transfer source or\n destination.)

\n

If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access\n point. For more information, see Managing data access with Amazon S3 access points in the\n Amazon S3 User Guide.

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

The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For buckets in Amazon Web Services Regions, the storage class\n defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

\n

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that\n can affect your S3 storage cost. For detailed information, see Considerations\n when working with S3 storage classes in DataSync.

" + "smithy.api#documentation": "

Specifies the storage class that you want your objects to use when Amazon S3 is a\n transfer destination.

\n

For buckets in Amazon Web Services Regions, the storage class defaults to\n STANDARD. For buckets on Outposts, the storage class defaults to\n OUTPOSTS.

\n

For more information, see Storage class\n considerations with Amazon S3 transfers.

" } }, "S3Config": { @@ -1351,13 +1351,13 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource\n Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about\n launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent\n on Outposts.

" + "smithy.api#documentation": "

(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.

\n

For more information, see Deploy your DataSync agent\n on Outposts.

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

The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.

" + "smithy.api#documentation": "

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.\n We recommend creating at least a name tag for your transfer location.

" } } }, @@ -1372,7 +1372,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is\n created.

" + "smithy.api#documentation": "

The ARN of the S3 location that you created.

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

Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.

\n

Before you begin, make sure that you understand how DataSync\n accesses an SMB file server.

" + "smithy.api#documentation": "

Creates a transfer location for a Server Message Block (SMB) file\n server. DataSync can use this location as a source or destination for\n transferring data.

\n

Before you begin, make sure that you understand how DataSync\n accesses\n SMB file servers.

" } }, "com.amazonaws.datasync#CreateLocationSmbRequest": { @@ -1407,7 +1407,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#SmbSubdirectory", "traits": { - "smithy.api#documentation": "

Specifies the name of the share exported by your SMB file server where DataSync\n will read or write data. You can include a subdirectory in the share path (for example,\n /path/to/subdirectory). Make sure that other SMB clients in your network can\n also mount this path.

\n

To copy all data in the specified subdirectory, DataSync must be able to mount\n the SMB share and access all of its data. For more information, see required permissions for SMB locations.

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

Specifies the name of the share exported by your SMB file server where DataSync\n will read or write data. You can include a subdirectory in the share path (for example,\n /path/to/subdirectory). Make sure that other SMB clients in your network can\n also mount this path.

\n

To copy all data in the subdirectory, DataSync must be able to mount the SMB\n share and access all of its data. For more information, see required permissions for SMB locations.

", "smithy.api#required": {} } }, @@ -1421,14 +1421,14 @@ "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "

Specifies the user name that can mount your SMB file server and has permission to access\n the files and folders involved in your transfer.

\n

For information about choosing a user with the right level of access for your transfer,\n see required permissions for SMB locations.

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

Specifies the user that can mount and access the files, folders, and file metadata in your\n SMB file server.

\n

For information about choosing a user with the right level of access for your transfer,\n see required permissions for SMB locations.

", "smithy.api#required": {} } }, "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "

Specifies the Windows domain name that your SMB file server belongs to.

\n

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

\n

For more information, see required permissions for SMB locations.

" + "smithy.api#documentation": "

Specifies the name of the Active Directory domain that your SMB file server belongs to.

\n

If you have multiple Active Directory domains in your environment, configuring this\n parameter makes sure that DataSync connects to the right file server.

" } }, "Password": { @@ -1557,10 +1557,16 @@ "smithy.api#documentation": "

Specifies a list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.

" } }, + "ManifestConfig": { + "target": "com.amazonaws.datasync#ManifestConfig", + "traits": { + "smithy.api#documentation": "

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

\n

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

" + } + }, "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information\n about for your DataSync transfer.

" + "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information\n about your DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.

\n

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

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

Deletes the configuration of a location used by DataSync.

" + "smithy.api#documentation": "

Deletes a transfer location resource from DataSync.

" } }, "com.amazonaws.datasync#DeleteLocationRequest": { @@ -1709,7 +1715,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an DataSync transfer task.

" + "smithy.api#documentation": "

Deletes a transfer task resource from DataSync.

" } }, "com.amazonaws.datasync#DeleteTaskRequest": { @@ -2012,7 +2018,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata about your DataSync location for an Amazon EFS\n file system.

" + "smithy.api#documentation": "

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

" } }, "com.amazonaws.datasync#DescribeLocationEfsRequest": { @@ -2096,7 +2102,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.

" + "smithy.api#documentation": "

Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.

" } }, "com.amazonaws.datasync#DescribeLocationFsxLustreRequest": { @@ -2163,7 +2169,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

\n \n

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't\n actually return a Password.

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

Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.

\n \n

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't\n actually return a Password.

\n " } }, "com.amazonaws.datasync#DescribeLocationFsxOntapRequest": { @@ -2245,7 +2251,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.

\n \n

Response elements related to SMB aren't supported with the\n DescribeLocationFsxOpenZfs operation.

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

Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.

\n \n

Response elements related to SMB aren't supported with the\n DescribeLocationFsxOpenZfs operation.

\n " } }, "com.amazonaws.datasync#DescribeLocationFsxOpenZfsRequest": { @@ -2318,7 +2324,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata about an Amazon FSx for Windows File Server location, such as information\n about its path.

" + "smithy.api#documentation": "

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

" } }, "com.amazonaws.datasync#DescribeLocationFsxWindowsRequest": { @@ -2327,7 +2333,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FSx for Windows File Server location to\n describe.

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

Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.

", "smithy.api#required": {} } } @@ -2342,19 +2348,19 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was\n described.

" + "smithy.api#documentation": "

The ARN of the FSx for Windows File Server location.

" } }, "LocationUri": { "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "

The URL of the FSx for Windows File Server location that was described.

" + "smithy.api#documentation": "

The uniform resource identifier (URI) of the FSx for Windows File Server location.

" } }, "SecurityGroupArns": { "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx\n for Windows File Server file system.

" + "smithy.api#documentation": "

The ARNs of the security groups that are configured for the FSx for Windows File Server file\n system.

" } }, "CreationTime": { @@ -2366,13 +2372,13 @@ "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "

The user who has the permissions to access files and folders in the FSx for Windows File\n Server file system.

" + "smithy.api#documentation": "

The user with the permissions to mount and access the FSx for Windows File Server file\n system.

" } }, "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "

The name of the Windows domain that the FSx for Windows File Server belongs to.

" + "smithy.api#documentation": "

The name of the Microsoft Active Directory domain that the FSx for Windows File Server file\n system belongs to.

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

Returns metadata, such as the authentication information about the Hadoop Distributed File\n System (HDFS) location.

" + "smithy.api#documentation": "

Provides details about how an DataSync transfer location for a Hadoop\n Distributed File System (HDFS) is configured.

" } }, "com.amazonaws.datasync#DescribeLocationHdfsRequest": { @@ -2406,7 +2412,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the HDFS cluster location to describe.

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

Specifies the Amazon Resource Name (ARN) of the HDFS location.

", "smithy.api#required": {} } } @@ -2421,19 +2427,19 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The ARN of the HDFS cluster location.

" + "smithy.api#documentation": "

The ARN of the HDFS location.

" } }, "LocationUri": { "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "

The URI of the HDFS cluster location.

" + "smithy.api#documentation": "

The URI of the HDFS location.

" } }, "NameNodes": { "target": "com.amazonaws.datasync#HdfsNameNodeList", "traits": { - "smithy.api#documentation": "

The NameNode that manage the HDFS namespace.

" + "smithy.api#documentation": "

The NameNode that manages the HDFS namespace.

" } }, "BlockSize": { @@ -2457,7 +2463,7 @@ "QopConfiguration": { "target": "com.amazonaws.datasync#QopConfiguration", "traits": { - "smithy.api#documentation": "

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)\n and data transfer protection settings configured on the Hadoop Distributed File System (HDFS)\n cluster.

" + "smithy.api#documentation": "

The Quality of Protection (QOP) configuration, which specifies the Remote Procedure Call\n (RPC) and data transfer protection settings configured on the HDFS cluster.

" } }, "AuthenticationType": { @@ -2469,7 +2475,7 @@ "SimpleUser": { "target": "com.amazonaws.datasync#HdfsUser", "traits": { - "smithy.api#documentation": "

The user name used to identify the client on the host operating system. This parameter is\n used if the AuthenticationType is defined as SIMPLE.

" + "smithy.api#documentation": "

The user name to identify the client on the host operating system. This parameter is used\n if the AuthenticationType is defined as SIMPLE.

" } }, "KerberosPrincipal": { @@ -2481,7 +2487,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

The ARNs of the agents that are used to connect to the HDFS cluster.

" + "smithy.api#documentation": "

The ARNs of the DataSync agents that can connect with your HDFS cluster.

" } }, "CreationTime": { @@ -2543,7 +2549,7 @@ "LocationUri": { "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "

The URL of the NFS location.

" + "smithy.api#documentation": "

The URI of the NFS location.

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

Returns metadata about your DataSync location for an object storage\n system.

" + "smithy.api#documentation": "

Provides details about how an DataSync transfer location for an object\n storage system is configured.

" } }, "com.amazonaws.datasync#DescribeLocationObjectStorageRequest": { @@ -2593,7 +2599,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the object storage system location that you want\n information about.

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

Specifies the Amazon Resource Name (ARN) of the object storage system location.

", "smithy.api#required": {} } } @@ -2615,7 +2621,7 @@ "LocationUri": { "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "

The URL of the object storage system location.

" + "smithy.api#documentation": "

The URI of the object storage system location.

" } }, "AccessKey": { @@ -2639,7 +2645,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

The ARNs of the DataSync agents that can securely connect with your\n location.

" + "smithy.api#documentation": "

The ARNs of the DataSync agents that can connect with your object storage\n system.

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

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

" + "smithy.api#documentation": "

Provides details about how an DataSync transfer location for an S3 bucket\n is configured.

" } }, "com.amazonaws.datasync#DescribeLocationS3Request": { @@ -2686,7 +2692,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

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

Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.

", "smithy.api#required": {} } } @@ -2702,7 +2708,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

" + "smithy.api#documentation": "

The ARN of the Amazon S3 location.

" } }, "LocationUri": { @@ -2714,7 +2720,7 @@ "S3StorageClass": { "target": "com.amazonaws.datasync#S3StorageClass", "traits": { - "smithy.api#documentation": "

The Amazon S3 storage class that you chose to store your files in when this location is\n used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage\n classes have behaviors that can affect your S3 storage cost. For detailed information, see\n Considerations\n when working with S3 storage classes in DataSync.

" + "smithy.api#documentation": "

When Amazon S3 is a destination location, this is the storage class that you chose\n for your objects.

\n

Some storage classes have behaviors that can affect your Amazon S3 storage costs.\n For more information, see Storage class\n considerations with Amazon S3 transfers.

" } }, "S3Config": { @@ -2723,13 +2729,13 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name\n (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a\n DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent\n on Outposts.

" + "smithy.api#documentation": "

The ARNs of the DataSync agents deployed on your Outpost when using working with\n Amazon S3 on Outposts.

\n

For more information, see Deploy your DataSync agent\n on Outposts.

" } }, "CreationTime": { "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "

The time that the Amazon S3 bucket location was created.

" + "smithy.api#documentation": "

The time that the Amazon S3 location was created.

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

Returns metadata, such as the path and user information about an SMB location.

" + "smithy.api#documentation": "

Provides details about how an DataSync transfer location for a Server\n Message Block (SMB) file server is configured.

" } }, "com.amazonaws.datasync#DescribeLocationSmbRequest": { @@ -2764,7 +2770,7 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SMB location to describe.

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

Specifies the Amazon Resource Name (ARN) of the SMB location that you want information\n about.

", "smithy.api#required": {} } } @@ -2780,37 +2786,37 @@ "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SMB location that was described.

" + "smithy.api#documentation": "

The ARN of the SMB location.

" } }, "LocationUri": { "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "

The URL of the source SMB location that was described.

" + "smithy.api#documentation": "

The URI of the SMB location.

" } }, "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source SMB file system location that is\n created.

" + "smithy.api#documentation": "

The ARNs of the DataSync agents that can connect with your SMB file\n server.

" } }, "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "

The user who can mount the share, has the permissions to access files and folders in the\n SMB share.

" + "smithy.api#documentation": "

The user that can mount and access the files, folders, and file metadata in your SMB file\n server.

" } }, "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "

The name of the Windows domain that the SMB server belongs to.

" + "smithy.api#documentation": "

The name of the Microsoft Active Directory domain that the SMB file server belongs\n to.

" } }, "MountOptions": { "target": "com.amazonaws.datasync#SmbMountOptions", "traits": { - "smithy.api#documentation": "

The mount options that are available for DataSync to use to access an SMB location.

" + "smithy.api#documentation": "

The protocol that DataSync use to access your SMB file.

" } }, "CreationTime": { @@ -3213,6 +3219,12 @@ "smithy.api#documentation": "

A list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.

" } }, + "ManifestConfig": { + "target": "com.amazonaws.datasync#ManifestConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the manifest that lists the files or objects to transfer. For more\n information, see Specifying what DataSync transfers by using a manifest.

" + } + }, "StartTime": { "target": "com.amazonaws.datasync#Time", "traits": { @@ -3254,12 +3266,6 @@ "smithy.api#documentation": "

The total number of bytes that are involved in the transfer. For the number of bytes\n sent over the network, see BytesCompressed.

" } }, - "Result": { - "target": "com.amazonaws.datasync#TaskExecutionResultDetail", - "traits": { - "smithy.api#documentation": "

The result of the task execution.

" - } - }, "BytesCompressed": { "target": "com.amazonaws.datasync#long", "traits": { @@ -3267,10 +3273,16 @@ "smithy.api#documentation": "

The physical number of bytes transferred over the network after compression was applied.\n In most cases, this number is less than BytesTransferred unless the data isn't\n compressible.

" } }, + "Result": { + "target": "com.amazonaws.datasync#TaskExecutionResultDetail", + "traits": { + "smithy.api#documentation": "

The result of the task execution.

" + } + }, "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "

The configuration of your task report, which provides detailed information about for your DataSync transfer.

" + "smithy.api#documentation": "

The configuration of your task report, which provides detailed information about for your\n DataSync transfer. For more information, see Creating a task report.

" } }, "FilesDeleted": { @@ -3428,10 +3440,16 @@ "smithy.api#documentation": "

A list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.

" } }, + "ManifestConfig": { + "target": "com.amazonaws.datasync#ManifestConfig", + "traits": { + "smithy.api#documentation": "

The configuration of the manifest that lists the files or objects to transfer. For more\n information, see Specifying what DataSync transfers by using a manifest.

" + } + }, "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "

The configuration of your task report. For more information, see Creating a task report.

" + "smithy.api#documentation": "

The configuration of your task report, which provides detailed information about for your\n DataSync transfer. For more information, see Creating a task report.

" } } }, @@ -5145,7 +5163,7 @@ "Domain": { "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "

Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that\n your storage virtual machine (SVM) belongs to.

" + "smithy.api#documentation": "

Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that\n your storage virtual machine (SVM) belongs to.

\n

If you have multiple domains in your environment, configuring this setting makes sure that\n DataSync connects to the right SVM.

" } }, "MountOptions": { @@ -5161,7 +5179,7 @@ "User": { "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "

Specifies a user name that can mount the location and access the files, folders, and\n metadata that you need in the SVM.

\n

If you provide a user in your Active Directory, note the following:

\n
    \n
  • \n

    If you're using Directory Service for Microsoft Active Directory, the user must be a member of the\n Amazon Web Services Delegated FSx Administrators group.

    \n
    • \n
  • \n

    If you're using a self-managed Active Directory, the user must be a member of either\n the Domain Admins group or a custom group that you specified for file system\n administration when you created your file system.

    \n
    • \n
\n

Make sure that the user has the permissions it needs to copy the data you want:

\n
    \n
  • \n

    \n SE_TCB_NAME: Required to set object ownership and file metadata. With\n this privilege, you also can copy NTFS discretionary access lists (DACLs).

    \n
    • \n
  • \n

    \n SE_SECURITY_NAME: May be needed to copy NTFS system access control lists\n (SACLs). This operation specifically requires the Windows privilege, which is granted to\n members of the Domain Admins group. If you configure your task to copy SACLs, make sure\n that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.

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

Specifies a user that can mount and access the files, folders, and metadata in your SVM.

\n

For information about choosing a user with the right level of access for your transfer, see Using\n the SMB protocol.

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

Returns a list of executed tasks.

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

Returns a list of executions for an DataSync transfer task.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5977,19 +5995,19 @@ "TaskArn": { "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task whose tasks you want to list.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the task that you want execution\n information about.

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

The maximum number of executed tasks to list.

" + "smithy.api#documentation": "

Specifies how many results you want in the response.

" } }, "NextToken": { "target": "com.amazonaws.datasync#NextToken", "traits": { - "smithy.api#documentation": "

An opaque string that indicates the position at which to begin the next list of the\n executed tasks.

" + "smithy.api#documentation": "

Specifies an opaque string that indicates the position at which to begin the next list\n of results in the response.

" } } }, @@ -6004,13 +6022,13 @@ "TaskExecutions": { "target": "com.amazonaws.datasync#TaskExecutionList", "traits": { - "smithy.api#documentation": "

A list of executed tasks.

" + "smithy.api#documentation": "

A list of the task's executions.

" } }, "NextToken": { "target": "com.amazonaws.datasync#NextToken", "traits": { - "smithy.api#documentation": "

An opaque string that indicates the position at which to begin returning the next list\n of executed tasks.

" + "smithy.api#documentation": "

The opaque string that indicates the position to begin the next list of results in the\n response.

" } } }, @@ -6230,6 +6248,54 @@ } } }, + "com.amazonaws.datasync#ManifestAction": { + "type": "enum", + "members": { + "TRANSFER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFER" + } + } + } + }, + "com.amazonaws.datasync#ManifestConfig": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.datasync#ManifestAction", + "traits": { + "smithy.api#documentation": "

Specifies what DataSync uses the manifest for.

" + } + }, + "Format": { + "target": "com.amazonaws.datasync#ManifestFormat", + "traits": { + "smithy.api#documentation": "

Specifies the file format of your manifest. For more information, see Creating a manifest.

" + } + }, + "Source": { + "target": "com.amazonaws.datasync#SourceManifestConfig", + "traits": { + "smithy.api#documentation": "

Specifies the manifest that you want DataSync to use and where it's\n hosted.

\n \n

You must specify this parameter if you're configuring a new manifest on or after February 7,\n 2024.

\n

If you don't, you'll get a 400 status code and ValidationException error\n stating that you're missing the IAM role for DataSync to access the\n S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest.

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

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

" + } + }, + "com.amazonaws.datasync#ManifestFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + } + } + }, "com.amazonaws.datasync#MaxP95Performance": { "type": "structure", "members": { @@ -6910,55 +6976,55 @@ "VerifyMode": { "target": "com.amazonaws.datasync#VerifyMode", "traits": { - "smithy.api#documentation": "

Specifies how and when DataSync checks the integrity of your data during a\n transfer.

\n

Default value: POINT_IN_TIME_CONSISTENT\n

\n

\n ONLY_FILES_TRANSFERRED (recommended): DataSync calculates the\n checksum of transferred files and metadata at the source location. At the end of the transfer,\n DataSync then compares this checksum to the checksum calculated on those files at\n the destination.

\n

We recommend this option when transferring to S3 Glacier Flexible Retrieval or\n S3 Glacier Deep Archive storage classes. For more information, see\n Storage class\n considerations with Amazon S3 locations.

\n

\n POINT_IN_TIME_CONSISTENT: At the end of the transfer, DataSync\n scans the entire source and destination to verify that both locations are fully\n synchronized.

\n

You can't use this option when transferring to S3 Glacier Flexible Retrieval or\n S3 Glacier Deep Archive storage classes. For more information, see\n Storage class\n considerations with Amazon S3 locations.

\n

\n NONE: DataSync doesn't run additional verification at the end of\n the transfer. All data transmissions are still integrity-checked with checksum verification\n during the transfer.

" + "smithy.api#documentation": "

Specifies how and when DataSync checks the integrity of your data during a\n transfer.

\n
    \n
  • \n

    \n ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates\n the checksum of transferred files and metadata at the source location. At the end of the\n transfer, DataSync then compares this checksum to the checksum calculated on\n those files at the destination.

    \n

    We recommend this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.

    \n
    • \n
  • \n

    \n POINT_IN_TIME_CONSISTENT (default) - At the end of the transfer,\n DataSync scans the entire source and destination to verify that both locations\n are fully synchronized.

    \n

    You can't use this option when transferring to S3 Glacier Flexible Retrieval\n or S3 Glacier Deep Archive storage classes. For more information, see\n Storage\n class considerations with Amazon S3 locations.

    \n
    • \n
  • \n

    \n NONE - DataSync doesn't run additional verification at the\n end of the transfer. All data transmissions are still integrity-checked with checksum\n verification during the transfer.

    \n
    • \n
" } }, "OverwriteMode": { "target": "com.amazonaws.datasync#OverwriteMode", "traits": { - "smithy.api#documentation": "

Specifies whether data at the destination location should be overwritten or preserved. If\n set to NEVER, a destination file for example will not be replaced by a source\n file (even if the destination file differs from the source file). If you modify files in the\n destination and you sync the files, you can use this value to protect against overwriting\n those changes.

\n

Some storage classes have specific behaviors that can affect your Amazon S3\n storage cost. For detailed information, see Considerations\n when working with Amazon S3 storage classes in DataSync.

" + "smithy.api#documentation": "

Specifies whether DataSync should modify or preserve data at the destination\n location.

\n
    \n
  • \n

    \n ALWAYS (default) - DataSync modifies data in the destination\n location when source data (including metadata) has changed.

    \n

    If DataSync overwrites objects, you might incur additional charges for\n certain Amazon S3 storage classes (for example, for retrieval or early deletion).\n For more information, see Storage\n class considerations with Amazon S3 transfers.

    \n
    • \n
  • \n

    \n NEVER - DataSync doesn't overwrite data in the destination\n location even if the source data has changed. You can use this option to protect against\n overwriting changes made to files or objects in the destination.

    \n
    • \n
" } }, "Atime": { "target": "com.amazonaws.datasync#Atime", "traits": { - "smithy.api#documentation": "

Specifies whether to preserve metadata indicating the last time a file was read or\n written to. If you set Atime to BEST_EFFORT, DataSync\n attempts to preserve the original Atime attribute on all source files (that is,\n the version before the PREPARING phase of the task execution).

\n \n

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

\n \n

Default value: BEST_EFFORT\n

\n

\n BEST_EFFORT: Attempt to preserve the per-file Atime value\n (recommended).

\n

\n NONE: Ignore Atime.

\n \n

If Atime is set to BEST_EFFORT, Mtime must be set\n to PRESERVE.

\n

If Atime is set to NONE, Mtime must also be\n NONE.

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

Specifies whether to preserve metadata indicating the last time a file was read or\n written to.

\n \n

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

\n \n
    \n
  • \n

    \n BEST_EFFORT (default) - DataSync attempts to preserve the\n original Atime attribute on all source files (that is, the version before the\n PREPARING phase of the task execution). This option is\n recommended.

    \n
    • \n
  • \n

    \n NONE - Ignores Atime.

    \n
    • \n
\n \n

If Atime is set to BEST_EFFORT, Mtime must be set\n to PRESERVE.

\n

If Atime is set to NONE, Mtime must also be\n NONE.

\n " } }, "Mtime": { "target": "com.amazonaws.datasync#Mtime", "traits": { - "smithy.api#documentation": "

Specifies whether to preserve metadata indicating the last time that a file was written\n to before the PREPARING phase of your task execution. This option is required\n when you need to run the a task more than once.

\n

Default Value: PRESERVE\n

\n

\n PRESERVE: Preserve original Mtime (recommended)

\n

\n NONE: Ignore Mtime.

\n \n

If Mtime is set to PRESERVE, Atime must be set to\n BEST_EFFORT.

\n

If Mtime is set to NONE, Atime must also be set\n to NONE.

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

Specifies whether to preserve metadata indicating the last time that a file was written\n to before the PREPARING phase of your task execution. This option is required\n when you need to run the a task more than once.

\n
    \n
  • \n

    \n PRESERVE (default) - Preserves original Mtime, which is\n recommended.

    \n
    • \n
  • \n

    \n NONE - Ignores Mtime.

    \n
    • \n
\n \n

If Mtime is set to PRESERVE, Atime must be set to\n BEST_EFFORT.

\n

If Mtime is set to NONE, Atime must also be set\n to NONE.

\n " } }, "Uid": { "target": "com.amazonaws.datasync#Uid", "traits": { - "smithy.api#documentation": "

Specifies the POSIX user ID (UID) of the file's owner.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: INT_VALUE. This preserves the integer value of the ID.

\n

\n INT_VALUE: Preserve the integer value of UID and group ID (GID)\n (recommended).

\n

\n NONE: Ignore UID and GID.

" + "smithy.api#documentation": "

Specifies the POSIX user ID (UID) of the file's owner.

\n
    \n
  • \n

    \n INT_VALUE (default) - Preserves the integer value of UID and group ID\n (GID), which is recommended.

    \n
    • \n
  • \n

    \n NONE - Ignores UID and GID.

    \n
    • \n
\n

For more information, see Metadata copied by DataSync.

" } }, "Gid": { "target": "com.amazonaws.datasync#Gid", "traits": { - "smithy.api#documentation": "

Specifies the POSIX group ID (GID) of the file's owners.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: INT_VALUE. This preserves the integer value of the ID.

\n

\n INT_VALUE: Preserve the integer value of user ID (UID) and GID\n (recommended).

\n

\n NONE: Ignore UID and GID.

" + "smithy.api#documentation": "

Specifies the POSIX group ID (GID) of the file's owners.

\n
    \n
  • \n

    \n INT_VALUE (default) - Preserves the integer value of user ID (UID) and\n GID, which is recommended.

    \n
    • \n
  • \n

    \n NONE - Ignores UID and GID.

    \n
    • \n
\n

For more information, see Metadata copied by DataSync.

" } }, "PreserveDeletedFiles": { "target": "com.amazonaws.datasync#PreserveDeletedFiles", "traits": { - "smithy.api#documentation": "

Specifies whether files in the destination location that don't exist in the source\n should be preserved. This option can affect your Amazon S3 storage cost. If your task\n deletes objects, you might incur minimum storage duration charges for certain storage classes.\n For detailed information, see Considerations\n when working with Amazon S3 storage classes in DataSync.

\n

Default value: PRESERVE\n

\n

\n PRESERVE: Ignore such destination files (recommended).

\n

\n REMOVE: Delete destination files that aren’t present in the\n source.

\n \n

If you set this parameter to REMOVE, you can't set\n TransferMode to ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.

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

Specifies whether files in the destination location that don't exist in the source\n should be preserved. This option can affect your Amazon S3 storage cost. If your task\n deletes objects, you might incur minimum storage duration charges for certain storage classes.\n For detailed information, see Considerations\n when working with Amazon S3 storage classes in DataSync.

\n
    \n
  • \n

    \n PRESERVE (default) - Ignores such destination files, which is\n recommended.

    \n
    • \n
  • \n

    \n REMOVE - Deletes destination files that aren’t present in the\n source.

    \n
    • \n
\n \n

If you set this parameter to REMOVE, you can't set\n TransferMode to ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.

\n " } }, "PreserveDevices": { "target": "com.amazonaws.datasync#PreserveDevices", "traits": { - "smithy.api#documentation": "

Specifies whether DataSync should preserve the metadata of block and\n character devices in the source location and recreate the files with that device name and\n metadata on the destination. DataSync copies only the name and metadata of such\n devices.

\n \n

DataSync can't copy the actual contents of these devices because they're\n nonterminal and don't return an end-of-file (EOF) marker.

\n \n

Default value: NONE\n

\n

\n NONE: Ignore special devices (recommended).

\n

\n PRESERVE: Preserve character and block device metadata. This option\n currently isn't supported for Amazon EFS.

" + "smithy.api#documentation": "

Specifies whether DataSync should preserve the metadata of block and\n character devices in the source location and recreate the files with that device name and\n metadata on the destination. DataSync copies only the name and metadata of such\n devices.

\n \n

DataSync can't copy the actual contents of these devices because they're\n nonterminal and don't return an end-of-file (EOF) marker.

\n \n
    \n
  • \n

    \n NONE (default) - Ignores special devices (recommended).

    \n
    • \n
  • \n

    \n PRESERVE - Preserves character and block device metadata. This option\n currently isn't supported for Amazon EFS.

    \n
    • \n
" } }, "PosixPermissions": { "target": "com.amazonaws.datasync#PosixPermissions", "traits": { - "smithy.api#documentation": "

Specifies which users or groups can access a file for a specific purpose such as reading,\n writing, or execution of the file.

\n

For more information, see Metadata copied by DataSync.

\n

Default value: PRESERVE\n

\n

\n PRESERVE: Preserve POSIX-style permissions (recommended).

\n

\n NONE: Ignore permissions.

\n \n

DataSync can preserve extant permissions of a source location.

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

Specifies which users or groups can access a file for a specific purpose such as reading,\n writing, or execution of the file.

\n

For more information, see Metadata copied by DataSync.

\n
    \n
  • \n

    \n PRESERVE (default) - Preserves POSIX-style permissions, which is\n recommended.

    \n
    • \n
  • \n

    \n NONE - Ignores POSIX-style permissions.

    \n
    • \n
\n \n

DataSync can preserve extant permissions of a source location.

\n " } }, "BytesPerSecond": { @@ -6976,25 +7042,25 @@ "LogLevel": { "target": "com.amazonaws.datasync#LogLevel", "traits": { - "smithy.api#documentation": "

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs\n log group. To specify the log group, see CloudWatchLogGroupArn.

\n

If you set LogLevel to OFF, no logs are published.\n BASIC publishes logs on errors for individual files transferred.\n TRANSFER publishes logs for every file or object that is transferred and\n integrity checked.

" + "smithy.api#documentation": "

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs\n log group. To specify the log group, see CloudWatchLogGroupArn.

\n
    \n
  • \n

    \n BASIC - Publishes logs with only basic information (such as transfer\n errors).

    \n
    • \n
  • \n

    \n TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.

    \n
    • \n
  • \n

    \n OFF - No logs are published.

    \n
    • \n
" } }, "TransferMode": { "target": "com.amazonaws.datasync#TransferMode", "traits": { - "smithy.api#documentation": "

Determines whether DataSync transfers only the data and metadata that differ\n between the source and the destination location or transfers all the content from the source\n (without comparing what's in the destination).

\n

\n CHANGED: DataSync copies only data or metadata that is new or\n different content from the source location to the destination location.

\n

\n ALL: DataSync copies all source location content to the destination\n (without comparing what's in the destination).

" + "smithy.api#documentation": "

Determines whether DataSync transfers only the data and metadata that differ\n between the source and the destination location or transfers all the content from the source\n (without comparing what's in the destination).

\n
    \n
  • \n

    \n CHANGED (default) - DataSync copies only data or metadata that\n is new or different content from the source location to the destination location.

    \n
    • \n
  • \n

    \n ALL - DataSync copies everything in the source to the\n destination without comparing differences between the locations.

    \n
    • \n
" } }, "SecurityDescriptorCopyFlags": { "target": "com.amazonaws.datasync#SmbSecurityDescriptorCopyFlags", "traits": { - "smithy.api#documentation": "

Specifies which components of the SMB security descriptor are copied from source to\n destination objects.

\n

This value is only used for transfers between SMB and Amazon FSx for Windows File Server\n locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.

\n

Default value: OWNER_DACL\n

\n

\n OWNER_DACL: For each copied object, DataSync copies the following\n metadata:

\n
    \n
  • \n

    The object owner.

    \n
    • \n
  • \n

    NTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.

    \n

    DataSync won't copy NTFS system access control lists (SACLs) with this\n option.

    \n
    • \n
\n

\n OWNER_DACL_SACL: For each copied object, DataSync copies the\n following metadata:

\n
    \n
  • \n

    The object owner.

    \n
    • \n
  • \n

    NTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.

    \n
    • \n
  • \n

    SACLs, which are used by administrators to log attempts to access a secured\n object.

    \n

    Copying SACLs requires granting additional permissions to the Windows user that\n DataSync uses to access your SMB location. For information about choosing a\n user that ensures sufficient permissions to files, folders, and metadata, see user.

    \n
    • \n
\n

\n NONE: None of the SMB security descriptor components are copied. Destination\n objects are owned by the user that was provided for accessing the destination location. DACLs\n and SACLs are set based on the destination server’s configuration.

" + "smithy.api#documentation": "

Specifies which components of the SMB security descriptor are copied from source to\n destination objects.

\n

This value is only used for transfers between SMB and Amazon FSx for Windows File Server\n locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.

\n
    \n
  • \n

    \n OWNER_DACL (default) - For each copied object, DataSync copies\n the following metadata:

    \n
      \n
    • \n

      The object owner.

      \n
      • \n
    • \n

      NTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.

      \n

      DataSync won't copy NTFS system access control lists (SACLs) with this\n option.

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

    \n OWNER_DACL_SACL - For each copied object, DataSync copies the\n following metadata:

    \n
      \n
    • \n

      The object owner.

      \n
      • \n
    • \n

      NTFS discretionary access control lists (DACLs), which determine whether to grant\n access to an object.

      \n
      • \n
    • \n

      SACLs, which are used by administrators to log attempts to access a secured\n object.

      \n

      Copying SACLs requires granting additional permissions to the Windows user that\n DataSync uses to access your SMB location. For information about choosing\n a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending\n on the type of location in your transfer).

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

    \n NONE - None of the SMB security descriptor components are copied.\n Destination objects are owned by the user that was provided for accessing the destination\n location. DACLs and SACLs are set based on the destination server’s configuration.

    \n
    • \n
" } }, "ObjectTags": { "target": "com.amazonaws.datasync#ObjectTags", "traits": { - "smithy.api#documentation": "

Specifies whether object tags are preserved when transferring between object storage\n systems. If you want your DataSync task to ignore object tags, specify the\n NONE value.

\n

Default Value: PRESERVE\n

" + "smithy.api#documentation": "

Specifies whether you want DataSync to PRESERVE object tags\n (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

" } } }, @@ -7110,7 +7176,7 @@ "Version": { "target": "com.amazonaws.datasync#AgentVersion", "traits": { - "smithy.api#documentation": "

The version of the DataSync agent.

\n \n

Beginning December 7, 2023, we will discontinue version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, replace those agents before then to avoid data transfer or storage discovery disruptions. If you need more help, contact Amazon Web Services Support.

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

The version of the DataSync agent.

\n \n

On December 7, 2023, we discontinued version 1 DataSync agents. Check the DataSync console to see if you have affected agents. If you do, replace those agents or delete them if they aren't in use. If you need more help, contact Amazon Web Services Support.

\n " } } }, @@ -7413,7 +7479,7 @@ "BucketAccessRoleArn": { "target": "com.amazonaws.datasync#IamRoleArn", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket.

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

Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket.

", "smithy.api#required": {} } } @@ -7635,13 +7701,58 @@ "BucketAccessRoleArn": { "target": "com.amazonaws.datasync#IamRoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role for accessing the S3 bucket.

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

Specifies the ARN of the IAM role that DataSync uses to access\n your S3 bucket.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access\n an Amazon S3 bucket.

\n

For detailed information about using such a role, see Creating a Location for\n Amazon S3 in the DataSync User Guide.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.

\n

For more information, see Accessing\n S3 buckets.

" + } + }, + "com.amazonaws.datasync#S3ManifestConfig": { + "type": "structure", + "members": { + "ManifestObjectPath": { + "target": "com.amazonaws.datasync#S3Subdirectory", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 object key of your manifest. This can include a prefix\n (for example, prefix/my-manifest.csv).

", + "smithy.api#required": {} + } + }, + "BucketAccessRoleArn": { + "target": "com.amazonaws.datasync#IamRoleArn", + "traits": { + "smithy.api#documentation": "

Specifies the Identity and Access Management (IAM) role that allows DataSync to access your\n manifest. For more information, see Providing DataSync access to your manifest.

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

Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.

", + "smithy.api#required": {} + } + }, + "ManifestObjectVersionId": { + "target": "com.amazonaws.datasync#S3ObjectVersionId", + "traits": { + "smithy.api#documentation": "

Specifies the object version ID of the manifest that you want DataSync to use.\n If you don't set this, DataSync uses the latest version of the object.

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

Specifies the S3 bucket where you're hosting the manifest that you want DataSync to use. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

" + } + }, + "com.amazonaws.datasync#S3ObjectVersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^.+$" } }, "com.amazonaws.datasync#S3StorageClass": { @@ -7850,6 +7961,21 @@ } } }, + "com.amazonaws.datasync#SourceManifestConfig": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.datasync#S3ManifestConfig", + "traits": { + "smithy.api#documentation": "

Specifies the S3 bucket where you're hosting your manifest.

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

Specifies the manifest that you want DataSync to use and where it's hosted.\n For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

" + } + }, "com.amazonaws.datasync#SourceNetworkInterfaceArns": { "type": "list", "member": { @@ -7974,16 +8100,22 @@ "smithy.api#documentation": "

Specifies a list of filter rules that determines which files to exclude from a task. The\n list contains a single filter string that consists of the patterns to exclude. The patterns\n are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" } }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", + "ManifestConfig": { + "target": "com.amazonaws.datasync#ManifestConfig", "traits": { - "smithy.api#documentation": "

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing\n the task execution.

\n

\n Tags are key-value pairs that help you manage, filter, and search for\n your DataSync resources.

" + "smithy.api#documentation": "

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

\n

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

\n

To remove a manifest configuration, specify this parameter with an empty value.

" } }, "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

" + "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information\n about your DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.

\n

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

\n

To remove a task report configuration, specify this parameter as empty.

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

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing\n the task execution.

\n

\n Tags are key-value pairs that help you manage, filter, and search for\n your DataSync resources.

" } } }, @@ -8266,18 +8398,18 @@ "TaskExecutionArn": { "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task that was executed.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a task execution.

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

The status of a task execution.

" + "smithy.api#documentation": "

The status of a task execution. For more information, see Task execution statuses.

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

Represents a single entry in a list of task executions.\n TaskExecutionListEntry returns an array that contains a list of specific\n invocations of a task when the ListTaskExecutions\n operation is called.

" + "smithy.api#documentation": "

Represents a single entry in a list of DataSync task executions that's\n returned with the ListTaskExecutions\n operation.

" } }, "com.amazonaws.datasync#TaskExecutionResultDetail": { @@ -9310,7 +9442,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the configuration of a DataSync transfer task.

" + "smithy.api#documentation": "

Updates the configuration of an DataSync transfer task.

" } }, "com.amazonaws.datasync#UpdateTaskExecution": { @@ -9404,10 +9536,16 @@ "smithy.api#documentation": "

Specifies a list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.

" } }, + "ManifestConfig": { + "target": "com.amazonaws.datasync#ManifestConfig", + "traits": { + "smithy.api#documentation": "

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

\n

When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

\n

To remove a manifest configuration, specify this parameter as empty.

" + } + }, "TaskReportConfig": { "target": "com.amazonaws.datasync#TaskReportConfig", "traits": { - "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

" + "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information\n about your DataSync transfer. For more information, see Monitoring your DataSync\n transfers with task reports.

\n

When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

\n

To remove a task report configuration, specify this parameter as empty.

" } } }, diff --git a/codegen/sdk/aws-models/lex-models-v2.json b/codegen/sdk/aws-models/lex-models-v2.json index 7c01c6e53fb..084e80fe179 100644 --- a/codegen/sdk/aws-models/lex-models-v2.json +++ b/codegen/sdk/aws-models/lex-models-v2.json @@ -2741,6 +2741,94 @@ "smithy.api#pattern": "^(\\bAmazonLexTestAlias\\b|[0-9a-zA-Z][_-]?)+$" } }, + "com.amazonaws.lexmodelsv2#BotAliasReplicaSummary": { + "type": "structure", + "members": { + "botAliasId": { + "target": "com.amazonaws.lexmodelsv2#BotAliasId", + "traits": { + "smithy.api#documentation": "

The bot alias ID for all the alias bot replications.

" + } + }, + "botAliasReplicationStatus": { + "target": "com.amazonaws.lexmodelsv2#BotAliasReplicationStatus", + "traits": { + "smithy.api#documentation": "

The replication statuses for all the alias bot replications.

" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "

The bot version for all the alias bot replications.

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

The creation time and date for all the alias bot replications.

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

The last time and date updated for all the alias bot replications.

" + } + }, + "failureReasons": { + "target": "com.amazonaws.lexmodelsv2#FailureReasons", + "traits": { + "smithy.api#documentation": "

The reasons for failure for the aliases bot replications.

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

Contains information about all the aliases replication statuses applicable for global resiliency.

" + } + }, + "com.amazonaws.lexmodelsv2#BotAliasReplicaSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#BotAliasReplicaSummary" + } + }, + "com.amazonaws.lexmodelsv2#BotAliasReplicationStatus": { + "type": "enum", + "members": { + "Creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "Updating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Updating" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the operation to replicate the bot alias. Values: Creating, Updating, Available, Deleting, Failed.

" + } + }, "com.amazonaws.lexmodelsv2#BotAliasStatus": { "type": "enum", "members": { @@ -3513,6 +3601,76 @@ "target": "com.amazonaws.lexmodelsv2#BotRecommendationSummary" } }, + "com.amazonaws.lexmodelsv2#BotReplicaStatus": { + "type": "enum", + "members": { + "Enabling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabling" + } + }, + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enabled" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the operation to replicate the bot. Values: Enabling, Enabled, Deleting, Failed.

" + } + }, + "com.amazonaws.lexmodelsv2#BotReplicaSummary": { + "type": "structure", + "members": { + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The replica region used in the replication statuses summary.

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

The creation time and date for the replicated bots.

" + } + }, + "botReplicaStatus": { + "target": "com.amazonaws.lexmodelsv2#BotReplicaStatus", + "traits": { + "smithy.api#documentation": "

The operation status for the replicated bot applicable.

" + } + }, + "failureReasons": { + "target": "com.amazonaws.lexmodelsv2#FailureReasons", + "traits": { + "smithy.api#documentation": "

The reasons for the failure for the replicated bot.

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

Contains summary information about all the replication statuses applicable for global resiliency.

" + } + }, + "com.amazonaws.lexmodelsv2#BotReplicaSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#BotReplicaSummary" + } + }, "com.amazonaws.lexmodelsv2#BotSortAttribute": { "type": "enum", "members": { @@ -3711,6 +3869,109 @@ } } }, + "com.amazonaws.lexmodelsv2#BotVersionReplicaSortAttribute": { + "type": "enum", + "members": { + "BotVersion": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BotVersion" + } + } + } + }, + "com.amazonaws.lexmodelsv2#BotVersionReplicaSortBy": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.lexmodelsv2#BotVersionReplicaSortAttribute", + "traits": { + "smithy.api#documentation": "

The attribute of the sort category for the version replicated bots.

", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.lexmodelsv2#SortOrder", + "traits": { + "smithy.api#documentation": "

The order of the sort category for the version replicated bots.

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

The sort category for the version replicated bots.

" + } + }, + "com.amazonaws.lexmodelsv2#BotVersionReplicaSummary": { + "type": "structure", + "members": { + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "

The bot version for the summary information for all the version replication statuses.

" + } + }, + "botVersionReplicationStatus": { + "target": "com.amazonaws.lexmodelsv2#BotVersionReplicationStatus", + "traits": { + "smithy.api#documentation": "

The version replication status for all the replicated bots.

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

The creation date and time of the replication status for all the replicated bots.

" + } + }, + "failureReasons": { + "target": "com.amazonaws.lexmodelsv2#FailureReasons", + "traits": { + "smithy.api#documentation": "

The reasons for replication failure for all the replicated bots.

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

Contains summary information for all the version replication statuses applicable for Global resiliency.

" + } + }, + "com.amazonaws.lexmodelsv2#BotVersionReplicaSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#BotVersionReplicaSummary" + } + }, + "com.amazonaws.lexmodelsv2#BotVersionReplicationStatus": { + "type": "enum", + "members": { + "Creating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Creating" + } + }, + "Available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Available" + } + }, + "Deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of the operation to replicate the bot version. Values: Creating, Available, Deleting, Failed.

" + } + }, "com.amazonaws.lexmodelsv2#BotVersionSortAttribute": { "type": "enum", "members": { @@ -5017,6 +5278,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.lexmodelsv2#CreateBotReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#CreateBotReplicaRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#CreateBotReplicaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Action to create a replication of the source bot in the secondary region.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/bots/{botId}/replicas", + "code": 202 + } + } + }, + "com.amazonaws.lexmodelsv2#CreateBotReplicaRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The request for the unique bot ID of the source bot to be replicated in the secondary region.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The request for the secondary region that will be used in the replication of the source bot.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#CreateBotReplicaResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The unique bot ID of the replicated bot generated.

" + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The region of the replicated bot generated.

" + } + }, + "sourceRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The source region for the source bot used for the replicated bot generated.

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

The creation date and time of the replicated bot generated.

" + } + }, + "botReplicaStatus": { + "target": "com.amazonaws.lexmodelsv2#BotReplicaStatus", + "traits": { + "smithy.api#documentation": "

The operational status of the replicated bot generated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lexmodelsv2#CreateBotRequest": { "type": "structure", "members": { @@ -6891,6 +7250,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.lexmodelsv2#DeleteBotReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DeleteBotReplicaRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#DeleteBotReplicaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

The action to delete the replicated bot in the secondary region.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/bots/{botId}/replicas/{replicaRegion}", + "code": 202 + } + } + }, + "com.amazonaws.lexmodelsv2#DeleteBotReplicaRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The unique ID of the replicated bot to be deleted from the secondary region

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The secondary region of the replicated bot that will be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#DeleteBotReplicaResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The unique bot ID of the replicated bot generated.

" + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The region of the replicated bot generated.

" + } + }, + "botReplicaStatus": { + "target": "com.amazonaws.lexmodelsv2#BotReplicaStatus", + "traits": { + "smithy.api#documentation": "

The operational status of the replicated bot generated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lexmodelsv2#DeleteBotRequest": { "type": "structure", "members": { @@ -8539,7 +8985,109 @@ "botRecommendationResults": { "target": "com.amazonaws.lexmodelsv2#BotRecommendationResults", "traits": { - "smithy.api#documentation": "

The object representing the URL of the bot definition, the URL of\n the associated transcript and a statistical summary of the bot\n recommendation results.

" + "smithy.api#documentation": "

The object representing the URL of the bot definition, the URL of\n the associated transcript and a statistical summary of the bot\n recommendation results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#DescribeBotReplica": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DescribeBotReplicaRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#DescribeBotReplicaResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Monitors the bot replication status through the UI console.

", + "smithy.api#http": { + "method": "GET", + "uri": "/bots/{botId}/replicas/{replicaRegion}", + "code": 200 + } + } + }, + "com.amazonaws.lexmodelsv2#DescribeBotReplicaRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The request for the unique bot ID of the replicated bot being monitored.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The request for the region of the replicated bot being monitored.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#DescribeBotReplicaResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The unique bot ID of the replicated bot being monitored.

" + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The region of the replicated bot being monitored.

" + } + }, + "sourceRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The source region of the replicated bot being monitored.

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

The creation date and time of the replicated bot being monitored.

" + } + }, + "botReplicaStatus": { + "target": "com.amazonaws.lexmodelsv2#BotReplicaStatus", + "traits": { + "smithy.api#documentation": "

The operational status of the replicated bot being monitored.

" + } + }, + "failureReasons": { + "target": "com.amazonaws.lexmodelsv2#FailureReasons", + "traits": { + "smithy.api#documentation": "

The failure reasons the bot being monitored failed to replicate.

" } } }, @@ -12615,6 +13163,9 @@ { "target": "com.amazonaws.lexmodelsv2#CreateBotLocale" }, + { + "target": "com.amazonaws.lexmodelsv2#CreateBotReplica" + }, { "target": "com.amazonaws.lexmodelsv2#CreateBotVersion" }, @@ -12651,6 +13202,9 @@ { "target": "com.amazonaws.lexmodelsv2#DeleteBotLocale" }, + { + "target": "com.amazonaws.lexmodelsv2#DeleteBotReplica" + }, { "target": "com.amazonaws.lexmodelsv2#DeleteBotVersion" }, @@ -12696,6 +13250,9 @@ { "target": "com.amazonaws.lexmodelsv2#DescribeBotRecommendation" }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeBotReplica" + }, { "target": "com.amazonaws.lexmodelsv2#DescribeBotResourceGeneration" }, @@ -12747,18 +13304,27 @@ { "target": "com.amazonaws.lexmodelsv2#ListBotAliases" }, + { + "target": "com.amazonaws.lexmodelsv2#ListBotAliasReplicas" + }, { "target": "com.amazonaws.lexmodelsv2#ListBotLocales" }, { "target": "com.amazonaws.lexmodelsv2#ListBotRecommendations" }, + { + "target": "com.amazonaws.lexmodelsv2#ListBotReplicas" + }, { "target": "com.amazonaws.lexmodelsv2#ListBotResourceGenerations" }, { "target": "com.amazonaws.lexmodelsv2#ListBots" }, + { + "target": "com.amazonaws.lexmodelsv2#ListBotVersionReplicas" + }, { "target": "com.amazonaws.lexmodelsv2#ListBotVersions" }, @@ -13842,6 +14408,116 @@ "smithy.api#output": {} } }, + "com.amazonaws.lexmodelsv2#ListBotAliasReplicas": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListBotAliasReplicasRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListBotAliasReplicasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

The action to list the replicated bots created from the source bot alias.

", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/replicas/{replicaRegion}/botaliases", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotAliasReplicasRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The request for the unique bot ID of the replicated bot created from the source bot alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The request for the secondary region of the replicated bot created from the source bot alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "

The request for maximum results to list the replicated bots created from the source bot alias.

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

The request for the next token for the replicated bot created from the source bot alias.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#ListBotAliasReplicasResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The unique bot ID of the replicated bot created from the source bot alias.

" + } + }, + "sourceRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The source region of the replicated bot created from the source bot alias.

" + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The secondary region of the replicated bot created from the source bot alias.

" + } + }, + "botAliasReplicaSummaries": { + "target": "com.amazonaws.lexmodelsv2#BotAliasReplicaSummaryList", + "traits": { + "smithy.api#documentation": "

The summary information of the replicated bot created from the source bot alias.

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

The next token for the replicated bots created from the source bot alias.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lexmodelsv2#ListBotAliases": { "type": "operation", "input": { @@ -14166,6 +14842,79 @@ "smithy.api#output": {} } }, + "com.amazonaws.lexmodelsv2#ListBotReplicas": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListBotReplicasRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListBotReplicasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

The action to list the replicated bots.

", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/replicas", + "code": 200 + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotReplicasRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The request for the unique bot IDs in the list of replicated bots.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#ListBotReplicasResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

the unique bot IDs in the list of replicated bots.

" + } + }, + "sourceRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The source region of the source bots in the list of replicated bots.

" + } + }, + "botReplicaSummaries": { + "target": "com.amazonaws.lexmodelsv2#BotReplicaSummaryList", + "traits": { + "smithy.api#documentation": "

The summary details for the replicated bots.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lexmodelsv2#ListBotResourceGenerations": { "type": "operation", "input": { @@ -14290,6 +15039,122 @@ "smithy.api#output": {} } }, + "com.amazonaws.lexmodelsv2#ListBotVersionReplicas": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListBotVersionReplicasRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListBotVersionReplicasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Contains information about all the versions replication statuses applicable for Global Resiliency.

", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/replicas/{replicaRegion}/botversions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotVersionReplicasRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The request for the unique ID in the list of replicated bots.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The request for the region used in the list of replicated bots.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum results given in the list of replicated bots.

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

The next token given in the list of replicated bots.

" + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#BotVersionReplicaSortBy", + "traits": { + "smithy.api#documentation": "

The requested sort category for the list of replicated bots.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#ListBotVersionReplicasResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "

The unique ID of the bots in the list of replicated bots.

" + } + }, + "sourceRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The source region used for the bots in the list of replicated bots.

" + } + }, + "replicaRegion": { + "target": "com.amazonaws.lexmodelsv2#ReplicaRegion", + "traits": { + "smithy.api#documentation": "

The region used for the replicated bots in the list of replicated bots.

" + } + }, + "botVersionReplicaSummaries": { + "target": "com.amazonaws.lexmodelsv2#BotVersionReplicaSummaryList", + "traits": { + "smithy.api#documentation": "

The information summary used for the replicated bots in the list of replicated bots.

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

The next token used for the replicated bots in the list of replicated bots.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.lexmodelsv2#ListBotVersions": { "type": "operation", "input": { @@ -17726,6 +18591,16 @@ "smithy.api#documentation": "

Specifies the time window that utterance statistics are returned\n for. The time window is always relative to the last time that the that\n utterances were aggregated. For example, if the\n ListAggregatedUtterances operation is called at 1600,\n the time window is set to 1 hour, and the last refresh time was 1530,\n only utterances made between 1430 and 1530 are returned.

\n

You can choose the time window that statistics should be returned\n for.

\n
    \n
  • \n

    \n Hours - You can request\n utterance statistics for 1, 3, 6, 12, or 24 hour time windows.\n Statistics are refreshed every half hour for 1 hour time windows,\n and hourly for the other time windows.

    \n
    • \n
  • \n

    \n Days - You can request\n utterance statistics for 3 days. Statistics are refreshed every 6\n hours.

    \n
    • \n
  • \n

    \n Weeks - You can see\n statistics for one or two weeks. Statistics are refreshed every\n 12 hours for one week time windows, and once per day for two week\n time windows.

    \n
    • \n
" } }, + "com.amazonaws.lexmodelsv2#ReplicaRegion": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The region that contains the replicated bots. Minimum value = 2, maximum value = 25.

", + "smithy.api#length": { + "min": 2, + "max": 25 + } + } + }, "com.amazonaws.lexmodelsv2#ResourceCount": { "type": "integer" }, diff --git a/codegen/sdk/aws-models/redshift.json b/codegen/sdk/aws-models/redshift.json index 65a22483118..5dbca5f4e1e 100644 --- a/codegen/sdk/aws-models/redshift.json +++ b/codegen/sdk/aws-models/redshift.json @@ -9984,6 +9984,29 @@ "smithy.api#pattern": "^[a-zA-Z0-9_+.#@$-]+$" } }, + "com.amazonaws.redshift#ImpactRankingType": { + "type": "enum", + "members": { + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + } + } + }, "com.amazonaws.redshift#ImportTablesCompleted": { "type": "list", "member": { @@ -10794,6 +10817,84 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshift#ListRecommendations": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#ListRecommendationsMessage" + }, + "output": { + "target": "com.amazonaws.redshift#ListRecommendationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Recommendations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.redshift#ListRecommendationsMessage": { + "type": "structure", + "members": { + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Amazon Redshift cluster for which the list of Advisor recommendations is returned. \n If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

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

The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for which the list of Advisor recommendations is returned.\n If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of response records to return in each call. If the number of remaining response records \n exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve \n the next set of records by retrying the command with the returned marker value.

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

A value that indicates the starting point for the next set of response records in a subsequent request. If a \n value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshift#ListRecommendationsResult": { + "type": "structure", + "members": { + "Recommendations": { + "target": "com.amazonaws.redshift#RecommendationList", + "traits": { + "smithy.api#documentation": "

The Advisor recommendations for action on the Amazon Redshift cluster.

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

A value that indicates the starting point for the next set of response records in a subsequent \n request. If a value is returned in a response, you can retrieve the next set\n of records by providing this returned marker value in the Marker parameter\n and retrying the command. If the Marker field is empty, all response\n records have been retrieved for the request.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#LogDestinationType": { "type": "enum", "members": { @@ -13272,6 +13373,153 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#Recommendation": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

A unique identifier of the Advisor recommendation.

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

The unique identifier of the cluster for which the recommendation is returned.

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

The Amazon Redshift cluster namespace ARN for which the recommendations is returned.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time (UTC) that the recommendation was created.

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

The type of Advisor recommendation.

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

The title of the recommendation.

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

The description of the recommendation.

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

The description of what was observed about your cluster.

" + } + }, + "ImpactRanking": { + "target": "com.amazonaws.redshift#ImpactRankingType", + "traits": { + "smithy.api#documentation": "

The scale of the impact that the Advisor recommendation has to the performance and cost of the cluster.

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

The description of the recommendation.

" + } + }, + "RecommendedActions": { + "target": "com.amazonaws.redshift#RecommendedActionList", + "traits": { + "smithy.api#documentation": "

List of Amazon Redshift recommended actions.

" + } + }, + "ReferenceLinks": { + "target": "com.amazonaws.redshift#ReferenceLinkList", + "traits": { + "smithy.api#documentation": "

List of helpful links for more information about the Advisor recommendation.

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

An Amazon Redshift Advisor recommended action on the Amazon Redshift cluster.

" + } + }, + "com.amazonaws.redshift#RecommendationList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#Recommendation", + "traits": { + "smithy.api#xmlName": "Recommendation" + } + } + }, + "com.amazonaws.redshift#RecommendedAction": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The specific instruction about the command.

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

The database name to perform the action on. Only applicable if the type of command is SQL.

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

The command to run.

" + } + }, + "Type": { + "target": "com.amazonaws.redshift#RecommendedActionType", + "traits": { + "smithy.api#documentation": "

The type of command.

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

The recommended action from the Amazon Redshift Advisor recommendation.

" + } + }, + "com.amazonaws.redshift#RecommendedActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#RecommendedAction", + "traits": { + "smithy.api#xmlName": "RecommendedAction" + } + } + }, + "com.amazonaws.redshift#RecommendedActionType": { + "type": "enum", + "members": { + "SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL" + } + }, + "CLI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLI" + } + } + } + }, "com.amazonaws.redshift#RecurringCharge": { "type": "structure", "members": { @@ -13737,6 +13985,9 @@ { "target": "com.amazonaws.redshift#GetResourcePolicy" }, + { + "target": "com.amazonaws.redshift#ListRecommendations" + }, { "target": "com.amazonaws.redshift#ModifyAquaConfiguration" }, @@ -14886,6 +15137,35 @@ } } }, + "com.amazonaws.redshift#ReferenceLink": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The hyperlink text that describes the link to more information.

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

The URL address to find more information.

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

A link to an Amazon Redshift Advisor reference for more information about a recommendation.

" + } + }, + "com.amazonaws.redshift#ReferenceLinkList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#ReferenceLink", + "traits": { + "smithy.api#xmlName": "ReferenceLink" + } + } + }, "com.amazonaws.redshift#RejectDataShare": { "type": "operation", "input": { From 0c770f04f0f49364bd4b48185aa83f59db079bba Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 7 Feb 2024 19:03:18 +0000 Subject: [PATCH 11/32] feat: update AWS service endpoints metadata --- .../aws/sdk/kotlin/codegen/endpoints.json | 30 ++++--------------- 1 file changed, 6 insertions(+), 24 deletions(-) diff --git a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json index 4cef7a07075..c7687dd4ec6 100644 --- a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json +++ b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json @@ -14350,12 +14350,6 @@ } ] }, "endpoints" : { - "af-south-1" : { - "hostname" : "resource-explorer-2.af-south-1.api.aws" - }, - "ap-east-1" : { - "hostname" : "resource-explorer-2.ap-east-1.api.aws" - }, "ap-northeast-1" : { "hostname" : "resource-explorer-2.ap-northeast-1.api.aws" }, @@ -14368,9 +14362,6 @@ "ap-south-1" : { "hostname" : "resource-explorer-2.ap-south-1.api.aws" }, - "ap-south-2" : { - "hostname" : "resource-explorer-2.ap-south-2.api.aws" - }, "ap-southeast-1" : { "hostname" : "resource-explorer-2.ap-southeast-1.api.aws" }, @@ -14380,24 +14371,15 @@ "ap-southeast-3" : { "hostname" : "resource-explorer-2.ap-southeast-3.api.aws" }, - "ap-southeast-4" : { - "hostname" : "resource-explorer-2.ap-southeast-4.api.aws" - }, "ca-central-1" : { "hostname" : "resource-explorer-2.ca-central-1.api.aws" }, "eu-central-1" : { "hostname" : "resource-explorer-2.eu-central-1.api.aws" }, - "eu-central-2" : { - "hostname" : "resource-explorer-2.eu-central-2.api.aws" - }, "eu-north-1" : { "hostname" : "resource-explorer-2.eu-north-1.api.aws" }, - "eu-south-1" : { - "hostname" : "resource-explorer-2.eu-south-1.api.aws" - }, "eu-west-1" : { "hostname" : "resource-explorer-2.eu-west-1.api.aws" }, @@ -14407,12 +14389,6 @@ "eu-west-3" : { "hostname" : "resource-explorer-2.eu-west-3.api.aws" }, - "il-central-1" : { - "hostname" : "resource-explorer-2.il-central-1.api.aws" - }, - "me-central-1" : { - "hostname" : "resource-explorer-2.me-central-1.api.aws" - }, "me-south-1" : { "hostname" : "resource-explorer-2.me-south-1.api.aws" }, @@ -20726,6 +20702,12 @@ "cn-northwest-1" : { } } }, + "inspector2" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, "internetmonitor" : { "defaults" : { "dnsSuffix" : "api.amazonwebservices.com.cn", From f15d23b736a192c8cb75f7b225163e2e19ccdb12 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 7 Feb 2024 19:06:07 +0000 Subject: [PATCH 12/32] chore: release 1.0.52 --- CHANGELOG.md | 7 +++++++ gradle.properties | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 42515f8735f..132148c830e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [1.0.52] - 02/07/2024 + +### Features +* (**datasync**) AWS DataSync now supports manifests for specifying files or objects to transfer. +* (**lexmodelsv2**) This release introduces a new bot replication feature as part of Lex Global Resiliency offering. This feature leverages a new set of APIs that allow customers to create bot replicas and replicate changes to bots across regions. +* (**redshift**) LisRecommendations API to fetch Amazon Redshift Advisor recommendations. + ## [1.0.51] - 02/06/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 128f55691e0..ced8fb9a238 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.52-SNAPSHOT +sdkVersion=1.0.52 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 7af78324f38f25115ce76d6d904056024ae18a5b Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 7 Feb 2024 19:06:09 +0000 Subject: [PATCH 13/32] chore: bump snapshot version to 1.0.53-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index ced8fb9a238..667b305b835 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.52 +sdkVersion=1.0.53-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 3303e43af3657258d304e0e2dbe153677c1074ba Mon Sep 17 00:00:00 2001 From: Ian Botsford <83236726+ianbotsf@users.noreply.github.com> Date: Wed, 7 Feb 2024 15:19:46 -0800 Subject: [PATCH 14/32] fix: bump smithy-kotlin version to consume upstream fixes for URL parsing (#1205) --- .changes/03502878-f89d-4d73-94d5-0584d145657f.json | 8 ++++++++ gradle/libs.versions.toml | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 .changes/03502878-f89d-4d73-94d5-0584d145657f.json diff --git a/.changes/03502878-f89d-4d73-94d5-0584d145657f.json b/.changes/03502878-f89d-4d73-94d5-0584d145657f.json new file mode 100644 index 00000000000..3149610db7d --- /dev/null +++ b/.changes/03502878-f89d-4d73-94d5-0584d145657f.json @@ -0,0 +1,8 @@ +{ + "id": "03502878-f89d-4d73-94d5-0584d145657f", + "type": "bugfix", + "description": "Bump **smithy-kotlin** version to consume upstream fixes for URL parsing", + "issues": [ + "awslabs/smithy-kotlin#1031" + ] +} \ No newline at end of file diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index ebdc1bf23d2..122dc2ed829 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -9,8 +9,8 @@ coroutines-version = "1.7.3" atomicfu-version = "0.23.1" # smithy-kotlin codegen and runtime are versioned separately -smithy-kotlin-runtime-version = "1.0.12" -smithy-kotlin-codegen-version = "0.30.13" +smithy-kotlin-runtime-version = "1.0.13" +smithy-kotlin-codegen-version = "0.30.14" # codegen smithy-version = "1.42.0" From fdce93bc184848958ccfa3a7707301e3a578c39e Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 8 Feb 2024 19:02:23 +0000 Subject: [PATCH 15/32] feat: update AWS API models --- codegen/sdk/aws-models/codepipeline.json | 337 +++++++++++++++++++++-- codegen/sdk/aws-models/quicksight.json | 216 ++++++++++++++- codegen/sdk/aws-models/workspaces.json | 30 +- 3 files changed, 561 insertions(+), 22 deletions(-) diff --git a/codegen/sdk/aws-models/codepipeline.json b/codegen/sdk/aws-models/codepipeline.json index d531132cc4d..1d0f55894d8 100644 --- a/codegen/sdk/aws-models/codepipeline.json +++ b/codegen/sdk/aws-models/codepipeline.json @@ -594,6 +594,12 @@ "smithy.api#documentation": "

The last update time of the action execution.

" } }, + "updatedBy": { + "target": "com.amazonaws.codepipeline#LastUpdatedBy", + "traits": { + "smithy.api#documentation": "

The ARN of the user who changed the pipeline execution details.

" + } + }, "status": { "target": "com.amazonaws.codepipeline#ActionExecutionStatus", "traits": { @@ -631,6 +637,12 @@ "traits": { "smithy.api#documentation": "

The pipeline execution ID used to filter action execution history.

" } + }, + "latestInPipelineExecution": { + "target": "com.amazonaws.codepipeline#LatestInPipelineExecutionFilter", + "traits": { + "smithy.api#documentation": "

The latest execution in the pipeline.

\n \n

Filtering on the latest execution is available for executions run on or after\n February 08, 2024.

\n " + } } }, "traits": { @@ -733,6 +745,9 @@ "traits": { "smithy.api#documentation": "

The deepest external link to the external resource (for example, a repository URL or\n deployment endpoint) that is used when running the action.

" } + }, + "errorDetails": { + "target": "com.amazonaws.codepipeline#ErrorDetails" } }, "traits": { @@ -2818,6 +2833,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.codepipeline#ConcurrentPipelineExecutionsLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.codepipeline#Message" + } + }, + "traits": { + "smithy.api#documentation": "

The pipeline has reached the limit for concurrent pipeline executions.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.codepipeline#ConflictException": { "type": "structure", "members": { @@ -3490,6 +3517,29 @@ } } }, + "com.amazonaws.codepipeline#ExecutionMode": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "SUPERSEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERSEDED" + } + }, + "PARALLEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARALLEL" + } + } + } + }, "com.amazonaws.codepipeline#ExecutionSummary": { "type": "string", "traits": { @@ -4018,6 +4068,48 @@ "smithy.api#output": {} } }, + "com.amazonaws.codepipeline#GitBranchFilterCriteria": { + "type": "structure", + "members": { + "includes": { + "target": "com.amazonaws.codepipeline#GitBranchPatternList", + "traits": { + "smithy.api#documentation": "

The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.

" + } + }, + "excludes": { + "target": "com.amazonaws.codepipeline#GitBranchPatternList", + "traits": { + "smithy.api#documentation": "

The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.

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

The Git repository branches specified as filter criteria to start the pipeline.

" + } + }, + "com.amazonaws.codepipeline#GitBranchNamePattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.codepipeline#GitBranchPatternList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#GitBranchNamePattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8 + } + } + }, "com.amazonaws.codepipeline#GitConfiguration": { "type": "structure", "members": { @@ -4031,12 +4123,133 @@ "push": { "target": "com.amazonaws.codepipeline#GitPushFilterList", "traits": { - "smithy.api#documentation": "

The field where the repository event that will start the pipeline, such as pushing\n Git tags, is specified with details.

\n \n

Git tags is the only supported event type.

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

The field where the repository event that will start the pipeline, such as pushing\n Git tags, is specified with details.

" + } + }, + "pullRequest": { + "target": "com.amazonaws.codepipeline#GitPullRequestFilterList", + "traits": { + "smithy.api#documentation": "

The field where the repository event that will start the pipeline is specified as pull requests.

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

A type of trigger configuration for Git-based source actions.

\n \n

You can specify the Git configuration trigger type for all third-party\n Git-based source actions that are supported by the\n CodeStarSourceConnection action type.

\n \n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

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

A type of trigger configuration for Git-based source actions.

\n \n

You can specify the Git configuration trigger type for all third-party\n Git-based source actions that are supported by the\n CodeStarSourceConnection action type.

\n " + } + }, + "com.amazonaws.codepipeline#GitFilePathFilterCriteria": { + "type": "structure", + "members": { + "includes": { + "target": "com.amazonaws.codepipeline#GitFilePathPatternList", + "traits": { + "smithy.api#documentation": "

The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.

" + } + }, + "excludes": { + "target": "com.amazonaws.codepipeline#GitFilePathPatternList", + "traits": { + "smithy.api#documentation": "

The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.

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

The Git repository file paths specified as filter criteria to start the pipeline.

" + } + }, + "com.amazonaws.codepipeline#GitFilePathPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.codepipeline#GitFilePathPatternList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#GitFilePathPattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8 + } + } + }, + "com.amazonaws.codepipeline#GitPullRequestEventType": { + "type": "enum", + "members": { + "OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPEN" + } + }, + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "CLOSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOSED" + } + } + } + }, + "com.amazonaws.codepipeline#GitPullRequestEventTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#GitPullRequestEventType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.codepipeline#GitPullRequestFilter": { + "type": "structure", + "members": { + "events": { + "target": "com.amazonaws.codepipeline#GitPullRequestEventTypeList", + "traits": { + "smithy.api#documentation": "

The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.

" + } + }, + "branches": { + "target": "com.amazonaws.codepipeline#GitBranchFilterCriteria", + "traits": { + "smithy.api#documentation": "

The field that specifies to filter on branches for the pull request trigger configuration.

" + } + }, + "filePaths": { + "target": "com.amazonaws.codepipeline#GitFilePathFilterCriteria", + "traits": { + "smithy.api#documentation": "

The field that specifies to filter on file paths for the pull request trigger configuration.

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

The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.

" + } + }, + "com.amazonaws.codepipeline#GitPullRequestFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#GitPullRequestFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } } }, "com.amazonaws.codepipeline#GitPushFilter": { @@ -4047,6 +4260,18 @@ "traits": { "smithy.api#documentation": "

The field that contains the details for the Git tags trigger\n configuration.

" } + }, + "branches": { + "target": "com.amazonaws.codepipeline#GitBranchFilterCriteria", + "traits": { + "smithy.api#documentation": "

The field that specifies to filter on branches for the push trigger configuration.

" + } + }, + "filePaths": { + "target": "com.amazonaws.codepipeline#GitFilePathFilterCriteria", + "traits": { + "smithy.api#documentation": "

The field that specifies to filter on file paths for the push trigger configuration.

" + } } }, "traits": { @@ -4061,7 +4286,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1 + "max": 3 } } }, @@ -4591,6 +4816,28 @@ "com.amazonaws.codepipeline#LastUpdatedBy": { "type": "string" }, + "com.amazonaws.codepipeline#LatestInPipelineExecutionFilter": { + "type": "structure", + "members": { + "pipelineExecutionId": { + "target": "com.amazonaws.codepipeline#PipelineExecutionId", + "traits": { + "smithy.api#documentation": "

The execution ID for the latest execution in the pipeline.

", + "smithy.api#required": {} + } + }, + "startTimeRange": { + "target": "com.amazonaws.codepipeline#StartTimeRange", + "traits": { + "smithy.api#documentation": "

The start time to filter on for the latest execution in the pipeline. Valid\n options:

\n
    \n
  • \n

    All

    \n
    • \n
  • \n

    Latest

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

The field that specifies to filter on the latest execution in the pipeline.

\n \n

Filtering on the latest execution is available for executions run on or after\n February 08, 2024.

\n " + } + }, "com.amazonaws.codepipeline#LimitExceededException": { "type": "structure", "members": { @@ -5371,16 +5618,16 @@ "smithy.api#documentation": "

The version number of the pipeline. A new pipeline always has a version number of\n 1. This number is incremented when a pipeline is updated.

" } }, - "pipelineType": { - "target": "com.amazonaws.codepipeline#PipelineType", + "executionMode": { + "target": "com.amazonaws.codepipeline#ExecutionMode", "traits": { - "smithy.api#documentation": "

CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.

\n
    \n
  • \n

    V1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.

    \n
    • \n
  • \n

    V2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.

    \n
    • \n
\n \n

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.

\n \n

For information about pricing for CodePipeline, see Pricing.

\n

\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.

\n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

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

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

" } }, - "triggers": { - "target": "com.amazonaws.codepipeline#PipelineTriggerDeclarationList", + "pipelineType": { + "target": "com.amazonaws.codepipeline#PipelineType", "traits": { - "smithy.api#documentation": "

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

\n \n

When a trigger configuration is specified, default change detection for\n repository and branch commits is disabled.

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

CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.

\n
    \n
  • \n

    V1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.

    \n
    • \n
  • \n

    V2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.

    \n
    • \n
\n \n

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.

\n \n

For information about pricing for CodePipeline, see Pricing.

\n

\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.

" } }, "variables": { @@ -5388,6 +5635,12 @@ "traits": { "smithy.api#documentation": "

A list that defines the pipeline variables for a pipeline resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9@\\-_]+.

" } + }, + "triggers": { + "target": "com.amazonaws.codepipeline#PipelineTriggerDeclarationList", + "traits": { + "smithy.api#documentation": "

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

\n \n

When a trigger configuration is specified, default change detection for\n repository and branch commits is disabled.

\n " + } } }, "traits": { @@ -5433,14 +5686,20 @@ "smithy.api#documentation": "

A list of ArtifactRevision objects included in a pipeline\n execution.

" } }, - "trigger": { - "target": "com.amazonaws.codepipeline#ExecutionTrigger" - }, "variables": { "target": "com.amazonaws.codepipeline#ResolvedPipelineVariableList", "traits": { "smithy.api#documentation": "

A list of pipeline variables used for the pipeline execution.

" } + }, + "trigger": { + "target": "com.amazonaws.codepipeline#ExecutionTrigger" + }, + "executionMode": { + "target": "com.amazonaws.codepipeline#ExecutionMode", + "traits": { + "smithy.api#documentation": "

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

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

The interaction that stopped a pipeline execution.

" } + }, + "executionMode": { + "target": "com.amazonaws.codepipeline#ExecutionMode", + "traits": { + "smithy.api#documentation": "

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

" + } } }, "traits": { @@ -5688,7 +5953,13 @@ "pipelineType": { "target": "com.amazonaws.codepipeline#PipelineType", "traits": { - "smithy.api#documentation": "

CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.

\n
    \n
  • \n

    V1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.

    \n
    • \n
  • \n

    V2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.

    \n
    • \n
\n \n

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.

\n \n

For information about pricing for CodePipeline, see Pricing.

\n

\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.

\n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

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

CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.

\n
    \n
  • \n

    V1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.

    \n
    • \n
  • \n

    V2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.

    \n
    • \n
\n \n

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.

\n \n

For information about pricing for CodePipeline, see Pricing.

\n

\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.

" + } + }, + "executionMode": { + "target": "com.amazonaws.codepipeline#ExecutionMode", + "traits": { + "smithy.api#documentation": "

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

" } }, "created": { @@ -5727,7 +5998,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents information about the specified trigger configuration, such as the\n filter criteria and the source stage for the action that contains the trigger.

\n \n

This is only supported for the CodeStarSourceConnection action\n type.

\n \n \n

When a trigger configuration is specified, default change detection for\n repository and branch commits is disabled.

\n \n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

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

Represents information about the specified trigger configuration, such as the\n filter criteria and the source stage for the action that contains the trigger.

\n \n

This is only supported for the CodeStarSourceConnection action\n type.

\n \n \n

When a trigger configuration is specified, default change detection for\n repository and branch commits is disabled.

\n " } }, "com.amazonaws.codepipeline#PipelineTriggerDeclarationList": { @@ -5738,7 +6009,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 20 + "max": 50 } } }, @@ -5789,7 +6060,7 @@ } }, "traits": { - "smithy.api#documentation": "

A pipeline-level variable used for a pipeline execution.

\n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

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

A pipeline-level variable used for a pipeline execution.

" } }, "com.amazonaws.codepipeline#PipelineVariableDeclaration": { @@ -5816,7 +6087,7 @@ } }, "traits": { - "smithy.api#documentation": "

A variable declared at the pipeline level.

\n \n

V2 type pipelines, along with triggers on Git tags and pipeline-level variables,\n are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types\n in the CodePipeline User Guide.

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

A variable declared at the pipeline level.

" } }, "com.amazonaws.codepipeline#PipelineVariableDeclarationList": { @@ -7053,6 +7324,12 @@ "smithy.api#documentation": "

Represents information about the run of a stage.

" } }, + "com.amazonaws.codepipeline#StageExecutionList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#StageExecution" + } + }, "com.amazonaws.codepipeline#StageExecutionStatus": { "type": "enum", "members": { @@ -7163,6 +7440,12 @@ "inboundExecution": { "target": "com.amazonaws.codepipeline#StageExecution" }, + "inboundExecutions": { + "target": "com.amazonaws.codepipeline#StageExecutionList", + "traits": { + "smithy.api#documentation": "

The inbound executions for a stage.

" + } + }, "inboundTransitionState": { "target": "com.amazonaws.codepipeline#TransitionState", "traits": { @@ -7218,6 +7501,9 @@ "target": "com.amazonaws.codepipeline#StartPipelineExecutionOutput" }, "errors": [ + { + "target": "com.amazonaws.codepipeline#ConcurrentPipelineExecutionsLimitExceededException" + }, { "target": "com.amazonaws.codepipeline#ConflictException" }, @@ -7282,6 +7568,23 @@ "smithy.api#output": {} } }, + "com.amazonaws.codepipeline#StartTimeRange": { + "type": "enum", + "members": { + "Latest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Latest" + } + }, + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + } + } + }, "com.amazonaws.codepipeline#StopExecutionTrigger": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/quicksight.json b/codegen/sdk/aws-models/quicksight.json index 9d1ea934978..7ab4cf82fb7 100644 --- a/codegen/sdk/aws-models/quicksight.json +++ b/codegen/sdk/aws-models/quicksight.json @@ -3656,6 +3656,12 @@ "traits": { "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The palette (chart color) display setup of the visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The palette (chart color) display setup of the visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } } }, "traits": { @@ -6298,6 +6316,20 @@ } } }, + "com.amazonaws.quicksight#ContextMenuOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availability status of the context menu options. If the value of this property is set to ENABLED, dashboard readers can interact with the context menu.

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

The context menu options for a visual's interactions.

" + } + }, "com.amazonaws.quicksight#ContributionAnalysisDefault": { "type": "structure", "members": { @@ -9637,6 +9669,12 @@ "traits": { "smithy.api#documentation": "

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The map style options of the filled map visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The visual palette configuration of a FunnelChartVisual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The visual palette configuration of a GaugeChartVisual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } } }, "traits": { @@ -24155,6 +24211,12 @@ }, "VisualPalette": { "target": "com.amazonaws.quicksight#VisualPalette" + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The tooltip display setup of the visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The visual palette configuration of a histogram.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The custom narrative of the insight visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The options that determine the presentation of a KPI visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The visual palette configuration of a line chart.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The contribution analysis (anomaly configuration) setup of the visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The paginated report options for a pivot table visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The axis behavior options of a radar chart.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The data label configuration of a sankey diagram.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The palette (chart color) display setup of the visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

A collection of inline visualizations to display within a chart.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

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

The tooltip display setup of the visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } } }, "traits": { @@ -49457,13 +49591,13 @@ "GrantPermissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "

The permissions that you want to grant on a resource.

" + "smithy.api#documentation": "

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

" } }, "RevokePermissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "

The permissions that you want to revoke from a resource.

" + "smithy.api#documentation": "

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

" } } }, @@ -52540,6 +52674,26 @@ } } }, + "com.amazonaws.quicksight#VisualInteractionOptions": { + "type": "structure", + "members": { + "VisualMenuOption": { + "target": "com.amazonaws.quicksight#VisualMenuOption", + "traits": { + "smithy.api#documentation": "

The on-visual menu options for a visual.

" + } + }, + "ContextMenuOption": { + "target": "com.amazonaws.quicksight#ContextMenuOption", + "traits": { + "smithy.api#documentation": "

The context menu options for a visual.

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

The general visual interactions setup for visual publish options

" + } + }, "com.amazonaws.quicksight#VisualList": { "type": "list", "member": { @@ -52676,6 +52830,20 @@ "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" } }, + "com.amazonaws.quicksight#WaterfallChartColorConfiguration": { + "type": "structure", + "members": { + "GroupColorConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration", + "traits": { + "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

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

The color configuration of a waterfall visual.

" + } + }, "com.amazonaws.quicksight#WaterfallChartConfiguration": { "type": "structure", "members": { @@ -52738,6 +52906,18 @@ "traits": { "smithy.api#documentation": "

The visual palette configuration of a waterfall visual.

" } + }, + "ColorConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartColorConfiguration", + "traits": { + "smithy.api#documentation": "

The color configuration of a waterfall visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } } }, "traits": { @@ -52758,6 +52938,32 @@ "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" } }, + "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration": { + "type": "structure", + "members": { + "PositiveBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the positive bars of a waterfall chart.

" + } + }, + "NegativeBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the negative bars of a waterfall chart.

" + } + }, + "TotalBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the total bars of a waterfall chart.

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

The color configuration for individual groups within a waterfall visual.

" + } + }, "com.amazonaws.quicksight#WaterfallChartOptions": { "type": "structure", "members": { @@ -52953,6 +53159,12 @@ "traits": { "smithy.api#documentation": "

The options for a word cloud visual.

" } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/workspaces.json b/codegen/sdk/aws-models/workspaces.json index ac276cc1149..78d911dc5db 100644 --- a/codegen/sdk/aws-models/workspaces.json +++ b/codegen/sdk/aws-models/workspaces.json @@ -4261,6 +4261,12 @@ "traits": { "smithy.api#documentation": "

If you received a NextToken from a previous call that was paginated,\n provide this token to receive the next set of results.

" } + }, + "WorkspaceName": { + "target": "com.amazonaws.workspaces#WorkspaceName", + "traits": { + "smithy.api#documentation": "

The name of the user-decoupled WorkSpace.

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

Reboots the specified WorkSpaces.

\n

You cannot reboot a WorkSpace unless its state is AVAILABLE,\n UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING \n state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes.

\n

This operation is asynchronous and returns before the WorkSpaces have rebooted.

" + "smithy.api#documentation": "

Reboots the specified WorkSpaces.

\n

You cannot reboot a WorkSpace unless its state is AVAILABLE or\n UNHEALTHY.

\n

This operation is asynchronous and returns before the WorkSpaces have rebooted.

" } }, "com.amazonaws.workspaces#RebootWorkspacesRequest": { @@ -7909,7 +7915,7 @@ "State": { "target": "com.amazonaws.workspaces#WorkspaceState", "traits": { - "smithy.api#documentation": "

The operational state of the WorkSpace.

\n
    \n
  • \n

    \n PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).

    \n
    • \n
  • \n

    \n AVAILABLE – The WorkSpace is running and has passed the health checks.

    \n
    • \n
  • \n

    \n IMPAIRED – Refer to UNHEALTHY state.

    \n
    • \n
  • \n

    \n UNHEALTHY – The WorkSpace is not responding to health checks.

    \n
    • \n
  • \n

    \n REBOOTING – The WorkSpace is being rebooted (restarted).

    \n
    • \n
  • \n

    \n STARTING – The WorkSpace is starting up and health checks are being run.

    \n
    • \n
  • \n

    \n REBUILDING – The WorkSpace is being rebuilt.

    \n
    • \n
  • \n

    \n RESTORING – The WorkSpace is being restored.

    \n
    • \n
  • \n

    \n MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.

    \n
    • \n
  • \n

    \n ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.

    \n
    • \n
  • \n

    \n TERMINATING – The WorkSpace is being deleted.

    \n
    • \n
  • \n

    \n TERMINATED – The WorkSpace has been deleted.

    \n
    • \n
  • \n

    \n SUSPENDED – The WorkSpace has been suspended for image creation.

    \n
    • \n
  • \n

    \n UPDATING – The WorkSpace is undergoing an update.

    \n
    • \n
  • \n

    \n STOPPING – The WorkSpace is being stopped.

    \n
    • \n
  • \n

    \n STOPPED – The WorkSpace has been stopped.

    \n
    • \n
  • \n

    \n ERROR – The WorkSpace is an error state (for example, an error occurred during startup).

    \n
    • \n
\n \n

After a WorkSpace is terminated, the TERMINATED state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.

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

The operational state of the WorkSpace.

\n \n

After a WorkSpace is terminated, the TERMINATED state is returned only\n briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace\n has been successfully terminated.

\n " } }, "BundleId": { @@ -7960,6 +7966,12 @@ "smithy.api#documentation": "

Indicates whether the data stored on the root volume is encrypted.

" } }, + "WorkspaceName": { + "target": "com.amazonaws.workspaces#WorkspaceName", + "traits": { + "smithy.api#documentation": "

The name of the user-decoupled WorkSpace.

" + } + }, "WorkspaceProperties": { "target": "com.amazonaws.workspaces#WorkspaceProperties", "traits": { @@ -8826,6 +8838,12 @@ "target": "com.amazonaws.workspaces#Workspace" } }, + "com.amazonaws.workspaces#WorkspaceName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$" + } + }, "com.amazonaws.workspaces#WorkspaceProperties": { "type": "structure", "members": { @@ -8889,7 +8907,7 @@ "UserName": { "target": "com.amazonaws.workspaces#UserName", "traits": { - "smithy.api#documentation": "

The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

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

The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

\n

The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.

", "smithy.api#required": {} } }, @@ -8929,6 +8947,12 @@ "traits": { "smithy.api#documentation": "

The tags for the WorkSpace.

" } + }, + "WorkspaceName": { + "target": "com.amazonaws.workspaces#WorkspaceName", + "traits": { + "smithy.api#documentation": "

The name of the user-decoupled WorkSpace.

" + } } }, "traits": { From 87cb3e61990cca33baf98725c00b2fe3ba23d088 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 8 Feb 2024 19:05:20 +0000 Subject: [PATCH 16/32] chore: release 1.0.53 --- .changes/03502878-f89d-4d73-94d5-0584d145657f.json | 8 -------- CHANGELOG.md | 10 ++++++++++ gradle.properties | 2 +- 3 files changed, 11 insertions(+), 9 deletions(-) delete mode 100644 .changes/03502878-f89d-4d73-94d5-0584d145657f.json diff --git a/.changes/03502878-f89d-4d73-94d5-0584d145657f.json b/.changes/03502878-f89d-4d73-94d5-0584d145657f.json deleted file mode 100644 index 3149610db7d..00000000000 --- a/.changes/03502878-f89d-4d73-94d5-0584d145657f.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "id": "03502878-f89d-4d73-94d5-0584d145657f", - "type": "bugfix", - "description": "Bump **smithy-kotlin** version to consume upstream fixes for URL parsing", - "issues": [ - "awslabs/smithy-kotlin#1031" - ] -} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 132148c830e..3006092c95b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## [1.0.53] - 02/08/2024 + +### Features +* (**codepipeline**) Add ability to execute pipelines with new parallel & queued execution modes and add support for triggers with filtering on branches and file paths. +* (**quicksight**) General Interactions for Visuals; Waterfall Chart Color Configuration; Documentation Update +* (**workspaces**) This release introduces User-Decoupling feature. This feature allows Workspaces Core customers to provision workspaces without providing users. CreateWorkspaces and DescribeWorkspaces APIs will now take a new optional parameter "WorkspaceName". + +### Fixes +* [#1031](https://github.com/awslabs/smithy-kotlin/issues/1031) Bump **smithy-kotlin** version to consume upstream fixes for URL parsing + ## [1.0.52] - 02/07/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 667b305b835..945e250215e 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.53-SNAPSHOT +sdkVersion=1.0.53 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 5a5fc1fe7375d37102d635f778eca1b678d0a93d Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 8 Feb 2024 19:05:21 +0000 Subject: [PATCH 17/32] chore: bump snapshot version to 1.0.54-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 945e250215e..a0b0a2dab46 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.53 +sdkVersion=1.0.54-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 7771ef702b3365d109981a6a9d2e4f70d3b663ff Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 9 Feb 2024 19:05:10 +0000 Subject: [PATCH 18/32] feat: update AWS API models --- codegen/sdk/aws-models/amp.json | 678 +++++++++--------- codegen/sdk/aws-models/batch.json | 208 +++++- codegen/sdk/aws-models/braket.json | 5 +- .../sdk/aws-models/cost-optimization-hub.json | 10 +- codegen/sdk/aws-models/ecs.json | 36 +- codegen/sdk/aws-models/iot.json | 39 +- codegen/sdk/aws-models/pricing.json | 38 +- 7 files changed, 621 insertions(+), 393 deletions(-) diff --git a/codegen/sdk/aws-models/amp.json b/codegen/sdk/aws-models/amp.json index 9f1b541ff84..ea89decadda 100644 --- a/codegen/sdk/aws-models/amp.json +++ b/codegen/sdk/aws-models/amp.json @@ -7,13 +7,13 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "

Description of the error.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "User does not have sufficient access to perform this action.", + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -41,13 +41,13 @@ "aws.api#arn": { "template": "workspace/{workspaceId}" }, - "smithy.api#documentation": "The definition of the alert manager in the AMP workspace" + "smithy.api#documentation": "

The alert manager definition, a YAML configuration for the alertmanager in your\n Amazon Managed Service for Prometheus workspace.

\n

For details about the alert manager definition, see AlertManagedDefinitionData.

" } }, "com.amazonaws.amp#AlertManagerDefinitionData": { "type": "blob", "traits": { - "smithy.api#documentation": "The alert manager definition data." + "smithy.api#documentation": "

The base-64 encoded blob that is alert manager definition.

\n

For details about the alert manager definition, see AlertManagedDefinitionData.

" } }, "com.amazonaws.amp#AlertManagerDefinitionDescription": { @@ -56,34 +56,34 @@ "status": { "target": "com.amazonaws.amp#AlertManagerDefinitionStatus", "traits": { - "smithy.api#documentation": "The status of alert manager definition.", + "smithy.api#documentation": "

A structure that displays the current status of the alert manager definition..

", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.amp#AlertManagerDefinitionData", "traits": { - "smithy.api#documentation": "The alert manager definition.", + "smithy.api#documentation": "

The actual alert manager definition.

\n

For details about the alert manager definition, see AlertManagedDefinitionData.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the alert manager definition was created.", + "smithy.api#documentation": "

The date and time that the alert manager definition was created.

", "smithy.api#required": {} } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the alert manager definition was modified.", + "smithy.api#documentation": "

The date and time that the alert manager definition was most recently changed.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the properties of an alert manager definition." + "smithy.api#documentation": "

The details of an alert manager definition.

" } }, "com.amazonaws.amp#AlertManagerDefinitionStatus": { @@ -92,25 +92,25 @@ "statusCode": { "target": "com.amazonaws.amp#AlertManagerDefinitionStatusCode", "traits": { - "smithy.api#documentation": "Status code of this definition.", + "smithy.api#documentation": "

The current status of the alert manager.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "

If there is a failure, the reason for the failure.

" } } }, "traits": { - "smithy.api#documentation": "Represents the status of a definition." + "smithy.api#documentation": "

The status of the alert manager.

" } }, "com.amazonaws.amp#AlertManagerDefinitionStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of an alert manager definition.", + "smithy.api#documentation": "

State of an AlertManagerDefinition.

", "smithy.api#enum": [ { "name": "CREATING", @@ -203,7 +203,7 @@ "date" ] }, - "smithy.api#documentation": "Amazon Managed Service for Prometheus", + "smithy.api#documentation": "

Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for\n container metrics that makes it easier to securely monitor container environments at\n scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data\n model and query language that you use today to monitor the performance of your\n containerized workloads, and also enjoy improved scalability, availability, and security\n without having to manage the underlying infrastructure.

\n

For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.

\n

Amazon Managed Service for Prometheus includes two APIs.

\n
    \n
  • \n

    Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert\n managers.

    \n
    • \n
  • \n

    Use the Prometheus-compatible API to work within your Prometheus\n workspace.

    \n
    • \n
", "smithy.api#title": "Amazon Prometheus Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -958,13 +958,13 @@ "workspaceArn": { "target": "com.amazonaws.amp#WorkspaceArn", "traits": { - "smithy.api#documentation": "The ARN of an AMP workspace.", + "smithy.api#documentation": "

ARN of the Amazon Managed Service for Prometheus workspace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A representation of an AMP destination." + "smithy.api#documentation": "

The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper\n should send metrics to.

" } }, "com.amazonaws.amp#ClusterArn": { @@ -973,7 +973,7 @@ "aws.api#arnReference": { "type": "AWS::EKS::Cluster" }, - "smithy.api#documentation": "The ARN of an EKS cluster.", + "smithy.api#documentation": "

The ARN of an EKS cluster.

", "smithy.api#pattern": "^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$" } }, @@ -983,27 +983,27 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "

Description of the error.

", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Identifier of the resource affected.", + "smithy.api#documentation": "

Identifier of the resource affected.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of the resource affected.", + "smithy.api#documentation": "

Type of the resource affected.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updating or deleting a resource can cause an inconsistent state.", + "smithy.api#documentation": "

The request would cause an inconsistent state.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1040,7 +1040,7 @@ } ], "traits": { - "smithy.api#documentation": "Create an alert manager definition.", + "smithy.api#documentation": "

The CreateAlertManagerDefinition operation creates the alert manager\n definition in a workspace. If a workspace already has an alert manager definition, don't\n use this operation to update it. Instead, use\n PutAlertManagerDefinition.

", "smithy.api#http": { "code": 202, "method": "POST", @@ -1055,7 +1055,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace in which to create the alert manager definition.", + "smithy.api#documentation": "

The ID of the workspace to add the alert manager definition to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1063,20 +1063,20 @@ "data": { "target": "com.amazonaws.amp#AlertManagerDefinitionData", "traits": { - "smithy.api#documentation": "The alert manager definition data.", + "smithy.api#documentation": "

The alert manager definition to add. A base64-encoded version of the YAML alert\n manager definition file.

\n

For details about the alert manager definition, see AlertManagedDefinitionData.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateAlertManagerDefinition operation." + "smithy.api#documentation": "

Represents the input of a CreateAlertManagerDefinition operation.

" } }, "com.amazonaws.amp#CreateAlertManagerDefinitionResponse": { @@ -1085,13 +1085,13 @@ "status": { "target": "com.amazonaws.amp#AlertManagerDefinitionStatus", "traits": { - "smithy.api#documentation": "The status of alert manager definition.", + "smithy.api#documentation": "

A structure that displays the current status of the alert manager definition.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateAlertManagerDefinition operation." + "smithy.api#documentation": "

Represents the output of a CreateAlertManagerDefinition operation.

" } }, "com.amazonaws.amp#CreateLoggingConfiguration": { @@ -1117,7 +1117,7 @@ } ], "traits": { - "smithy.api#documentation": "Create logging configuration.", + "smithy.api#documentation": "

The CreateLoggingConfiguration operation creates a logging configuration\n for the workspace. Use this operation to set the CloudWatch log group to which\n the logs will be published to.

", "smithy.api#http": { "code": 202, "method": "POST", @@ -1132,7 +1132,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#documentation": "

The ID of the workspace to create the logging configuration for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1140,20 +1140,20 @@ "logGroupArn": { "target": "com.amazonaws.amp#LogGroupArn", "traits": { - "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#documentation": "

The ARN of the CloudWatch log group to which the vended log data will be\n published. This log group must exist prior to calling this API.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateLoggingConfiguration operation." + "smithy.api#documentation": "

Represents the input of a CreateLoggingConfiguration operation.

" } }, "com.amazonaws.amp#CreateLoggingConfigurationResponse": { @@ -1162,13 +1162,13 @@ "status": { "target": "com.amazonaws.amp#LoggingConfigurationStatus", "traits": { - "smithy.api#documentation": "The status of the logging configuration.", + "smithy.api#documentation": "

A structure that displays the current status of the logging configuration.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateLoggingConfiguration operation." + "smithy.api#documentation": "

Represents the output of a CreateLoggingConfiguration operation.

" } }, "com.amazonaws.amp#CreateRuleGroupsNamespace": { @@ -1203,7 +1203,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a rule group namespace.", + "smithy.api#documentation": "

The CreateRuleGroupsNamespace operation creates a rule groups namespace\n within a workspace. A rule groups namespace is associated with exactly one rules file. A\n workspace can have multiple rule groups namespaces.

\n

Use this operation only to create new rule groups namespaces. To update an existing\n rule groups namespace, use PutRuleGroupsNamespace.

", "smithy.api#http": { "code": 202, "method": "POST", @@ -1218,7 +1218,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace in which to create the rule group namespace.", + "smithy.api#documentation": "

The ID of the workspace to add the rule groups namespace.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1226,33 +1226,33 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "

The name for the new rule groups namespace.

", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.amp#RuleGroupsNamespaceData", "traits": { - "smithy.api#documentation": "The namespace data that define the rule groups.", + "smithy.api#documentation": "

The rules file to use in the new namespace.

\n

Contains the base64-encoded version of the YAML rules file.

\n

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "Optional, user-provided tags for this rule groups namespace." + "smithy.api#documentation": "

The list of tag keys and values to associate with the rule groups namespace.

" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateRuleGroupsNamespace operation." + "smithy.api#documentation": "

Represents the input of a CreateRuleGroupsNamespace operation.

" } }, "com.amazonaws.amp#CreateRuleGroupsNamespaceResponse": { @@ -1261,33 +1261,33 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "

The name of the new rule groups namespace.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#RuleGroupsNamespaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this rule groups namespace.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new rule groups namespace.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatus", "traits": { - "smithy.api#documentation": "The status of rule groups namespace.", + "smithy.api#documentation": "

A structure that returns the current status of the rule groups namespace.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this rule groups namespace." + "smithy.api#documentation": "

The list of tag keys and values that are associated with the namespace.

" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateRuleGroupsNamespace operation." + "smithy.api#documentation": "

Represents the output of a CreateRuleGroupsNamespace operation.

" } }, "com.amazonaws.amp#CreateScraper": { @@ -1322,7 +1322,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a scraper.", + "smithy.api#documentation": "

The CreateScraper operation creates a scraper to collect metrics. A\n scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS\n cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the\n scraper to control what metrics are collected, and what transformations are applied\n prior to sending them to your workspace.

\n

If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see \n Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User \n Guide.

\n

You cannot update a scraper. If you want to change the configuration of the scraper,\n create a new scraper and delete the old one.

\n

The scrapeConfiguration parameter contains the base64-encoded version of\n the YAML configuration file.

\n \n

For more information about collectors, including what metrics are collected, and\n how to configure the scraper, see Amazon Web Services managed\n collectors in the Amazon Managed Service for Prometheus User \n Guide.

\n ", "smithy.api#examples": [ { "title": "CreateScraper with optional alias input, optional clientToken input, and one set of tags", @@ -1378,46 +1378,46 @@ "alias": { "target": "com.amazonaws.amp#ScraperAlias", "traits": { - "smithy.api#documentation": "An optional user-assigned alias for this scraper. This alias is for user reference and does not need to be unique." + "smithy.api#documentation": "

(optional) a name to associate with the scraper. This is for your use, and does not\n need to be unique.

" } }, "scrapeConfiguration": { "target": "com.amazonaws.amp#ScrapeConfiguration", "traits": { - "smithy.api#documentation": "The configuration used to create the scraper.", + "smithy.api#documentation": "

The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User \n Guide.

", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.amp#Source", "traits": { - "smithy.api#documentation": "The source that the scraper will be discovering and collecting metrics from.", + "smithy.api#documentation": "

The Amazon EKS cluster from which the scraper will collect metrics.

", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.amp#Destination", "traits": { - "smithy.api#documentation": "The destination that the scraper will be producing metrics to.", + "smithy.api#documentation": "

The Amazon Managed Service for Prometheus workspace to send metrics to.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

(Optional) A unique, case-sensitive identifier that you can provide to ensure the\n idempotency of the request.

", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "Optional, user-provided tags for this scraper." + "smithy.api#documentation": "

(Optional) The list of tag keys and values to associate with the scraper.

" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateScraper operation.", + "smithy.api#documentation": "

Represents the input of a CreateScraper operation.

", "smithy.api#input": {} } }, @@ -1427,33 +1427,33 @@ "scraperId": { "target": "com.amazonaws.amp#ScraperId", "traits": { - "smithy.api#documentation": "The generated ID of the scraper that was just created.", + "smithy.api#documentation": "

The ID of the new scraper.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#ScraperArn", "traits": { - "smithy.api#documentation": "The ARN of the scraper that was just created.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new scraper.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#ScraperStatus", "traits": { - "smithy.api#documentation": "The status of the scraper that was just created (usually CREATING).", + "smithy.api#documentation": "

A structure that displays the current status of the scraper.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this scraper." + "smithy.api#documentation": "

The list of tag keys and values that are associated with the scraper.

" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateScraper operation.", + "smithy.api#documentation": "

Represents the output of a CreateScraper operation.

", "smithy.api#output": {} } }, @@ -1486,7 +1486,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new AMP workspace.", + "smithy.api#documentation": "

Creates a Prometheus workspace. A workspace is a logical space dedicated to the\n storage and querying of Prometheus metrics. You can have one or more workspaces in each\n Region in your account.

", "smithy.api#http": { "code": 202, "method": "POST", @@ -1501,31 +1501,31 @@ "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique." + "smithy.api#documentation": "

An alias that you assign to this workspace to help you identify it. It does not need\n to be unique.

\n

Blank spaces at the beginning or end of the alias that you specify will be trimmed\n from the value used.

" } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#idempotencyToken": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "Optional, user-provided tags for this workspace." + "smithy.api#documentation": "

The list of tag keys and values to associate with the workspace.

" } }, "kmsKeyArn": { "target": "com.amazonaws.amp#KmsKeyArn", "traits": { - "smithy.api#documentation": "Optional, customer managed KMS key used to encrypt data for this workspace" + "smithy.api#documentation": "

(optional) The ARN for a customer managed KMS key to use for \n encrypting data within your workspace. For more information about using your\n own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User \n Guide.

" } } }, "traits": { - "smithy.api#documentation": "Represents the input of a CreateWorkspace operation." + "smithy.api#documentation": "

Represents the input of a CreateWorkspace operation.

" } }, "com.amazonaws.amp#CreateWorkspaceResponse": { @@ -1534,39 +1534,39 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The generated ID of the workspace that was just created.", + "smithy.api#documentation": "

The unique ID for the new workspace.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#WorkspaceArn", "traits": { - "smithy.api#documentation": "The ARN of the workspace that was just created.", + "smithy.api#documentation": "

The ARN for the new workspace.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#WorkspaceStatus", "traits": { - "smithy.api#documentation": "The status of the workspace that was just created (usually CREATING).", + "smithy.api#documentation": "

The current status of the new workspace. Immediately after you create the workspace,\n the status is usually CREATING.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this workspace." + "smithy.api#documentation": "

The list of tag keys and values that are associated with the workspace.

" } }, "kmsKeyArn": { "target": "com.amazonaws.amp#KmsKeyArn", "traits": { - "smithy.api#documentation": "Customer managed KMS key ARN for this workspace" + "smithy.api#documentation": "

(optional) If the workspace was created with a customer managed KMS \n key, the ARN for the key used.

" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a CreateWorkspace operation." + "smithy.api#documentation": "

Represents the output of a CreateWorkspace operation.

" } }, "com.amazonaws.amp#DeleteAlertManagerDefinition": { @@ -1598,7 +1598,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an alert manager definition.", + "smithy.api#documentation": "

Deletes the alert manager definition from a workspace.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -1613,7 +1613,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace in which to delete the alert manager definition.", + "smithy.api#documentation": "

The ID of the workspace to delete the alert manager definition from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1621,14 +1621,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteAlertManagerDefinition operation." + "smithy.api#documentation": "

Represents the input of a DeleteAlertManagerDefinition operation.

" } }, "com.amazonaws.amp#DeleteLoggingConfiguration": { @@ -1657,7 +1657,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete logging configuration.", + "smithy.api#documentation": "

Deletes the logging configuration for a workspace.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -1672,7 +1672,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#documentation": "

The ID of the workspace containing the logging configuration to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1680,14 +1680,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteLoggingConfiguration operation." + "smithy.api#documentation": "

Represents the input of a DeleteLoggingConfiguration operation.

" } }, "com.amazonaws.amp#DeleteRuleGroupsNamespace": { @@ -1719,7 +1719,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete a rule groups namespace.", + "smithy.api#documentation": "

Deletes one rule groups namespace and its associated rule groups definition.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -1734,7 +1734,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to delete rule group definition.", + "smithy.api#documentation": "

The ID of the workspace containing the rule groups namespace and definition to\n delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1742,7 +1742,7 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "

The name of the rule groups namespace to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1750,14 +1750,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteRuleGroupsNamespace operation." + "smithy.api#documentation": "

Represents the input of a DeleteRuleGroupsNamespace operation.

" } }, "com.amazonaws.amp#DeleteScraper": { @@ -1789,7 +1789,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a scraper.", + "smithy.api#documentation": "

The DeleteScraper operation deletes one scraper, and stops any metrics\n collection that the scraper performs.

", "smithy.api#examples": [ { "title": "DeleteScraper with optional clientToken input", @@ -1819,7 +1819,7 @@ "scraperId": { "target": "com.amazonaws.amp#ScraperId", "traits": { - "smithy.api#documentation": "The ID of the scraper to delete.", + "smithy.api#documentation": "

The ID of the scraper to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1827,14 +1827,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

(Optional) A unique, case-sensitive identifier that you can provide to ensure the \n idempotency of the request.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteScraper operation.", + "smithy.api#documentation": "

Represents the input of a DeleteScraper operation.

", "smithy.api#input": {} } }, @@ -1844,20 +1844,20 @@ "scraperId": { "target": "com.amazonaws.amp#ScraperId", "traits": { - "smithy.api#documentation": "The ID of the scraper that was deleted.", + "smithy.api#documentation": "

The ID of the scraper to delete.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#ScraperStatus", "traits": { - "smithy.api#documentation": "The status of the scraper that is being deleted.", + "smithy.api#documentation": "

The current status of the scraper.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DeleteScraper operation.", + "smithy.api#documentation": "

Represents the output of a DeleteScraper operation.

", "smithy.api#output": {} } }, @@ -1890,7 +1890,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an AMP workspace.", + "smithy.api#documentation": "

Deletes an existing workspace.

\n \n

When you delete a workspace, the data that has been ingested into it is not\n immediately deleted. It will be permanently deleted within one month.

\n ", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -1905,7 +1905,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to delete.", + "smithy.api#documentation": "

The ID of the workspace to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1913,14 +1913,14 @@ "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#httpQuery": "clientToken", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DeleteWorkspace operation." + "smithy.api#documentation": "

Represents the input of a DeleteWorkspace operation.

" } }, "com.amazonaws.amp#DescribeAlertManagerDefinition": { @@ -1949,7 +1949,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an alert manager definition.", + "smithy.api#documentation": "

Retrieves the full information about the alert manager definition for a\n workspace.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1964,14 +1964,14 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to describe.", + "smithy.api#documentation": "

The ID of the workspace to retrieve the alert manager definition from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeAlertManagerDefinition operation." + "smithy.api#documentation": "

Represents the input of a DescribeAlertManagerDefinition operation.

" } }, "com.amazonaws.amp#DescribeAlertManagerDefinitionResponse": { @@ -1980,13 +1980,13 @@ "alertManagerDefinition": { "target": "com.amazonaws.amp#AlertManagerDefinitionDescription", "traits": { - "smithy.api#documentation": "The properties of the selected workspace's alert manager definition.", + "smithy.api#documentation": "

The alert manager definition.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeAlertManagerDefinition operation." + "smithy.api#documentation": "

Represents the output of a DescribeAlertManagerDefinition operation.

" } }, "com.amazonaws.amp#DescribeLoggingConfiguration": { @@ -2012,7 +2012,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes logging configuration.", + "smithy.api#documentation": "

Returns complete information about the current logging configuration of the\n workspace.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2027,14 +2027,14 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#documentation": "

The ID of the workspace to describe the logging configuration for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeLoggingConfiguration operation." + "smithy.api#documentation": "

Represents the input of a DescribeLoggingConfiguration operation.

" } }, "com.amazonaws.amp#DescribeLoggingConfigurationResponse": { @@ -2043,13 +2043,13 @@ "loggingConfiguration": { "target": "com.amazonaws.amp#LoggingConfigurationMetadata", "traits": { - "smithy.api#documentation": "Metadata object containing information about the logging configuration of a workspace.", + "smithy.api#documentation": "

A structure that displays the information about the logging configuration.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeLoggingConfiguration operation." + "smithy.api#documentation": "

Represents the output of a DescribeLoggingConfiguration operation.

" } }, "com.amazonaws.amp#DescribeRuleGroupsNamespace": { @@ -2078,7 +2078,7 @@ } ], "traits": { - "smithy.api#documentation": "Describe a rule groups namespace.", + "smithy.api#documentation": "

Returns complete information about one rule groups namespace. To retrieve a list of\n rule groups namespaces, use ListRuleGroupsNamespaces.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2093,7 +2093,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to describe.", + "smithy.api#documentation": "

The ID of the workspace containing the rule groups namespace.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2101,14 +2101,14 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace.", + "smithy.api#documentation": "

The name of the rule groups namespace that you want information for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeRuleGroupsNamespace operation." + "smithy.api#documentation": "

Represents the input of a DescribeRuleGroupsNamespace operation.

" } }, "com.amazonaws.amp#DescribeRuleGroupsNamespaceResponse": { @@ -2117,13 +2117,13 @@ "ruleGroupsNamespace": { "target": "com.amazonaws.amp#RuleGroupsNamespaceDescription", "traits": { - "smithy.api#documentation": "The selected rule groups namespace.", + "smithy.api#documentation": "

The information about the rule groups namespace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeRuleGroupsNamespace operation." + "smithy.api#documentation": "

Represents the output of a DescribeRuleGroupsNamespace operation.

" } }, "com.amazonaws.amp#DescribeScraper": { @@ -2152,7 +2152,7 @@ } ], "traits": { - "smithy.api#documentation": "Describe an existing scraper.", + "smithy.api#documentation": "

The DescribeScraper operation displays information about an existing\n scraper.

", "smithy.api#examples": [ { "title": "DescribeScraper, with no statusReason to report", @@ -2258,14 +2258,14 @@ "scraperId": { "target": "com.amazonaws.amp#ScraperId", "traits": { - "smithy.api#documentation": "The IDs of the scraper to describe.", + "smithy.api#documentation": "

The ID of the scraper to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeScraper operation.", + "smithy.api#documentation": "

Represents the input of a DescribeScraper operation.

", "smithy.api#input": {} } }, @@ -2275,13 +2275,13 @@ "scraper": { "target": "com.amazonaws.amp#ScraperDescription", "traits": { - "smithy.api#documentation": "The properties of the selected scrapers.", + "smithy.api#documentation": "

Contains details about the scraper.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeScraper operation.", + "smithy.api#documentation": "

Represents the output of a DescribeScraper operation.

", "smithy.api#output": {} } }, @@ -2311,7 +2311,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an existing AMP workspace.", + "smithy.api#documentation": "

Returns information about an existing workspace.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2384,14 +2384,14 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to describe.", + "smithy.api#documentation": "

The ID of the workspace to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeWorkspace operation." + "smithy.api#documentation": "

Represents the input of a DescribeWorkspace operation.

" } }, "com.amazonaws.amp#DescribeWorkspaceResponse": { @@ -2400,13 +2400,13 @@ "workspace": { "target": "com.amazonaws.amp#WorkspaceDescription", "traits": { - "smithy.api#documentation": "The properties of the selected workspace.", + "smithy.api#documentation": "

A structure that contains details about the workspace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a DescribeWorkspace operation." + "smithy.api#documentation": "

Represents the output of a DescribeWorkspace operation.

" } }, "com.amazonaws.amp#Destination": { @@ -2415,12 +2415,12 @@ "ampConfiguration": { "target": "com.amazonaws.amp#AmpConfiguration", "traits": { - "smithy.api#documentation": "A representation of an AMP destination." + "smithy.api#documentation": "

The Amazon Managed Service for Prometheusworkspace to send metrics to.

" } } }, "traits": { - "smithy.api#documentation": "A representation of a destination that a scraper can produce metrics to." + "smithy.api#documentation": "

Where to send the metrics from a scraper.

" } }, "com.amazonaws.amp#EksConfiguration": { @@ -2429,32 +2429,32 @@ "clusterArn": { "target": "com.amazonaws.amp#ClusterArn", "traits": { - "smithy.api#documentation": "The ARN of an EKS cluster.", + "smithy.api#documentation": "

ARN of the Amazon EKS cluster.

", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.amp#SecurityGroupIds", "traits": { - "smithy.api#documentation": "A list of security group IDs specified for VPC configuration." + "smithy.api#documentation": "

A list of the security group IDs for the Amazon EKS cluster VPC configuration.

" } }, "subnetIds": { "target": "com.amazonaws.amp#SubnetIds", "traits": { - "smithy.api#documentation": "A list of subnet IDs specified for VPC configuration.", + "smithy.api#documentation": "

A list of subnet IDs for the Amazon EKS cluster VPC configuration.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A representation of an EKS source." + "smithy.api#documentation": "

The EksConfiguration structure describes the connection to the \n Amazon EKS cluster from which a scraper collects metrics.

" } }, "com.amazonaws.amp#FilterKey": { "type": "string", "traits": { - "smithy.api#documentation": "The name of the key to filter by.", + "smithy.api#documentation": "

The name of the key by which to filter.

", "smithy.api#length": { "min": 1, "max": 256 @@ -2464,7 +2464,7 @@ "com.amazonaws.amp#FilterValue": { "type": "string", "traits": { - "smithy.api#documentation": "The value of a given key to filter by.", + "smithy.api#documentation": "

The value for a given key by which to filter.

", "smithy.api#length": { "min": 1, "max": 256 @@ -2477,7 +2477,7 @@ "target": "com.amazonaws.amp#FilterValue" }, "traits": { - "smithy.api#documentation": "A list of scraper filter values.", + "smithy.api#documentation": "

A list of scraper filter values.

", "smithy.api#length": { "min": 1, "max": 20 @@ -2504,7 +2504,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a default configuration.", + "smithy.api#documentation": "

The GetDefaultScraperConfiguration operation returns the default \n scraper configuration used when Amazon EKS creates a scraper for you.

", "smithy.api#examples": [ { "title": "GetDefaultScraperConfiguration", @@ -2526,7 +2526,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Represents the input of a GetDefaultScraperConfiguration operation.", + "smithy.api#documentation": "

Represents the input of a GetDefaultScraperConfiguration operation.

", "smithy.api#input": {} } }, @@ -2536,13 +2536,13 @@ "configuration": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "The default configuration.", + "smithy.api#documentation": "

The configuration file. Base 64 encoded. \n For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User \n Guide.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a GetDefaultScraperConfiguration operation.", + "smithy.api#documentation": "

Represents the output of a GetDefaultScraperConfiguration operation.

", "smithy.api#output": {} } }, @@ -2552,13 +2552,13 @@ "aws.api#arnReference": { "type": "AWS::IAM::Role" }, - "smithy.api#documentation": "An ARN identifying an IAM role used by the scraper." + "smithy.api#documentation": "

An ARN identifying an IAM role used by the scraper.

" } }, "com.amazonaws.amp#IdempotencyToken": { "type": "string", "traits": { - "smithy.api#documentation": "An identifier used to ensure the idempotency of a write request.", + "smithy.api#documentation": "

An identifier used to ensure the idempotency of a write request.

", "smithy.api#length": { "min": 1, "max": 64 @@ -2572,20 +2572,20 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "

Description of the error.

", "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Advice to clients on when the call can be safely retried.", + "smithy.api#documentation": "

Advice to clients on when the call can be safely retried.

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { - "smithy.api#documentation": "Unexpected error during processing of request.", + "smithy.api#documentation": "

An unexpected error occurred during the processing of the request.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} @@ -2597,7 +2597,7 @@ "aws.api#arnReference": { "type": "AWS::KMS::Key" }, - "smithy.api#documentation": "A KMS Key ARN.", + "smithy.api#documentation": "

A KMS Key ARN.

", "smithy.api#length": { "min": 20, "max": 2048 @@ -2631,7 +2631,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists rule groups namespaces.", + "smithy.api#documentation": "

Returns a list of rule groups namespaces in a workspace.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2652,7 +2652,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace.", + "smithy.api#documentation": "

The ID of the workspace containing the rule groups namespaces.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2660,21 +2660,21 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.", + "smithy.api#documentation": "

Use this parameter to filter the rule groups namespaces that are returned. Only the\n namespaces with names that begin with the value that you specify are returned.

", "smithy.api#httpQuery": "name" } }, "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.", + "smithy.api#documentation": "

The token for the next set of items to return. You receive this token from a previous\n call, and use it to get the next page of results. The other parameters must be the same\n as the initial call.

\n

For example, if your initial request has maxResults of 10, and there are\n 12 rule groups namespaces to return, then your initial request will return 10 and a\n nextToken. Using the next token in a subsequent call will return the\n remaining 2 namespaces.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Maximum results to return in response (default=100, maximum=1000).", + "smithy.api#documentation": "

The maximum number of results to return. The default is 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -2684,7 +2684,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a ListRuleGroupsNamespaces operation." + "smithy.api#documentation": "

Represents the input of a ListRuleGroupsNamespaces operation.

" } }, "com.amazonaws.amp#ListRuleGroupsNamespacesResponse": { @@ -2693,19 +2693,19 @@ "ruleGroupsNamespaces": { "target": "com.amazonaws.amp#RuleGroupsNamespaceSummaryList", "traits": { - "smithy.api#documentation": "The list of the selected rule groups namespaces.", + "smithy.api#documentation": "

The returned list of rule groups namespaces.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to use when requesting the next page in this list." + "smithy.api#documentation": "

A token indicating that there are more results to retrieve. You can use this token as\n part of your next ListRuleGroupsNamespaces request to retrieve those\n results.

" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a ListRuleGroupsNamespaces operation." + "smithy.api#documentation": "

Represents the output of a ListRuleGroupsNamespaces operation.

" } }, "com.amazonaws.amp#ListScrapers": { @@ -2731,7 +2731,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.", + "smithy.api#documentation": "

The ListScrapers operation lists all of the scrapers in\n your account. This includes scrapers being created or deleted. You can optionally\n filter the returned list.

", "smithy.api#examples": [ { "title": "ListScrapers, with a max result of 2, using a pagination token from a previous call to ListScrapers", @@ -2875,21 +2875,21 @@ "filters": { "target": "com.amazonaws.amp#ScraperFilters", "traits": { - "smithy.api#documentation": "A list of scraper filters.", + "smithy.api#documentation": "

(Optional) A list of key-value pairs to filter the list of scrapers returned.\n Keys include status, sourceArn, \n destinationArn, and alias.

\n

Filters on the same key are OR'd together, and filters on different\n keys are AND'd together. For example, \n status=ACTIVE&status=CREATING&alias=Test, will return all\n scrapers that have the alias Test, and are either in status ACTIVE or CREATING.

\n

To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus\n workspace, you would use the ARN of the workspace in a query:

\n

\n status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012\n

\n

If this is included, it filters the results to only the scrapers that match \n the filter.

", "smithy.api#httpQueryParams": {} } }, "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.", + "smithy.api#documentation": "

(Optional) The token for the next set of\n items to return. (You received this token from a previous call.)

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Maximum results to return in response (default=100, maximum=1000).", + "smithy.api#documentation": "

Optional) The maximum number of\n scrapers to return in one ListScrapers operation. The range is\n 1-1000.

\n

If you omit this parameter, the default of 100 is used.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -2899,7 +2899,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a ListScrapers operation.", + "smithy.api#documentation": "

Represents the input of a ListScrapers operation.

", "smithy.api#input": {} } }, @@ -2909,19 +2909,19 @@ "scrapers": { "target": "com.amazonaws.amp#ScraperSummaryList", "traits": { - "smithy.api#documentation": "The list of scrapers, filtered down if a set of filters was provided in the request.", + "smithy.api#documentation": "

A list of ScraperSummary structures giving information about scrapers\n in the account that match the filters provided.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to use when requesting the next page in this list." + "smithy.api#documentation": "

A token indicating that there are more\n results to retrieve. You can use this token as part of your next\n ListScrapers operation to retrieve those results.

" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a ListScrapers operation.", + "smithy.api#documentation": "

Represents the output of a ListScrapers operation.

", "smithy.api#output": {} } }, @@ -2951,7 +2951,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the tags you have assigned to the resource.", + "smithy.api#documentation": "

The ListTagsForResource operation returns the tags that are associated\n with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be\n tagged are workspaces and rule groups namespaces.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}" @@ -2965,7 +2965,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ARN of the resource.", + "smithy.api#documentation": "

The ARN of the resource to list tages for. Must be a workspace or rule groups\n namespace resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2976,7 +2976,10 @@ "type": "structure", "members": { "tags": { - "target": "com.amazonaws.amp#TagMap" + "target": "com.amazonaws.amp#TagMap", + "traits": { + "smithy.api#documentation": "

The list of tag keys and values associated with the resource.

" + } } } }, @@ -3003,7 +3006,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all AMP workspaces, including workspaces being created or deleted.", + "smithy.api#documentation": "

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes\n workspaces being created or deleted.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3024,21 +3027,21 @@ "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.", + "smithy.api#documentation": "

The token for the next set of items to return. You receive this token from a previous\n call, and use it to get the next page of results. The other parameters must be the same\n as the initial call.

\n

For example, if your initial request has maxResults of 10, and there are\n 12 workspaces to return, then your initial request will return 10 and a\n nextToken. Using the next token in a subsequent call will return the\n remaining 2 workspaces.

", "smithy.api#httpQuery": "nextToken" } }, "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.", + "smithy.api#documentation": "

If this is included, it filters the results to only the workspaces with names that\n start with the value that you specify here.

\n

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning\n and end of the alias that you specify.

", "smithy.api#httpQuery": "alias" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Maximum results to return in response (default=100, maximum=1000).", + "smithy.api#documentation": "

The maximum number of workspaces to return per request. The default is 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -3048,7 +3051,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a ListWorkspaces operation." + "smithy.api#documentation": "

Represents the input of a ListWorkspaces operation.

" } }, "com.amazonaws.amp#ListWorkspacesResponse": { @@ -3057,19 +3060,19 @@ "workspaces": { "target": "com.amazonaws.amp#WorkspaceSummaryList", "traits": { - "smithy.api#documentation": "The list of existing workspaces, including those undergoing creation or deletion.", + "smithy.api#documentation": "

An array of WorkspaceSummary structures containing information about the\n workspaces requested.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amp#PaginationToken", "traits": { - "smithy.api#documentation": "Pagination token to use when requesting the next page in this list." + "smithy.api#documentation": "

A token indicating that there are more results to retrieve. You can use this token as\n part of your next ListWorkspaces request to retrieve those results.

" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a ListWorkspaces operation." + "smithy.api#documentation": "

Represents the output of a ListWorkspaces operation.

" } }, "com.amazonaws.amp#LogGroupArn": { @@ -3104,7 +3107,7 @@ "aws.api#arn": { "template": "workspace/{workspaceId}" }, - "smithy.api#documentation": "The definition of logging configuration in an AMP workspace." + "smithy.api#documentation": "

The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.

" } }, "com.amazonaws.amp#LoggingConfigurationMetadata": { @@ -3113,41 +3116,41 @@ "status": { "target": "com.amazonaws.amp#LoggingConfigurationStatus", "traits": { - "smithy.api#documentation": "The status of the logging configuration.", + "smithy.api#documentation": "

The current status of the logging configuration.

", "smithy.api#required": {} } }, "workspace": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The workspace where the logging configuration exists.", + "smithy.api#documentation": "

The ID of the workspace the logging configuration is for.

", "smithy.api#required": {} } }, "logGroupArn": { "target": "com.amazonaws.amp#LogGroupArn", "traits": { - "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#documentation": "

The ARN of the CloudWatch log group to which the vended log data will be\n published.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the logging configuration was created.", + "smithy.api#documentation": "

The date and time that the logging configuration was created.

", "smithy.api#required": {} } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the logging configuration was modified.", + "smithy.api#documentation": "

The date and time that the logging configuration was most recently changed.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the properties of a logging configuration metadata." + "smithy.api#documentation": "

Contains information about the logging configuration.

" } }, "com.amazonaws.amp#LoggingConfigurationStatus": { @@ -3156,25 +3159,25 @@ "statusCode": { "target": "com.amazonaws.amp#LoggingConfigurationStatusCode", "traits": { - "smithy.api#documentation": "Status code of the logging configuration.", + "smithy.api#documentation": "

The current status of the logging configuration.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "

If failed, the reason for the failure.

" } } }, "traits": { - "smithy.api#documentation": "Represents the status of a logging configuration." + "smithy.api#documentation": "

The status of the logging configuration.

" } }, "com.amazonaws.amp#LoggingConfigurationStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of a logging configuration.", + "smithy.api#documentation": "

State of a logging configuration.

", "smithy.api#enum": [ { "name": "CREATING", @@ -3212,7 +3215,7 @@ "com.amazonaws.amp#PaginationToken": { "type": "string", "traits": { - "smithy.api#documentation": "A token used to access the next page in a paginated result set.", + "smithy.api#documentation": "

A token used to access the next page in a paginated result set.

", "smithy.api#length": { "max": 1000 } @@ -3250,7 +3253,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an alert manager definition.", + "smithy.api#documentation": "

Updates an existing alert manager definition in a workspace. If the workspace does not\n already have an alert manager definition, don't use this operation to create it.\n Instead, use CreateAlertManagerDefinition.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -3265,7 +3268,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace in which to update the alert manager definition.", + "smithy.api#documentation": "

The ID of the workspace to update the alert manager definition in.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3273,20 +3276,20 @@ "data": { "target": "com.amazonaws.amp#AlertManagerDefinitionData", "traits": { - "smithy.api#documentation": "The alert manager definition data.", + "smithy.api#documentation": "

The alert manager definition to use. A base64-encoded version of the YAML alert\n manager definition file.

\n

For details about the alert manager definition, see AlertManagedDefinitionData.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a PutAlertManagerDefinition operation." + "smithy.api#documentation": "

Represents the input of a PutAlertManagerDefinition operation.

" } }, "com.amazonaws.amp#PutAlertManagerDefinitionResponse": { @@ -3295,13 +3298,13 @@ "status": { "target": "com.amazonaws.amp#AlertManagerDefinitionStatus", "traits": { - "smithy.api#documentation": "The status of alert manager definition.", + "smithy.api#documentation": "

A structure that returns the current status of the alert manager definition.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of a PutAlertManagerDefinition operation." + "smithy.api#documentation": "

Represents the output of a PutAlertManagerDefinition operation.

" } }, "com.amazonaws.amp#PutRuleGroupsNamespace": { @@ -3336,7 +3339,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a rule groups namespace.", + "smithy.api#documentation": "

Updates an existing rule groups namespace within a workspace. A rule groups namespace\n is associated with exactly one rules file. A workspace can have multiple rule groups\n namespaces.

\n

Use this operation only to update existing rule groups namespaces. To create a new\n rule groups namespace, use CreateRuleGroupsNamespace.

\n

You can't use this operation to add tags to an existing rule groups namespace.\n Instead, use TagResource.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -3351,7 +3354,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace in which to update the rule group namespace.", + "smithy.api#documentation": "

The ID of the workspace where you are updating the rule groups namespace.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3359,7 +3362,7 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "

The name of the rule groups namespace that you are updating.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3367,20 +3370,20 @@ "data": { "target": "com.amazonaws.amp#RuleGroupsNamespaceData", "traits": { - "smithy.api#documentation": "The namespace data that define the rule groups.", + "smithy.api#documentation": "

The new rules file to use in the namespace. A base64-encoded version of the YAML rule\n groups file.

\n

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of a PutRuleGroupsNamespace operation." + "smithy.api#documentation": "

Represents the input of a PutRuleGroupsNamespace operation.

" } }, "com.amazonaws.amp#PutRuleGroupsNamespaceResponse": { @@ -3389,33 +3392,33 @@ "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "

The name of the rule groups namespace that was updated.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#RuleGroupsNamespaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this rule groups namespace.", + "smithy.api#documentation": "

The ARN of the rule groups namespace.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatus", "traits": { - "smithy.api#documentation": "The status of rule groups namespace.", + "smithy.api#documentation": "

A structure that includes the current status of the rule groups namespace.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this rule groups namespace." + "smithy.api#documentation": "

The list of tag keys and values that are associated with the namespace.

" } } }, "traits": { - "smithy.api#documentation": "Represents the output of a PutRuleGroupsNamespace operation." + "smithy.api#documentation": "

Represents the output of a PutRuleGroupsNamespace operation.

" } }, "com.amazonaws.amp#ResourceNotFoundException": { @@ -3424,27 +3427,27 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "

Description of the error.

", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Identifier of the resource affected.", + "smithy.api#documentation": "

Identifier of the resource affected.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of the resource affected.", + "smithy.api#documentation": "

Type of the resource affected.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request references a resource which does not exist.", + "smithy.api#documentation": "

The request references a resources that doesn't exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3478,7 +3481,7 @@ "aws.api#arn": { "template": "rulegroupsnamespace/{workspaceId}/{name}" }, - "smithy.api#documentation": "The definition of a rule group namespace in an AMP workspace" + "smithy.api#documentation": "

The definition of a rule group namespace in an Amazon Managed Service for Prometheus workspace.

" } }, "com.amazonaws.amp#RuleGroupsNamespaceArn": { @@ -3489,13 +3492,13 @@ "service": "ManagedPrometheusCP", "resource": "RuleGroupsNamespace" }, - "smithy.api#documentation": "An ARN identifying a rule groups namespace." + "smithy.api#documentation": "

An ARN identifying a rule groups namespace.

" } }, "com.amazonaws.amp#RuleGroupsNamespaceData": { "type": "blob", "traits": { - "smithy.api#documentation": "The rule groups namespace data." + "smithy.api#documentation": "

The rule groups namespace data.

" } }, "com.amazonaws.amp#RuleGroupsNamespaceDescription": { @@ -3504,60 +3507,60 @@ "arn": { "target": "com.amazonaws.amp#RuleGroupsNamespaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this rule groups namespace.", + "smithy.api#documentation": "

The ARN of the rule groups namespace.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "

The name of the rule groups namespace.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatus", "traits": { - "smithy.api#documentation": "The status of rule groups namespace.", + "smithy.api#documentation": "

The current status of the rule groups namespace.

", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.amp#RuleGroupsNamespaceData", "traits": { - "smithy.api#documentation": "The rule groups namespace data.", + "smithy.api#documentation": "

The rule groups file used in the namespace.

\n

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the rule groups namespace was created.", + "smithy.api#documentation": "

The date and time that the rule groups namespace was created.

", "smithy.api#required": {} } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the rule groups namespace was modified.", + "smithy.api#documentation": "

The date and time that the rule groups namespace was most recently changed.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this rule groups namespace." + "smithy.api#documentation": "

The list of tag keys and values that are associated with the rule groups\n namespace.

" } } }, "traits": { - "smithy.api#documentation": "Represents a description of the rule groups namespace." + "smithy.api#documentation": "

The details about one rule groups namespace.

" } }, "com.amazonaws.amp#RuleGroupsNamespaceName": { "type": "string", "traits": { - "smithy.api#documentation": "The namespace name that the rule group belong to.", + "smithy.api#documentation": "

The name of the namespace that the rule group belong to.

", "smithy.api#length": { "min": 1, "max": 64 @@ -3571,25 +3574,25 @@ "statusCode": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatusCode", "traits": { - "smithy.api#documentation": "Status code of this namespace.", + "smithy.api#documentation": "

The current status of the namespace.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "

The reason for the failure, if any.

" } } }, "traits": { - "smithy.api#documentation": "Represents the status of a namespace." + "smithy.api#documentation": "

The status information about a rule groups namespace.

" } }, "com.amazonaws.amp#RuleGroupsNamespaceStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of a namespace.", + "smithy.api#documentation": "

State of a namespace.

", "smithy.api#enum": [ { "name": "CREATING", @@ -3630,47 +3633,47 @@ "arn": { "target": "com.amazonaws.amp#RuleGroupsNamespaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this rule groups namespace.", + "smithy.api#documentation": "

The ARN of the rule groups namespace.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.amp#RuleGroupsNamespaceName", "traits": { - "smithy.api#documentation": "The rule groups namespace name.", + "smithy.api#documentation": "

The name of the rule groups namespace.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#RuleGroupsNamespaceStatus", "traits": { - "smithy.api#documentation": "The status of rule groups namespace.", + "smithy.api#documentation": "

A structure that displays the current status of the rule groups namespace.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the rule groups namespace was created.", + "smithy.api#documentation": "

The date and time that the rule groups namespace was created.

", "smithy.api#required": {} } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the rule groups namespace was modified.", + "smithy.api#documentation": "

The date and time that the rule groups namespace was most recently changed.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this rule groups namespace." + "smithy.api#documentation": "

The list of tag keys and values that are associated with the rule groups\n namespace.

" } } }, "traits": { - "smithy.api#documentation": "Represents a summary of the rule groups namespace." + "smithy.api#documentation": "

The high-level information about a rule groups namespace. To retrieve more\n information, use DescribeRuleGroupsNamespace.

" } }, "com.amazonaws.amp#RuleGroupsNamespaceSummaryList": { @@ -3679,7 +3682,7 @@ "target": "com.amazonaws.amp#RuleGroupsNamespaceSummary" }, "traits": { - "smithy.api#documentation": "A list of rule groups namespace summary." + "smithy.api#documentation": "

A list of rule groups namespace summary.

" } }, "com.amazonaws.amp#ScrapeConfiguration": { @@ -3688,12 +3691,12 @@ "configurationBlob": { "target": "smithy.api#Blob", "traits": { - "smithy.api#documentation": "Binary data representing a Prometheus configuration file." + "smithy.api#documentation": "

The base 64 encoded scrape configuration file.

" } } }, "traits": { - "smithy.api#documentation": "A representation of a Prometheus configuration file." + "smithy.api#documentation": "

A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User \n Guide.

" } }, "com.amazonaws.amp#Scraper": { @@ -3719,13 +3722,13 @@ "aws.api#arn": { "template": "scraper/{scraperId}" }, - "smithy.api#documentation": "A scraper is a logical and isolated Prometheus server dedicated to discovering and collecting metrics and producing them to an AMP workspace." + "smithy.api#documentation": "

A scraper is a logical and isolated Prometheus server dedicated to discovering and \n collecting metrics and producing them to an Amazon Managed Service for Prometheus workspace.

" } }, "com.amazonaws.amp#ScraperAlias": { "type": "string", "traits": { - "smithy.api#documentation": "A user-assigned scraper alias.", + "smithy.api#documentation": "

A user-assigned scraper alias.

", "smithy.api#length": { "min": 1, "max": 100 @@ -3741,7 +3744,7 @@ "service": "ManagedPrometheusCP", "resource": "Scraper" }, - "smithy.api#documentation": "An ARN identifying a scrape configuration." + "smithy.api#documentation": "

An ARN identifying a scrape configuration.

" } }, "com.amazonaws.amp#ScraperDescription": { @@ -3750,87 +3753,87 @@ "alias": { "target": "com.amazonaws.amp#ScraperAlias", "traits": { - "smithy.api#documentation": "Alias of this scraper." + "smithy.api#documentation": "

(Optional) A name associated with the scraper.

" } }, "scraperId": { "target": "com.amazonaws.amp#ScraperId", "traits": { - "smithy.api#documentation": "Unique string identifying this scraper.", + "smithy.api#documentation": "

The ID of the scraper.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#ScraperArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this scraper.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scraper.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.amp#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides \n permissions for the scraper to discover and collect metrics on your behalf.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#ScraperStatus", "traits": { - "smithy.api#documentation": "The status of this scraper.", + "smithy.api#documentation": "

A structure that contains the current status of the scraper.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the scraper was created.", + "smithy.api#documentation": "

The date and time that the scraper was created.

", "smithy.api#required": {} } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the scraper was last modified.", + "smithy.api#documentation": "

The date and time that the scraper was last modified.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this scraper." + "smithy.api#documentation": "

(Optional) The list of tag keys and values associated with the scraper.

" } }, "statusReason": { "target": "com.amazonaws.amp#StatusReason", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "

If there is a failure, the reason for the failure.

" } }, "scrapeConfiguration": { "target": "com.amazonaws.amp#ScrapeConfiguration", "traits": { - "smithy.api#documentation": "The configuration used to create the scraper.", + "smithy.api#documentation": "

The configuration file in use by the scraper.

", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.amp#Source", "traits": { - "smithy.api#documentation": "The source that the scraper is discovering and collecting metrics from.", + "smithy.api#documentation": "

The Amazon EKS cluster from which the scraper collects metrics.

", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.amp#Destination", "traits": { - "smithy.api#documentation": "The destination that the scraper is producing metrics to.", + "smithy.api#documentation": "

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the properties of a scraper.", + "smithy.api#documentation": "

The ScraperDescription structure contains the full details about one\n scraper in your account.

", "smithy.api#references": [ { "resource": "com.amazonaws.amp#Scraper" @@ -3843,17 +3846,17 @@ "key": { "target": "com.amazonaws.amp#FilterKey", "traits": { - "smithy.api#documentation": "The name of the key to filter by. Currently supported filter keys are 'status', 'sourceArn', 'destinationArn', and 'alias'." + "smithy.api#documentation": "

The name of the key to filter by. Currently supported filter keys are \n status, sourceArn, destinationArn, and \n alias.

" } }, "value": { "target": "com.amazonaws.amp#FilterValues", "traits": { - "smithy.api#documentation": "The values of the given key to filter by." + "smithy.api#documentation": "

The values of the given key by which to filter.

" } }, "traits": { - "smithy.api#documentation": "A list of scraper filters.", + "smithy.api#documentation": "

A list of scraper filters.

", "smithy.api#length": { "min": 1, "max": 4 @@ -3863,7 +3866,7 @@ "com.amazonaws.amp#ScraperId": { "type": "string", "traits": { - "smithy.api#documentation": "A scraper ID.", + "smithy.api#documentation": "

A scraper ID.

", "smithy.api#length": { "min": 1, "max": 64 @@ -3877,19 +3880,19 @@ "statusCode": { "target": "com.amazonaws.amp#ScraperStatusCode", "traits": { - "smithy.api#documentation": "Status code of this scraper.", + "smithy.api#documentation": "

The current status of the scraper.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the status of a scraper." + "smithy.api#documentation": "

The ScraperStatus structure contains status information about the \n scraper.

" } }, "com.amazonaws.amp#ScraperStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of a scraper.", + "smithy.api#documentation": "

State of a scraper.

", "smithy.api#enum": [ { "name": "CREATING", @@ -3925,80 +3928,80 @@ "alias": { "target": "com.amazonaws.amp#ScraperAlias", "traits": { - "smithy.api#documentation": "Alias of this scraper." + "smithy.api#documentation": "

(Optional) A name associated with the scraper.

" } }, "scraperId": { "target": "com.amazonaws.amp#ScraperId", "traits": { - "smithy.api#documentation": "Unique string identifying this scraper.", + "smithy.api#documentation": "

The ID of the scraper.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.amp#ScraperArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this scraper.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scraper.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.amp#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that provides \n permissions for the scraper to discover and collect metrics on your behalf.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#ScraperStatus", "traits": { - "smithy.api#documentation": "The status of this scraper.", + "smithy.api#documentation": "

A structure that contains the current status of the scraper.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the scraper was created.", + "smithy.api#documentation": "

The date and time that the scraper was created.

", "smithy.api#required": {} } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the scraper was last modified.", + "smithy.api#documentation": "

The date and time that the scraper was last modified.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this scraper." + "smithy.api#documentation": "

(Optional) The list of tag keys and values associated with the scraper.

" } }, "statusReason": { "target": "com.amazonaws.amp#StatusReason", "traits": { - "smithy.api#documentation": "The reason for failure if any." + "smithy.api#documentation": "

If there is a failure, the reason for the failure.

" } }, "source": { "target": "com.amazonaws.amp#Source", "traits": { - "smithy.api#documentation": "The source that the scraper is discovering and collecting metrics from.", + "smithy.api#documentation": "

The Amazon EKS cluster from which the scraper collects metrics.

", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.amp#Destination", "traits": { - "smithy.api#documentation": "The destination that the scraper is producing metrics to.", + "smithy.api#documentation": "

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents a summary of the properties of a scraper.", + "smithy.api#documentation": "

The ScraperSummary structure contains a summary of the details about one\n scraper in your account.

", "smithy.api#references": [ { "resource": "com.amazonaws.amp#Scraper" @@ -4012,13 +4015,13 @@ "target": "com.amazonaws.amp#ScraperSummary" }, "traits": { - "smithy.api#documentation": "A list of scraper summaries." + "smithy.api#documentation": "

A list of scraper summaries.

" } }, "com.amazonaws.amp#SecurityGroupId": { "type": "string", "traits": { - "smithy.api#documentation": "ID of a VPC security group.", + "smithy.api#documentation": "

ID of a VPC security group.

", "smithy.api#length": { "min": 0, "max": 255 @@ -4032,7 +4035,7 @@ "target": "com.amazonaws.amp#SecurityGroupId" }, "traits": { - "smithy.api#documentation": "A list of security group IDs specified for VPC configuration.", + "smithy.api#documentation": "

A list of security group IDs specified for VPC configuration.

", "smithy.api#length": { "min": 1, "max": 5 @@ -4045,41 +4048,41 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "

Description of the error.

", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Identifier of the resource affected.", + "smithy.api#documentation": "

Identifier of the resource affected.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Type of the resource affected.", + "smithy.api#documentation": "

Type of the resource affected.

", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating service.", + "smithy.api#documentation": "

Service quotas code for the originating service.

", "smithy.api#required": {} } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating quota.", + "smithy.api#documentation": "

Service quotas code of the originating quota.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Request would cause a service quota to be exceeded.", + "smithy.api#documentation": "

Completing the request would cause a service quota to be exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -4090,18 +4093,18 @@ "eksConfiguration": { "target": "com.amazonaws.amp#EksConfiguration", "traits": { - "smithy.api#documentation": "A representation of an EKS source." + "smithy.api#documentation": "

The Amazon EKS cluster from which a scraper collects metrics.

" } } }, "traits": { - "smithy.api#documentation": "A representation of a source that a scraper can discover and collect metrics from." + "smithy.api#documentation": "

The source of collected metrics for a scraper.

" } }, "com.amazonaws.amp#StatusReason": { "type": "string", "traits": { - "smithy.api#documentation": "The reason for failure if any.", + "smithy.api#documentation": "

The reason for the failure, if any.

", "smithy.api#length": { "min": 1, "max": 256 @@ -4111,7 +4114,7 @@ "com.amazonaws.amp#SubnetId": { "type": "string", "traits": { - "smithy.api#documentation": "ID of a VPC subnet.", + "smithy.api#documentation": "

ID of a VPC subnet.

", "smithy.api#length": { "min": 0, "max": 255 @@ -4125,7 +4128,7 @@ "target": "com.amazonaws.amp#SubnetId" }, "traits": { - "smithy.api#documentation": "A list of subnet IDs specified for VPC configuration.", + "smithy.api#documentation": "

A list of subnet IDs specified for VPC configuration.

", "smithy.api#length": { "min": 1, "max": 5 @@ -4153,17 +4156,17 @@ "key": { "target": "com.amazonaws.amp#TagKey", "traits": { - "smithy.api#documentation": "The key of the tag.\n\nConstraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters.\nValid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @\nMay not begin with `aws:`.\n" + "smithy.api#documentation": "

The key of the tag. May not begin with aws:.

" } }, "value": { "target": "com.amazonaws.amp#TagValue", "traits": { - "smithy.api#documentation": "The value of the tag.\n\nConstraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.\nValid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @\n" + "smithy.api#documentation": "

The value of the tag.

" } }, "traits": { - "smithy.api#documentation": "The list of tags assigned to the resource.", + "smithy.api#documentation": "

The list of tags assigned to the resource.

", "smithy.api#length": { "max": 50 } @@ -4195,7 +4198,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates tags for the specified resource.", + "smithy.api#documentation": "

The TagResource operation associates tags with an Amazon Managed Service for Prometheus\n resource. The only resources that can be tagged are workspaces and rule groups\n namespaces.

\n

If you specify a new tag key for the resource, this tag is appended to the list of\n tags associated with the resource. If you specify a tag key that is already associated\n with the resource, the new tag value that you specify replaces the previous value for\n that tag.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}" @@ -4208,7 +4211,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ARN of the resource.", + "smithy.api#documentation": "

The ARN of the workspace or rule groups namespace to apply tags to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4216,6 +4219,7 @@ "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { + "smithy.api#documentation": "

The list of tag keys and values to associate with the resource.

\n

Keys may not begin with aws:.

", "smithy.api#required": {} } } @@ -4241,32 +4245,32 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "

Description of the error.

", "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating service." + "smithy.api#documentation": "

Service quotas code for the originating service.

" } }, "quotaCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Service Quotas requirement to identify originating quota." + "smithy.api#documentation": "

Service quotas code for the originating quota.

" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Advice to clients on when the call can be safely retried.", + "smithy.api#documentation": "

Advice to clients on when the call can be safely retried.

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { - "smithy.api#documentation": "Request was denied due to request throttling.", + "smithy.api#documentation": "

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} @@ -4298,7 +4302,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes tags from the specified resource.", + "smithy.api#documentation": "

Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources\n that can be tagged are workspaces and rule groups namespaces.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}" @@ -4312,7 +4316,7 @@ "resourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The ARN of the resource.", + "smithy.api#documentation": "

The ARN of the workspace or rule groups namespace.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4320,7 +4324,7 @@ "tagKeys": { "target": "com.amazonaws.amp#TagKeys", "traits": { - "smithy.api#documentation": "One or more tag keys", + "smithy.api#documentation": "

The keys of the tags to remove.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -4357,7 +4361,7 @@ } ], "traits": { - "smithy.api#documentation": "Update logging configuration.", + "smithy.api#documentation": "

Updates the log group ARN or the workspace ID of the current logging\n configuration.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -4372,7 +4376,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace to vend logs to.", + "smithy.api#documentation": "

The ID of the workspace to update the logging configuration for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4380,20 +4384,20 @@ "logGroupArn": { "target": "com.amazonaws.amp#LogGroupArn", "traits": { - "smithy.api#documentation": "The ARN of the CW log group to which the vended log data will be published.", + "smithy.api#documentation": "

The ARN of the CloudWatch log group to which the vended log data will be\n published.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of an UpdateLoggingConfiguration operation." + "smithy.api#documentation": "

Represents the input of an UpdateLoggingConfiguration operation.

" } }, "com.amazonaws.amp#UpdateLoggingConfigurationResponse": { @@ -4402,13 +4406,13 @@ "status": { "target": "com.amazonaws.amp#LoggingConfigurationStatus", "traits": { - "smithy.api#documentation": "The status of the logging configuration.", + "smithy.api#documentation": "

A structure that contains the current status of the logging configuration.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the output of an UpdateLoggingConfiguration operation." + "smithy.api#documentation": "

Represents the output of an UpdateLoggingConfiguration operation.

" } }, "com.amazonaws.amp#UpdateWorkspaceAlias": { @@ -4443,7 +4447,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an AMP workspace alias.", + "smithy.api#documentation": "

Updates the alias of an existing workspace.

", "smithy.api#http": { "code": 204, "method": "POST", @@ -4458,7 +4462,7 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "The ID of the workspace being updated.", + "smithy.api#documentation": "

The ID of the workspace to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4466,19 +4470,19 @@ "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "The new alias of the workspace." + "smithy.api#documentation": "

The new alias for the workspace. It does not need to be unique.

\n

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning\n and end of the alias that you specify.

" } }, "clientToken": { "target": "com.amazonaws.amp#IdempotencyToken", "traits": { - "smithy.api#documentation": "Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.", + "smithy.api#documentation": "

A unique identifier that you can provide to ensure the idempotency of the request.\n Case-sensitive.

", "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "Represents the input of an UpdateWorkspaceAlias operation." + "smithy.api#documentation": "

Represents the input of an UpdateWorkspaceAlias operation.

" } }, "com.amazonaws.amp#Uri": { @@ -4496,26 +4500,26 @@ "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Description of the error.", + "smithy.api#documentation": "

Description of the error.

", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.amp#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "Reason the request failed validation.", + "smithy.api#documentation": "

Reason the request failed validation.

", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.amp#ValidationExceptionFieldList", "traits": { - "smithy.api#documentation": "The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message." + "smithy.api#documentation": "

The field that caused the error, if applicable.

" } } }, "traits": { - "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.", + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an Amazon Web Services\n service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4526,20 +4530,20 @@ "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The field name.", + "smithy.api#documentation": "

The name of the field that caused an exception.

", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Message describing why the field failed validation.", + "smithy.api#documentation": "

A message describing why the field caused an exception.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an exception." + "smithy.api#documentation": "

Information about a field passed into a request that resulted in an exception.

" } }, "com.amazonaws.amp#ValidationExceptionFieldList": { @@ -4548,13 +4552,13 @@ "target": "com.amazonaws.amp#ValidationExceptionField" }, "traits": { - "smithy.api#documentation": "A list of fields." + "smithy.api#documentation": "

A list of fields.

" } }, "com.amazonaws.amp#ValidationExceptionReason": { "type": "string", "traits": { - "smithy.api#documentation": "Possible reasons a request failed validation.", + "smithy.api#documentation": "

Possible reasons a request failed validation.

", "smithy.api#enum": [ { "name": "UNKNOWN_OPERATION", @@ -4612,13 +4616,13 @@ "aws.api#arn": { "template": "workspace/{workspaceId}" }, - "smithy.api#documentation": "An AMP workspace is a logical and isolated Prometheus server dedicated to Prometheus resources such as metrics, where you ingest, store, and query your Prometheus metrics." + "smithy.api#documentation": "

An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server \n dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.

" } }, "com.amazonaws.amp#WorkspaceAlias": { "type": "string", "traits": { - "smithy.api#documentation": "A user-assigned workspace alias.", + "smithy.api#documentation": "

A user-assigned workspace alias.

", "smithy.api#length": { "min": 1, "max": 100 @@ -4633,7 +4637,7 @@ "service": "ManagedPrometheusCP", "resource": "Workspace" }, - "smithy.api#documentation": "An ARN identifying a Workspace.", + "smithy.api#documentation": "

An ARN identifying a Workspace.

", "smithy.api#pattern": "^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$" } }, @@ -4643,58 +4647,58 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "Unique string identifying this workspace.", + "smithy.api#documentation": "

The unique ID for the workspace.

", "smithy.api#required": {} } }, "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "Alias of this workspace." + "smithy.api#documentation": "

The alias that is assigned to this workspace to help identify it. It may not be\n unique.

" } }, "arn": { "target": "com.amazonaws.amp#WorkspaceArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of this workspace.", + "smithy.api#documentation": "

The ARN of the workspace.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#WorkspaceStatus", "traits": { - "smithy.api#documentation": "The status of this workspace.", + "smithy.api#documentation": "

The current status of the workspace.

", "smithy.api#required": {} } }, "prometheusEndpoint": { "target": "com.amazonaws.amp#Uri", "traits": { - "smithy.api#documentation": "Prometheus endpoint URI." + "smithy.api#documentation": "

The Prometheus endpoint available for this workspace.

" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the workspace was created.", + "smithy.api#documentation": "

The date and time that the workspace was created.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this workspace." + "smithy.api#documentation": "

The list of tag keys and values that are associated with the workspace.

" } }, "kmsKeyArn": { "target": "com.amazonaws.amp#KmsKeyArn", "traits": { - "smithy.api#documentation": "The customer managed KMS key of this workspace." + "smithy.api#documentation": "

(optional) If the workspace was created with a customer managed KMS \n key, the ARN for the key used.

" } } }, "traits": { - "smithy.api#documentation": "Represents the properties of a workspace.", + "smithy.api#documentation": "

The full details about one Amazon Managed Service for Prometheus workspace in your account.

", "smithy.api#references": [ { "resource": "com.amazonaws.amp#Workspace" @@ -4705,7 +4709,7 @@ "com.amazonaws.amp#WorkspaceId": { "type": "string", "traits": { - "smithy.api#documentation": "A workspace ID.", + "smithy.api#documentation": "

A workspace ID.

", "smithy.api#length": { "min": 1, "max": 64 @@ -4719,19 +4723,19 @@ "statusCode": { "target": "com.amazonaws.amp#WorkspaceStatusCode", "traits": { - "smithy.api#documentation": "Status code of this workspace.", + "smithy.api#documentation": "

The current status of the workspace.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Represents the status of a workspace." + "smithy.api#documentation": "

The status of the workspace.

" } }, "com.amazonaws.amp#WorkspaceStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "State of a workspace.", + "smithy.api#documentation": "

State of a workspace.

", "smithy.api#enum": [ { "name": "CREATING", @@ -4767,52 +4771,52 @@ "workspaceId": { "target": "com.amazonaws.amp#WorkspaceId", "traits": { - "smithy.api#documentation": "Unique string identifying this workspace.", + "smithy.api#documentation": "

The unique ID for the workspace.

", "smithy.api#required": {} } }, "alias": { "target": "com.amazonaws.amp#WorkspaceAlias", "traits": { - "smithy.api#documentation": "Alias of this workspace." + "smithy.api#documentation": "

The alias that is assigned to this workspace to help identify it. It may not be\n unique.

" } }, "arn": { "target": "com.amazonaws.amp#WorkspaceArn", "traits": { - "smithy.api#documentation": "The AmazonResourceName of this workspace.", + "smithy.api#documentation": "

The ARN of the workspace.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amp#WorkspaceStatus", "traits": { - "smithy.api#documentation": "The status of this workspace.", + "smithy.api#documentation": "

The current status of the workspace.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time when the workspace was created.", + "smithy.api#documentation": "

The date and time that the workspace was created.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amp#TagMap", "traits": { - "smithy.api#documentation": "The tags of this workspace." + "smithy.api#documentation": "

The list of tag keys and values that are associated with the workspace.

" } }, "kmsKeyArn": { "target": "com.amazonaws.amp#KmsKeyArn", "traits": { - "smithy.api#documentation": "Customer managed KMS key ARN for this workspace" + "smithy.api#documentation": "

(optional) If the workspace was created with a customer managed KMS \n key, the ARN for the key used.

" } } }, "traits": { - "smithy.api#documentation": "Represents a summary of the properties of a workspace.", + "smithy.api#documentation": "

The information about one Amazon Managed Service for Prometheus workspace in your account.

", "smithy.api#references": [ { "resource": "com.amazonaws.amp#Workspace" @@ -4826,7 +4830,7 @@ "target": "com.amazonaws.amp#WorkspaceSummary" }, "traits": { - "smithy.api#documentation": "A list of workspace summaries." + "smithy.api#documentation": "

A list of workspace summaries.

" } } } diff --git a/codegen/sdk/aws-models/batch.json b/codegen/sdk/aws-models/batch.json index ff7df26e713..440703338f0 100644 --- a/codegen/sdk/aws-models/batch.json +++ b/codegen/sdk/aws-models/batch.json @@ -1515,7 +1515,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a job in an Batch job queue. Jobs that are in the\n SUBMITTED\n or\n PENDING\n are\n canceled. A job\n inRUNNABLE remains in RUNNABLE until it reaches the head of the\n job queue. Then the job status is updated to\n FAILED.

\n \n

A PENDING job is canceled after all dependency jobs are completed.\n Therefore, it may take longer than expected to cancel a job in PENDING\n status.

\n

When you try to cancel an array parent job in PENDING, Batch attempts to\n cancel all child jobs. The array parent job is canceled when all child jobs are\n completed.

\n \n

Jobs that progressed to the STARTING or\n RUNNING state aren't canceled. However, the API operation still succeeds, even\n if no job is canceled. These jobs must be terminated with the TerminateJob\n operation.

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

Cancels a job in an Batch job queue. Jobs that are in the\n SUBMITTED\n or\n PENDING\n are\n canceled. A job\n inRUNNABLE remains in RUNNABLE until it reaches the head of the\n job queue. Then the job status is updated to\n FAILED.

\n \n

A PENDING job is canceled after all dependency jobs are completed.\n Therefore, it may take longer than expected to cancel a job in PENDING\n status.

\n

When you try to cancel an array parent job in PENDING, Batch attempts to\n cancel all child jobs. The array parent job is canceled when all child jobs are\n completed.

\n \n

Jobs that progressed to the STARTING or\n RUNNING state aren't canceled. However, the API operation still succeeds, even\n if no job is canceled. These jobs must be terminated with the TerminateJob\n operation.

", "smithy.api#examples": [ { "title": "To cancel a job", @@ -1731,7 +1731,7 @@ "allocationStrategy": { "target": "com.amazonaws.batch#CRAllocationStrategy", "traits": { - "smithy.api#documentation": "

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

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

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

\n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

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

\n
\n
SPOT_PRICE_CAPACITY_OPTIMIZED
\n
\n

The price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
\n

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.

" + "smithy.api#documentation": "

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

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

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

\n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

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

\n
\n
SPOT_PRICE_CAPACITY_OPTIMIZED
\n
\n

The price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
\n

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

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

The maximum number of\n vCPUs that a\n compute environment can\n support.

\n \n

With BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. For example, no more than a single instance from among those specified in your compute\n environment is allocated.

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

The maximum number of\n vCPUs that a\n compute environment can\n support.

\n \n

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

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

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

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

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

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

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

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

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n " } }, "placementGroup": { @@ -1848,7 +1848,7 @@ "maxvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

\n \n

With BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, and SPOT_PRICE_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. That is, no more than a single instance from among those specified in your compute\n environment.

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

The maximum number of Amazon EC2 vCPUs that an environment can reach.

\n \n

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

\n " } }, "desiredvCpus": { @@ -1872,7 +1872,7 @@ "allocationStrategy": { "target": "com.amazonaws.batch#CRUpdateAllocationStrategy", "traits": { - "smithy.api#documentation": "

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

\n

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n \n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

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

\n
\n
SPOT_PRICE_CAPACITY_OPTIMIZED
\n
\n

The price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
\n

With both BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, and SPOT_PRICE_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.

" + "smithy.api#documentation": "

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

\n

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n \n
\n
BEST_FIT_PROGRESSIVE
\n
\n

Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.

\n
\n
SPOT_CAPACITY_OPTIMIZED
\n
\n

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

\n
\n
SPOT_PRICE_CAPACITY_OPTIMIZED
\n
\n

The price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.

\n
\n
\n

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.

" } }, "instanceTypes": { @@ -1890,7 +1890,7 @@ "instanceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

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

\n

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

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

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

\n

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

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

\n " } }, "tags": { @@ -2112,7 +2112,16 @@ } }, "runtimePlatform": { - "target": "com.amazonaws.batch#RuntimePlatform" + "target": "com.amazonaws.batch#RuntimePlatform", + "traits": { + "smithy.api#documentation": "

An object that represents the compute environment architecture for Batch jobs on Fargate.

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

The private repository authentication credentials to use.

" + } } }, "traits": { @@ -2175,7 +2184,7 @@ "image": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The image used to start a container. This string is passed directly to the Docker daemon.\n Images in the Docker Hub registry are available by default. Other repositories are specified with\n \n repository-url/image:tag\n .\n It can be 255 characters long. It can contain uppercase and lowercase letters, numbers,\n hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the\n Create a container section of the Docker Remote API and the IMAGE\n parameter of docker run.

\n \n

Docker image architecture must match the processor architecture of the compute resources\n that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based\n compute resources.

\n \n
    \n
  • \n

    Images in Amazon ECR Public repositories use the full registry/repository[:tag] or\n registry/repository[@digest] naming conventions. For example,\n public.ecr.aws/registry_alias/my-web-app:latest\n .

    \n
    • \n
  • \n

    Images in Amazon ECR repositories use the full registry and repository URI (for example,\n 123456789012.dkr.ecr..amazonaws.com/).

    \n
    • \n
  • \n

    Images in official repositories on Docker Hub use a single name (for example,\n ubuntu or mongo).

    \n
    • \n
  • \n

    Images in other repositories on Docker Hub are qualified with an organization name (for\n example, amazon/amazon-ecs-agent).

    \n
    • \n
  • \n

    Images in other online repositories are qualified further by a domain name (for example,\n quay.io/assemblyline/ubuntu).

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

Required.\n The image used to start a container. This string is passed directly to the\n Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are\n specified with\n \n repository-url/image:tag\n .\n It can be 255 characters long. It can contain uppercase and lowercase letters, numbers,\n hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the\n Create a container section of the Docker Remote API and the IMAGE\n parameter of docker run.

\n \n

Docker image architecture must match the processor architecture of the compute resources\n that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based\n compute resources.

\n \n
    \n
  • \n

    Images in Amazon ECR Public repositories use the full registry/repository[:tag] or\n registry/repository[@digest] naming conventions. For example,\n public.ecr.aws/registry_alias/my-web-app:latest\n .

    \n
    • \n
  • \n

    Images in Amazon ECR repositories use the full registry and repository URI (for example,\n 123456789012.dkr.ecr..amazonaws.com/).

    \n
    • \n
  • \n

    Images in official repositories on Docker Hub use a single name (for example,\n ubuntu or mongo).

    \n
    • \n
  • \n

    Images in other repositories on Docker Hub are qualified with an organization name (for\n example, amazon/amazon-ecs-agent).

    \n
    • \n
  • \n

    Images in other online repositories are qualified further by a domain name (for example,\n quay.io/assemblyline/ubuntu).

    \n
    • \n
" } }, "vcpus": { @@ -2305,7 +2314,16 @@ } }, "runtimePlatform": { - "target": "com.amazonaws.batch#RuntimePlatform" + "target": "com.amazonaws.batch#RuntimePlatform", + "traits": { + "smithy.api#documentation": "

An object that represents the compute environment architecture for Batch jobs on Fargate.

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

The private repository authentication credentials to use.

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

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.

\n

In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.

\n \n

Multi-node parallel jobs aren't supported on Spot Instances.

\n \n

In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how\n you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of\n your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.

\n \n

To create a compute environment that uses EKS resources, the caller must have permissions to call\n eks:DescribeCluster.

\n \n \n

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it\n also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is\n available. You're responsible for the management of the guest operating system. This includes any updates and\n security patches. You're also responsible for any additional application software or utilities that you install on\n the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete\n these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
    2. \n
  2. \n

    Add the compute environment to an existing job queue.

    \n
    3. \n
  3. \n

    Remove the earlier compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the earlier compute environment.

    \n
    5. \n
\n

In April 2022, Batch added enhanced support for updating compute environments. For more information, see\n Updating compute\n environments. To use the enhanced updating of compute environments to update AMIs, follow these\n rules:

\n
    \n
  • \n

    Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.

    \n
    • \n
  • \n

    Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE, \n SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.

    \n
    • \n
  • \n

    Set the update to latest image version (updateToLatestImageVersion)\n parameter to\n true.\n The updateToLatestImageVersion parameter is used when you update a compute\n environment. This parameter is ignored when you create a compute\n environment.

    \n
    • \n
  • \n

    Don't specify an AMI ID in imageId, imageIdOverride (in \n ec2Configuration\n ), or in the launch\n template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's\n supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID\n in the imageId or imageIdOverride parameters, or the launch template identified by the\n LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the\n AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the\n imageId or imageIdOverride parameters. It can only be replaced by specifying a different\n launch template, or if the launch template version is set to $Default or $Latest, by\n setting either a new default version for the launch template (if $Default) or by adding a new version\n to the launch template (if $Latest).

    \n
    • \n
\n

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be\n re-selected. If the version setting in the launch template (launchTemplate) is set to\n $Latest or $Default, the latest or default version of the launch template is evaluated up\n at the time of the infrastructure update, even if the launchTemplate wasn't updated.

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

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.

\n

In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.

\n \n

Multi-node parallel jobs aren't supported on Spot Instances.

\n \n

In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how\n you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of\n your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.

\n \n

To create a compute environment that uses EKS resources, the caller must have permissions to call\n eks:DescribeCluster.

\n \n \n

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it\n also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is\n available. You're responsible for the management of the guest operating system. This includes any updates and\n security patches. You're also responsible for any additional application software or utilities that you install on\n the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete\n these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
    2. \n
  2. \n

    Add the compute environment to an existing job queue.

    \n
    3. \n
  3. \n

    Remove the earlier compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the earlier compute environment.

    \n
    5. \n
\n

In April 2022, Batch added enhanced support for updating compute environments. For more information, see\n Updating compute\n environments. To use the enhanced updating of compute environments to update AMIs, follow these\n rules:

\n
    \n
  • \n

    Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.

    \n
    • \n
  • \n

    Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE, \n SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.

    \n
    • \n
  • \n

    Set the update to latest image version (updateToLatestImageVersion)\n parameter to\n true.\n The updateToLatestImageVersion parameter is used when you update a compute\n environment. This parameter is ignored when you create a compute\n environment.

    \n
    • \n
  • \n

    Don't specify an AMI ID in imageId, imageIdOverride (in \n ec2Configuration\n ), or in the launch\n template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's\n supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID\n in the imageId or imageIdOverride parameters, or the launch template identified by the\n LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the\n AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the\n imageId or imageIdOverride parameters. It can only be replaced by specifying a different\n launch template, or if the launch template version is set to $Default or $Latest, by\n setting either a new default version for the launch template (if $Default) or by adding a new version\n to the launch template (if $Latest).

    \n
    • \n
\n

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be\n re-selected. If the version setting in the launch template (launchTemplate) is set to\n $Latest or $Default, the latest or default version of the launch template is evaluated up\n at the time of the infrastructure update, even if the launchTemplate wasn't updated.

\n ", "smithy.api#examples": [ { "title": "To create a managed EC2 compute environment", @@ -2390,6 +2408,44 @@ "computeEnvironmentName": "C4OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand" } + }, + { + "title": "To create a managed EC2 Spot compute environment", + "documentation": "This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.", + "input": { + "computeEnvironmentName": "M4Spot", + "state": "ENABLED", + "type": "MANAGED", + "computeResources": { + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "type": "SPOT", + "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", + "tags": { + "Name": "Batch Instance - M4Spot" + }, + "desiredvCpus": 4, + "minvCpus": 0, + "instanceTypes": [ + "m4" + ], + "securityGroupIds": [ + "sg-cf5093b2" + ], + "instanceRole": "ecsInstanceRole", + "maxvCpus": 128, + "bidPercentage": 20, + "ec2KeyPair": "id_rsa" + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" + }, + "output": { + "computeEnvironmentName": "M4Spot", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot" + } } ], "smithy.api#http": { @@ -2439,7 +2495,7 @@ "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

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

\n \n

If your account already created the Batch service-linked role, that role is used by default for your compute\n environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your\n account, and no role is specified here, the service attempts to create the Batch service-linked role in your\n account.

\n \n

If your specified role has a path other than /, then you must specify either the full role ARN\n (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path\n of /foo/, specify /foo/bar as the role name. For more information, see Friendly names\n and paths in the IAM User Guide.

\n \n

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

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

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

\n \n

If your account already created the Batch service-linked role, that role is used by default for your compute\n environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your\n account, and no role is specified here, the service attempts to create the Batch service-linked role in your\n account.

\n \n

If your specified role has a path other than /, then you must specify either the full role ARN\n (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path\n of /foo/, specify /foo/bar as the role name. For more information, see Friendly names\n and paths in the IAM User Guide.

\n \n

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

\n " } }, "tags": { @@ -2517,6 +2573,29 @@ "jobQueueName": "LowPriority", "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority" } + }, + { + "title": "To create a job queue with multiple compute environments", + "documentation": "This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.", + "input": { + "priority": 10, + "state": "ENABLED", + "computeEnvironmentOrder": [ + { + "computeEnvironment": "C4OnDemand", + "order": 1 + }, + { + "computeEnvironment": "M4Spot", + "order": 2 + } + ], + "jobQueueName": "HighPriority" + }, + "output": { + "jobQueueName": "HighPriority", + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority" + } } ], "smithy.api#http": { @@ -3107,7 +3186,7 @@ "jobDefinitions": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format\n arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version\n using the form ${JobDefinitionName}:${Revision}.

" + "smithy.api#documentation": "

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the\n format\n arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}\n or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.

" } }, "maxResults": { @@ -3585,7 +3664,7 @@ "target": "com.amazonaws.batch#ImageType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The image type to match with the instance type to select an AMI. The supported values are\n different for ECS and EKS resources.

\n
\n
ECS
\n
\n

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

\n
\n
ECS_AL2
\n
\n

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

\n
\n
ECS_AL2_NVIDIA
\n
\n

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

\n
\n
ECS_AL1
\n
\n

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

\n
\n
\n
\n
EKS
\n
\n

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux\n AMI (EKS_AL2) is used. If a new image type is specified in an update,\n but neither an imageId nor a imageIdOverride parameter is specified,\n then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

\n
\n
EKS_AL2
\n
\n

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

\n
\n
EKS_AL2_NVIDIA
\n
\n

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

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

The image type to match with the instance type to select an AMI. The supported values are\n different for ECS and EKS resources.

\n
\n
ECS
\n
\n

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

\n
\n
ECS_AL2
\n
\n

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

\n
\n
ECS_AL2_NVIDIA
\n
\n

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

\n
\n
ECS_AL2023
\n
\n

\n Amazon Linux 2023: Batch\n supports Amazon Linux 2023.

\n \n

Amazon Linux 2023 does not support A1 instances.

\n \n
\n
ECS_AL1
\n
\n

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

\n
\n
\n
\n
EKS
\n
\n

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux\n AMI (EKS_AL2) is used. If a new image type is specified in an update,\n but neither an imageId nor a imageIdOverride parameter is specified,\n then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

\n
\n
EKS_AL2
\n
\n

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

\n
\n
EKS_AL2_NVIDIA
\n
\n

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

\n
\n
\n
\n
", "smithy.api#required": {} } }, @@ -4180,7 +4259,10 @@ } }, "metadata": { - "target": "com.amazonaws.batch#EksMetadata" + "target": "com.amazonaws.batch#EksMetadata", + "traits": { + "smithy.api#documentation": "

Describes and uniquely identifies Kubernetes resources. For example, the compute environment\n that a pod runs in or the jobID for a job running in the pod. For more information,\n see Understanding Kubernetes Objects in the Kubernetes\n documentation.

" + } } }, "traits": { @@ -4394,7 +4476,7 @@ "computeReservation": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

A value used to reserve some of the available maximum vCPU for fair share identifiers that\n aren't already used.

\n

The reserved ratio is\n (computeReservation/100)^ActiveFairShares\n \n where \n ActiveFairShares\n is the number of active fair share\n identifiers.

\n

For example, a computeReservation value of 50 indicates that Batchreserves\n 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if\n there are two fair share identifiers. It reserves 12.5% if there are three fair share\n identifiers. A computeReservation value of 25 indicates that Batch should reserve\n 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are\n two fair share identifiers, and 1.56% if there are three fair share identifiers.

\n

The minimum value is 0 and the maximum value is 99.

" + "smithy.api#documentation": "

A value used to reserve some of the available maximum vCPU for fair share identifiers that\n aren't already used.

\n

The reserved ratio is\n (computeReservation/100)^ActiveFairShares\n \n where \n ActiveFairShares\n is the number of active fair share\n identifiers.

\n

For example, a computeReservation value of 50 indicates that Batch reserves\n 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if\n there are two fair share identifiers. It reserves 12.5% if there are three fair share\n identifiers. A computeReservation value of 25 indicates that Batch should reserve\n 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are\n two fair share identifiers, and 1.56% if there are three fair share identifiers.

\n

The minimum value is 0 and the maximum value is 99.

" } }, "shareDistribution": { @@ -4760,7 +4842,7 @@ "target": "com.amazonaws.batch#Long", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's\n when the job transitioned from the STARTING state to the RUNNING state.\n This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

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

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's\n when the job transitioned from the STARTING state to the RUNNING state.\n

", "smithy.api#required": {} } }, @@ -5103,7 +5185,7 @@ "attemptDurationSeconds": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The job timeout time (in seconds) that's measured from the job attempt's\n startedAt timestamp. After this time passes, Batch terminates your jobs if they\n aren't finished. The minimum value for the timeout is 60 seconds.

\n

For array jobs, the timeout applies to the child jobs, not to the parent array job.

\n

For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the\n individual nodes.

" + "smithy.api#documentation": "

The job timeout time (in seconds) that's measured from the job attempt's\n startedAt timestamp. After this time passes, Batch terminates your jobs if they\n aren't finished. The minimum value for the timeout is 60 seconds.

\n

For array jobs, the timeout applies to the child jobs, not to the parent array job.

\n

For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the\n individual nodes.

" } } }, @@ -5178,7 +5260,7 @@ "version": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

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

\n

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

\n \n

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

\n \n

Default: $Default.

" + "smithy.api#documentation": "

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

\n

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

\n \n

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

\n \n

Default: $Default.

" } } }, @@ -5263,6 +5345,22 @@ } ] } + }, + { + "title": "To list submitted jobs", + "documentation": "This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.", + "input": { + "jobQueue": "HighPriority", + "jobStatus": "SUBMITTED" + }, + "output": { + "jobSummaryList": [ + { + "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786", + "jobName": "example" + } + ] + } } ], "smithy.api#http": { @@ -5611,7 +5709,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details for a Docker volume mount point that's used in a job's container properties. This\n parameter maps to Volumes in the Create a container section of the Docker Remote API and the\n --volume option to docker run.

" + "smithy.api#documentation": "

Details for a Docker volume mount point that's used in a job's container properties. This\n parameter maps to Volumes in the Create a container section of the Docker Remote API and the\n --volume option to docker run.

" } }, "com.amazonaws.batch#MountPoints": { @@ -5926,6 +6024,40 @@ "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1", "revision": 1 } + }, + { + "title": "RegisterJobDefinition with tags", + "documentation": "This demonstrates calling the RegisterJobDefinition action, including tags.", + "input": { + "jobDefinitionName": "sleep30", + "type": "container", + "containerProperties": { + "image": "busybox", + "command": [ + "sleep", + "30" + ], + "resourceRequirements": [ + { + "type": "MEMORY", + "value": "128" + }, + { + "type": "VCPU", + "value": "1" + } + ] + }, + "tags": { + "Department": "Engineering", + "User": "JaneDoe" + } + }, + "output": { + "jobDefinitionName": "sleep30", + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", + "revision": 1 + } } ], "smithy.api#http": { @@ -6052,6 +6184,22 @@ "smithy.api#output": {} } }, + "com.amazonaws.batch#RepositoryCredentials": { + "type": "structure", + "members": { + "credentialsParameter": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

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

The repository credentials for private registry authentication.

" + } + }, "com.amazonaws.batch#ResourceRequirement": { "type": "structure", "members": { @@ -6148,18 +6296,18 @@ "operatingSystemFamily": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The operating system for the compute environment.\n Valid values are:\n LINUX (default), WINDOWS_SERVER_2019_CORE,\n WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and\n WINDOWS_SERVER_2022_FULL.

\n \n

The following parameters can’t be set for Windows containers: linuxParameters,\n privileged, user, ulimits,\n readonlyRootFilesystem,\n and efsVolumeConfiguration.

\n \n \n

The Batch Scheduler checks before registering a task definition with Fargate. If the job\n requires a Windows container and the first compute environment is LINUX, the\n compute environment is skipped and the next is checked until a Windows-based compute environment\n is found.

\n \n \n

Fargate Spot is not supported for Windows-based containers on Fargate. A job\n queue will be blocked if a Fargate Windows job is submitted to a job queue with only Fargate\n Spot compute environments.\n However, you can attach both FARGATE and FARGATE_SPOT\n compute environments to the same job\n queue.

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

The operating system for the compute environment.\n Valid values are:\n LINUX (default), WINDOWS_SERVER_2019_CORE,\n WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and\n WINDOWS_SERVER_2022_FULL.

\n \n

The following parameters can’t be set for Windows containers: linuxParameters,\n privileged, user, ulimits,\n readonlyRootFilesystem,\n and efsVolumeConfiguration.

\n \n \n

The Batch Scheduler checks\n the compute environments\n that are attached to the job queue before registering a task definition with\n Fargate. In this\n scenario, the job queue is where the job is submitted. If the job requires a\n Windows container and the first compute environment is LINUX, the compute\n environment is skipped and the next compute environment is checked until a Windows-based compute\n environment is found.

\n \n \n

Fargate Spot is not supported for\n ARM64 and\n Windows-based containers on Fargate. A job queue will be blocked if a\n Fargate\n ARM64 or\n Windows job is submitted to a job queue with only Fargate Spot compute environments.\n However, you can attach both FARGATE and\n FARGATE_SPOT compute environments to the same job queue.

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

The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.

\n \n

This parameter must be set to\n X86_64\n for Windows containers.

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

\n The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.

\n \n

This parameter must be set to\n X86_64\n for Windows containers.

\n \n \n

Fargate Spot is not supported for ARM64 and Windows-based containers on\n Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is\n submitted to a job queue with only Fargate Spot compute environments. However, you can attach\n both FARGATE and FARGATE_SPOT compute environments to the same job\n queue.

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

An object that represents the compute environment architecture for Batch jobs on Fargate.

" + "smithy.api#documentation": "

\n An object that represents the compute environment architecture for Batch jobs on Fargate.\n

" } }, "com.amazonaws.batch#SchedulingPolicyDetail": { @@ -6374,7 +6522,7 @@ "schedulingPriorityOverride": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a\n higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling\n priority in the job definition.

\n

The minimum supported value is 0 and the maximum supported value is 9999.

" + "smithy.api#documentation": "

The scheduling priority for the job. This only affects jobs in job queues with a fair share\n policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority.\n This\n overrides any scheduling priority in the job definition and works only within a single share\n identifier.

\n

The minimum supported value is 0 and the maximum supported value is 9999.

" } }, "arrayProperties": { @@ -6430,7 +6578,7 @@ "timeout": { "target": "com.amazonaws.batch#JobTimeout", "traits": { - "smithy.api#documentation": "

The timeout configuration for this SubmitJob operation. You can specify a timeout duration\n after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't\n retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration\n specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job.\n For more information, see Job\n Timeouts in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The timeout configuration for this SubmitJob operation. You can specify a timeout duration\n after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't\n retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration\n specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job.\n For more information, see Job\n Timeouts in the Amazon Elastic Container Service Developer Guide.

" } }, "tags": { @@ -6716,7 +6864,7 @@ "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The hard limit for the ulimit type.

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

The hard limit for the ulimit type.

", "smithy.api#required": {} } }, @@ -6724,7 +6872,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of the ulimit.

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

The type of the ulimit. Valid values are: core | cpu | \n data | fsize | locks | memlock | msgqueue | \n nice | nofile | nproc | rss | rtprio | \n rttime | sigpending | stack.

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

The ulimit settings to pass to the container.

\n \n

This object isn't applicable to jobs that are running on Fargate resources.

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

The ulimit settings to pass to the container. For more information, see \n Ulimit.

\n \n

This object isn't applicable to jobs that are running on Fargate resources.

\n " } }, "com.amazonaws.batch#Ulimits": { @@ -6889,7 +7037,7 @@ "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

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

\n \n

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

\n \n

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

\n \n

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

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

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

\n \n

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

\n \n

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

\n \n

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

\n " } }, "updatePolicy": { diff --git a/codegen/sdk/aws-models/braket.json b/codegen/sdk/aws-models/braket.json index 52f6bc61426..a24b0d86564 100644 --- a/codegen/sdk/aws-models/braket.json +++ b/codegen/sdk/aws-models/braket.json @@ -1022,6 +1022,9 @@ { "target": "com.amazonaws.braket#ConflictException" }, + { + "target": "com.amazonaws.braket#DeviceOfflineException" + }, { "target": "com.amazonaws.braket#DeviceRetiredException" }, @@ -2285,7 +2288,7 @@ "service": "com.amazonaws.braket#Braket", "resource": "com.amazonaws.braket#JobResource" }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:braket:[a-z0-9\\-]*:[0-9]{12}:job/.*$" + "smithy.api#pattern": "^arn:aws[a-z\\-]*:braket:[a-z0-9\\-]+:[0-9]{12}:job/.*$" } }, "com.amazonaws.braket#JobCheckpointConfig": { diff --git a/codegen/sdk/aws-models/cost-optimization-hub.json b/codegen/sdk/aws-models/cost-optimization-hub.json index a143deddb27..3194cd4af31 100644 --- a/codegen/sdk/aws-models/cost-optimization-hub.json +++ b/codegen/sdk/aws-models/cost-optimization-hub.json @@ -1897,7 +1897,7 @@ "accountId": { "target": "com.amazonaws.costoptimizationhub#AccountId", "traits": { - "smithy.api#documentation": "

The enrollment status of a specific account ID in the organization.

" + "smithy.api#documentation": "

The account ID of a member account in the organization.

" } }, "nextToken": { @@ -1923,7 +1923,13 @@ "items": { "target": "com.amazonaws.costoptimizationhub#AccountEnrollmentStatuses", "traits": { - "smithy.api#documentation": "

The account enrollment statuses.

" + "smithy.api#documentation": "

The enrollment status of a specific account ID, including creation and last updated\n timestamps.

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

The enrollment status of all member accounts in the organization if the account is the\n management account.

" } }, "nextToken": { diff --git a/codegen/sdk/aws-models/ecs.json b/codegen/sdk/aws-models/ecs.json index 7222d5107ba..66b3977f47d 100644 --- a/codegen/sdk/aws-models/ecs.json +++ b/codegen/sdk/aws-models/ecs.json @@ -2490,7 +2490,7 @@ "systemControls": { "target": "com.amazonaws.ecs#SystemControls", "traits": { - "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run. For example, you can configure\n\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.

" + "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.

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

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto use container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

\n \n

For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:

\n
    \n
  • \n

    Linux platform version 1.3.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
    • \n
\n \n

For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto use container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI,\n\t\t\tyour instance needs at least version 1.26.0-1 of the ecs-init package. If\n\t\t\tyour container instances are launched from version 20190301 or later, then\n\t\t\tthey contain the required versions of the container agent and ecs-init. For\n\t\t\tmore information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

\n \n

For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:

\n
    \n
  • \n

    Linux platform version 1.3.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
    • \n
\n \n

For more information about how to create a container dependency, see Container dependency in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#ContainerInstance": { @@ -3420,7 +3420,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL deployment controller type. For more information, see\n\t\t\t\tAmazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.

\n

For information about the maximum number of task sets and otther quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL deployment controller type. For more information, see\n\t\t\t\tAmazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.

\n

For information about the maximum number of task sets and otther quotas, see Amazon ECS\n\t\t\t\tservice quotas in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#CreateTaskSetRequest": { @@ -5774,7 +5774,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide;.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide;.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
    • \n
\n " } }, "com.amazonaws.ecs#ExecuteCommand": { @@ -8631,7 +8631,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n

If you change the root user account setting, the default settings are reset for users and\n\t\t\troles that do not have specified individual account settings. For more information, see\n\t\t\t\tAccount\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.

\n

When you specify serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat, the Amazon Resource Name (ARN) and\n\t\t\tresource ID format of the resource type for a specified user, role, or the root user for an\n\t\t\taccount is affected. The opt-in and opt-out account setting must be set for each Amazon ECS\n\t\t\tresource separately. The ARN and resource ID format of a resource is defined by the\n\t\t\topt-in status of the user or role that created the resource. You must turn on this\n\t\t\tsetting to use Amazon ECS features such as resource tagging.

\n

When you specify awsvpcTrunking, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is turned on, any new container instances that support\n\t\t\tthe feature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.

\n

When you specify containerInsights, the default setting indicating\n\t\t\twhether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If\n\t\t\t\tcontainerInsights is turned on, any new clusters that are created will\n\t\t\thave Container Insights turned on unless you disable it during cluster creation. For\n\t\t\tmore information, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.

\n

Amazon ECS is introducing tagging authorization for resource creation. Users must have\n\t\t\tpermissions for actions that create the resource, such as ecsCreateCluster.\n\t\t\tIf tags are specified when you create a resource, Amazon Web Services performs additional\n\t\t\tauthorization to verify if users or roles have permissions to create tags. Therefore,\n\t\t\tyou must grant explicit permissions to use the ecs:TagResource action. For\n\t\t\tmore information, see Grant\n\t\t\t\tpermission to tag resources on creation in the Amazon ECS Developer\n\t\t\t\tGuide.

\n

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS\n\t\t\ttask hosted on Fargate, the tasks need to be stopped and new tasks launched to replace\n\t\t\tthem. Use fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance, see\n\t\t\t\tAmazon Web Services Fargate task\n\t\t\t\tmaintenance in the Amazon ECS Developer Guide.

\n

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

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

Modifies an account setting. Account settings are set on a per-Region basis.

\n

If you change the root user account setting, the default settings are reset for users and\n\t\t\troles that do not have specified individual account settings. For more information, see\n\t\t\t\tAccount\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.

", "smithy.api#examples": [ { "title": "To modify your account settings", @@ -8713,7 +8713,7 @@ "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "

The resource name for which to modify the account setting. If you specify\n\t\t\t\tserviceLongArnFormat, the ARN for your Amazon ECS services is affected. If\n\t\t\tyou specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS\n\t\t\ttasks is affected. If you specify containerInstanceLongArnFormat, the ARN\n\t\t\tand resource ID for your Amazon ECS container instances is affected. If you specify\n\t\t\t\tawsvpcTrunking, the ENI limit for your Amazon ECS container instances is\n\t\t\taffected. If you specify containerInsights, the default setting for Amazon Web Services\n\t\t\tCloudWatch Container Insights for your clusters is affected. If you specify\n\t\t\t\ttagResourceAuthorization, the opt-in option for tagging resources on\n\t\t\tcreation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer\n\t\t\t\tGuide. If you specify fargateTaskRetirementWaitPeriod, the\n\t\t\tdefault wait time to retire a Fargate task due to required maintenance is\n\t\t\taffected.

\n

When you specify fargateFIPSMode for the name and\n\t\t\t\tenabled for the value, Fargate uses FIPS-140 compliant\n\t\t\tcryptographic algorithms on your tasks. For more information about FIPS-140 compliance\n\t\t\twith Fargate, see Amazon Web Services Fargate\n\t\t\t\tFederal Information Processing Standard (FIPS) 140-2 compliance in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS\n\t\t\ttask hosted on Fargate, the tasks need to be stopped and new tasks launched to replace\n\t\t\tthem. Use fargateTaskRetirementWaitPeriod to set the wait time to retire a\n\t\t\tFargate task to the default. For information about the Fargate tasks maintenance,\n\t\t\tsee Amazon Web Services Fargate task\n\t\t\t\tmaintenance in the Amazon ECS Developer Guide.

\n

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

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

The resource name for which to modify the account setting.

\n

The following are the valid values for the account setting name.

\n
    \n
  • \n

    \n serviceLongArnFormat - When modified, the Amazon Resource Name\n\t\t\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting\n\t\t\t\t\tmust be set for each Amazon ECS resource separately. The ARN and resource ID format\n\t\t\t\t\tof a resource is defined by the opt-in status of the user or role that created\n\t\t\t\t\tthe resource. You must turn on this setting to use Amazon ECS features such as\n\t\t\t\t\tresource tagging.

    \n
    • \n
  • \n

    \n taskLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the\n\t\t\t\t\troot user for an account is affected. The opt-in and opt-out account setting must\n\t\t\t\t\tbe set for each Amazon ECS resource separately. The ARN and resource ID format of a\n\t\t\t\t\tresource is defined by the opt-in status of the user or role that created the\n\t\t\t\t\tresource. You must turn on this setting to use Amazon ECS features such as resource\n\t\t\t\t\ttagging.

    \n
    • \n
  • \n

    \n containerInstanceLongArnFormat - When modified, the Amazon\n\t\t\t\t\tResource Name (ARN) and resource ID format of the resource type for a specified\n\t\t\t\t\tuser, role, or the root user for an account is affected. The opt-in and opt-out\n\t\t\t\t\taccount setting must be set for each Amazon ECS resource separately. The ARN and\n\t\t\t\t\tresource ID format of a resource is defined by the opt-in status of the user or\n\t\t\t\t\trole that created the resource. You must turn on this setting to use Amazon ECS\n\t\t\t\t\tfeatures such as resource tagging.

    \n
    • \n
  • \n

    \n awsvpcTrunking - When modified, the elastic network interface\n\t\t\t\t\t(ENI) limit for any new container instances that support the feature is changed.\n\t\t\t\t\tIf awsvpcTrunking is turned on, any new container instances that\n\t\t\t\t\tsupport the feature are launched have the increased ENI limits available to\n\t\t\t\t\tthem. For more information, see Elastic\n\t\t\t\t\t\tNetwork Interface Trunking in the Amazon Elastic Container Service Developer Guide.

    \n
    • \n
  • \n

    \n containerInsights - When modified, the default setting indicating\n\t\t\t\t\twhether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed.\n\t\t\t\t\tIf containerInsights is turned on, any new clusters that are\n\t\t\t\t\tcreated will have Container Insights turned on unless you disable it during\n\t\t\t\t\tcluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

    \n
    • \n
  • \n

    \n dualStackIPv6 - When turned on, when using a VPC in dual stack\n\t\t\t\t\tmode, your tasks using the awsvpc network mode can have an IPv6\n\t\t\t\t\taddress assigned. For more information on using IPv6 with tasks launched on\n\t\t\t\t\tAmazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6\n\t\t\t\t\twith tasks launched on Fargate, see Using a VPC in dual-stack mode.

    \n
    • \n
  • \n

    \n fargateFIPSMode - If you specify fargateFIPSMode,\n\t\t\t\t\tFargate FIPS 140 compliance is affected.

    \n
    • \n
  • \n

    \n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a\n\t\t\t\t\tsecurity or infrastructure update is needed for an Amazon ECS task hosted on\n\t\t\t\t\tFargate, the tasks need to be stopped and new tasks launched to replace them.\n\t\t\t\t\tUse fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance,\n\t\t\t\t\tsee Amazon Web Services Fargate\n\t\t\t\t\t\ttask maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.

    \n
    • \n
  • \n

    \n tagResourceAuthorization - Amazon ECS is introducing tagging\n\t\t\t\t\tauthorization for resource creation. Users must have permissions for actions\n\t\t\t\t\tthat create the resource, such as ecsCreateCluster. If tags are\n\t\t\t\t\tspecified when you create a resource, Amazon Web Services performs additional authorization to\n\t\t\t\t\tverify if users or roles have permissions to create tags. Therefore, you must\n\t\t\t\t\tgrant explicit permissions to use the ecs:TagResource action. For\n\t\t\t\t\tmore information, see Grant permission to tag resources on creation in the\n\t\t\t\t\t\tAmazon ECS Developer Guide.

    \n
    • \n
  • \n

    \n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -8749,7 +8749,7 @@ "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "

The Amazon ECS resource name for which to modify the account setting. If you specify\n\t\t\t\tserviceLongArnFormat, the ARN for your Amazon ECS services is affected. If\n\t\t\tyou specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS\n\t\t\ttasks is affected. If you specify containerInstanceLongArnFormat, the ARN\n\t\t\tand resource ID for your Amazon ECS container instances is affected. If you specify\n\t\t\t\tawsvpcTrunking, the elastic network interface (ENI) limit for your\n\t\t\tAmazon ECS container instances is affected. If you specify containerInsights,\n\t\t\tthe default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If\n\t\t\tyou specify fargateFIPSMode, Fargate FIPS 140 compliance is affected. If\n\t\t\tyou specify tagResourceAuthorization, the opt-in option for tagging\n\t\t\tresources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer\n\t\t\t\tGuide. If you specify fargateTaskRetirementWaitPeriod, the\n\t\t\twait time to retire a Fargate task is affected.

\n

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

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

The Amazon ECS account setting name to modify.

\n

The following are the valid values for the account setting name.

\n
    \n
  • \n

    \n serviceLongArnFormat - When modified, the Amazon Resource Name\n\t\t\t\t\t(ARN) and resource ID format of the resource type for a specified user, role, or\n\t\t\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting\n\t\t\t\t\tmust be set for each Amazon ECS resource separately. The ARN and resource ID format\n\t\t\t\t\tof a resource is defined by the opt-in status of the user or role that created\n\t\t\t\t\tthe resource. You must turn on this setting to use Amazon ECS features such as\n\t\t\t\t\tresource tagging.

    \n
    • \n
  • \n

    \n taskLongArnFormat - When modified, the Amazon Resource Name (ARN)\n\t\t\t\t\tand resource ID format of the resource type for a specified user, role, or the\n\t\t\t\t\troot user for an account is affected. The opt-in and opt-out account setting must\n\t\t\t\t\tbe set for each Amazon ECS resource separately. The ARN and resource ID format of a\n\t\t\t\t\tresource is defined by the opt-in status of the user or role that created the\n\t\t\t\t\tresource. You must turn on this setting to use Amazon ECS features such as resource\n\t\t\t\t\ttagging.

    \n
    • \n
  • \n

    \n containerInstanceLongArnFormat - When modified, the Amazon\n\t\t\t\t\tResource Name (ARN) and resource ID format of the resource type for a specified\n\t\t\t\t\tuser, role, or the root user for an account is affected. The opt-in and opt-out\n\t\t\t\t\taccount setting must be set for each Amazon ECS resource separately. The ARN and\n\t\t\t\t\tresource ID format of a resource is defined by the opt-in status of the user or\n\t\t\t\t\trole that created the resource. You must turn on this setting to use Amazon ECS\n\t\t\t\t\tfeatures such as resource tagging.

    \n
    • \n
  • \n

    \n awsvpcTrunking - When modified, the elastic network interface\n\t\t\t\t\t(ENI) limit for any new container instances that support the feature is changed.\n\t\t\t\t\tIf awsvpcTrunking is turned on, any new container instances that\n\t\t\t\t\tsupport the feature are launched have the increased ENI limits available to\n\t\t\t\t\tthem. For more information, see Elastic\n\t\t\t\t\t\tNetwork Interface Trunking in the Amazon Elastic Container Service Developer Guide.

    \n
    • \n
  • \n

    \n containerInsights - When modified, the default setting indicating\n\t\t\t\t\twhether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed.\n\t\t\t\t\tIf containerInsights is turned on, any new clusters that are\n\t\t\t\t\tcreated will have Container Insights turned on unless you disable it during\n\t\t\t\t\tcluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

    \n
    • \n
  • \n

    \n dualStackIPv6 - When turned on, when using a VPC in dual stack\n\t\t\t\t\tmode, your tasks using the awsvpc network mode can have an IPv6\n\t\t\t\t\taddress assigned. For more information on using IPv6 with tasks launched on\n\t\t\t\t\tAmazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6\n\t\t\t\t\twith tasks launched on Fargate, see Using a VPC in dual-stack mode.

    \n
    • \n
  • \n

    \n fargateFIPSMode - If you specify fargateFIPSMode,\n\t\t\t\t\tFargate FIPS 140 compliance is affected.

    \n
    • \n
  • \n

    \n fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a\n\t\t\t\t\tsecurity or infrastructure update is needed for an Amazon ECS task hosted on\n\t\t\t\t\tFargate, the tasks need to be stopped and new tasks launched to replace them.\n\t\t\t\t\tUse fargateTaskRetirementWaitPeriod to configure the wait time to\n\t\t\t\t\tretire a Fargate task. For information about the Fargate tasks maintenance,\n\t\t\t\t\tsee Amazon Web Services Fargate\n\t\t\t\t\t\ttask maintenance in the Amazon ECS Developer\n\t\t\t\t\tGuide.

    \n
    • \n
  • \n

    \n tagResourceAuthorization - Amazon ECS is introducing tagging\n\t\t\t\t\tauthorization for resource creation. Users must have permissions for actions\n\t\t\t\t\tthat create the resource, such as ecsCreateCluster. If tags are\n\t\t\t\t\tspecified when you create a resource, Amazon Web Services performs additional authorization to\n\t\t\t\t\tverify if users or roles have permissions to create tags. Therefore, you must\n\t\t\t\t\tgrant explicit permissions to use the ecs:TagResource action. For\n\t\t\t\t\tmore information, see Grant permission to tag resources on creation in the\n\t\t\t\t\t\tAmazon ECS Developer Guide.

    \n
    • \n
  • \n

    \n guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether\n\t\t\tAmazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your\n\t\t\tAmazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -9190,7 +9190,7 @@ "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { - "smithy.api#documentation": "

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Using data volumes in\n\t\t\t\ttasks in the Amazon ECS Developer Guide.

\n \n

For tasks using the Fargate launch type, the task requires the\n\t\t\t\tfollowing platforms:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
    • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
    • \n
\n " } }, "runtimePlatform": { @@ -9597,7 +9597,7 @@ "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { - "smithy.api#documentation": "

Any failures associated with the call.

" + "smithy.api#documentation": "

Any failures associated with the call.

\n

For information about how to address failures, see Service event messages and API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.

" } } }, @@ -10028,13 +10028,13 @@ "timeout": { "target": "com.amazonaws.ecs#TimeoutConfiguration", "traits": { - "smithy.api#documentation": "

A reference to an object that represents the configured timeouts for Service Connect.

" + "smithy.api#documentation": "

A reference to an object that represents the configured timeouts for\n\t\t\tService Connect.

" } }, "tls": { "target": "com.amazonaws.ecs#ServiceConnectTlsConfiguration", "traits": { - "smithy.api#documentation": "

A reference to an object that represents a Transport Layer Security (TLS) configuration.

" + "smithy.api#documentation": "

A reference to an object that represents a Transport Layer Security (TLS)\n\t\t\tconfiguration.

" } } }, @@ -10698,7 +10698,7 @@ "reason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An optional message specified when a task is stopped. For example, if you're using a custom\n\t\t\tscheduler, you can use this parameter to specify the reason for stopping the task here,\n\t\t\tand the message appears in subsequent DescribeTasks API operations on\n\t\t\tthis task.

" + "smithy.api#documentation": "

An optional message specified when a task is stopped. For example, if you're using a\n\t\t\tcustom scheduler, you can use this parameter to specify the reason for stopping the task\n\t\t\there, and the message appears in subsequent DescribeTasks API\n\t\t\toperations on this task.

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

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run. For example, you can configure\n\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.

\n

We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\tawsvpc or host network mode. Doing this has the following\n\t\t\tdisadvantages:

\n
    \n
  • \n

    For tasks that use the awsvpc network mode including Fargate,\n\t\t\t\t\tif you set systemControls for any container, it applies to all\n\t\t\t\t\tcontainers in the task. If you set different systemControls for\n\t\t\t\t\tmultiple containers in a single task, the container that's started last\n\t\t\t\t\tdetermines which systemControls take effect.

    \n
    • \n
  • \n

    For tasks that use the host network mode, the network namespace\n\t\t\t\t\tsystemControls aren't supported.

    \n
    • \n
\n

If you're setting an IPC resource namespace to use for the containers in the task, the\n\t\t\tfollowing conditions apply to your system controls. For more information, see IPC mode.

\n
    \n
  • \n

    For tasks that use the host IPC mode, IPC namespace\n\t\t\t\t\tsystemControls aren't supported.

    \n
    • \n
  • \n

    For tasks that use the task IPC mode, IPC namespace\n\t\t\t\t\tsystemControls values apply to all containers within a\n\t\t\t\t\ttask.

    \n
    • \n
\n \n

This parameter is not supported for Windows containers.

\n \n \n

This parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.

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

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run. For example, you can configure\n\t\t\t\tnet.ipv4.tcp_keepalive_time setting to maintain longer lived\n\t\t\tconnections.

\n

We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\tawsvpc or host network mode. Doing this has the following\n\t\t\tdisadvantages:

\n
    \n
  • \n

    For tasks that use the awsvpc network mode including Fargate,\n\t\t\t\t\tif you set systemControls for any container, it applies to all\n\t\t\t\t\tcontainers in the task. If you set different systemControls for\n\t\t\t\t\tmultiple containers in a single task, the container that's started last\n\t\t\t\t\tdetermines which systemControls take effect.

    \n
    • \n
  • \n

    For tasks that use the host network mode, the network namespace\n\t\t\t\t\t\tsystemControls aren't supported.

    \n
    • \n
\n

If you're setting an IPC resource namespace to use for the containers in the task, the\n\t\t\tfollowing conditions apply to your system controls. For more information, see IPC mode.

\n
    \n
  • \n

    For tasks that use the host IPC mode, IPC namespace\n\t\t\t\t\t\tsystemControls aren't supported.

    \n
    • \n
  • \n

    For tasks that use the task IPC mode, IPC namespace\n\t\t\t\t\t\tsystemControls values apply to all containers within a\n\t\t\t\t\ttask.

    \n
    • \n
\n \n

This parameter is not supported for Windows containers.

\n \n \n

This parameter is only supported for tasks that are hosted on\n Fargate if the tasks are using platform version 1.4.0 or later\n (Linux). This isn't supported for Windows containers on\n Fargate.

\n " } }, "com.amazonaws.ecs#SystemControls": { @@ -11368,7 +11368,7 @@ "stopCode": { "target": "com.amazonaws.ecs#TaskStopCode", "traits": { - "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

\n

For more information about stop code, see Stopped tasks error codes in the Amazon ECS Developer Guide.

" + "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

\n

For more information about stop code, see Stopped tasks\n\t\t\t\terror codes in the Amazon ECS Developer Guide.

" } }, "stoppedAt": { @@ -12137,18 +12137,18 @@ "idleTimeoutSeconds": { "target": "com.amazonaws.ecs#Duration", "traits": { - "smithy.api#documentation": "

The amount of time in seconds a connection will stay active while idle. A \n\t\t\tvalue of 0 can be set to disable idleTimeout.

\n

The idleTimeout default for\n\t\t\tHTTP/HTTP2/GRPC is 5 minutes.

\n

The idleTimeout default for TCP is 1 hour.

" + "smithy.api#documentation": "

The amount of time in seconds a connection will stay active while idle. A value of\n\t\t\t\t0 can be set to disable idleTimeout.

\n

The idleTimeout default for\n\t\t\t\tHTTP/HTTP2/GRPC is 5 minutes.

\n

The idleTimeout default for TCP is 1 hour.

" } }, "perRequestTimeoutSeconds": { "target": "com.amazonaws.ecs#Duration", "traits": { - "smithy.api#documentation": "

The amount of time waiting for the upstream to respond with a complete response \n\t\t\tper request. A value of 0 can be set to disable perRequestTimeout. \n\t\t\tperRequestTimeout can only be set if Service Connect appProtocol \n\t\t\tisn't TCP. Only idleTimeout is allowed for TCP\n appProtocol.

" + "smithy.api#documentation": "

The amount of time waiting for the upstream to respond with a complete response per\n\t\t\trequest. A value of 0 can be set to disable perRequestTimeout.\n\t\t\t\tperRequestTimeout can only be set if Service Connect\n\t\t\t\tappProtocol isn't TCP. Only idleTimeout is\n\t\t\tallowed for TCP\n appProtocol.

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

An object that represents the timeout configurations for Service Connect.

\n \n

If idleTimeout is set to a time that is less than\n\t\t\t\tperRequestTimeout, the connection will close when the\n\t\t\t\tidleTimeout is reached and not the\n\t\t\t\tperRequestTimeout.

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

An object that represents the timeout configurations for Service Connect.

\n \n

If idleTimeout is set to a time that is less than\n\t\t\t\t\tperRequestTimeout, the connection will close when the\n\t\t\t\t\tidleTimeout is reached and not the\n\t\t\t\tperRequestTimeout.

\n " } }, "com.amazonaws.ecs#Timestamp": { @@ -13378,7 +13378,7 @@ "configuredAtLaunch": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Indicates whether the volume should be configured at launch time. This is used to\n\t\t\tcreate Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each\n\t\t\ttask definition revision may only have one volume configured at launch in the volume\n\t\t\tconfiguration.

\n

To configure a volume at launch time, use this task definition revision and specify a\n\t\t\tvolumeConfigurations object when calling the\n\t\t\tCreateService, UpdateService, RunTask or\n\t\t\tStartTask APIs.

" + "smithy.api#documentation": "

Indicates whether the volume should be configured at launch time. This is used to\n\t\t\tcreate Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each\n\t\t\ttask definition revision may only have one volume configured at launch in the volume\n\t\t\tconfiguration.

\n

To configure a volume at launch time, use this task definition revision and specify a\n\t\t\t\tvolumeConfigurations object when calling the\n\t\t\tCreateService, UpdateService, RunTask or\n\t\t\t\tStartTask APIs.

" } } }, diff --git a/codegen/sdk/aws-models/iot.json b/codegen/sdk/aws-models/iot.json index bf0574a0b02..dae1711d153 100644 --- a/codegen/sdk/aws-models/iot.json +++ b/codegen/sdk/aws-models/iot.json @@ -7003,6 +7003,12 @@ "traits": { "smithy.api#documentation": "

An object that specifies the TLS configuration for a domain.

" } + }, + "serverCertificateConfig": { + "target": "com.amazonaws.iot#ServerCertificateConfig", + "traits": { + "smithy.api#documentation": "

The server certificate configuration.

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

An object that specifies the TLS configuration for a domain.

" } + }, + "serverCertificateConfig": { + "target": "com.amazonaws.iot#ServerCertificateConfig", + "traits": { + "smithy.api#documentation": "

The server certificate configuration.

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

Returns a unique endpoint specific to the Amazon Web Services account making the call.

\n

Requires permission to access the DescribeEndpoint action.

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

Returns or creates a unique endpoint specific to the Amazon Web Services account making the\n call.

\n \n

The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint.

\n \n

Requires permission to access the DescribeEndpoint action.

", "smithy.api#http": { "method": "GET", "uri": "/endpoint", @@ -16123,6 +16135,9 @@ "smithy.api#documentation": "

Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.

" } }, + "com.amazonaws.iot#EnableOCSPCheck": { + "type": "boolean" + }, "com.amazonaws.iot#EnableTopicRule": { "type": "operation", "input": { @@ -18075,7 +18090,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a registration code used to register a CA certificate with IoT.

\n

Requires permission to access the GetRegistrationCode action.

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

Gets a registration code used to register a CA certificate with IoT.

\n

IoT will create a registration code as part of this API call if the registration\n code doesn't exist or has been deleted. If you already have a registration code, this API\n call will return the same registration code.

\n

Requires permission to access the GetRegistrationCode action.

", "smithy.api#http": { "method": "GET", "uri": "/registrationcode", @@ -29757,6 +29772,20 @@ } } }, + "com.amazonaws.iot#ServerCertificateConfig": { + "type": "structure", + "members": { + "enableOCSPCheck": { + "target": "com.amazonaws.iot#EnableOCSPCheck", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server\n certificate check is enabled or not.

\n

For more information, see Configuring OCSP server-certificate stapling in domain\n configuration from Amazon Web Services IoT Core Developer Guide.

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

The server certificate configuration.

" + } + }, "com.amazonaws.iot#ServerCertificateStatus": { "type": "enum", "members": { @@ -34005,6 +34034,12 @@ "traits": { "smithy.api#documentation": "

An object that specifies the TLS configuration for a domain.

" } + }, + "serverCertificateConfig": { + "target": "com.amazonaws.iot#ServerCertificateConfig", + "traits": { + "smithy.api#documentation": "

The server certificate configuration.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/pricing.json b/codegen/sdk/aws-models/pricing.json index 81d9da150ba..1f0a6f8687a 100644 --- a/codegen/sdk/aws-models/pricing.json +++ b/codegen/sdk/aws-models/pricing.json @@ -33,7 +33,7 @@ "name": "pricing" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

The Amazon Web Services Price List API is a centralized and convenient way to programmatically\n query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location,\n Storage Class, and Operating System, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:

\n
    \n
  • \n

    Build cost control and scenario planning tools

    \n
    • \n
  • \n

    Reconcile billing data

    \n
    • \n
  • \n

    Forecast future spend for budgeting purposes

    \n
    • \n
  • \n

    Provide cost benefit analysis that compare your internal workloads with Amazon Web Services

    \n
    • \n
\n

Use GetServices without a service code to retrieve the service codes for\n all Amazon Web Services, then GetServices with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use GetAttributeValues to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n use GetProducts to find specific products that you're interested in, such as\n an AmazonEC2 instance, with a Provisioned IOPS\n volumeType.

\n

For more information, see Using the\n Amazon Web Services Price List API in the Billing User\n Guide.

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

The Amazon Web Services Price List API is a centralized and convenient way to programmatically\n query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location,\n Storage Class, and Operating System, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:

\n
    \n
  • \n

    Build cost control and scenario planning tools

    \n
    • \n
  • \n

    Reconcile billing data

    \n
    • \n
  • \n

    Forecast future spend for budgeting purposes

    \n
    • \n
  • \n

    Provide cost benefit analysis that compare your internal workloads with Amazon Web Services

    \n
    • \n
\n

Use GetServices without a service code to retrieve the service codes for\n all Amazon Web Services, then GetServices with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use GetAttributeValues to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n use GetProducts to find specific products that you're interested in, such as\n an AmazonEC2 instance, with a Provisioned IOPS\n volumeType.

\n

For more information, see Using the\n Amazon Web Services Price List API in the Billing User\n Guide.

", "smithy.api#title": "AWS Price List Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -781,6 +781,9 @@ }, { "target": "com.amazonaws.pricing#NotFoundException" + }, + { + "target": "com.amazonaws.pricing#ThrottlingException" } ], "traits": { @@ -952,6 +955,9 @@ }, { "target": "com.amazonaws.pricing#NotFoundException" + }, + { + "target": "com.amazonaws.pricing#ThrottlingException" } ], "traits": { @@ -1039,6 +1045,9 @@ }, { "target": "com.amazonaws.pricing#NotFoundException" + }, + { + "target": "com.amazonaws.pricing#ThrottlingException" } ], "traits": { @@ -1104,6 +1113,9 @@ }, { "target": "com.amazonaws.pricing#NotFoundException" + }, + { + "target": "com.amazonaws.pricing#ThrottlingException" } ], "traits": { @@ -1192,7 +1204,8 @@ "traits": { "smithy.api#documentation": "

An error on the server occurred during the processing of your request. Try again later.

", "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#httpError": 500, + "smithy.api#retryable": {} } }, "com.amazonaws.pricing#InvalidNextTokenException": { @@ -1247,6 +1260,9 @@ }, { "target": "com.amazonaws.pricing#NotFoundException" + }, + { + "target": "com.amazonaws.pricing#ThrottlingException" } ], "traits": { @@ -1389,7 +1405,7 @@ "min": 18, "max": 2048 }, - "smithy.api#pattern": "^arn:[A-Za-z0-9][-.A-Za-z0-9]{0,62}:pricing:::price-list/[A-Za-z0-9_/.-]{1,1023}$" + "smithy.api#pattern": "^arn:[A-Za-z0-9][-.A-Za-z0-9]{0,62}:pricing:::price-list/[A-Za-z0-9+_/.-]{1,1023}$" } }, "com.amazonaws.pricing#PriceListJsonItems": { @@ -1458,6 +1474,22 @@ "smithy.api#mediaType": "application/json" } }, + "com.amazonaws.pricing#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.pricing#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You've made too many requests exceeding service quotas.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, "com.amazonaws.pricing#errorMessage": { "type": "string" } From 9a8a90320df7c95c801d6e860fd6f725ff407ab8 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 9 Feb 2024 19:05:10 +0000 Subject: [PATCH 19/32] feat: update AWS service endpoints metadata --- .../main/resources/aws/sdk/kotlin/codegen/endpoints.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json index c7687dd4ec6..66628592e43 100644 --- a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json +++ b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json @@ -23279,6 +23279,12 @@ "us-gov-west-1" : { } } }, + "emr-serverless" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "es" : { "endpoints" : { "fips" : { From ea3b8a8d6ffce5ca07fec675c93bed36d994e43e Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 9 Feb 2024 19:08:03 +0000 Subject: [PATCH 20/32] chore: release 1.0.54 --- CHANGELOG.md | 13 +++++++++++++ gradle.properties | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3006092c95b..f0f2db2884c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## [1.0.54] - 02/09/2024 + +### Features +* (**batch**) This feature allows Batch to support configuration of repository credentials for jobs running on ECS +* (**braket**) Creating a job will result in DeviceOfflineException when using an offline device, and DeviceRetiredException when using a retired device. +* (**costoptimizationhub**) Adding includeMemberAccounts field to the response of ListEnrollmentStatuses API. +* (**iot**) This release allows AWS IoT Core users to enable Online Certificate Status Protocol (OCSP) Stapling for TLS X.509 Server Certificates when creating and updating AWS IoT Domain Configurations with Custom Domain. +* (**pricing**) Add Throttling Exception to all APIs. + +### Documentation +* (**amp**) Overall documentation updates. +* (**ecs**) Documentation only update for Amazon ECS. + ## [1.0.53] - 02/08/2024 ### Features diff --git a/gradle.properties b/gradle.properties index a0b0a2dab46..66948d8e0ca 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.54-SNAPSHOT +sdkVersion=1.0.54 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 6a9c91ffae83c65c24a5fc129eeff011c4d43c10 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 9 Feb 2024 19:08:04 +0000 Subject: [PATCH 21/32] chore: bump snapshot version to 1.0.55-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 66948d8e0ca..67d3565999e 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.54 +sdkVersion=1.0.55-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 5aa88c1a94ee90e5926ea70b7384e35fd4375cfd Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 12 Feb 2024 19:05:53 +0000 Subject: [PATCH 22/32] feat: update AWS API models --- codegen/sdk/aws-models/appsync.json | 216 ++++++++++++++++++- codegen/sdk/aws-models/cloudwatch.json | 7 +- codegen/sdk/aws-models/neptune-graph.json | 29 ++- codegen/sdk/aws-models/route-53-domains.json | 104 +++++++-- 4 files changed, 330 insertions(+), 26 deletions(-) diff --git a/codegen/sdk/aws-models/appsync.json b/codegen/sdk/aws-models/appsync.json index 59b231d88ba..8b30eca4a3e 100644 --- a/codegen/sdk/aws-models/appsync.json +++ b/codegen/sdk/aws-models/appsync.json @@ -1257,6 +1257,12 @@ "traits": { "smithy.api#documentation": "

The cache instance status.

\n
    \n
  • \n

    \n AVAILABLE: The instance is available for use.

    \n
    • \n
  • \n

    \n CREATING: The instance is currently creating.

    \n
    • \n
  • \n

    \n DELETING: The instance is currently deleting.

    \n
    • \n
  • \n

    \n MODIFYING: The instance is currently modifying.

    \n
    • \n
  • \n

    \n FAILED: The instance has failed creation.

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

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

\n
    \n
  • \n

    NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.

    \n
    • \n
  • \n

    EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.

    \n
    • \n
\n

Metrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.

" + } } }, "traits": { @@ -1920,6 +1926,23 @@ "com.amazonaws.appsync#BooleanValue": { "type": "boolean" }, + "com.amazonaws.appsync#CacheHealthMetricsConfig": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.appsync#CachingConfig": { "type": "structure", "members": { @@ -2223,6 +2246,12 @@ "smithy.api#documentation": "

The cache instance type. Valid values are

\n
    \n
  • \n

    \n SMALL\n

    \n
    • \n
  • \n

    \n MEDIUM\n

    \n
    • \n
  • \n

    \n LARGE\n

    \n
    • \n
  • \n

    \n XLARGE\n

    \n
    • \n
  • \n

    \n LARGE_2X\n

    \n
    • \n
  • \n

    \n LARGE_4X\n

    \n
    • \n
  • \n

    \n LARGE_8X (not available in all regions)

    \n
    • \n
  • \n

    \n LARGE_12X\n

    \n
    • \n
\n

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

\n

The following legacy instance types are available, but their use is discouraged:

\n
    \n
  • \n

    \n T2_SMALL: A t2.small instance type.

    \n
    • \n
  • \n

    \n T2_MEDIUM: A t2.medium instance type.

    \n
    • \n
  • \n

    \n R4_LARGE: A r4.large instance type.

    \n
    • \n
  • \n

    \n R4_XLARGE: A r4.xlarge instance type.

    \n
    • \n
  • \n

    \n R4_2XLARGE: A r4.2xlarge instance type.

    \n
    • \n
  • \n

    \n R4_4XLARGE: A r4.4xlarge instance type.

    \n
    • \n
  • \n

    \n R4_8XLARGE: A r4.8xlarge instance type.

    \n
    • \n
", "smithy.api#required": {} } + }, + "healthMetricsConfig": { + "target": "com.amazonaws.appsync#CacheHealthMetricsConfig", + "traits": { + "smithy.api#documentation": "

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

\n
    \n
  • \n

    NetworkBandwidthOutAllowanceExceeded: The number of times a specified GraphQL operation was\n called.

    \n
    • \n
  • \n

    EngineCPUUtilization: The number of GraphQL errors that occurred during a specified GraphQL\n operation.

    \n
    • \n
\n

Metrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.

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

Amazon EventBridge settings.

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

Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.

\n

\n metricsConfig can be ENABLED or DISABLED.

" + } } }, "traits": { @@ -2539,6 +2574,9 @@ "target": "com.amazonaws.appsync#CreateFunctionResponse" }, "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, @@ -2788,6 +2826,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.

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

The enhancedMetricsConfig object.

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

The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.

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

Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.

\n

\n metricsConfig can be ENABLED or DISABLED.

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

Amazon EventBridge settings.

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

Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.

\n

\n metricsConfig can be ENABLED or DISABLED.

" + } } }, "traits": { @@ -3293,6 +3349,40 @@ } } }, + "com.amazonaws.appsync#DataSourceLevelMetricsBehavior": { + "type": "enum", + "members": { + "FULL_REQUEST_DATA_SOURCE_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_REQUEST_DATA_SOURCE_METRICS" + } + }, + "PER_DATA_SOURCE_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PER_DATA_SOURCE_METRICS" + } + } + } + }, + "com.amazonaws.appsync#DataSourceLevelMetricsConfig": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.appsync#DataSourceType": { "type": "enum", "members": { @@ -3624,6 +3714,9 @@ "target": "com.amazonaws.appsync#DeleteFunctionResponse" }, "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, @@ -4232,6 +4325,35 @@ "smithy.api#documentation": "

Describes an OpenSearch data source configuration.

\n

As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is\n deprecated. For new data sources, use OpenSearchServiceDataSourceConfig to specify an OpenSearch data source.

" } }, + "com.amazonaws.appsync#EnhancedMetricsConfig": { + "type": "structure", + "members": { + "resolverLevelMetricsBehavior": { + "target": "com.amazonaws.appsync#ResolverLevelMetricsBehavior", + "traits": { + "smithy.api#documentation": "

Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

\n
    \n
  • \n

    GraphQL errors: The number of GraphQL errors that occurred.

    \n
    • \n
  • \n

    Requests: The number of invocations that occurred during a request.

    \n
    • \n
  • \n

    Latency: The time to complete a resolver invocation.

    \n
    • \n
  • \n

    Cache hits: The number of cache hits during a request.

    \n
    • \n
  • \n

    Cache misses: The number of cache misses during a request.

    \n
    • \n
\n

These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be\n recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at\n a time:

\n
    \n
  • \n

    \n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the\n request.

    \n
    • \n
  • \n

    \n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricConfig value set to ENABLED.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "dataSourceLevelMetricsBehavior": { + "target": "com.amazonaws.appsync#DataSourceLevelMetricsBehavior", + "traits": { + "smithy.api#documentation": "

Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:

\n
    \n
  • \n

    Requests: The number of invocations that occured during a request.

    \n
    • \n
  • \n

    Latency: The time to complete a data source invocation.

    \n
    • \n
  • \n

    Errors: The number of errors that occurred during a data source invocation.

    \n
    • \n
\n

These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics\n will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of\n these values at a time:

\n
    \n
  • \n

    \n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources\n in the request.

    \n
    • \n
  • \n

    \n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the\n metricConfig value set to ENABLED.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "operationLevelMetricsConfig": { + "target": "com.amazonaws.appsync#OperationLevelMetricsConfig", + "traits": { + "smithy.api#documentation": "

Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:

\n
    \n
  • \n

    Requests: The number of times a specified GraphQL operation was called.

    \n
    • \n
  • \n

    GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.

    \n
    • \n
\n

Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or\n DISABLED.

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

Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and\n performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data\n is sent to your CloudWatch account, and you can configure the types of data that will be sent.

\n

Enhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig contains three required parameters, each controlling one of these\n categories:

\n
    \n
  1. \n

    \n resolverLevelMetricsBehavior: Controls how resolver metrics will be emitted to\n CloudWatch. Resolver metrics include:

    \n
      \n
    • \n

      GraphQL errors: The number of GraphQL errors that occurred.

      \n
      • \n
    • \n

      Requests: The number of invocations that occurred during a request.

      \n
      • \n
    • \n

      Latency: The time to complete a resolver invocation.

      \n
      • \n
    • \n

      Cache hits: The number of cache hits during a request.

      \n
      • \n
    • \n

      Cache misses: The number of cache misses during a request.

      \n
      • \n
    \n

    These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics\n will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of\n these values at a time:

    \n
      \n
    • \n

      \n FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers\n in the request.

      \n
      • \n
    • \n

      \n PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the\n metricConfig value set to ENABLED.

      \n
      • \n
    \n
    2. \n
  2. \n

    \n dataSourceLevelMetricsBehavior: Controls how data source metrics will be emitted to\n CloudWatch. Data source metrics include:

    \n
      \n
    • \n

      Requests: The number of invocations that occured during a request.

      \n
      • \n
    • \n

      Latency: The time to complete a data source invocation.

      \n
      • \n
    • \n

      Errors: The number of errors that occurred during a data source invocation.

      \n
      • \n
    \n

    These metrics can be emitted to CloudWatch per data source or for all data sources in the request.\n Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior\n accepts one of these values at a time:

    \n
      \n
    • \n

      \n FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data\n sources in the request.

      \n
      • \n
    • \n

      \n PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that\n have the metricConfig value set to ENABLED.

      \n
      • \n
    \n
    3. \n
  3. \n

    \n operationLevelMetricsConfig: Controls how operation metrics will be emitted to\n CloudWatch. Operation metrics include:

    \n
      \n
    • \n

      Requests: The number of times a specified GraphQL operation was called.

      \n
      • \n
    • \n

      GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.

      \n
      • \n
    \n

    Metrics will be recorded by API ID and operation name. You can set the value to ENABLED\n or DISABLED.

    \n
    4. \n
" + } + }, "com.amazonaws.appsync#EnvironmentVariableKey": { "type": "string", "traits": { @@ -5783,6 +5905,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.

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

The enhancedMetricsConfig object.

" + } } }, "traits": { @@ -6990,6 +7118,23 @@ "smithy.api#documentation": "

Describes an OpenSearch data source configuration.

" } }, + "com.amazonaws.appsync#OperationLevelMetricsConfig": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.appsync#OutputType": { "type": "enum", "members": { @@ -7077,7 +7222,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a list of environmental variables in an API by its ID value.

\n

When creating an environmental variable, it must follow the constraints below:

\n
    \n
  • \n

    Both JavaScript and VTL templates support environmental variables.

    \n
    • \n
  • \n

    Environmental variables are not evaluated before function invocation.

    \n
    • \n
  • \n

    Environmental variables only support string values.

    \n
    • \n
  • \n

    Any defined value in an environmental variable is considered a string literal and not\n expanded.

    \n
    • \n
  • \n

    Variable evaluations should ideally be performed in the function code.

    \n
    • \n
\n

When creating an environmental variable key-value pair, it must follow the additional constraints\n below:

\n
    \n
  • \n

    Keys must begin with a letter.

    \n
    • \n
  • \n

    Keys must be at least two characters long.

    \n
    • \n
  • \n

    Keys can only contain letters, numbers, and the underscore character (_).

    \n
    • \n
  • \n

    Values can be up to 512 characters long.

    \n
    • \n
  • \n

    You can configure up to 50 key-value pairs in a GraphQL API.

    \n
    • \n
\n

You can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.

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

Creates a list of environmental variables in an API by its ID value.

\n

When creating an environmental variable, it must follow the constraints below:

\n
    \n
  • \n

    Both JavaScript and VTL templates support environmental variables.

    \n
    • \n
  • \n

    Environmental variables are not evaluated before function invocation.

    \n
    • \n
  • \n

    Environmental variables only support string values.

    \n
    • \n
  • \n

    Any defined value in an environmental variable is considered a string literal and not\n expanded.

    \n
    • \n
  • \n

    Variable evaluations should ideally be performed in the function code.

    \n
    • \n
\n

When creating an environmental variable key-value pair, it must follow the additional constraints\n below:

\n
    \n
  • \n

    Keys must begin with a letter.

    \n
    • \n
  • \n

    Keys must be at least two characters long.

    \n
    • \n
  • \n

    Keys can only contain letters, numbers, and the underscore character (_).

    \n
    • \n
  • \n

    Values can be up to 512 characters long.

    \n
    • \n
  • \n

    You can configure up to 50 key-value pairs in a GraphQL API.

    \n
    • \n
\n

You can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/apis/{apiId}/environmentVariables", @@ -7099,7 +7244,7 @@ "environmentVariables": { "target": "com.amazonaws.appsync#EnvironmentVariableMap", "traits": { - "smithy.api#documentation": "

The list of environmental variables to add to the API.

\n

When creating an environmental variable key-value pair, it must follow the additional constraints\n below:

\n
    \n
  • \n

    Keys must begin with a letter.

    \n
    • \n
  • \n

    Keys must be at least two characters long.

    \n
    • \n
  • \n

    Keys can only contain letters, numbers, and the underscore character (_).

    \n
    • \n
  • \n

    Values can be up to 512 characters long.

    \n
    • \n
  • \n

    You can configure up to 50 key-value pairs in a GraphQL API.

    \n
    • \n
\n

You can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.

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

The list of environmental variables to add to the API.

\n

When creating an environmental variable key-value pair, it must follow the additional constraints\n below:

\n
    \n
  • \n

    Keys must begin with a letter.

    \n
    • \n
  • \n

    Keys must be at least two characters long.

    \n
    • \n
  • \n

    Keys can only contain letters, numbers, and the underscore character (_).

    \n
    • \n
  • \n

    Values can be up to 512 characters long.

    \n
    • \n
  • \n

    You can configure up to 50 key-value pairs in a GraphQL API.

    \n
    • \n
\n

You can create a list of environmental variables by adding it to the environmentVariables\n payload as a list in the format {\"key1\":\"value1\",\"key2\":\"value2\", …}. Note that each call of the\n PutGraphqlApiEnvironmentVariables action will result in the overwriting of the existing\n environmental variable list of that API. This means the existing environmental variables will be lost. To avoid\n this, you must include all existing and new environmental variables in the list each time you call this\n action.

", "smithy.api#required": {} } } @@ -7337,6 +7482,12 @@ "traits": { "smithy.api#documentation": "

The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.

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

Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.

\n

\n metricsConfig can be ENABLED or DISABLED.

" + } } }, "traits": { @@ -7370,6 +7521,40 @@ } } }, + "com.amazonaws.appsync#ResolverLevelMetricsBehavior": { + "type": "enum", + "members": { + "FULL_REQUEST_RESOLVER_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "PER_RESOLVER_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PER_RESOLVER_METRICS" + } + } + } + }, + "com.amazonaws.appsync#ResolverLevelMetricsConfig": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.appsync#Resolvers": { "type": "list", "member": { @@ -8233,6 +8418,12 @@ "smithy.api#documentation": "

The cache instance type. Valid values are

\n
    \n
  • \n

    \n SMALL\n

    \n
    • \n
  • \n

    \n MEDIUM\n

    \n
    • \n
  • \n

    \n LARGE\n

    \n
    • \n
  • \n

    \n XLARGE\n

    \n
    • \n
  • \n

    \n LARGE_2X\n

    \n
    • \n
  • \n

    \n LARGE_4X\n

    \n
    • \n
  • \n

    \n LARGE_8X (not available in all regions)

    \n
    • \n
  • \n

    \n LARGE_12X\n

    \n
    • \n
\n

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

\n

The following legacy instance types are available, but their use is discouraged:

\n
    \n
  • \n

    \n T2_SMALL: A t2.small instance type.

    \n
    • \n
  • \n

    \n T2_MEDIUM: A t2.medium instance type.

    \n
    • \n
  • \n

    \n R4_LARGE: A r4.large instance type.

    \n
    • \n
  • \n

    \n R4_XLARGE: A r4.xlarge instance type.

    \n
    • \n
  • \n

    \n R4_2XLARGE: A r4.2xlarge instance type.

    \n
    • \n
  • \n

    \n R4_4XLARGE: A r4.4xlarge instance type.

    \n
    • \n
  • \n

    \n R4_8XLARGE: A r4.8xlarge instance type.

    \n
    • \n
", "smithy.api#required": {} } + }, + "healthMetricsConfig": { + "target": "com.amazonaws.appsync#CacheHealthMetricsConfig", + "traits": { + "smithy.api#documentation": "

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:

\n
    \n
  • \n

    NetworkBandwidthOutAllowanceExceeded: The number of times a specified GraphQL operation was\n called.

    \n
    • \n
  • \n

    EngineCPUUtilization: The number of GraphQL errors that occurred during a specified GraphQL\n operation.

    \n
    • \n
\n

Metrics will be recorded by API ID. You can set the value to ENABLED or\n DISABLED.

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

The new Amazon EventBridge settings.

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

Enables or disables enhanced data source metrics for specified data sources. Note that\n metricsConfig won't be used unless the dataSourceLevelMetricsBehavior value is set\n to PER_DATA_SOURCE_METRICS. If the dataSourceLevelMetricsBehavior is set to\n FULL_REQUEST_DATA_SOURCE_METRICS instead, metricsConfig will be ignored. However,\n you can still set its value.

\n

\n metricsConfig can be ENABLED or DISABLED.

" + } } }, "traits": { @@ -8555,6 +8752,9 @@ "target": "com.amazonaws.appsync#UpdateFunctionResponse" }, "errors": [ + { + "target": "com.amazonaws.appsync#BadRequestException" + }, { "target": "com.amazonaws.appsync#ConcurrentModificationException" }, @@ -8801,6 +9001,12 @@ "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of resolvers that can be invoked in a single request. The default value is 0\n (or unspecified), which will set the limit to 10000. When specified, the limit value can be\n between 1 and 10000. This field will produce a limit error if the operation falls out\n of bounds.

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

The enhancedMetricsConfig object.

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

The resolver code that contains the request and response functions. When code is used, the\n runtime is required. The runtime value must be APPSYNC_JS.

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

Enables or disables enhanced resolver metrics for specified resolvers. Note that metricsConfig\n won't be used unless the resolverLevelMetricsBehavior value is set to\n PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to\n FULL_REQUEST_RESOLVER_METRICS instead, metricsConfig will be ignored. However, you\n can still set its value.

\n

\n metricsConfig can be ENABLED or DISABLED.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/cloudwatch.json b/codegen/sdk/aws-models/cloudwatch.json index a06c5a4bb8a..ec59da37962 100644 --- a/codegen/sdk/aws-models/cloudwatch.json +++ b/codegen/sdk/aws-models/cloudwatch.json @@ -5955,7 +5955,12 @@ } ], "traits": { - "smithy.api#documentation": "

Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.

\n

You can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.

\n

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 1000 different metrics.

\n

Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

\n

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

\n

You specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.

\n

Data points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.

\n

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n
    \n
  • \n

    The SampleCount value of the statistic set is 1 and Min,\n\t\t\t\t\tMax, and Sum are all equal.

    \n
    • \n
  • \n

    The Min and\n\t\t\t\t\tMax are equal, and Sum is equal to Min \n\t\t\t\t\tmultiplied by SampleCount.

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

Publishes metric data points to Amazon CloudWatch. CloudWatch associates\n\t\t\tthe data points with the specified metric. If the specified metric does not exist,\n\t\t\tCloudWatch creates the metric. When CloudWatch creates a metric, it can\n\t\t\ttake up to fifteen minutes for the metric to appear in calls to ListMetrics.

\n

You can publish either individual data points in the Value field, or \n\t\tarrays of values and the number of times each value occurred during the period by using the \n\t\tValues and Counts fields in the MetricDatum structure. Using\n\t\tthe Values and Counts method enables you to publish up to 150 values per metric\n\t\t\twith one PutMetricData request, and\n\t\tsupports retrieving percentile statistics on this data.

\n

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can \n\t\t\tsend a payload compressed by gzip. Each request\n\t\tis also limited to no more than 1000 different metrics.

\n

Although the Value parameter accepts numbers of type\n\t\t\tDouble, CloudWatch rejects values that are either too small\n\t\t\tor too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,\n\t\t\t-Infinity) are not supported.

\n

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension\n\t\t\tconsists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the\n\t\t\tAmazon CloudWatch User Guide.

\n

You specify the time stamp to be associated with each data point. You can specify\n\t\ttime stamps that are as much as two weeks before the current date, and as much as 2 hours after \n\t\tthe current day and time.

\n

Data points with time stamps from 24 hours ago or longer can take at least 48\n\t\t\thours to become available for GetMetricData or \n\t\t\tGetMetricStatistics from the time they \n\t\t\tare submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available\n\t\t\tfor for GetMetricData or \n\t\t\tGetMetricStatistics.

\n

CloudWatch needs raw data points to calculate percentile statistics. If you publish \n\t\t\tdata using a statistic set instead, you can only retrieve \n\t\t\tpercentile statistics for this data if one of the following conditions is true:

\n
    \n
  • \n

    The SampleCount value of the statistic set is 1 and Min,\n\t\t\t\t\tMax, and Sum are all equal.

    \n
    • \n
  • \n

    The Min and\n\t\t\t\t\tMax are equal, and Sum is equal to Min \n\t\t\t\t\tmultiplied by SampleCount.

    \n
    • \n
", + "smithy.api#requestCompression": { + "encodings": [ + "gzip" + ] + } } }, "com.amazonaws.cloudwatch#PutMetricDataInput": { diff --git a/codegen/sdk/aws-models/neptune-graph.json b/codegen/sdk/aws-models/neptune-graph.json index f7e0c8ee28e..691342ea783 100644 --- a/codegen/sdk/aws-models/neptune-graph.json +++ b/codegen/sdk/aws-models/neptune-graph.json @@ -1800,7 +1800,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.\n (true to enable, or false to disable.

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable.

" } }, "kmsKeyIdentifier": { @@ -1896,7 +1896,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

" } }, "vectorSearchConfiguration": { @@ -2123,7 +2123,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.\n (true to enable, or false to disable).

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable).

" } }, "kmsKeyIdentifier": { @@ -2735,6 +2735,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.neptunegraph#DocumentValuedMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#Document" + } + }, "com.amazonaws.neptunegraph#EdgeLabels": { "type": "list", "member": { @@ -2803,7 +2812,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a \n parameterized query call, you can use an HTTP request.

\n \n

\n Non-parametrized queries are not considered for plan caching. You can force plan caching with \n planCache=enabled. The plan cache will be reused only for the same exact query. Slight variations \n in the query will not be able to reuse the query plan cache.\n

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

Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a \n parameterized query call, you can use an HTTP request.

\n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached \n that allows one of the following IAM actions in that cluster, depending on the query:\n

\n
    \n
  • \n

    neptune-graph:ReadDataViaQuery

    \n
    • \n
  • \n

    neptune-graph:WriteDataViaQuery

    \n
    • \n
  • \n

    neptune-graph:DeleteDataViaQuery

    \n
    • \n
\n \n

\n Non-parametrized queries are not considered for plan caching. You can force plan caching with \n planCache=enabled. The plan cache will be reused only for the same exact query. Slight variations \n in the query will not be able to reuse the query plan cache.\n

\n ", "smithy.api#endpoint": { "hostPrefix": "{graphIdentifier}." }, @@ -2846,6 +2855,12 @@ "smithy.api#required": {} } }, + "parameters": { + "target": "com.amazonaws.neptunegraph#DocumentValuedMap", + "traits": { + "smithy.api#documentation": "

The data parameters the query can use in JSON format. For example: {\"name\": \"john\", \"age\": 20}. (optional)

" + } + }, "planCache": { "target": "com.amazonaws.neptunegraph#PlanCacheType", "traits": { @@ -3796,7 +3811,7 @@ ], "traits": { "aws.api#dataPlane": {}, - "smithy.api#documentation": "

Retrieves the status of a specified query.

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

Retrieves the status of a specified query.

\n \n

\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the \n neptune-graph:GetQueryStatus IAM action attached.\n

\n ", "smithy.api#endpoint": { "hostPrefix": "{graphIdentifier}." }, @@ -5587,7 +5602,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.\n (true to enable, or false to disable).

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable).

" } } }, @@ -6181,7 +6196,7 @@ "publicConnectivity": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated.\n (true to enable, or false to disable.

" + "smithy.api#documentation": "

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.\n (true to enable, or false to disable.

" } }, "provisionedMemory": { diff --git a/codegen/sdk/aws-models/route-53-domains.json b/codegen/sdk/aws-models/route-53-domains.json index 3630eb4559d..c856bf397ed 100644 --- a/codegen/sdk/aws-models/route-53-domains.json +++ b/codegen/sdk/aws-models/route-53-domains.json @@ -331,7 +331,7 @@ "Availability": { "target": "com.amazonaws.route53domains#DomainAvailability", "traits": { - "smithy.api#documentation": "

Whether the domain name is available for registering.

\n \n

You can register only domains designated as AVAILABLE.

\n \n

Valid values:

\n
\n
AVAILABLE
\n
\n

The domain name is available.

\n
\n
AVAILABLE_RESERVED
\n
\n

The domain name is reserved under specific conditions.

\n
\n
AVAILABLE_PREORDER
\n
\n

The domain name is available and can be preordered.

\n
\n
DONT_KNOW
\n
\n

The TLD registry didn't reply with a definitive answer about whether the\n\t\t\t\t\t\tdomain name is available. Route 53 can return this response for a variety of\n\t\t\t\t\t\treasons, for example, the registry is performing maintenance. Try again\n\t\t\t\t\t\tlater.

\n
\n
PENDING
\n
\n

The TLD registry didn't return a response in the expected amount of time.\n\t\t\t\t\t\tWhen the response is delayed, it usually takes just a few extra seconds. You\n\t\t\t\t\t\tcan resubmit the request immediately.

\n
\n
RESERVED
\n
\n

The domain name has been reserved for another person or\n\t\t\t\t\t\torganization.

\n
\n
UNAVAILABLE
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_PREMIUM
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_RESTRICTED
\n
\n

The domain name is forbidden.

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

Whether the domain name is available for registering.

\n \n

You can register only domains designated as AVAILABLE.

\n \n

Valid values:

\n
\n
AVAILABLE
\n
\n

The domain name is available.

\n
\n
AVAILABLE_RESERVED
\n
\n

The domain name is reserved under specific conditions.

\n
\n
AVAILABLE_PREORDER
\n
\n

The domain name is available and can be preordered.

\n
\n
DONT_KNOW
\n
\n

The TLD registry didn't reply with a definitive answer about whether the\n\t\t\t\t\t\tdomain name is available. Route 53 can return this response for a variety of\n\t\t\t\t\t\treasons, for example, the registry is performing maintenance. Try again\n\t\t\t\t\t\tlater.

\n
\n
INVALID_NAME_FOR_TLD
\n
\n

The TLD isn't valid. For example, it can contain characters that aren't allowed.

\n
\n
PENDING
\n
\n

The TLD registry didn't return a response in the expected amount of time.\n\t\t\t\t\t\tWhen the response is delayed, it usually takes just a few extra seconds. You\n\t\t\t\t\t\tcan resubmit the request immediately.

\n
\n
RESERVED
\n
\n

The domain name has been reserved for another person or\n\t\t\t\t\t\torganization.

\n
\n
UNAVAILABLE
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_PREMIUM
\n
\n

The domain name is not available.

\n
\n
UNAVAILABLE_RESTRICTED
\n
\n

The domain name is forbidden.

\n
\n
" } } }, @@ -2555,6 +2555,18 @@ "traits": { "smithy.api#enumValue": "DONT_KNOW" } + }, + "INVALID_NAME_FOR_TLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_NAME_FOR_TLD" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } } } }, @@ -3284,25 +3296,25 @@ "AdminPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

" + "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

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

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

" + "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

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

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

" + "smithy.api#documentation": "

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If the value is false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

" } }, "RegistrarName": { "target": "com.amazonaws.route53domains#RegistrarName", "traits": { - "smithy.api#documentation": "

Name of the registrar of the domain as identified in the registry. Domains with a\n\t\t\t.com, .net, or .org TLD are registered by Amazon Registrar. All other domains are\n\t\t\tregistered by our registrar associate, Gandi. The value for domains that are registered\n\t\t\tby Gandi is \"GANDI SAS\".

" + "smithy.api#documentation": "

Name of the registrar of the domain as identified in the registry.

" } }, "WhoIsServer": { @@ -3376,6 +3388,18 @@ "traits": { "smithy.api#documentation": "

A complex type that contains information about the DNSSEC configuration.

" } + }, + "BillingContact": { + "target": "com.amazonaws.route53domains#ContactDetail", + "traits": { + "smithy.api#documentation": "

Provides details about the domain billing contact.

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

Specifies whether contact information is concealed from WHOIS queries. If the value is\n\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\tAmazon Registrar or for our registrar associate,\n\t\tGandi. If the value is false, WHOIS queries return the\n\t\tinformation that you entered for the billing contact.

" + } } }, "traits": { @@ -4216,6 +4240,18 @@ "traits": { "smithy.api#enumValue": "INTERNAL_TRANSFER_IN_DOMAIN" } + }, + "RELEASE_TO_GANDI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELEASE_TO_GANDI" + } + }, + "TRANSFER_ON_RENEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSFER_ON_RENEW" + } } } }, @@ -4227,7 +4263,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 18 + "max": 20 } } }, @@ -4459,19 +4495,31 @@ "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

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

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (the domain owner).

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (the domain owner).

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

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

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" + } + }, + "BillingContact": { + "target": "com.amazonaws.route53domains#ContactDetail", + "traits": { + "smithy.api#documentation": "

Provides detailed contact information. For information about the values that you\n\t\t\tspecify for each element, see ContactDetail.

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

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the billing contact.

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

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

Transfers a domain from another registrar to Amazon Route 53.

\n

For more information about transferring domains, see the following topics:

\n \n

If the registrar for your domain is also the DNS service provider for the domain, we\n\t\t\thighly recommend that you transfer your DNS service to Route 53 or to another DNS\n\t\t\tservice provider before you transfer your registration. Some registrars provide free DNS\n\t\t\tservice when you purchase a domain registration. When you transfer the registration, the\n\t\t\tprevious registrar will not renew your domain registration and could end your DNS\n\t\t\tservice at any time.

\n \n

If the registrar for your domain is also the DNS service provider for the domain\n\t\t\t\tand you don't transfer DNS service to another provider, your website, email, and the\n\t\t\t\tweb applications associated with the domain might become unavailable.

\n \n

If the transfer is successful, this method returns an operation ID that you can use to\n\t\t\ttrack the progress and completion of the action. If the transfer doesn't complete\n\t\t\tsuccessfully, the domain registrant will be notified by email.

" + "smithy.api#documentation": "

Transfers a domain from another registrar to Amazon Route 53.

\n

For more information about transferring domains, see the following topics:

\n \n \n

During the transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and .tv, \n\t\t\tupdates to the owner contact are ignored and the owner contact data from the registry is used. \n\t\t\tYou can\n\t\t\tupdate the owner contact after the transfer is complete. For more information, see\n\t\t\tUpdateDomainContact.

\n \n

If the registrar for your domain is also the DNS service provider for the domain, we\n\t\t\thighly recommend that you transfer your DNS service to Route 53 or to another DNS\n\t\t\tservice provider before you transfer your registration. Some registrars provide free DNS\n\t\t\tservice when you purchase a domain registration. When you transfer the registration, the\n\t\t\tprevious registrar will not renew your domain registration and could end your DNS\n\t\t\tservice at any time.

\n \n

If the registrar for your domain is also the DNS service provider for the domain\n\t\t\t\tand you don't transfer DNS service to another provider, your website, email, and the\n\t\t\t\tweb applications associated with the domain might become unavailable.

\n \n

If the transfer is successful, this method returns an operation ID that you can use to\n\t\t\ttrack the progress and completion of the action. If the transfer doesn't complete\n\t\t\tsuccessfully, the domain registrant will be notified by email.

" } }, "com.amazonaws.route53domains#TransferDomainRequest": { @@ -5809,13 +5857,25 @@ "PrivacyProtectRegistrantContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

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

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" + "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n \n

Default: true\n

" + } + }, + "BillingContact": { + "target": "com.amazonaws.route53domains#ContactDetail", + "traits": { + "smithy.api#documentation": "

Provides detailed contact information.

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

\n\t\t\tWhether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the billing contact.\n\t\t

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n " } } }, @@ -5950,7 +6010,7 @@ } }, "traits": { - "smithy.api#documentation": "

Whether the domain name can be transferred to Route 53.

\n \n

You can transfer only domains that have a value of TRANSFERABLE or\n\t\t\t\t\tTransferable.

\n \n

Valid values:

\n
\n
TRANSFERABLE
\n
\n

The domain name can be transferred to Route 53.

\n
\n
UNTRANSFERRABLE
\n
\n

The domain name can't be transferred to Route 53.

\n
\n
DONT_KNOW
\n
\n

Reserved for future use.

\n
\n
DOMAIN_IN_OWN_ACCOUNT
\n
\n

The domain already exists in the current Amazon Web Services account.

\n
\n
DOMAIN_IN_ANOTHER_ACCOUNT
\n
\n

the domain exists in another Amazon Web Services account.

\n
\n
PREMIUM_DOMAIN
\n
\n

Premium domain transfer is not supported.

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

Whether the domain name can be transferred to Route 53.

\n \n

You can transfer only domains that have a value of TRANSFERABLE or\n\t\t\t\t\tTransferable.

\n \n

Valid values:

\n
\n
TRANSFERABLE
\n
\n

The domain name can be transferred to Route 53.

\n
\n
UNTRANSFERRABLE
\n
\n

The domain name can't be transferred to Route 53.

\n
\n
DONT_KNOW
\n
\n

Reserved for future use.

\n
\n
DOMAIN_IN_OWN_ACCOUNT
\n
\n

The domain already exists in the current Amazon Web Services account.

\n
\n
DOMAIN_IN_ANOTHER_ACCOUNT
\n
\n

The domain exists in another Amazon Web Services account.

\n
\n
PREMIUM_DOMAIN
\n
\n

Premium domain transfer is not supported.

\n
\n
" } }, "com.amazonaws.route53domains#UnsupportedTLD": { @@ -6040,19 +6100,25 @@ "AdminPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

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

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n " } }, "RegistrantPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

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

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the registrant contact (domain owner).

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n " } }, "TechPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.

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

Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the technical contact.

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

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

\n\t\t\tWhether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar or for our registrar associate,\n\t\t\tGandi. If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the billing contact.\n\t\t

\n \n

You must specify the same privacy setting for the administrative, billing, registrant, and\n\t\t\t\ttechnical contacts.

\n " } } }, @@ -6109,6 +6175,12 @@ "traits": { "smithy.api#documentation": "

Customer's consent for the owner change request. Required if the domain is not free (consent price is more than $0.00).

" } + }, + "BillingContact": { + "target": "com.amazonaws.route53domains#ContactDetail", + "traits": { + "smithy.api#documentation": "

Provides detailed contact information.

" + } } }, "traits": { From 9355d446983b44750675de00c1046f3eef201211 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 12 Feb 2024 19:08:44 +0000 Subject: [PATCH 23/32] chore: release 1.0.55 --- CHANGELOG.md | 8 ++++++++ gradle.properties | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f0f2db2884c..d2e004ed373 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [1.0.55] - 02/12/2024 + +### Features +* (**appsync**) Adds support for new options on GraphqlAPIs, Resolvers and Data Sources for emitting Amazon CloudWatch metrics for enhanced monitoring of AppSync APIs. +* (**cloudwatch**) This release enables PutMetricData API request payload compression by default. +* (**neptunegraph**) Adding a new option "parameters" for data plane api ExecuteQuery to support running parameterized query via SDK. +* (**route53domains**) This release adds bill contact support for RegisterDomain, TransferDomain, UpdateDomainContact and GetDomainDetail API. + ## [1.0.54] - 02/09/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 67d3565999e..8b70195a8d5 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.55-SNAPSHOT +sdkVersion=1.0.55 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 38c0a28eddcc6a59d781a04a9ba78d3287f657fd Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 12 Feb 2024 19:08:45 +0000 Subject: [PATCH 24/32] chore: bump snapshot version to 1.0.56-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 8b70195a8d5..7c3428aeaff 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.55 +sdkVersion=1.0.56-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 670220f2d505e91305c240efc75fb1e641fd19b0 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 13 Feb 2024 19:05:56 +0000 Subject: [PATCH 25/32] feat: update AWS API models --- codegen/sdk/aws-models/lightsail.json | 6 + .../sdk/aws-models/marketplace-catalog.json | 43 +- .../sdk/aws-models/resource-explorer-2.json | 368 +++++++++++++++--- codegen/sdk/aws-models/securitylake.json | 10 +- 4 files changed, 362 insertions(+), 65 deletions(-) diff --git a/codegen/sdk/aws-models/lightsail.json b/codegen/sdk/aws-models/lightsail.json index 1c67d67ce00..aadfd83d7db 100644 --- a/codegen/sdk/aws-models/lightsail.json +++ b/codegen/sdk/aws-models/lightsail.json @@ -23357,6 +23357,12 @@ "traits": { "smithy.api#documentation": "

Indicates the certificate that needs to be associated with the database.

" } + }, + "relationalDatabaseBlueprintId": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "

This parameter is used to update the major version of the database. Enter the\n blueprintId for the major version that you want to update to.

\n

Use the GetRelationalDatabaseBlueprints action to get a list of available blueprint\n IDs.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/marketplace-catalog.json b/codegen/sdk/aws-models/marketplace-catalog.json index e8647e36cc9..9af92448fac 100644 --- a/codegen/sdk/aws-models/marketplace-catalog.json +++ b/codegen/sdk/aws-models/marketplace-catalog.json @@ -805,7 +805,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object containing all the filter fields for AMI products. Client can add a maximum of 8\n filters in a single ListEntities request.

" + "smithy.api#documentation": "

Object containing all the filter fields for AMI products. Client can add only one wildcard filter and a maximum of 8\n filters in a single ListEntities request.

" } }, "com.amazonaws.marketplacecatalog#AmiProductLastModifiedDateFilter": { @@ -1031,7 +1031,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata and content for multiple entities.

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

Returns metadata and content for multiple entities. This is the Batch version of the DescribeEntity API and uses the same IAM permission action as DescribeEntity API.

", "smithy.api#http": { "method": "POST", "uri": "/BatchDescribeEntities", @@ -1503,7 +1503,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object containing all the filter fields for container products. Client can add a maximum of 8 filters in a single ListEntities request.

" + "smithy.api#documentation": "

Object containing all the filter fields for container products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

" } }, "com.amazonaws.marketplacecatalog#ContainerProductLastModifiedDateFilter": { @@ -1771,7 +1771,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object containing all the filter fields for data products. Client can add a maximum of 8 filters in a single ListEntities request.

" + "smithy.api#documentation": "

Object containing all the filter fields for data products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

" } }, "com.amazonaws.marketplacecatalog#DataProductLastModifiedDateFilter": { @@ -2126,6 +2126,12 @@ "smithy.api#documentation": "

The optional name provided in the StartChangeSet request. If you do not\n provide a name, one is set by default.

" } }, + "Intent": { + "target": "com.amazonaws.marketplacecatalog#Intent", + "traits": { + "smithy.api#documentation": "

The optional intent provided in the StartChangeSet request. If you do not\n provide an intent, APPLY is set by default.

" + } + }, "StartTime": { "target": "com.amazonaws.marketplacecatalog#DateTimeISO8601", "traits": { @@ -2776,6 +2782,23 @@ "smithy.api#pattern": "^[\\w\\-@]+$" } }, + "com.amazonaws.marketplacecatalog#Intent": { + "type": "enum", + "members": { + "VALIDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATE" + } + }, + "APPLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPLY" + } + } + } + }, "com.amazonaws.marketplacecatalog#InternalServiceException": { "type": "structure", "members": { @@ -3294,7 +3317,7 @@ } }, "traits": { - "smithy.api#documentation": "

A filter for offers entity.

" + "smithy.api#documentation": "

Object containing all the filter fields for offers entity. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

" } }, "com.amazonaws.marketplacecatalog#OfferLastModifiedDateFilter": { @@ -3997,7 +4020,7 @@ } }, "traits": { - "smithy.api#documentation": "

A filter for ResaleAuthorization entity.

" + "smithy.api#documentation": "

Object containing all the filter fields for resale authorization entity. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

" } }, "com.amazonaws.marketplacecatalog#ResaleAuthorizationLastModifiedDateFilter": { @@ -4800,7 +4823,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object containing all the filter fields for SaaS products. Client can add a maximum of\n 8 filters in a single ListEntities request.

" + "smithy.api#documentation": "

Object containing all the filter fields for SaaS products. Client can add only one wildcard filter and a maximum of 8 filters in a single ListEntities request.

" } }, "com.amazonaws.marketplacecatalog#SaaSProductLastModifiedDateFilter": { @@ -5138,6 +5161,12 @@ "traits": { "smithy.api#documentation": "

A list of objects specifying each key name and value for the\n ChangeSetTags property.

" } + }, + "Intent": { + "target": "com.amazonaws.marketplacecatalog#Intent", + "traits": { + "smithy.api#documentation": "

The intent related to the request. The default is APPLY.\n To test your request before applying changes to your entities, use VALIDATE.\n This feature is currently available for adding versions to single-AMI products. For more information, see\n Add a new version.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/resource-explorer-2.json b/codegen/sdk/aws-models/resource-explorer-2.json index 9f7e808e127..a69f93ec778 100644 --- a/codegen/sdk/aws-models/resource-explorer-2.json +++ b/codegen/sdk/aws-models/resource-explorer-2.json @@ -1624,6 +1624,13 @@ "documentation": "The AWS region used to dispatch the request.", "type": "String" }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, @@ -1666,6 +1673,21 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, { "conditions": [], "endpoint": { @@ -1710,16 +1732,19 @@ { "fn": "booleanEquals", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true ] } ], @@ -1729,61 +1754,51 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] - } - ], - "rules": [ + }, { - "conditions": [ + "fn": "booleanEquals", + "argv": [ + true, { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "ref": "PartitionResult" }, - true + "supportsDualStack" ] } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://resource-explorer-2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, + ] + } + ], + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://resource-explorer-2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ], "type": "tree" }, { "conditions": [], - "endpoint": { - "url": "https://resource-explorer-2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ], "type": "tree" @@ -1840,6 +1855,58 @@ ], "type": "tree" }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://resource-explorer-2.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, { "conditions": [], "endpoint": { @@ -1873,7 +1940,21 @@ }, "params": { "Region": "us-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1885,7 +1966,21 @@ }, "params": { "Region": "us-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1897,7 +1992,21 @@ }, "params": { "Region": "cn-north-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1909,7 +2018,21 @@ }, "params": { "Region": "cn-north-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1921,7 +2044,21 @@ }, "params": { "Region": "us-gov-east-1", - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1933,7 +2070,117 @@ }, "params": { "Region": "us-gov-east-1", - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://resource-explorer-2.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1946,6 +2193,7 @@ "params": { "Region": "us-east-1", "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1958,6 +2206,7 @@ }, "params": { "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1969,6 +2218,19 @@ "params": { "Region": "us-east-1", "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } }, diff --git a/codegen/sdk/aws-models/securitylake.json b/codegen/sdk/aws-models/securitylake.json index 6a9b765a8b2..ed5fb4aed87 100644 --- a/codegen/sdk/aws-models/securitylake.json +++ b/codegen/sdk/aws-models/securitylake.json @@ -1279,7 +1279,7 @@ "regions": { "target": "com.amazonaws.securitylake#RegionList", "traits": { - "smithy.api#documentation": "

Replication enables automatic, asynchronous copying of objects across Amazon S3\n buckets. Amazon S3 buckets that are configured for object replication can be owned\n by the same Amazon Web Services account or by different accounts. You can replicate objects\n to a single destination bucket or to multiple destination buckets. The destination buckets\n can be in different Amazon Web Services Regions or within the same Region as the source\n bucket.

\n

Set up one or more rollup Regions by providing the Region or Regions that should\n contribute to the central rollup Region.

" + "smithy.api#documentation": "

Specifies one or more centralized rollup Regions. The Amazon Web Services Region specified in the region \n parameter of the \n CreateDataLake\n \n or \n UpdateDataLake\n operations contributes data to the rollup Region or \n Regions specified in this parameter.

\n

Replication enables automatic, asynchronous copying of objects across Amazon S3\n buckets. S3 buckets that are configured for object replication can be owned\n by the same Amazon Web Services account or by different accounts. You can replicate objects\n to a single destination bucket or to multiple destination buckets. The destination buckets\n can be in different Regions or within the same Region as the source bucket.

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

Provides replication details of Amazon Security Lake object.

" + "smithy.api#documentation": "

Provides replication details for objects stored in the Amazon Security Lake data lake.

" } }, "com.amazonaws.securitylake#DataLakeResource": { @@ -2472,7 +2472,7 @@ "regions": { "target": "com.amazonaws.securitylake#RegionList", "traits": { - "smithy.api#documentation": "

List the Amazon Web Services Regions from which exceptions are retrieved.

" + "smithy.api#documentation": "

The Amazon Web Services Regions from which exceptions are retrieved.

" } }, "maxResults": { @@ -2558,7 +2558,7 @@ "regions": { "target": "com.amazonaws.securitylake#RegionList", "traits": { - "smithy.api#documentation": "

The list of regions where Security Lake is enabled.

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

The list of Regions where Security Lake is enabled.

", "smithy.api#httpQuery": "regions" } } @@ -2638,7 +2638,7 @@ "regions": { "target": "com.amazonaws.securitylake#RegionList", "traits": { - "smithy.api#documentation": "

The list of regions for which log sources are displayed.

" + "smithy.api#documentation": "

The list of Regions for which log sources are displayed.

" } }, "sources": { From faf4c2c3240fc136818bf815ee049da2857631ec Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 13 Feb 2024 19:05:56 +0000 Subject: [PATCH 26/32] feat: update AWS service endpoints metadata --- .../aws/sdk/kotlin/codegen/endpoints.json | 120 +++--------------- 1 file changed, 19 insertions(+), 101 deletions(-) diff --git a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json index 66628592e43..8ed378172ba 100644 --- a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json +++ b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json @@ -14341,72 +14341,26 @@ } }, "resource-explorer-2" : { - "defaults" : { - "dnsSuffix" : "api.aws", - "variants" : [ { - "dnsSuffix" : "api.aws", - "hostname" : "{service}-fips.{region}.{dnsSuffix}", - "tags" : [ "fips" ] - } ] - }, "endpoints" : { - "ap-northeast-1" : { - "hostname" : "resource-explorer-2.ap-northeast-1.api.aws" - }, - "ap-northeast-2" : { - "hostname" : "resource-explorer-2.ap-northeast-2.api.aws" - }, - "ap-northeast-3" : { - "hostname" : "resource-explorer-2.ap-northeast-3.api.aws" - }, - "ap-south-1" : { - "hostname" : "resource-explorer-2.ap-south-1.api.aws" - }, - "ap-southeast-1" : { - "hostname" : "resource-explorer-2.ap-southeast-1.api.aws" - }, - "ap-southeast-2" : { - "hostname" : "resource-explorer-2.ap-southeast-2.api.aws" - }, - "ap-southeast-3" : { - "hostname" : "resource-explorer-2.ap-southeast-3.api.aws" - }, - "ca-central-1" : { - "hostname" : "resource-explorer-2.ca-central-1.api.aws" - }, - "eu-central-1" : { - "hostname" : "resource-explorer-2.eu-central-1.api.aws" - }, - "eu-north-1" : { - "hostname" : "resource-explorer-2.eu-north-1.api.aws" - }, - "eu-west-1" : { - "hostname" : "resource-explorer-2.eu-west-1.api.aws" - }, - "eu-west-2" : { - "hostname" : "resource-explorer-2.eu-west-2.api.aws" - }, - "eu-west-3" : { - "hostname" : "resource-explorer-2.eu-west-3.api.aws" - }, - "me-south-1" : { - "hostname" : "resource-explorer-2.me-south-1.api.aws" - }, - "sa-east-1" : { - "hostname" : "resource-explorer-2.sa-east-1.api.aws" - }, - "us-east-1" : { - "hostname" : "resource-explorer-2.us-east-1.api.aws" - }, - "us-east-2" : { - "hostname" : "resource-explorer-2.us-east-2.api.aws" - }, - "us-west-1" : { - "hostname" : "resource-explorer-2.us-west-1.api.aws" - }, - "us-west-2" : { - "hostname" : "resource-explorer-2.us-west-2.api.aws" - } + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-northeast-3" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ap-southeast-3" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } } }, "resource-groups" : { @@ -21044,24 +20998,6 @@ "cn-north-1" : { } } }, - "resource-explorer-2" : { - "defaults" : { - "dnsSuffix" : "api.amazonwebservices.com.cn", - "variants" : [ { - "dnsSuffix" : "api.amazonwebservices.com.cn", - "hostname" : "{service}-fips.{region}.{dnsSuffix}", - "tags" : [ "fips" ] - } ] - }, - "endpoints" : { - "cn-north-1" : { - "hostname" : "resource-explorer-2.cn-north-1.api.amazonwebservices.com.cn" - }, - "cn-northwest-1" : { - "hostname" : "resource-explorer-2.cn-northwest-1.api.amazonwebservices.com.cn" - } - } - }, "resource-groups" : { "endpoints" : { "cn-north-1" : { }, @@ -24968,24 +24904,6 @@ } } }, - "resource-explorer-2" : { - "defaults" : { - "dnsSuffix" : "api.aws", - "variants" : [ { - "dnsSuffix" : "api.aws", - "hostname" : "{service}-fips.{region}.{dnsSuffix}", - "tags" : [ "fips" ] - } ] - }, - "endpoints" : { - "us-gov-east-1" : { - "hostname" : "resource-explorer-2.us-gov-east-1.api.aws" - }, - "us-gov-west-1" : { - "hostname" : "resource-explorer-2.us-gov-west-1.api.aws" - } - } - }, "resource-groups" : { "defaults" : { "variants" : [ { From 76b02ddea6972a975a1d9bf7ef46c785c24dbea9 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 13 Feb 2024 19:08:49 +0000 Subject: [PATCH 27/32] chore: release 1.0.56 --- CHANGELOG.md | 10 ++++++++++ gradle.properties | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d2e004ed373..e600a5bee45 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## [1.0.56] - 02/13/2024 + +### Features +* (**lightsail**) This release adds support to upgrade the major version of a database. +* (**marketplacecatalog**) AWS Marketplace Catalog API now supports setting intent on requests +* (**resourceexplorer2**) Resource Explorer now uses newly supported IPv4 'amazonaws.com' endpoints by default. + +### Documentation +* (**securitylake**) Documentation updates for Security Lake + ## [1.0.55] - 02/12/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 7c3428aeaff..ac7f77d48b2 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.56-SNAPSHOT +sdkVersion=1.0.56 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 675413cc200f93a492c2d0cf5e6fa4a77490f3cf Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 13 Feb 2024 19:08:50 +0000 Subject: [PATCH 28/32] chore: bump snapshot version to 1.0.57-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index ac7f77d48b2..7cd9d9720d7 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.56 +sdkVersion=1.0.57-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 1b88a5d29134016c05a3be16dc7d2a3cfb2f3466 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 14 Feb 2024 19:05:12 +0000 Subject: [PATCH 29/32] feat: update AWS API models --- codegen/sdk/aws-models/controltower.json | 1418 ++++++++++++++++-- codegen/sdk/aws-models/lookoutequipment.json | 109 +- codegen/sdk/aws-models/qbusiness.json | 279 +++- 3 files changed, 1639 insertions(+), 167 deletions(-) diff --git a/codegen/sdk/aws-models/controltower.json b/codegen/sdk/aws-models/controltower.json index 89da4567e8c..0f16f243391 100644 --- a/codegen/sdk/aws-models/controltower.json +++ b/codegen/sdk/aws-models/controltower.json @@ -34,6 +34,12 @@ } ], "resources": [ + { + "target": "com.amazonaws.controltower#BaselineResource" + }, + { + "target": "com.amazonaws.controltower#EnabledBaselineResource" + }, { "target": "com.amazonaws.controltower#LandingZoneResource" } @@ -70,7 +76,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "

These interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.

\n

To call these APIs, you'll need to know:

\n
    \n
  • \n

    the controlIdentifier for the control--or guardrail--you are targeting.

    \n
    • \n
  • \n

    the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.

    \n
    • \n
  • \n

    the ARN associated with a resource that you wish to tag or untag.

    \n
    • \n
\n

\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n

\n

The controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.

\n

The controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.\n

\n

A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed.

\n \n

\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n

\n

\n Example:\n

\n

\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n

\n \n

\n To get the targetIdentifier:\n

\n

The targetIdentifier is the ARN for an OU.

\n

In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

\n \n

\n OU ARN format:\n

\n

\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n

\n \n

\n Details and examples\n

\n \n

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n

\n

\n Recording API Requests\n

\n

Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.

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

These interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.

\n

To call these APIs, you'll need to know:

\n
    \n
  • \n

    the controlIdentifier for the control--or guardrail--you are targeting.

    \n
    • \n
  • \n

    the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.

    \n
    • \n
  • \n

    the ARN associated with a resource that you wish to tag or untag.

    \n
    • \n
\n

\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n

\n

The controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.

\n

The controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.\n

\n

A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed.

\n \n

\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n

\n

\n Example:\n

\n

\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n

\n \n

\n To get the targetIdentifier:\n

\n

The targetIdentifier is the ARN for an OU.

\n

In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

\n \n

\n OU ARN format:\n

\n

\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n

\n \n

\n Details and examples\n

\n \n

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n

\n

\n Recording API Requests\n

\n

Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.

", "smithy.api#title": "AWS Control Tower", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -949,6 +955,166 @@ "smithy.api#pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$" } }, + "com.amazonaws.controltower#BaselineArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z-]+:controltower:[a-z0-9-]*:[0-9]{0,12}:baseline/[A-Z0-9]{16}$" + } + }, + "com.amazonaws.controltower#BaselineOperation": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the specified operation.

" + } + }, + "operationType": { + "target": "com.amazonaws.controltower#BaselineOperationType", + "traits": { + "smithy.api#documentation": "

An enumerated type (enum) with possible values of ENABLE_BASELINE, DISABLE_BASELINE, UPDATE_ENABLED_BASELINE, or RESET_ENABLED_BASELINE.

" + } + }, + "status": { + "target": "com.amazonaws.controltower#BaselineOperationStatus", + "traits": { + "smithy.api#documentation": "

An enumerated type (enum) with possible values of SUCCEEDED, FAILED, or IN_PROGRESS.

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

The start time of the operation, in ISO 8601 format.

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

The end time of the operation (if applicable), in ISO 8601 format.

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

A status message that gives more information about the operation's status, if applicable.

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

An object of shape BaselineOperation, returning details about the specified Baseline operation ID.

" + } + }, + "com.amazonaws.controltower#BaselineOperationStatus": { + "type": "enum", + "members": { + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + } + } + }, + "com.amazonaws.controltower#BaselineOperationType": { + "type": "enum", + "members": { + "ENABLE_BASELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_BASELINE" + } + }, + "DISABLE_BASELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_BASELINE" + } + }, + "UPDATE_ENABLED_BASELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_ENABLED_BASELINE" + } + }, + "RESET_ENABLED_BASELINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESET_ENABLED_BASELINE" + } + } + } + }, + "com.amazonaws.controltower#BaselineResource": { + "type": "resource", + "identifiers": { + "baselineIdentifier": { + "target": "com.amazonaws.controltower#BaselineArn" + } + }, + "read": { + "target": "com.amazonaws.controltower#GetBaseline" + }, + "list": { + "target": "com.amazonaws.controltower#ListBaselines" + } + }, + "com.amazonaws.controltower#BaselineSummary": { + "type": "structure", + "members": { + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The full ARN of a Baseline.

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

The human-readable name of a Baseline.

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

A summary description of a Baseline.

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

Returns a summary of information about a Baseline object.

" + } + }, + "com.amazonaws.controltower#BaselineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#pattern": "^\\d+(?:\\.\\d+){0,2}$" + } + }, + "com.amazonaws.controltower#Baselines": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#BaselineSummary" + } + }, "com.amazonaws.controltower#ConflictException": { "type": "structure", "members": { @@ -1100,7 +1266,7 @@ "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "

The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review \n Launch your landing zone.

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

The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file.

", "smithy.api#required": {} } }, @@ -1206,6 +1372,77 @@ "smithy.api#output": {} } }, + "com.amazonaws.controltower#DisableBaseline": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#DisableBaselineInput" + }, + "output": { + "target": "com.amazonaws.controltower#DisableBaselineOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#ConflictException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/disable-baseline" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.controltower#DisableBaselineInput": { + "type": "structure", + "members": { + "enabledBaselineIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

Identifier of the EnabledBaseline resource to be deactivated, in ARN format.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#DisableBaselineOutput": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controltower#DisableControl": { "type": "operation", "input": { @@ -1238,7 +1475,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

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

This API call turns off a control. It starts an asynchronous operation that deletes AWS\n resources on the specified organizational unit and the accounts it contains. The resources\n will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1252,7 +1489,7 @@ "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n landing zone Region deny control. For information on how to find the controlIdentifier, see the overview page.

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

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.

", "smithy.api#required": {} } }, @@ -1320,13 +1557,13 @@ "smithy.api#documentation": "

The drift summary of the enabled control.

\n

Amazon Web Services Control Tower expects the enabled control\n configuration to include all supported and governed Regions. If the enabled control differs\n from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.

" } }, - "com.amazonaws.controltower#EnableControl": { + "com.amazonaws.controltower#EnableBaseline": { "type": "operation", "input": { - "target": "com.amazonaws.controltower#EnableControlInput" + "target": "com.amazonaws.controltower#EnableBaselineInput" }, "output": { - "target": "com.amazonaws.controltower#EnableControlOutput" + "target": "com.amazonaws.controltower#EnableBaselineOutput" }, "errors": [ { @@ -1352,83 +1589,421 @@ } ], "traits": { - "smithy.api#documentation": "

This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n created will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

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

Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target.

", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/enable-control" + "uri": "/enable-baseline" } } }, - "com.amazonaws.controltower#EnableControlInput": { + "com.amazonaws.controltower#EnableBaselineInput": { "type": "structure", "members": { - "controlIdentifier": { - "target": "com.amazonaws.controltower#ControlIdentifier", + "baselineVersion": { + "target": "com.amazonaws.controltower#BaselineVersion", "traits": { - "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n landing zone Region deny control. For information on how to find the controlIdentifier, see the overview page.

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

The specific version to be enabled of the specified baseline.

", "smithy.api#required": {} } }, - "targetIdentifier": { - "target": "com.amazonaws.controltower#TargetIdentifier", + "parameters": { + "target": "com.amazonaws.controltower#EnabledBaselineParameters", "traits": { - "smithy.api#documentation": "

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

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

A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.

" + } + }, + "baselineIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the baseline to be enabled.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.controltower#TagMap", + "targetIdentifier": { + "target": "com.amazonaws.controltower#Arn", "traits": { - "smithy.api#documentation": "

Tags to be applied to the EnabledControl resource.

" + "smithy.api#documentation": "

The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.

", + "smithy.api#required": {} } }, - "parameters": { - "target": "com.amazonaws.controltower#EnabledControlParameters", + "tags": { + "target": "com.amazonaws.controltower#TagMap", "traits": { - "smithy.api#documentation": "

An array of EnabledControlParameter objects

" + "smithy.api#documentation": "

Tags associated with input to EnableBaseline.

" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.controltower#EnableControlOutput": { + "com.amazonaws.controltower#EnableBaselineOutput": { "type": "structure", "members": { "operationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "

The ID of the asynchronous operation, which is used to track status. The operation is\n available for 90 days.

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

The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.controltower#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the EnabledControl resource.

" + "smithy.api#documentation": "

The ARN of the EnabledBaseline resource.

", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.controltower#EnabledControlDetails": { - "type": "structure", - "members": { - "arn": { - "target": "com.amazonaws.controltower#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the enabled control.

" - } - }, - "controlIdentifier": { - "target": "com.amazonaws.controltower#ControlIdentifier", - "traits": { - "smithy.api#documentation": "

The control identifier of the enabled control. For information on how to find the controlIdentifier, see the overview page.

" - } + "com.amazonaws.controltower#EnableControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#EnableControlInput" + }, + "output": { + "target": "com.amazonaws.controltower#EnableControlOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" }, - "targetIdentifier": { - "target": "com.amazonaws.controltower#TargetIdentifier", - "traits": { - "smithy.api#documentation": "

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

" - } + { + "target": "com.amazonaws.controltower#ConflictException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n created will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/enable-control" + } + } + }, + "com.amazonaws.controltower#EnableControlInput": { + "type": "structure", + "members": { + "controlIdentifier": { + "target": "com.amazonaws.controltower#ControlIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.

", + "smithy.api#required": {} + } + }, + "targetIdentifier": { + "target": "com.amazonaws.controltower#TargetIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.controltower#TagMap", + "traits": { + "smithy.api#documentation": "

Tags to be applied to the EnabledControl resource.

" + } + }, + "parameters": { + "target": "com.amazonaws.controltower#EnabledControlParameters", + "traits": { + "smithy.api#documentation": "

A list of input parameter values, which are specified to configure the control when you enable it.

" + } + } + } + }, + "com.amazonaws.controltower#EnableControlOutput": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the asynchronous operation, which is used to track status. The operation is\n available for 90 days.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the EnabledControl resource.

" + } + } + } + }, + "com.amazonaws.controltower#EnabledBaselineBaselineIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.controltower#EnabledBaselineDetails": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the EnabledBaseline resource.

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

The specific Baseline enabled as part of the EnabledBaseline resource.

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

The enabled version of the Baseline.

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

The target on which to enable the Baseline.

", + "smithy.api#required": {} + } + }, + "statusSummary": { + "target": "com.amazonaws.controltower#EnablementStatusSummary", + "traits": { + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.controltower#EnabledBaselineParameterSummaries", + "traits": { + "smithy.api#documentation": "

Shows the parameters that are applied when enabling this Baseline.

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

Details of the EnabledBaseline resource.

" + } + }, + "com.amazonaws.controltower#EnabledBaselineFilter": { + "type": "structure", + "members": { + "targetIdentifiers": { + "target": "com.amazonaws.controltower#EnabledBaselineTargetIdentifiers", + "traits": { + "smithy.api#documentation": "

Identifiers for the targets of the Baseline filter operation.

" + } + }, + "baselineIdentifiers": { + "target": "com.amazonaws.controltower#EnabledBaselineBaselineIdentifiers", + "traits": { + "smithy.api#documentation": "

Identifiers for the Baseline objects returned as part of the filter operation.

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

A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.

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

A string denoting the parameter key.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.controltower#EnabledBaselineParameterDocument", + "traits": { + "smithy.api#documentation": "

A low-level Document object of any type (for example, a Java Object).

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

A key-value parameter to an EnabledBaseline resource.

" + } + }, + "com.amazonaws.controltower#EnabledBaselineParameterDocument": { + "type": "document" + }, + "com.amazonaws.controltower#EnabledBaselineParameterSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnabledBaselineParameterSummary" + } + }, + "com.amazonaws.controltower#EnabledBaselineParameterSummary": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A string denoting the parameter key.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.controltower#EnabledBaselineParameterDocument", + "traits": { + "smithy.api#documentation": "

A low-level document object of any type (for example, a Java Object).

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

Summary of an applied parameter to an EnabledBaseline resource.

" + } + }, + "com.amazonaws.controltower#EnabledBaselineParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnabledBaselineParameter" + } + }, + "com.amazonaws.controltower#EnabledBaselineResource": { + "type": "resource", + "identifiers": { + "enabledBaselineIdentifier": { + "target": "com.amazonaws.controltower#Arn" + } + }, + "create": { + "target": "com.amazonaws.controltower#EnableBaseline" + }, + "read": { + "target": "com.amazonaws.controltower#GetEnabledBaseline" + }, + "update": { + "target": "com.amazonaws.controltower#UpdateEnabledBaseline" + }, + "delete": { + "target": "com.amazonaws.controltower#DisableBaseline" + }, + "list": { + "target": "com.amazonaws.controltower#ListEnabledBaselines" + }, + "operations": [ + { + "target": "com.amazonaws.controltower#ResetEnabledBaseline" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.controltower#GetBaselineOperation" + } + ], + "traits": { + "aws.api#arn": { + "template": "enabledbaseline/{enabledBaselineIdentifier}" + } + } + }, + "com.amazonaws.controltower#EnabledBaselineSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the EnabledBaseline resource

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

The specific baseline that is enabled as part of the EnabledBaseline resource.

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

The enabled version of the baseline.

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

The target upon which the baseline is enabled.

", + "smithy.api#required": {} + } + }, + "statusSummary": { + "target": "com.amazonaws.controltower#EnablementStatusSummary", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns a summary of information about an EnabledBaseline object.

" + } + }, + "com.amazonaws.controltower#EnabledBaselineTargetIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.controltower#EnabledBaselines": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnabledBaselineSummary" + } + }, + "com.amazonaws.controltower#EnabledControlDetails": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the enabled control.

" + } + }, + "controlIdentifier": { + "target": "com.amazonaws.controltower#ControlIdentifier", + "traits": { + "smithy.api#documentation": "

The control identifier of the enabled control. For information on how to find the controlIdentifier, see the overview page.

" + } + }, + "targetIdentifier": { + "target": "com.amazonaws.controltower#TargetIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

" + } }, "targetRegions": { "target": "com.amazonaws.controltower#TargetRegions", @@ -1465,20 +2040,20 @@ "key": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The key of a key/value pair. It is of type string.

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

The key of a key/value pair.

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

The value of a key/value pair. It can be of type array\n string, number, object, or boolean.

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

The value of a key/value pair.

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

A set of parameters that configure the behavior of the enabled control. A key/value pair, where Key is of type String and Value is of type Document.

" + "smithy.api#documentation": "

A key/value pair, where Key is of type String and Value is of type Document.

" } }, "com.amazonaws.controltower#EnabledControlParameterSummaries": { @@ -1545,61 +2120,203 @@ "driftStatusSummary": { "target": "com.amazonaws.controltower#DriftStatusSummary", "traits": { - "smithy.api#documentation": "

The drift status of the enabled control.

" + "smithy.api#documentation": "

The drift status of the enabled control.

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

Returns a summary of information about an enabled control.

" + } + }, + "com.amazonaws.controltower#EnabledControls": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#EnabledControlSummary" + } + }, + "com.amazonaws.controltower#EnablementStatus": { + "type": "enum", + "members": { + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UNDER_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNDER_CHANGE" + } + } + } + }, + "com.amazonaws.controltower#EnablementStatusSummary": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.controltower#EnablementStatus", + "traits": { + "smithy.api#documentation": "

The deployment status of the enabled control.

\n

Valid values:

\n
    \n
  • \n

    \n SUCCEEDED: The enabledControl configuration was deployed successfully.

    \n
    • \n
  • \n

    \n UNDER_CHANGE: The enabledControl configuration is changing.

    \n
    • \n
  • \n

    \n FAILED: The enabledControl configuration failed to deploy.

    \n
    • \n
" + } + }, + "lastOperationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The last operation identifier for the enabled control.

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

The deployment summary of the enabled control.

" + } + }, + "com.amazonaws.controltower#GetBaseline": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#GetBaselineInput" + }, + "output": { + "target": "com.amazonaws.controltower#GetBaselineOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve details about an existing Baseline resource by specifying its identifier.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-baseline" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controltower#GetBaselineInput": { + "type": "structure", + "members": { + "baselineIdentifier": { + "target": "com.amazonaws.controltower#BaselineArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Baseline resource to be retrieved.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#GetBaselineOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#GetBaselineOperationInput" + }, + "output": { + "target": "com.amazonaws.controltower#GetBaselineOperationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-baseline-operation" + } + } + }, + "com.amazonaws.controltower#GetBaselineOperationInput": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).

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

Returns a summary of information about an enabled control.

" - } - }, - "com.amazonaws.controltower#EnabledControls": { - "type": "list", - "member": { - "target": "com.amazonaws.controltower#EnabledControlSummary" + "smithy.api#input": {} } }, - "com.amazonaws.controltower#EnablementStatus": { - "type": "enum", + "com.amazonaws.controltower#GetBaselineOperationOutput": { + "type": "structure", "members": { - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "UNDER_CHANGE": { - "target": "smithy.api#Unit", + "baselineOperation": { + "target": "com.amazonaws.controltower#BaselineOperation", "traits": { - "smithy.api#enumValue": "UNDER_CHANGE" + "smithy.api#documentation": "

A baselineOperation object that shows information about the specified operation ID.

", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.controltower#EnablementStatusSummary": { + "com.amazonaws.controltower#GetBaselineOutput": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.controltower#EnablementStatus", + "arn": { + "target": "com.amazonaws.controltower#BaselineArn", "traits": { - "smithy.api#documentation": "

The deployment status of the enabled control.

\n

Valid values:

\n
    \n
  • \n

    \n SUCCEEDED: The enabledControl configuration was deployed successfully.

    \n
    • \n
  • \n

    \n UNDER_CHANGE: The enabledControl configuration is changing.

    \n
    • \n
  • \n

    \n FAILED: The enabledControl configuration failed to deploy.

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

The baseline ARN.

", + "smithy.api#required": {} } }, - "lastOperationIdentifier": { - "target": "com.amazonaws.controltower#OperationIdentifier", + "name": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The last operation identifier for the enabled control.

" + "smithy.api#documentation": "

A user-friendly name for the baseline.

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

A description of the baseline.

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

The deployment summary of the enabled control.

" + "smithy.api#output": {} } }, "com.amazonaws.controltower#GetControlOperation": { @@ -1661,6 +2378,70 @@ } } }, + "com.amazonaws.controltower#GetEnabledBaseline": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#GetEnabledBaselineInput" + }, + "output": { + "target": "com.amazonaws.controltower#GetEnabledBaselineOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieve details of an EnabledBaseline resource by specifying its identifier.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-enabled-baseline" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controltower#GetEnabledBaselineInput": { + "type": "structure", + "members": { + "enabledBaselineIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

Identifier of the EnabledBaseline resource to be retrieved, in ARN format.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#GetEnabledBaselineOutput": { + "type": "structure", + "members": { + "enabledBaselineDetails": { + "target": "com.amazonaws.controltower#EnabledBaselineDetails", + "traits": { + "smithy.api#documentation": "

Details of the EnabledBaseline resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controltower#GetEnabledControl": { "type": "operation", "input": { @@ -1886,7 +2667,7 @@ "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "

The landing zone manifest JSON text file that specifies the landing zone configurations.

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

The landing zone manifest.yaml text file that specifies the landing zone configurations.

", "smithy.api#required": {} } }, @@ -1899,7 +2680,7 @@ "status": { "target": "com.amazonaws.controltower#LandingZoneStatus", "traits": { - "smithy.api#documentation": "

The landing zone deployment status.

" + "smithy.api#documentation": "

The landing zone deployment status. One of ACTIVE, PROCESSING, FAILED.

" } }, "latestAvailableVersion": { @@ -2029,106 +2810,294 @@ "UPDATE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "UPDATE" + "smithy.api#enumValue": "UPDATE" + } + }, + "RESET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESET" + } + } + } + }, + "com.amazonaws.controltower#LandingZoneResource": { + "type": "resource", + "identifiers": { + "landingZoneIdentifier": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.controltower#CreateLandingZone" + }, + "read": { + "target": "com.amazonaws.controltower#GetLandingZone" + }, + "update": { + "target": "com.amazonaws.controltower#UpdateLandingZone" + }, + "delete": { + "target": "com.amazonaws.controltower#DeleteLandingZone" + }, + "list": { + "target": "com.amazonaws.controltower#ListLandingZones" + }, + "operations": [ + { + "target": "com.amazonaws.controltower#ResetLandingZone" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.controltower#GetLandingZoneOperation" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "LandingZone" + } + } + }, + "com.amazonaws.controltower#LandingZoneStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROCESSING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.controltower#LandingZoneSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#LandingZoneSummary" + } + }, + "com.amazonaws.controltower#LandingZoneSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the landing zone.

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

Returns a summary of information about a landing zone.

" + } + }, + "com.amazonaws.controltower#LandingZoneVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 10 + }, + "smithy.api#pattern": "^\\d+.\\d+$" + } + }, + "com.amazonaws.controltower#ListBaselines": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#ListBaselinesInput" + }, + "output": { + "target": "com.amazonaws.controltower#ListBaselinesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a summary list of all available baselines.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-baselines" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "baselines" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controltower#ListBaselinesInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A pagination token.

" } }, - "RESET": { - "target": "smithy.api#Unit", + "maxResults": { + "target": "com.amazonaws.controltower#ListBaselinesMaxResults", "traits": { - "smithy.api#enumValue": "RESET" + "smithy.api#documentation": "

The maximum number of results to be shown.

" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.controltower#LandingZoneResource": { - "type": "resource", - "identifiers": { - "landingZoneIdentifier": { - "target": "smithy.api#String" + "com.amazonaws.controltower#ListBaselinesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 4, + "max": 100 + } + } + }, + "com.amazonaws.controltower#ListBaselinesOutput": { + "type": "structure", + "members": { + "baselines": { + "target": "com.amazonaws.controltower#Baselines", + "traits": { + "smithy.api#documentation": "

A list of Baseline object details.

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

A pagination token.

" + } } }, - "create": { - "target": "com.amazonaws.controltower#CreateLandingZone" - }, - "read": { - "target": "com.amazonaws.controltower#GetLandingZone" - }, - "update": { - "target": "com.amazonaws.controltower#UpdateLandingZone" - }, - "delete": { - "target": "com.amazonaws.controltower#DeleteLandingZone" + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.controltower#ListEnabledBaselines": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#ListEnabledBaselinesInput" }, - "list": { - "target": "com.amazonaws.controltower#ListLandingZones" + "output": { + "target": "com.amazonaws.controltower#ListEnabledBaselinesOutput" }, - "operations": [ + "errors": [ { - "target": "com.amazonaws.controltower#ResetLandingZone" - } - ], - "collectionOperations": [ + "target": "com.amazonaws.controltower#AccessDeniedException" + }, { - "target": "com.amazonaws.controltower#GetLandingZoneOperation" + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" } ], "traits": { - "aws.cloudformation#cfnResource": { - "name": "LandingZone" - } + "smithy.api#documentation": "

Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-enabled-baselines" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "enabledBaselines" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.controltower#LandingZoneStatus": { - "type": "enum", + "com.amazonaws.controltower#ListEnabledBaselinesInput": { + "type": "structure", "members": { - "ACTIVE": { - "target": "smithy.api#Unit", + "filter": { + "target": "com.amazonaws.controltower#EnabledBaselineFilter", "traits": { - "smithy.api#enumValue": "ACTIVE" + "smithy.api#documentation": "

A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.

" } }, - "PROCESSING": { - "target": "smithy.api#Unit", + "nextToken": { + "target": "com.amazonaws.controltower#ListEnabledBaselinesNextToken", "traits": { - "smithy.api#enumValue": "PROCESSING" + "smithy.api#documentation": "

A pagination token.

" } }, - "FAILED": { - "target": "smithy.api#Unit", + "maxResults": { + "target": "com.amazonaws.controltower#ListEnabledBaselinesMaxResults", "traits": { - "smithy.api#enumValue": "FAILED" + "smithy.api#documentation": "

The maximum number of results to be shown.

" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.controltower#LandingZoneSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.controltower#LandingZoneSummary" + "com.amazonaws.controltower#ListEnabledBaselinesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 100 + } } }, - "com.amazonaws.controltower#LandingZoneSummary": { + "com.amazonaws.controltower#ListEnabledBaselinesNextToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S+" + } + }, + "com.amazonaws.controltower#ListEnabledBaselinesOutput": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.controltower#Arn", + "enabledBaselines": { + "target": "com.amazonaws.controltower#EnabledBaselines", "traits": { - "smithy.api#documentation": "

The ARN of the landing zone.

" + "smithy.api#documentation": "

Retuens a list of summaries of EnabledBaseline resources.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.controltower#ListEnabledBaselinesNextToken", + "traits": { + "smithy.api#documentation": "

A pagination token.

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

Returns a summary of information about a landing zone.

" - } - }, - "com.amazonaws.controltower#LandingZoneVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 10 - }, - "smithy.api#pattern": "^\\d+.\\d+$" + "smithy.api#output": {} } }, "com.amazonaws.controltower#ListEnabledControls": { @@ -2399,7 +3368,7 @@ } }, "traits": { - "smithy.api#documentation": "

An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.

\n

The expected Regions are based on the Regions that are governed by the landing zone. In\n certain cases, a control is not actually enabled in the Region as expected, such as during\n drift, or mixed governance.

" + "smithy.api#documentation": "

An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.

\n

The expected Regions are based on the Regions that are governed by the landing zone. In\n certain cases, a control is not actually enabled in the Region as expected, such as during\n drift, or mixed governance.

" } }, "com.amazonaws.controltower#RegionName": { @@ -2411,6 +3380,76 @@ } } }, + "com.amazonaws.controltower#ResetEnabledBaseline": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#ResetEnabledBaselineInput" + }, + "output": { + "target": "com.amazonaws.controltower#ResetEnabledBaselineOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#ConflictException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/reset-enabled-baseline" + } + } + }, + "com.amazonaws.controltower#ResetEnabledBaselineInput": { + "type": "structure", + "members": { + "enabledBaselineIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#ResetEnabledBaselineOutput": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controltower#ResetLandingZone": { "type": "operation", "input": { @@ -2641,7 +3680,7 @@ "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The ID of the service that is associated with the error.\n

" + "smithy.api#documentation": "

The ID of the service that is associated with the error.

" } }, "quotaCode": { @@ -2653,7 +3692,7 @@ "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of seconds to wait before retrying.

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

The number of seconds the caller should wait before retrying.

", "smithy.api#httpHeader": "Retry-After" } } @@ -2732,6 +3771,89 @@ "smithy.api#output": {} } }, + "com.amazonaws.controltower#UpdateEnabledBaseline": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#UpdateEnabledBaselineInput" + }, + "output": { + "target": "com.amazonaws.controltower#UpdateEnabledBaselineOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#ConflictException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an EnabledBaseline resource's applied parameters or version.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/update-enabled-baseline" + } + } + }, + "com.amazonaws.controltower#UpdateEnabledBaselineInput": { + "type": "structure", + "members": { + "baselineVersion": { + "target": "com.amazonaws.controltower#BaselineVersion", + "traits": { + "smithy.api#documentation": "

Specifies the new Baseline version, to which the EnabledBaseline should be updated.

", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.controltower#EnabledBaselineParameters", + "traits": { + "smithy.api#documentation": "

Parameters to apply when making an update.

" + } + }, + "enabledBaselineIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

Specifies the EnabledBaseline resource to be updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#UpdateEnabledBaselineOutput": { + "type": "structure", + "members": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controltower#UpdateEnabledControl": { "type": "operation", "input": { @@ -2859,7 +3981,7 @@ "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "

The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review \n Launch your landing zone.

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

The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review \n The manifest file.

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

The input does not satisfy the constraints specified by an Amazon Web Services service.

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

The input does not satisfy the constraints specified by an Amazon Web Services service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } diff --git a/codegen/sdk/aws-models/lookoutequipment.json b/codegen/sdk/aws-models/lookoutequipment.json index c674a23dd80..c457d0e2101 100644 --- a/codegen/sdk/aws-models/lookoutequipment.json +++ b/codegen/sdk/aws-models/lookoutequipment.json @@ -1585,6 +1585,12 @@ "traits": { "smithy.api#documentation": "

Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.

" } + }, + "ModelDiagnosticsOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#ModelDiagnosticsOutputConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics.\n \n \n You must also specify the RoleArn request parameter.

" + } } }, "traits": { @@ -1657,6 +1663,22 @@ "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Status": "PENDING" } + }, + { + "title": "Creates a retraining scheduler with a specific start date", + "documentation": "", + "input": { + "ModelName": "sample-model", + "RetrainingStartDate": "2024-01-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D", + "ClientToken": "sample-client-token" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "PENDING" + } } ] } @@ -1896,7 +1918,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:dataset\\/.+$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:dataset\\/[0-9a-zA-Z_-]{1,200}\\/.+$" } }, "com.amazonaws.lookoutequipment#DatasetIdentifier": { @@ -2582,7 +2604,7 @@ "IngestedFilesSummary": { "target": "com.amazonaws.lookoutequipment#IngestedFilesSummary", "traits": { - "smithy.api#documentation": "

IngestedFilesSummary associated with the given dataset for the latest successful\n associated ingestion job id.

" + "smithy.api#documentation": "

IngestedFilesSummary associated with the given dataset for the latest successful\n associated ingestion job id.

" } }, "RoleArn": { @@ -3237,6 +3259,12 @@ "traits": { "smithy.api#documentation": "

Indicates the status of the retraining scheduler.

" } + }, + "ModelDiagnosticsOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#ModelDiagnosticsOutputConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for the model's pointwise model diagnostics.

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

Indicates the reason for the AutoPromotionResult. For example, a model\n might not be promoted if its performance was worse than the active version, if there was an\n error during training, or if the retraining scheduler was using MANUAL promote\n mode. The model will be promoted in MANAGED promote mode if the performance is\n better than the previous model.

" } + }, + "ModelDiagnosticsOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#ModelDiagnosticsOutputConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.

" + } + }, + "ModelDiagnosticsResultsObject": { + "target": "com.amazonaws.lookoutequipment#S3Object", + "traits": { + "smithy.api#documentation": "

The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.

" + } } }, "traits": { @@ -4576,7 +4616,7 @@ "SensorsWithShortDateRange": { "target": "com.amazonaws.lookoutequipment#SensorsWithShortDateRange", "traits": { - "smithy.api#documentation": "

Parameter that describes the total number of sensors that have a short date range of\n less than 90 days of data overall.

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

Parameter that describes the total number of sensors that have a short date range of\n less than 14 days of data overall.

", "smithy.api#required": {} } } @@ -5235,7 +5275,7 @@ "InferenceExecutionSummaries": { "target": "com.amazonaws.lookoutequipment#InferenceExecutionSummaries", "traits": { - "smithy.api#documentation": "

Provides an array of information about the individual inference executions returned from\n the ListInferenceExecutions operation, including model used, inference\n scheduler, data configuration, and so on.

" + "smithy.api#documentation": "

Provides an array of information about the individual inference executions returned from\n the ListInferenceExecutions operation, including model used, inference\n scheduler, data configuration, and so on.

\n \n

If you don't supply the InferenceSchedulerName request parameter, or\n if you supply the name of an inference scheduler that doesn't exist,\n ListInferenceExecutions returns an empty array in\n InferenceExecutionSummaries.

\n " } } }, @@ -5446,7 +5486,7 @@ "LabelGroupName": { "target": "com.amazonaws.lookoutequipment#LabelGroupName", "traits": { - "smithy.api#documentation": "

Retruns the name of the label group.

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

Returns the name of the label group.

", "smithy.api#required": {} } }, @@ -5503,7 +5543,7 @@ "LabelSummaries": { "target": "com.amazonaws.lookoutequipment#LabelSummaries", "traits": { - "smithy.api#documentation": "

A summary of the items in the label group.

" + "smithy.api#documentation": "

A summary of the items in the label group.

\n \n

If you don't supply the LabelGroupName request parameter, or if you supply\n the name of a label group that doesn't exist, ListLabels returns an empty array in\n LabelSummaries.

\n " } } }, @@ -5620,7 +5660,7 @@ "ModelVersionSummaries": { "target": "com.amazonaws.lookoutequipment#ModelVersionSummaries", "traits": { - "smithy.api#documentation": "

Provides information on the specified model version, including the created time, model\n and dataset ARNs, and status.

" + "smithy.api#documentation": "

Provides information on the specified model version, including the created time, model\n and dataset ARNs, and status.

\n \n

If you don't supply the ModelName request parameter, or if you supply the name\n of a model that doesn't exist, ListModelVersions returns an empty array in\n ModelVersionSummaries.

\n " } } }, @@ -6055,6 +6095,48 @@ "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+$" } }, + "com.amazonaws.lookoutequipment#ModelDiagnosticsOutputConfiguration": { + "type": "structure", + "members": { + "S3OutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#ModelDiagnosticsS3OutputConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location for the pointwise model diagnostics.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.lookoutequipment#NameOrArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.

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

Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.

" + } + }, + "com.amazonaws.lookoutequipment#ModelDiagnosticsS3OutputConfiguration": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.lookoutequipment#S3Bucket", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.lookoutequipment#S3Prefix", + "traits": { + "smithy.api#documentation": "

The Amazon S3 prefix for the location of the pointwise model diagnostics. The\n prefix specifies the folder and evaluation result file name.\n (bucket).

\n

When you call CreateModel or UpdateModel, specify the path\n within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model\n as a compressed JSON file with the name model_diagnostics_results.json.gz.

\n

When you call DescribeModel or DescribeModelVersion, prefix contains\n the file path and filename of the model evaluation file.

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

The Amazon S3 location for the pointwise model diagnostics for an Amazon Lookout for Equipment model.

" + } + }, "com.amazonaws.lookoutequipment#ModelMetrics": { "type": "string", "traits": { @@ -6206,6 +6288,9 @@ "traits": { "smithy.api#documentation": "

Indicates the status of the retraining scheduler.

" } + }, + "ModelDiagnosticsOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#ModelDiagnosticsOutputConfiguration" } }, "traits": { @@ -6227,7 +6312,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+\\/.+\\/model-version\\/[0-9]{1,}$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/[0-9a-zA-Z_-]{1,200}\\/.+\\/model-version\\/[0-9]{1,}$" } }, "com.amazonaws.lookoutequipment#ModelVersionSourceType": { @@ -6819,7 +6904,7 @@ "AffectedSensorCount": { "target": "com.amazonaws.lookoutequipment#Integer", "traits": { - "smithy.api#documentation": "

Indicates the number of sensors that have less than 90 days of data.

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

Indicates the number of sensors that have less than 14 days of data.

", "smithy.api#required": {} } } @@ -7903,6 +7988,12 @@ "traits": { "smithy.api#documentation": "

The ARN of the model to update.

" } + }, + "ModelDiagnosticsOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#ModelDiagnosticsOutputConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics for the model.\n You must also specify the RoleArn request parameter.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/qbusiness.json b/codegen/sdk/aws-models/qbusiness.json index 324cc5989dd..6ab736fd5ed 100644 --- a/codegen/sdk/aws-models/qbusiness.json +++ b/codegen/sdk/aws-models/qbusiness.json @@ -641,7 +641,7 @@ } }, "traits": { - "smithy.api#documentation": "

Enables filtering of Amazon Q web experience responses based on document\n attributes or metadata fields.

" + "smithy.api#documentation": "

Enables filtering of responses based on document attributes or metadata fields.

" } }, "com.amazonaws.qbusiness#AttributeFilters": { @@ -964,6 +964,15 @@ "smithy.api#documentation": "

Updates a blocked phrases configuration in your Amazon Q application.

" } }, + "com.amazonaws.qbusiness#BoostingDurationInSeconds": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 999999999 + } + } + }, "com.amazonaws.qbusiness#ChatSync": { "type": "operation", "input": { @@ -1623,7 +1632,7 @@ "qbusiness:TagResource", "qbusiness:ListTagsForResource" ], - "smithy.api#documentation": "

Creates an Amazon Q index.

\n

To determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.

\n

Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.

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

Creates an Amazon Q index.

\n

To determine if index creation has completed, check the Status field\n returned from a call to DescribeIndex. The Status field is set\n to ACTIVE when the index is ready to use.

\n

Once the index is active, you can index your documents using the \n BatchPutDocument\n API or the \n CreateDataSource\n API.

", "smithy.api#http": { "uri": "/applications/{applicationId}/indices", "method": "POST" @@ -2497,6 +2506,27 @@ "target": "com.amazonaws.qbusiness#DataSource" } }, + "com.amazonaws.qbusiness#DateAttributeBoostingConfiguration": { + "type": "structure", + "members": { + "boostingLevel": { + "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel", + "traits": { + "smithy.api#documentation": "

Specifies how much a document attribute is boosted.

", + "smithy.api#required": {} + } + }, + "boostingDurationInSeconds": { + "target": "com.amazonaws.qbusiness#BoostingDurationInSeconds", + "traits": { + "smithy.api#documentation": "

Specifies the duration, in seconds, of a boost applies to a DATE type\n document attribute.

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

Provides information on boosting DATE type document attributes.

\n

For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.

" + } + }, "com.amazonaws.qbusiness#DeleteApplication": { "type": "operation", "input": { @@ -3313,6 +3343,87 @@ "smithy.api#documentation": "

A document attribute or metadata field.

" } }, + "com.amazonaws.qbusiness#DocumentAttributeBoostingConfiguration": { + "type": "union", + "members": { + "numberConfiguration": { + "target": "com.amazonaws.qbusiness#NumberAttributeBoostingConfiguration", + "traits": { + "smithy.api#documentation": "

Provides information on boosting NUMBER type document attributes.

" + } + }, + "stringConfiguration": { + "target": "com.amazonaws.qbusiness#StringAttributeBoostingConfiguration", + "traits": { + "smithy.api#documentation": "

Provides information on boosting STRING type document attributes.

" + } + }, + "dateConfiguration": { + "target": "com.amazonaws.qbusiness#DateAttributeBoostingConfiguration", + "traits": { + "smithy.api#documentation": "

Provides information on boosting DATE type document attributes.

" + } + }, + "stringListConfiguration": { + "target": "com.amazonaws.qbusiness#StringListAttributeBoostingConfiguration", + "traits": { + "smithy.api#documentation": "

Provides information on boosting STRING_LIST type document\n attributes.

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

Provides information on boosting supported Amazon Q document attribute types.\n When an end user chat query matches document attributes that have been boosted,\n Amazon Q prioritizes generating responses from content that matches the boosted\n document attributes.

\n \n

For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.

\n \n

For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.

" + } + }, + "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "VERY_HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERY_HIGH" + } + } + } + }, + "com.amazonaws.qbusiness#DocumentAttributeBoostingOverrideMap": { + "type": "map", + "key": { + "target": "com.amazonaws.qbusiness#DocumentAttributeKey" + }, + "value": { + "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.qbusiness#DocumentAttributeCondition": { "type": "structure", "members": { @@ -3335,7 +3446,7 @@ } }, "traits": { - "smithy.api#documentation": "

The condition used for the target document attribute or metadata field when ingesting\n documents into Amazon Q. You use this with \n DocumentAttributeTarget\n to apply the condition.

\n

For example, you can create the 'Department' target field and have it prefill\n department names associated with the documents based on information in the 'Source_URI'\n field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI\n value, then prefill the target field 'Department' with the target value 'Finance' for\n the document.

\n

Amazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using DocumentAttributeTarget. Amazon Q then will map your newly\n created metadata field to your index field.

" + "smithy.api#documentation": "

The condition used for the target document attribute or metadata field when ingesting\n documents into Amazon Q. You use this with \n DocumentAttributeTarget\n to apply the condition.

\n

For example, you can create the 'Department' target field and have it prefill\n department names associated with the documents based on information in the 'Source_URI'\n field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI\n value, then prefill the target field 'Department' with the target value 'Finance' for\n the document.

\n

Amazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using DocumentAttributeTarget. Amazon Q then will map your newly\n created metadata field to your index field.

" } }, "com.amazonaws.qbusiness#DocumentAttributeConfiguration": { @@ -3421,7 +3532,7 @@ } }, "traits": { - "smithy.api#documentation": "

The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Q.

\n

For example, you can delete all customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID' by setting the\n target key as 'Customer_ID' and the deletion flag to TRUE. This removes all\n customer ID values in the field 'Customer_ID'. This would scrub personally identifiable\n information from each document's metadata.

\n

Amazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using \n DocumentAttributeTarget\n . Amazon Q\n will then map your newly created document attribute to your index field.

\n

You can also use this with \n DocumentAttributeCondition\n .

" + "smithy.api#documentation": "

The target document attribute or metadata field you want to alter when ingesting\n documents into Amazon Q.

\n

For example, you can delete all customer identification numbers associated with the\n documents, stored in the document metadata field called 'Customer_ID' by setting the\n target key as 'Customer_ID' and the deletion flag to TRUE. This removes all\n customer ID values in the field 'Customer_ID'. This would scrub personally identifiable\n information from each document's metadata.

\n

Amazon Q can't create a target field if it has not already been created as an\n index field. After you create your index field, you can create a document metadata field\n using \n DocumentAttributeTarget\n . Amazon Q\n will then map your newly created document attribute to your index field.

\n

You can also use this with \n DocumentAttributeCondition\n .

" } }, "com.amazonaws.qbusiness#DocumentAttributeValue": { @@ -3950,7 +4061,7 @@ "h2" ] }, - "smithy.api#documentation": "

\n

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

Amazon Q is in preview release and is subject to change.

\n \n

This is the Amazon Q (for business use) API Reference.\n Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that\n you can deploy within your organization. Amazon Q enhances employee productivity by\n supporting key tasks such as question-answering, knowledge discovery, writing email\n messages, summarizing text, drafting document outlines, and brainstorming ideas. Users\n ask questions of Amazon Q and get answers that are presented in a conversational\n manner. For an introduction to the service, see the \n Amazon Q (for business use) Developer\n Guide\n .

\n

For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations.

\n

For information about the IAM access control permissions you need to\n use this API, see IAM roles for Amazon Q in the\n Amazon Q (for business use) Developer Guide.

\n

You can use the following AWS SDKs to access Amazon Q APIs:

\n \n

The following resources provide additional information about using the Amazon Q\n API:

\n ", "smithy.api#title": "QBusiness", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -5598,7 +5709,7 @@ "lambdaArn": { "target": "com.amazonaws.qbusiness#LambdaArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to run a Lambda\n function during ingestion. For more information, see IAM roles for Custom\n Document Enrichment (CDE).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role with permission to run a Lambda\n function during ingestion. For more information, see IAM roles for\n Custom Document Enrichment (CDE).

" } }, "s3BucketName": { @@ -5615,7 +5726,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q.

\n

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.

\n

If you want to apply advanced alterations on the Amazon Q structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.

\n

You can only invoke one Lambda function. However, this function can invoke\n other functions it requires.

\n

For more information, see Custom document enrichment.

" + "smithy.api#documentation": "

Provides the configuration information for invoking a Lambda function in\n Lambda to alter document metadata and content when ingesting\n documents into Amazon Q.

\n

You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on\n the original or raw documents.

\n

If you want to apply advanced alterations on the Amazon Q structured documents,\n you must configure your Lambda function using PostExtractionHookConfiguration.

\n

You can only invoke one Lambda function. However, this function can invoke\n other functions it requires.

\n

For more information, see Custom document enrichment.

" } }, "com.amazonaws.qbusiness#Index": { @@ -5832,7 +5943,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Q.

\n

To apply advanced logic, to go beyond what you can do with basic logic, see \n HookConfiguration\n .

\n

For more information, see Custom document enrichment.

" + "smithy.api#documentation": "

Provides the configuration information for applying basic logic to alter document\n metadata and content when ingesting documents into Amazon Q.

\n

To apply advanced logic, to go beyond what you can do with basic logic, see \n HookConfiguration\n .

\n

For more information, see Custom document enrichment.

" } }, "com.amazonaws.qbusiness#InlineDocumentEnrichmentConfigurations": { @@ -7495,6 +7606,30 @@ "traits": { "smithy.api#enumValue": "HELPFUL" } + }, + "NOT_BASED_ON_DOCUMENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_BASED_ON_DOCUMENTS" + } + }, + "NOT_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_COMPLETE" + } + }, + "NOT_CONCISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONCISE" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } } } }, @@ -7519,6 +7654,12 @@ "smithy.api#documentation": "

The identifier for the Amazon Q index.

", "smithy.api#required": {} } + }, + "boostingOverride": { + "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingOverrideMap", + "traits": { + "smithy.api#documentation": "

Overrides the default boosts applied by Amazon Q to supported document attribute\n data types.

" + } } }, "traits": { @@ -7534,6 +7675,44 @@ } } }, + "com.amazonaws.qbusiness#NumberAttributeBoostingConfiguration": { + "type": "structure", + "members": { + "boostingLevel": { + "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel", + "traits": { + "smithy.api#documentation": "

Specifies the duration, in seconds, of a boost applies to a NUMBER type\n document attribute.

", + "smithy.api#required": {} + } + }, + "boostingType": { + "target": "com.amazonaws.qbusiness#NumberAttributeBoostingType", + "traits": { + "smithy.api#documentation": "

Specifies how much a document attribute is boosted.

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

Provides information on boosting NUMBER type document attributes.

\n

For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.

" + } + }, + "com.amazonaws.qbusiness#NumberAttributeBoostingType": { + "type": "enum", + "members": { + "PRIORITIZE_LARGER_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITIZE_LARGER_VALUES" + } + }, + "PRIORITIZE_SMALLER_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITIZE_SMALLER_VALUES" + } + } + } + }, "com.amazonaws.qbusiness#OAuth2ClientCredentialConfiguration": { "type": "structure", "members": { @@ -8259,7 +8438,7 @@ "ruleType": { "target": "com.amazonaws.qbusiness#RuleType", "traits": { - "smithy.api#documentation": "

The type fo rule.

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

The type of rule.

", "smithy.api#required": {} } }, @@ -8713,6 +8892,86 @@ } } }, + "com.amazonaws.qbusiness#StringAttributeBoostingConfiguration": { + "type": "structure", + "members": { + "boostingLevel": { + "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel", + "traits": { + "smithy.api#documentation": "

Specifies how much a document attribute is boosted.

", + "smithy.api#required": {} + } + }, + "attributeValueBoosting": { + "target": "com.amazonaws.qbusiness#StringAttributeValueBoosting", + "traits": { + "smithy.api#documentation": "

Specifies specific values of a STRING type document attribute being\n boosted.

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

Provides information on boosting STRING type document attributes.

\n \n

For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.

\n \n

For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.

" + } + }, + "com.amazonaws.qbusiness#StringAttributeValueBoosting": { + "type": "map", + "key": { + "target": "com.amazonaws.qbusiness#String" + }, + "value": { + "target": "com.amazonaws.qbusiness#StringAttributeValueBoostingLevel" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.qbusiness#StringAttributeValueBoostingLevel": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "VERY_HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERY_HIGH" + } + } + } + }, + "com.amazonaws.qbusiness#StringListAttributeBoostingConfiguration": { + "type": "structure", + "members": { + "boostingLevel": { + "target": "com.amazonaws.qbusiness#DocumentAttributeBoostingLevel", + "traits": { + "smithy.api#documentation": "

Specifies how much a document attribute is boosted.

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

Provides information on boosting STRING_LIST type document\n attributes.

\n \n

For STRING and STRING_LIST type document attributes to\n be used for boosting on the console and the API, they must be enabled for search\n using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes,\n you can't boost attributes of these data types on either the console or the\n API.

\n \n

For more information on how boosting document attributes work in Amazon Q, see\n Boosting using document attributes.

" + } + }, "com.amazonaws.qbusiness#SubnetId": { "type": "string", "traits": { @@ -8975,7 +9234,7 @@ "description": { "target": "com.amazonaws.qbusiness#TopicDescription", "traits": { - "smithy.api#documentation": "

A description for your topic control configuration. Use this outline how the large\n language model (LLM) should use this topic control configuration.

" + "smithy.api#documentation": "

A description for your topic control configuration. Use this to outline how the large\n language model (LLM) should use this topic control configuration.

" } }, "exampleChatMessages": { From 0b1d42313f0d4c4871e246d2e5ce9ab2b0bc82c3 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 14 Feb 2024 19:05:12 +0000 Subject: [PATCH 30/32] feat: update AWS service endpoints metadata --- .../aws/sdk/kotlin/codegen/endpoints.json | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json index 8ed378172ba..4a8041be452 100644 --- a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json +++ b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json @@ -11569,9 +11569,12 @@ "endpoints" : { "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-4" : { }, + "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, "eu-west-1" : { }, @@ -13288,6 +13291,13 @@ } } }, + "private-networks" : { + "endpoints" : { + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "profile" : { "endpoints" : { "af-south-1" : { }, @@ -26236,6 +26246,16 @@ } } }, + "api.pricing" : { + "defaults" : { + "credentialScope" : { + "service" : "pricing" + } + }, + "endpoints" : { + "us-iso-east-1" : { } + } + }, "api.sagemaker" : { "endpoints" : { "us-iso-east-1" : { } @@ -26267,6 +26287,11 @@ "us-iso-west-1" : { } } }, + "arc-zonal-shift" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, "athena" : { "endpoints" : { "us-iso-east-1" : { } @@ -27046,6 +27071,16 @@ } } }, + "api.pricing" : { + "defaults" : { + "credentialScope" : { + "service" : "pricing" + } + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, "api.sagemaker" : { "endpoints" : { "us-isob-east-1" : { } @@ -27069,6 +27104,11 @@ "us-isob-east-1" : { } } }, + "arc-zonal-shift" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, "autoscaling" : { "defaults" : { "protocols" : [ "http", "https" ] From b468f8dfb3f5692787651164073fd525af8cc363 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 14 Feb 2024 19:08:09 +0000 Subject: [PATCH 31/32] chore: release 1.0.57 --- CHANGELOG.md | 7 +++++++ gradle.properties | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e600a5bee45..ce704b36dff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [1.0.57] - 02/14/2024 + +### Features +* (**controltower**) Adds support for new Baseline and EnabledBaseline APIs for automating multi-account governance. +* (**lookoutequipment**) This feature allows customers to see pointwise model diagnostics results for their models. +* (**qbusiness**) This release adds the metadata-boosting feature, which allows customers to easily fine-tune the underlying ranking of retrieved RAG passages in order to optimize Q&A answer relevance. It also adds new feedback reasons for the PutFeedback API. + ## [1.0.56] - 02/13/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 7cd9d9720d7..6f8e26692fa 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.57-SNAPSHOT +sdkVersion=1.0.57 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 65cfa1d3ab6be98d3e2aaf50acda971fc3395c47 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 14 Feb 2024 19:08:10 +0000 Subject: [PATCH 32/32] chore: bump snapshot version to 1.0.58-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 6f8e26692fa..9f0ba7cdfce 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.0.57 +sdkVersion=1.0.58-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/