From fc48b40451e3153395c816175a8e8b9fbddd72b2 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 28 May 2024 18:03:42 +0000 Subject: [PATCH 01/41] feat: update AWS API models --- codegen/sdk/aws-models/dynamodb.json | 2 +- codegen/sdk/aws-models/ec2.json | 22 +++++- codegen/sdk/aws-models/kafka.json | 22 ++++++ codegen/sdk/aws-models/swf.json | 110 ++++++++++++++++++++++++++- 4 files changed, 150 insertions(+), 6 deletions(-) diff --git a/codegen/sdk/aws-models/dynamodb.json b/codegen/sdk/aws-models/dynamodb.json index 03dbda2a48d..5768b76c66b 100644 --- a/codegen/sdk/aws-models/dynamodb.json +++ b/codegen/sdk/aws-models/dynamodb.json @@ -2209,7 +2209,7 @@ "ResourcePolicy": { "target": "com.amazonaws.dynamodb#ResourcePolicy", "traits": { - "smithy.api#documentation": "

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

\n

When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

\n

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

" + "smithy.api#documentation": "

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

\n

When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

\n

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

\n \n

You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

\n
" } }, "OnDemandThroughput": { diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 0d83caf5624..1819002c68c 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -14667,7 +14667,7 @@ "BgpAsn": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

For devices that support BGP, the customer gateway's BGP ASN.

\n

Default: 65000

" + "smithy.api#documentation": "

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

\n

Default: 65000

\n

Valid values: 1 to 2,147,483,647\n

" } }, "PublicIp": { @@ -14706,7 +14706,7 @@ "IpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

\n IPv4 address for the customer gateway device's outside interface. The address must be static.\n

" + "smithy.api#documentation": "

IPv4 address for the customer gateway device's outside interface. The address must be\n static. If OutsideIpAddressType in your VPN connection options is set to\n PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If\n OutsideIpAddressType is set to PublicIpv4, you can use a\n public IPv4 address.

" } }, "DryRun": { @@ -14716,6 +14716,12 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } + }, + "BgpAsnExtended": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

\n

Valid values: 2,147,483,648 to 4,294,967,295\n

" + } } }, "traits": { @@ -21804,7 +21810,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "BgpAsn", - "smithy.api#documentation": "

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

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

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

\n

Valid values: 1 to 2,147,483,647\n

", "smithy.api#xmlName": "bgpAsn" } }, @@ -21820,7 +21826,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

The IP address of the customer gateway device's outside interface.

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

\n IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.\n

", "smithy.api#xmlName": "ipAddress" } }, @@ -21863,6 +21869,14 @@ "smithy.api#documentation": "

Any tags assigned to the customer gateway.

", "smithy.api#xmlName": "tagSet" } + }, + "BgpAsnExtended": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "BgpAsnExtended", + "smithy.api#documentation": "

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

\n

Valid values: 2,147,483,648 to 4,294,967,295\n

", + "smithy.api#xmlName": "bgpAsnExtended" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/kafka.json b/codegen/sdk/aws-models/kafka.json index 65ee60230cd..32392e8209a 100644 --- a/codegen/sdk/aws-models/kafka.json +++ b/codegen/sdk/aws-models/kafka.json @@ -1523,6 +1523,21 @@ "smithy.api#documentation": "

Details about consumer group replication.

" } }, + "com.amazonaws.kafka#ControllerNodeInfo": { + "type": "structure", + "members": { + "Endpoints": { + "target": "com.amazonaws.kafka#__listOf__string", + "traits": { + "smithy.api#documentation": "

Endpoints for accessing the Controller.

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

Controller node information.

" + } + }, "com.amazonaws.kafka#CreateCluster": { "type": "operation", "input": { @@ -6461,6 +6476,13 @@ "smithy.api#jsonName": "brokerNodeInfo" } }, + "ControllerNodeInfo": { + "target": "com.amazonaws.kafka#ControllerNodeInfo", + "traits": { + "smithy.api#documentation": "

The ControllerNodeInfo.

", + "smithy.api#jsonName": "controllerNodeInfo" + } + }, "InstanceType": { "target": "com.amazonaws.kafka#__string", "traits": { diff --git a/codegen/sdk/aws-models/swf.json b/codegen/sdk/aws-models/swf.json index b0015da3d10..03d54ccf9cf 100644 --- a/codegen/sdk/aws-models/swf.json +++ b/codegen/sdk/aws-models/swf.json @@ -1847,6 +1847,96 @@ "smithy.api#error": "client" } }, + "com.amazonaws.swf#DeleteActivityType": { + "type": "operation", + "input": { + "target": "com.amazonaws.swf#DeleteActivityTypeInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.swf#OperationNotPermittedFault" + }, + { + "target": "com.amazonaws.swf#TypeNotDeprecatedFault" + }, + { + "target": "com.amazonaws.swf#UnknownResourceFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified activity type.

\n

Note: Prior to deletion, activity types must first be deprecated.

\n

\n After an activity type has been deleted, you cannot schedule new activities of that type. Activities that started before the type was deleted will continue to run.\n

\n

\n Access Control\n

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.

" + } + }, + "com.amazonaws.swf#DeleteActivityTypeInput": { + "type": "structure", + "members": { + "domain": { + "target": "com.amazonaws.swf#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain in which the activity type is registered.

", + "smithy.api#required": {} + } + }, + "activityType": { + "target": "com.amazonaws.swf#ActivityType", + "traits": { + "smithy.api#documentation": "

The activity type to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.swf#DeleteWorkflowType": { + "type": "operation", + "input": { + "target": "com.amazonaws.swf#DeleteWorkflowTypeInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.swf#OperationNotPermittedFault" + }, + { + "target": "com.amazonaws.swf#TypeNotDeprecatedFault" + }, + { + "target": "com.amazonaws.swf#UnknownResourceFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified workflow type.

\n

Note: Prior to deletion, workflow types must first be deprecated.

\n

\n After a workflow type has been deleted, you cannot create new executions of that type. Executions that\n started before the type was deleted will continue to run.\n

\n

\n Access Control\n

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.

" + } + }, + "com.amazonaws.swf#DeleteWorkflowTypeInput": { + "type": "structure", + "members": { + "domain": { + "target": "com.amazonaws.swf#DomainName", + "traits": { + "smithy.api#documentation": "

The name of the domain in which the workflow type is registered.

", + "smithy.api#required": {} + } + }, + "workflowType": { + "target": "com.amazonaws.swf#WorkflowType", + "traits": { + "smithy.api#documentation": "

The workflow type to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.swf#DeprecateActivityType": { "type": "operation", "input": { @@ -1867,7 +1957,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deprecates the specified activity type. After an activity type has\n been deprecated, you cannot create new tasks of that activity type. Tasks of this type that\n were scheduled before the type was deprecated continue to run.

\n \n

This operation is eventually consistent. The results are best effort and may not\n exactly reflect recent updates and changes.

\n
\n

\n Access Control\n

\n

You can use IAM policies to control this action's access to Amazon SWF resources as\n follows:

\n \n

If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.

" + "smithy.api#documentation": "

Deprecates the specified activity type. After an activity type has\n been deprecated, you cannot create new tasks of that activity type. Tasks of this type that\n were scheduled before the type was deprecated continue to run.

\n

\n Access Control\n

\n

You can use IAM policies to control this action's access to Amazon SWF resources as\n follows:

\n \n

If the caller doesn't have sufficient permissions to invoke the action, or the\n parameter values fall outside the specified constraints, the action fails. The associated\n event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.\n For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF\n Workflows in the Amazon SWF Developer Guide.

" } }, "com.amazonaws.swf#DeprecateActivityTypeInput": { @@ -5580,6 +5670,12 @@ { "target": "com.amazonaws.swf#CountPendingDecisionTasks" }, + { + "target": "com.amazonaws.swf#DeleteActivityType" + }, + { + "target": "com.amazonaws.swf#DeleteWorkflowType" + }, { "target": "com.amazonaws.swf#DeprecateActivityType" }, @@ -7577,6 +7673,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.swf#TypeNotDeprecatedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.swf#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Returned when the resource type has not been deprecated.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.swf#UndeprecateActivityType": { "type": "operation", "input": { From 70145fbc1f17a74498f31d6fafb14aea53aaf786 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 28 May 2024 18:03:42 +0000 Subject: [PATCH 02/41] feat: update AWS service endpoints metadata --- .../resources/aws/sdk/kotlin/codegen/endpoints.json | 11 +++++------ 1 file changed, 5 insertions(+), 6 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 998cfec67fb..124642e23cd 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 @@ -8953,11 +8953,6 @@ "us-west-2" : { } } }, - "honeycode" : { - "endpoints" : { - "us-west-2" : { } - } - }, "iam" : { "endpoints" : { "aws-global" : { @@ -28922,7 +28917,11 @@ "partition" : "aws-iso-e", "partitionName" : "AWS ISOE (Europe)", "regionRegex" : "^eu\\-isoe\\-\\w+\\-\\d+$", - "regions" : { }, + "regions" : { + "eu-isoe-west-1" : { + "description" : "EU ISOE West" + } + }, "services" : { } }, { "defaults" : { From 03089b7b1e670849f0c6745e2c396f20e9dc83ee Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 28 May 2024 18:06:38 +0000 Subject: [PATCH 03/41] chore: release 1.2.21 --- CHANGELOG.md | 10 ++++++++++ gradle.properties | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 10a4619e3ef..e9541a97221 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## [1.2.21] - 05/28/2024 + +### Features +* (**ec2**) Providing support to accept BgpAsnExtended attribute +* (**kafka**) Adds ControllerNodeInfo in ListNodes response to support Raft mode for MSK +* (**swf**) This release adds new APIs for deleting activity type and workflow type resources. + +### Documentation +* (**dynamodb**) Doc-only update for DynamoDB. Specified the IAM actions needed to authorize a user to create a table with a resource-based policy. + ## [1.2.20] - 05/24/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 5f79f9fcded..ba8092a9ae1 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.2.21-SNAPSHOT +sdkVersion=1.2.21 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 4a8943685c1f5f71097f766a9c0d36877b31a746 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 28 May 2024 18:06:39 +0000 Subject: [PATCH 04/41] chore: bump snapshot version to 1.2.22-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index ba8092a9ae1..d24036e44e9 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.2.21 +sdkVersion=1.2.22-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 8b643e49bdea15c1b4205ecd996e9d94962a23b7 Mon Sep 17 00:00:00 2001 From: Ian Botsford <83236726+ianbotsf@users.noreply.github.com> Date: Wed, 29 May 2024 17:26:31 +0200 Subject: [PATCH 05/41] chore: bump smithy-kotlin version (#1319) --- gradle/libs.versions.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 87a87e8c15b..f4b6760efa3 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.2.4" -smithy-kotlin-codegen-version = "0.32.4" +smithy-kotlin-runtime-version = "1.2.5" +smithy-kotlin-codegen-version = "0.32.5" # codegen smithy-version = "1.47.0" From 176e69c8085cd3b0f00c4cdbcbedca1f05e43d21 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 29 May 2024 18:06:28 +0000 Subject: [PATCH 06/41] feat: update AWS API models --- codegen/sdk/aws-models/athena.json | 16 +- codegen/sdk/aws-models/codebuild.json | 18 +- codegen/sdk/aws-models/connect.json | 621 +++++++++++++++++++++++- codegen/sdk/aws-models/glue.json | 47 ++ codegen/sdk/aws-models/securityhub.json | 6 + 5 files changed, 692 insertions(+), 16 deletions(-) diff --git a/codegen/sdk/aws-models/athena.json b/codegen/sdk/aws-models/athena.json index e4d668b23c8..d6684867223 100644 --- a/codegen/sdk/aws-models/athena.json +++ b/codegen/sdk/aws-models/athena.json @@ -4188,7 +4188,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns query execution runtime statistics related to a single execution of a query if\n you have access to the workgroup in which the query ran. Query execution runtime\n statistics are returned only when QueryExecutionStatus$State is in a\n SUCCEEDED or FAILED state. Stage-level input and output row count and data size\n statistics are not shown when a query has row-level filters defined in Lake\n Formation.

" + "smithy.api#documentation": "

Returns query execution runtime statistics related to a single execution of a query if\n you have access to the workgroup in which the query ran. Statistics from the\n Timeline section of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The\n remaining non-timeline statistics in the response (like stage-level input and output row\n count and data size) are updated asynchronously and may not be available immediately\n after a query completes. The non-timeline statistics are also not included when a query\n has row-level filters defined in Lake Formation.

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

Imports a single ipynb file to a Spark enabled workgroup. To import the\n notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an\n InvalidRequestException occurs. The maximum file size that can be imported is 10\n megabytes. If an ipynb file with the same name already exists in the\n workgroup, throws an error.

" + "smithy.api#documentation": "

Imports a single ipynb file to a Spark enabled workgroup. To import the\n notebook, the request must specify a value for either Payload or\n NoteBookS3LocationUri. If neither is specified or both are specified,\n an InvalidRequestException occurs. The maximum file size that can be\n imported is 10 megabytes. If an ipynb file with the same name already\n exists in the workgroup, throws an error.

" } }, "com.amazonaws.athena#ImportNotebookInput": { @@ -4591,7 +4591,7 @@ "Payload": { "target": "com.amazonaws.athena#Payload", "traits": { - "smithy.api#documentation": "

The notebook content to be imported. The payload must be in ipynb format.

" + "smithy.api#documentation": "

The notebook content to be imported. The payload must be in ipynb\n format.

" } }, "Type": { @@ -4604,7 +4604,7 @@ "NotebookS3LocationUri": { "target": "com.amazonaws.athena#S3Uri", "traits": { - "smithy.api#documentation": "

A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

" + "smithy.api#documentation": "

A URI that specifies the Amazon S3 location of a notebook file in\n ipynb format.

" } }, "ClientRequestToken": { @@ -6212,7 +6212,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]+$" + "smithy.api#pattern": "^(?!.*[/:\\\\])[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]+$" } }, "com.amazonaws.athena#NotebookSessionSummary": { @@ -6950,7 +6950,7 @@ "OutputLocation": { "target": "com.amazonaws.athena#ResultOutputLocation", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your query and calculation results are stored,\n such as s3://path/to/query/bucket/. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Working with query\n results, recent queries, and output files. If workgroup settings override\n client-side settings, then the query uses the settings specified for the workgroup. See\n WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The location in Amazon S3 where your query and calculation results are stored,\n such as s3://path/to/query/bucket/. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena\n issues an error that no output location is provided. If workgroup settings override\n client-side settings, then the query uses the settings specified for the workgroup. See\n WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" } }, "EncryptionConfiguration": { @@ -6982,7 +6982,7 @@ "OutputLocation": { "target": "com.amazonaws.athena#ResultOutputLocation", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where your query and calculation results are stored,\n such as s3://path/to/query/bucket/. For more information, see Working with query\n results, recent queries, and output files. If workgroup settings override\n client-side settings, then the query uses the location for the query results and the\n encryption configuration that are specified for the workgroup. The \"workgroup settings\n override\" is specified in EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + "smithy.api#documentation": "

The location in Amazon S3 where your query and calculation results are stored,\n such as s3://path/to/query/bucket/. If workgroup settings override\n client-side settings, then the query uses the location for the query results and the\n encryption configuration that are specified for the workgroup. The \"workgroup settings\n override\" is specified in EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

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

The configuration for the workgroup, which includes the location in Amazon S3\n where query and calculation results are stored and the encryption option, if any, used\n for query and calculation results. To run the query, you must specify the query results\n location using one of the ways: either in the workgroup using this setting, or for\n individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more\n information, see Working with query results, recent queries, and output files.

" + "smithy.api#documentation": "

The configuration for the workgroup, which includes the location in Amazon S3\n where query and calculation results are stored and the encryption option, if any, used\n for query and calculation results. To run the query, you must specify the query results\n location using one of the ways: either in the workgroup using this setting, or for\n individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided.

" } }, "EnforceWorkGroupConfiguration": { diff --git a/codegen/sdk/aws-models/codebuild.json b/codegen/sdk/aws-models/codebuild.json index 7ad76194094..ed74781a2b9 100644 --- a/codegen/sdk/aws-models/codebuild.json +++ b/codegen/sdk/aws-models/codebuild.json @@ -2899,7 +2899,7 @@ "fleetServiceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The service role associated with the compute fleet.

" + "smithy.api#documentation": "

The service role associated with the compute fleet. For more information, see \n Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.

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

Specifies the type of build this webhook will trigger.

" } + }, + "manualCreation": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and \n secret values for the webhook. The payloadUrl and secret values in the output can be \n used to manually create a webhook within GitHub.

\n \n

manualCreation is only available for GitHub webhooks.

\n
" + } } }, "traits": { @@ -4118,7 +4124,7 @@ "fleetServiceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The service role associated with the compute fleet.

" + "smithy.api#documentation": "

The service role associated with the compute fleet. For more information, see \n Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.

" } }, "tags": { @@ -8487,7 +8493,7 @@ "fleetServiceRole": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { - "smithy.api#documentation": "

The service role associated with the compute fleet.

" + "smithy.api#documentation": "

The service role associated with the compute fleet. For more information, see \n Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.

" } }, "tags": { @@ -8964,6 +8970,12 @@ "smithy.api#documentation": "

Specifies the type of build this webhook will trigger.

" } }, + "manualCreation": { + "target": "com.amazonaws.codebuild#WrapperBoolean", + "traits": { + "smithy.api#documentation": "

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and \n secret values for the webhook. The payloadUrl and secret values in the output can \n be used to manually create a webhook within GitHub.

\n \n

manualCreation is only available for GitHub webhooks.

\n
" + } + }, "lastModifiedSecret": { "target": "com.amazonaws.codebuild#Timestamp", "traits": { diff --git a/codegen/sdk/aws-models/connect.json b/codegen/sdk/aws-models/connect.json index 480801937dc..f607dec1042 100644 --- a/codegen/sdk/aws-models/connect.json +++ b/codegen/sdk/aws-models/connect.json @@ -326,6 +326,20 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.connect#AgentHierarchyGroup": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the group.

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

Information about an agent hierarchy group.

" + } + }, "com.amazonaws.connect#AgentHierarchyGroups": { "type": "structure", "members": { @@ -384,6 +398,21 @@ "traits": { "smithy.api#documentation": "

Agent pause duration for a contact in seconds.

" } + }, + "HierarchyGroups": { + "target": "com.amazonaws.connect#HierarchyGroups", + "traits": { + "smithy.api#documentation": "

The agent hierarchy groups for the agent.

" + } + }, + "DeviceInfo": { + "target": "com.amazonaws.connect#DeviceInfo", + "traits": { + "smithy.api#documentation": "

Information regarding Agent’s device.

" + } + }, + "Capabilities": { + "target": "com.amazonaws.connect#ParticipantCapabilities" } }, "traits": { @@ -408,6 +437,20 @@ } } }, + "com.amazonaws.connect#AgentQualityMetrics": { + "type": "structure", + "members": { + "Audio": { + "target": "com.amazonaws.connect#AudioQualityMetricsInfo", + "traits": { + "smithy.api#documentation": "

Information about the audio quality of the Agent

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

Information about the quality of the Agent's media connection

" + } + }, "com.amazonaws.connect#AgentResourceId": { "type": "string", "traits": { @@ -2359,6 +2402,95 @@ "smithy.api#documentation": "

Configuration of the answering machine detection.

" } }, + "com.amazonaws.connect#AnsweringMachineDetectionStatus": { + "type": "enum", + "members": { + "ANSWERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANSWERED" + } + }, + "UNDETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNDETECTED" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "HUMAN_ANSWERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HUMAN_ANSWERED" + } + }, + "SIT_TONE_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIT_TONE_DETECTED" + } + }, + "SIT_TONE_BUSY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIT_TONE_BUSY" + } + }, + "SIT_TONE_INVALID_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIT_TONE_INVALID_NUMBER" + } + }, + "FAX_MACHINE_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAX_MACHINE_DETECTED" + } + }, + "VOICEMAIL_BEEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOICEMAIL_BEEP" + } + }, + "VOICEMAIL_NO_BEEP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VOICEMAIL_NO_BEEP" + } + }, + "AMD_UNRESOLVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMD_UNRESOLVED" + } + }, + "AMD_UNANSWERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMD_UNANSWERED" + } + }, + "AMD_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMD_ERROR" + } + }, + "AMD_NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMD_NOT_APPLICABLE" + } + } + } + }, "com.amazonaws.connect#Application": { "type": "structure", "members": { @@ -3680,6 +3812,38 @@ "smithy.api#documentation": "

A list of conditions which would be applied together with an AND\n condition.

" } }, + "com.amazonaws.connect#AttributeCondition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#PredefinedAttributeName", + "traits": { + "smithy.api#documentation": "

The name of predefined attribute.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ProficiencyValue", + "traits": { + "smithy.api#documentation": "

The value of predefined attribute.

" + } + }, + "ProficiencyLevel": { + "target": "com.amazonaws.connect#ProficiencyLevel", + "traits": { + "smithy.api#documentation": "

The proficiency level of the condition.

" + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.connect#ComparisonOperator", + "traits": { + "smithy.api#documentation": "

The operator of the condition.

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

An object to specify the predefined attribute condition.

" + } + }, "com.amazonaws.connect#AttributeName": { "type": "string", "traits": { @@ -3733,6 +3897,33 @@ "smithy.api#documentation": "

Has audio-specific configurations as the operating parameter for Echo Reduction.

" } }, + "com.amazonaws.connect#AudioQualityMetricsInfo": { + "type": "structure", + "members": { + "QualityScore": { + "target": "com.amazonaws.connect#AudioQualityScore", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Number measuring the estimated quality of the media connection.

" + } + }, + "PotentialQualityIssues": { + "target": "com.amazonaws.connect#PotentialAudioQualityIssues", + "traits": { + "smithy.api#documentation": "

List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.

\n

Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer\n

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

Contains information for score and potential quality issues for Audio

" + } + }, + "com.amazonaws.connect#AudioQualityScore": { + "type": "float", + "traits": { + "smithy.api#default": 0 + } + }, "com.amazonaws.connect#AutoAccept": { "type": "boolean", "traits": { @@ -4487,7 +4678,7 @@ } ], "traits": { - "smithy.api#documentation": "

Claims an available phone number to your Amazon Connect instance or traffic distribution\n group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

\n

For more information about how to use this operation, see Claim a phone number in your\n country and Claim phone\n numbers to traffic distribution groups in the Amazon Connect Administrator\n Guide.

\n \n

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call\n the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber\n operation.

\n
\n

If you plan to claim and release numbers frequently during a 30 day period,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until 30 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers during any 30 day period. If you claim and release phone numbers using\n the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 30\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

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

Claims an available phone number to your Amazon Connect instance or traffic distribution\n group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.

\n

For more information about how to use this operation, see Claim a phone number in your\n country and Claim phone\n numbers to traffic distribution groups in the Amazon Connect Administrator\n Guide.

\n \n

You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call\n the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber\n operation.

\n
\n

If you plan to claim and release numbers frequently,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until up to 180 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers. If you claim and release phone numbers using\n the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 180\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

", "smithy.api#http": { "method": "POST", "uri": "/phone-number/claim", @@ -4664,6 +4855,15 @@ } } }, + "com.amazonaws.connect#ComparisonOperator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, "com.amazonaws.connect#CompleteAttachedFileUpload": { "type": "operation", "input": { @@ -4921,6 +5121,57 @@ "traits": { "smithy.api#documentation": "

Tags associated with the contact. This contains both Amazon Web Services generated and\n user-defined tags.

" } + }, + "ConnectedToSystemTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when customer endpoint connected to Amazon Connect.

" + } + }, + "RoutingCriteria": { + "target": "com.amazonaws.connect#RoutingCriteria", + "traits": { + "smithy.api#documentation": "

Latest routing criteria on the contact.

" + } + }, + "Customer": { + "target": "com.amazonaws.connect#Customer", + "traits": { + "smithy.api#documentation": "

Information about the Customer on the contact.

" + } + }, + "Campaign": { + "target": "com.amazonaws.connect#Campaign" + }, + "AnsweringMachineDetectionStatus": { + "target": "com.amazonaws.connect#AnsweringMachineDetectionStatus", + "traits": { + "smithy.api#documentation": "

Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.

" + } + }, + "CustomerVoiceActivity": { + "target": "com.amazonaws.connect#CustomerVoiceActivity", + "traits": { + "smithy.api#documentation": "

Information about customer’s voice activity.

" + } + }, + "QualityMetrics": { + "target": "com.amazonaws.connect#QualityMetrics", + "traits": { + "smithy.api#documentation": "

Information about the quality of the participant's media connection.

" + } + }, + "DisconnectDetails": { + "target": "com.amazonaws.connect#DisconnectDetails", + "traits": { + "smithy.api#documentation": "

Information about the call disconnect experience.

" + } + }, + "SegmentAttributes": { + "target": "com.amazonaws.connect#SegmentAttributes", + "traits": { + "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.

" + } } }, "traits": { @@ -6276,7 +6527,7 @@ "Status": { "target": "com.amazonaws.connect#ContactFlowStatus", "traits": { - "smithy.api#documentation": "

Indicates the flow status as either SAVED or PUBLISHED. The\n PUBLISHED status will initiate validation on the content. the SAVED\n status does not initiate validation of the content. SAVED |\n PUBLISHED.

" + "smithy.api#documentation": "

Indicates the flow status as either SAVED or PUBLISHED. The\n PUBLISHED status will initiate validation on the content. the SAVED\n status does not initiate validation of the content. SAVED |\n PUBLISHED.

" } }, "Tags": { @@ -8843,6 +9094,57 @@ "target": "com.amazonaws.connect#CurrentMetric" } }, + "com.amazonaws.connect#Customer": { + "type": "structure", + "members": { + "DeviceInfo": { + "target": "com.amazonaws.connect#DeviceInfo", + "traits": { + "smithy.api#documentation": "

Information regarding Customer’s device.

" + } + }, + "Capabilities": { + "target": "com.amazonaws.connect#ParticipantCapabilities" + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Customer on the contact.

" + } + }, + "com.amazonaws.connect#CustomerQualityMetrics": { + "type": "structure", + "members": { + "Audio": { + "target": "com.amazonaws.connect#AudioQualityMetricsInfo", + "traits": { + "smithy.api#documentation": "

Information about the audio quality of the Customer

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

Information about the quality of the Customer's media connection

" + } + }, + "com.amazonaws.connect#CustomerVoiceActivity": { + "type": "structure", + "members": { + "GreetingStartTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp that measures the beginning of the customer greeting from an outbound voice call.

" + } + }, + "GreetingEndTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp that measures the end of the customer greeting from an outbound voice call.

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

Information about customer’s voice activity.

" + } + }, "com.amazonaws.connect#DataSetId": { "type": "string", "traits": { @@ -12256,6 +12558,32 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.connect#DeviceInfo": { + "type": "structure", + "members": { + "PlatformName": { + "target": "com.amazonaws.connect#PlatformName", + "traits": { + "smithy.api#documentation": "

Name of the platform that the participant used for the call.

" + } + }, + "PlatformVersion": { + "target": "com.amazonaws.connect#PlatformVersion", + "traits": { + "smithy.api#documentation": "

Version of the platform that the participant used for the call.

" + } + }, + "OperatingSystem": { + "target": "com.amazonaws.connect#OperatingSystem", + "traits": { + "smithy.api#documentation": "

Operating system that the participant used for the call.

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

Information regarding the device.

" + } + }, "com.amazonaws.connect#Dimensions": { "type": "structure", "members": { @@ -13178,6 +13506,20 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#DisconnectDetails": { + "type": "structure", + "members": { + "PotentialDisconnectIssue": { + "target": "com.amazonaws.connect#PotentialDisconnectIssue", + "traits": { + "smithy.api#documentation": "

Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.

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

Information about the call disconnect experience.

" + } + }, "com.amazonaws.connect#DisconnectReason": { "type": "structure", "members": { @@ -13344,6 +13686,9 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.connect#DurationInSeconds": { + "type": "integer" + }, "com.amazonaws.connect#Email": { "type": "string", "traits": { @@ -14899,6 +15244,58 @@ } } }, + "com.amazonaws.connect#Expiry": { + "type": "structure", + "members": { + "DurationInSeconds": { + "target": "com.amazonaws.connect#DurationInSeconds", + "traits": { + "smithy.api#documentation": "

The number of seconds to wait before expiring the routing step.

" + } + }, + "ExpiryTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp indicating when the routing step expires.

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

An object to specify the expiration of a routing step.

" + } + }, + "com.amazonaws.connect#Expression": { + "type": "structure", + "members": { + "AttributeCondition": { + "target": "com.amazonaws.connect#AttributeCondition", + "traits": { + "smithy.api#documentation": "

An object to specify the predefined attribute condition.

" + } + }, + "AndExpression": { + "target": "com.amazonaws.connect#Expressions", + "traits": { + "smithy.api#documentation": "

List of routing expressions which will be AND-ed together.

" + } + }, + "OrExpression": { + "target": "com.amazonaws.connect#Expressions", + "traits": { + "smithy.api#documentation": "

List of routing expressions which will be OR-ed together.

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

A tagged union to specify expression for a routing step.

" + } + }, + "com.amazonaws.connect#Expressions": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Expression" + } + }, "com.amazonaws.connect#FailedRequest": { "type": "structure", "members": { @@ -16712,6 +17109,44 @@ "smithy.api#documentation": "

Information about the hierarchy group.

" } }, + "com.amazonaws.connect#HierarchyGroups": { + "type": "structure", + "members": { + "Level1": { + "target": "com.amazonaws.connect#AgentHierarchyGroup", + "traits": { + "smithy.api#documentation": "

The group at level one of the agent hierarchy.

" + } + }, + "Level2": { + "target": "com.amazonaws.connect#AgentHierarchyGroup", + "traits": { + "smithy.api#documentation": "

The group at level two of the agent hierarchy.

" + } + }, + "Level3": { + "target": "com.amazonaws.connect#AgentHierarchyGroup", + "traits": { + "smithy.api#documentation": "

The group at level three of the agent hierarchy.

" + } + }, + "Level4": { + "target": "com.amazonaws.connect#AgentHierarchyGroup", + "traits": { + "smithy.api#documentation": "

The group at level four of the agent hierarchy.

" + } + }, + "Level5": { + "target": "com.amazonaws.connect#AgentHierarchyGroup", + "traits": { + "smithy.api#documentation": "

The group at level five of the agent hierarchy.

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

Information about the agent hierarchy. Hierarchies can be configured with up to five levels.

" + } + }, "com.amazonaws.connect#HierarchyLevel": { "type": "structure", "members": { @@ -17605,6 +18040,9 @@ "com.amazonaws.connect#InboundCallsEnabled": { "type": "boolean" }, + "com.amazonaws.connect#Index": { + "type": "integer" + }, "com.amazonaws.connect#InitiationMethodList": { "type": "list", "member": { @@ -23605,6 +24043,15 @@ "smithy.api#documentation": "

Information about the property value used in automation of a numeric questions. Label values\n are associated with minimum and maximum values for the numeric question.

\n
    \n
  • \n

    Sentiment scores have a minimum value of -5 and maximum value of 5.

    \n
  • \n
  • \n

    Duration labels, such as NON_TALK_TIME, CONTACT_DURATION,\n AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value\n of 0 and maximum value of 28800.

    \n
  • \n
  • \n

    Percentages have a minimum value of 0 and maximum value of 100.

    \n
  • \n
  • \n

    \n NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of\n 1000.

    \n
  • \n
" } }, + "com.amazonaws.connect#OperatingSystem": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, "com.amazonaws.connect#Origin": { "type": "string", "traits": { @@ -25708,6 +26155,54 @@ } } }, + "com.amazonaws.connect#PlatformName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.connect#PlatformVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.connect#PotentialAudioQualityIssue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.connect#PotentialAudioQualityIssues": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PotentialAudioQualityIssue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.connect#PotentialDisconnectIssue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, "com.amazonaws.connect#PredefinedAttribute": { "type": "structure", "members": { @@ -25913,6 +26408,15 @@ } } }, + "com.amazonaws.connect#ProficiencyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.connect#Prompt": { "type": "structure", "members": { @@ -26262,6 +26766,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#QualityMetrics": { + "type": "structure", + "members": { + "Agent": { + "target": "com.amazonaws.connect#AgentQualityMetrics", + "traits": { + "smithy.api#documentation": "

Information about the quality of Agent media connection.

" + } + }, + "Customer": { + "target": "com.amazonaws.connect#CustomerQualityMetrics", + "traits": { + "smithy.api#documentation": "

Information about the quality of Customer media connection.

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

Information about the quality of the participant's media connection.

" + } + }, "com.amazonaws.connect#Queue": { "type": "structure", "members": { @@ -27772,7 +28296,7 @@ } ], "traits": { - "smithy.api#documentation": "

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect admin website.

\n

After releasing a phone number, the phone number enters into a cooldown period of 30 days.\n It cannot be searched for or claimed again until the period has ended. If you accidentally\n release a phone number, contact Amazon Web Services Support.

\n
\n

If you plan to claim and release numbers frequently during a 30 day period,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until 30 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers during any 30 day period. If you claim and release phone numbers using\n the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 30\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

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

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You\n can call this API only in the Amazon Web Services Region where the number was claimed.

\n \n

To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the\n Amazon Connect admin website.

\n

After releasing a phone number, the phone number enters into a cooldown period for up to\n 180 days. It cannot be searched for or claimed again until the period has ended. If you\n accidentally release a phone number, contact Amazon Web Services Support.

\n
\n

If you plan to claim and release numbers frequently,\n contact us for a service quota exception. Otherwise, it is possible you will be blocked from\n claiming and releasing any more numbers until up to 180 days past the oldest number\n released has expired.

\n

By default you can claim and release up to 200% of your maximum number of active\n phone numbers. If you claim and release phone numbers using\n the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number\n service level quota, you will be blocked from claiming any more numbers until 180\n days past the oldest number released has expired.

\n

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180\n day period you release 99, claim 99, and then release 99, you will have exceeded the\n 200% limit. At that point you are blocked from claiming any more numbers until you\n open an Amazon Web Services support ticket.

", "smithy.api#http": { "method": "DELETE", "uri": "/phone-number/{PhoneNumberId}", @@ -28230,6 +28754,61 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#RoutingCriteria": { + "type": "structure", + "members": { + "Steps": { + "target": "com.amazonaws.connect#Steps", + "traits": { + "smithy.api#documentation": "

List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.

" + } + }, + "ActivationTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.

" + } + }, + "Index": { + "target": "com.amazonaws.connect#Index", + "traits": { + "smithy.api#documentation": "

Information about the index of the routing criteria.

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

Latest routing criteria on the contact.

" + } + }, + "com.amazonaws.connect#RoutingCriteriaStepStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "JOINED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JOINED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + } + } + }, "com.amazonaws.connect#RoutingExpression": { "type": "string", "traits": { @@ -32369,6 +32948,38 @@ } } }, + "com.amazonaws.connect#Step": { + "type": "structure", + "members": { + "Expiry": { + "target": "com.amazonaws.connect#Expiry", + "traits": { + "smithy.api#documentation": "

An object to specify the expiration of a routing step.

" + } + }, + "Expression": { + "target": "com.amazonaws.connect#Expression", + "traits": { + "smithy.api#documentation": "

A tagged union to specify expression for a routing step.

" + } + }, + "Status": { + "target": "com.amazonaws.connect#RoutingCriteriaStepStatus", + "traits": { + "smithy.api#documentation": "

Represents status of the Routing step.

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

Step signifies the criteria to be used for routing to an agent

" + } + }, + "com.amazonaws.connect#Steps": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Step" + } + }, "com.amazonaws.connect#StopContact": { "type": "operation", "input": { @@ -32395,7 +33006,7 @@ } ], "traits": { - "smithy.api#documentation": "

Ends the specified contact. Use this API to stop queued callbacks. It does not work for\n voice contacts that use the following initiation methods:

\n
    \n
  • \n

    DISCONNECT

    \n
  • \n
  • \n

    TRANSFER

    \n
  • \n
  • \n

    QUEUE_TRANSFER

    \n
  • \n
\n

Chat and task contacts can be terminated in any state, regardless of initiation\n method.

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

Ends the specified contact. Use this API to stop queued callbacks. It does not work for\n voice contacts that use the following initiation methods:

\n
    \n
  • \n

    DISCONNECT

    \n
  • \n
  • \n

    TRANSFER

    \n
  • \n
  • \n

    QUEUE_TRANSFER

    \n
  • \n
  • \n

    EXTERNAL_OUTBOUND

    \n
  • \n
  • \n

    MONITOR

    \n
  • \n
\n

Chat and task contacts can be terminated in any state, regardless of initiation\n method.

", "smithy.api#http": { "method": "POST", "uri": "/contact/stop", @@ -35111,7 +35722,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds).\n These properties can be used to change a customer's position in the queue. For example, you can\n move a contact to the back of the queue by setting a lower routing priority relative to other\n contacts in queue; or you can move a contact to the front of the queue by increasing the routing\n age which will make the contact look artificially older and therefore higher up in the\n first-in-first-out routing order. Note that adjusting the routing age of a contact affects only\n its position in queue, and not its actual queue wait time as reported through metrics. These\n properties can also be updated by using the Set routing priority / age flow\n block.

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

Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds).\n These properties can be used to change a customer's position in the queue. For example, you can\n move a contact to the back of the queue by setting a lower routing priority relative to other\n contacts in queue; or you can move a contact to the front of the queue by increasing the routing\n age which will make the contact look artificially older and therefore higher up in the\n first-in-first-out routing order. Note that adjusting the routing age of a contact affects only\n its position in queue, and not its actual queue wait time as reported through metrics. These\n properties can also be updated by using the Set routing priority / age flow\n block.

\n \n

Either QueuePriority or QueueTimeAdjustmentInSeconds should be provided within the request body, but not\n both.

\n
", "smithy.api#http": { "method": "POST", "uri": "/contacts/{InstanceId}/{ContactId}/routing-data", diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index f2f0a85d231..c9158662031 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -8643,6 +8643,12 @@ "smithy.api#required": {} } }, + "JobMode": { + "target": "com.amazonaws.glue#JobMode", + "traits": { + "smithy.api#documentation": "

A mode that describes how a job was created. Valid values are:

\n
    \n
  • \n

    \n SCRIPT - The job was created using the Glue Studio script editor.

    \n
  • \n
  • \n

    \n VISUAL - The job was created using the Glue Studio visual editor.

    \n
  • \n
  • \n

    \n NOTEBOOK - The job was created using an interactive sessions notebook.

    \n
  • \n
\n

When the JobMode field is missing or null, SCRIPT is assigned as the default value.

" + } + }, "Description": { "target": "com.amazonaws.glue#DescriptionString", "traits": { @@ -21907,6 +21913,12 @@ "smithy.api#documentation": "

The name you assign to this job definition.

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

A mode that describes how a job was created. Valid values are:

\n
    \n
  • \n

    \n SCRIPT - The job was created using the Glue Studio script editor.

    \n
  • \n
  • \n

    \n VISUAL - The job was created using the Glue Studio visual editor.

    \n
  • \n
  • \n

    \n NOTEBOOK - The job was created using an interactive sessions notebook.

    \n
  • \n
\n

When the JobMode field is missing or null, SCRIPT is assigned as the default value.

" + } + }, "Description": { "target": "com.amazonaws.glue#DescriptionString", "traits": { @@ -22183,6 +22195,29 @@ "target": "com.amazonaws.glue#Job" } }, + "com.amazonaws.glue#JobMode": { + "type": "enum", + "members": { + "SCRIPT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCRIPT" + } + }, + "VISUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VISUAL" + } + }, + "NOTEBOOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOTEBOOK" + } + } + } + }, "com.amazonaws.glue#JobName": { "type": "string" }, @@ -22240,6 +22275,12 @@ "smithy.api#documentation": "

The name of the job definition being used in this run.

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

A mode that describes how a job was created. Valid values are:

\n
    \n
  • \n

    \n SCRIPT - The job was created using the Glue Studio script editor.

    \n
  • \n
  • \n

    \n VISUAL - The job was created using the Glue Studio visual editor.

    \n
  • \n
  • \n

    \n NOTEBOOK - The job was created using an interactive sessions notebook.

    \n
  • \n
\n

When the JobMode field is missing or null, SCRIPT is assigned as the default value.

" + } + }, "StartedOn": { "target": "com.amazonaws.glue#TimestampValue", "traits": { @@ -22444,6 +22485,12 @@ "com.amazonaws.glue#JobUpdate": { "type": "structure", "members": { + "JobMode": { + "target": "com.amazonaws.glue#JobMode", + "traits": { + "smithy.api#documentation": "

A mode that describes how a job was created. Valid values are:

\n
    \n
  • \n

    \n SCRIPT - The job was created using the Glue Studio script editor.

    \n
  • \n
  • \n

    \n VISUAL - The job was created using the Glue Studio visual editor.

    \n
  • \n
  • \n

    \n NOTEBOOK - The job was created using an interactive sessions notebook.

    \n
  • \n
\n

When the JobMode field is missing or null, SCRIPT is assigned as the default value.

" + } + }, "Description": { "target": "com.amazonaws.glue#DescriptionString", "traits": { diff --git a/codegen/sdk/aws-models/securityhub.json b/codegen/sdk/aws-models/securityhub.json index e40392dad78..8d6b4ec06e0 100644 --- a/codegen/sdk/aws-models/securityhub.json +++ b/codegen/sdk/aws-models/securityhub.json @@ -34485,6 +34485,12 @@ "traits": { "smithy.api#enumValue": "ORGANIZATIONAL_UNIT" } + }, + "ROOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROOT" + } } } }, From fded9ac83b52be7d9f12f653f5b42355cd4d223d Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 29 May 2024 18:06:28 +0000 Subject: [PATCH 07/41] feat: update AWS service endpoints metadata --- .../resources/aws/sdk/kotlin/codegen/endpoints.json | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) 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 124642e23cd..06ea8df845f 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 @@ -14005,14 +14005,19 @@ }, "quicksight" : { "endpoints" : { + "af-south-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, + "api" : { }, "ca-central-1" : { }, "eu-central-1" : { }, + "eu-central-2" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -14625,7 +14630,9 @@ } ] }, "eu-central-1" : { }, + "eu-central-2" : { }, "eu-north-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -14664,6 +14671,7 @@ "deprecated" : true, "hostname" : "redshift-serverless-fips.us-west-2.amazonaws.com" }, + "sa-east-1" : { }, "us-east-1" : { "variants" : [ { "hostname" : "redshift-serverless-fips.us-east-1.amazonaws.com", @@ -21896,7 +21904,8 @@ }, "redshift-serverless" : { "endpoints" : { - "cn-north-1" : { } + "cn-north-1" : { }, + "cn-northwest-1" : { } } }, "resource-groups" : { From ce1081ade75803ce38eaa9efbe26e0cdf545c6c6 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 29 May 2024 18:09:24 +0000 Subject: [PATCH 08/41] chore: release 1.2.22 --- CHANGELOG.md | 9 +++++++++ gradle.properties | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e9541a97221..5f168fddf9d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## [1.2.22] - 05/29/2024 + +### Features +* (**athena**) Throwing validation errors on CreateNotebook with Name containing `/`,`:`,`\` +* (**codebuild**) AWS CodeBuild now supports manually creating GitHub webhooks +* (**connect**) This release includes changes to DescribeContact API's response by including ConnectedToSystemTimestamp, RoutingCriteria, Customer, Campaign, AnsweringMachineDetectionStatus, CustomerVoiceActivity, QualityMetrics, DisconnectDetails, and SegmentAttributes information from a contact in Amazon Connect. +* (**glue**) Add optional field JobMode to CreateJob and UpdateJob APIs. +* (**securityhub**) Add ROOT type for TargetType model + ## [1.2.21] - 05/28/2024 ### Features diff --git a/gradle.properties b/gradle.properties index d24036e44e9..7259e9c1de2 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.2.22-SNAPSHOT +sdkVersion=1.2.22 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 5fb49a00a0dd40e7741fdc4d92abab66707c158f Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 29 May 2024 18:09:26 +0000 Subject: [PATCH 09/41] chore: bump snapshot version to 1.2.23-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 7259e9c1de2..b97e10d8191 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.2.22 +sdkVersion=1.2.23-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 350aa29e7749cdec65943970bbee9690b9840c33 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 30 May 2024 18:06:56 +0000 Subject: [PATCH 10/41] feat: update AWS API models --- codegen/sdk/aws-models/acm.json | 32 +- codegen/sdk/aws-models/bedrock-agent.json | 43 + codegen/sdk/aws-models/bedrock-runtime.json | 1390 +++++++++++++++++-- codegen/sdk/aws-models/cloudtrail.json | 98 +- codegen/sdk/aws-models/connect.json | 14 +- codegen/sdk/aws-models/emr-serverless.json | 354 +++++ codegen/sdk/aws-models/rds.json | 10 +- codegen/sdk/aws-models/sagemaker.json | 155 ++- 8 files changed, 1936 insertions(+), 160 deletions(-) diff --git a/codegen/sdk/aws-models/acm.json b/codegen/sdk/aws-models/acm.json index e3a8c7ca0bf..b81b1ddf411 100644 --- a/codegen/sdk/aws-models/acm.json +++ b/codegen/sdk/aws-models/acm.json @@ -2291,7 +2291,22 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of\n the certificate of the issuing CA and the intermediate certificates of any other subordinate\n CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode\n the certificates and inspect individual fields.

" + "smithy.api#documentation": "

Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of\n the certificate of the issuing CA and the intermediate certificates of any other subordinate\n CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode\n the certificates and inspect individual fields.

", + "smithy.test#smokeTests": [ + { + "id": "GetCertificateFailure", + "params": { + "CertificateArn": "arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] } }, "com.amazonaws.acm#GetCertificateRequest": { @@ -2697,7 +2712,20 @@ "outputToken": "NextToken", "items": "CertificateSummaryList", "pageSize": "MaxItems" - } + }, + "smithy.test#smokeTests": [ + { + "id": "ListCertificatesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.acm#ListCertificatesRequest": { diff --git a/codegen/sdk/aws-models/bedrock-agent.json b/codegen/sdk/aws-models/bedrock-agent.json index 3b690c8af91..9d4cbfb72ab 100644 --- a/codegen/sdk/aws-models/bedrock-agent.json +++ b/codegen/sdk/aws-models/bedrock-agent.json @@ -1968,6 +1968,20 @@ "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" } }, + "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration": { + "type": "structure", + "members": { + "dimensions": { + "target": "com.amazonaws.bedrockagent#Dimensions", + "traits": { + "smithy.api#documentation": "

The dimensions details for the vector configuration used on the Bedrock embeddings model.

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

The vector configuration details for the Bedrock embeddings model.

" + } + }, "com.amazonaws.bedrockagent#BucketOwnerAccountId": { "type": "string", "traits": { @@ -3469,6 +3483,15 @@ } } }, + "com.amazonaws.bedrockagent#Dimensions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 4096 + } + } + }, "com.amazonaws.bedrockagent#DisassociateAgentKnowledgeBase": { "type": "operation", "input": { @@ -3559,6 +3582,20 @@ "smithy.api#pattern": "^DRAFT$" } }, + "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { + "type": "structure", + "members": { + "bedrockEmbeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelConfiguration", + "traits": { + "smithy.api#documentation": "

The vector configuration details on the Bedrock embeddings model.

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

The configuration details for the embeddings model.

" + } + }, "com.amazonaws.bedrockagent#FailureReason": { "type": "string", "traits": { @@ -8090,6 +8127,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

", "smithy.api#required": {} } + }, + "embeddingModelConfiguration": { + "target": "com.amazonaws.bedrockagent#EmbeddingModelConfiguration", + "traits": { + "smithy.api#documentation": "

The embeddings model configuration details for the vector model used in Knowledge Base.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/bedrock-runtime.json b/codegen/sdk/aws-models/bedrock-runtime.json index e19538049ae..cb80d34abee 100644 --- a/codegen/sdk/aws-models/bedrock-runtime.json +++ b/codegen/sdk/aws-models/bedrock-runtime.json @@ -14,6 +14,23 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.bedrockruntime#AdditionalModelResponseFieldPaths": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, "com.amazonaws.bedrockruntime#AmazonBedrockFrontendService": { "type": "service", "version": "2023-09-30", @@ -700,6 +717,20 @@ } } }, + "com.amazonaws.bedrockruntime#AnyToolChoice": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The model must request at least one tool (no text is generated).

" + } + }, + "com.amazonaws.bedrockruntime#AutoToolChoice": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The Model automatically decides if a tool should be called or to whether to generate text instead.

" + } + }, "com.amazonaws.bedrockruntime#Body": { "type": "blob", "traits": { @@ -709,52 +740,171 @@ "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockruntime#GuardrailIdentifier": { - "type": "string", + "com.amazonaws.bedrockruntime#ContentBlock": { + "type": "union", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Text to include in the message.

" + } + }, + "image": { + "target": "com.amazonaws.bedrockruntime#ImageBlock", + "traits": { + "smithy.api#documentation": "

Image to include in the message.

\n \n

This field is only supported by Anthropic Claude 3 models.

\n
" + } + }, + "toolUse": { + "target": "com.amazonaws.bedrockruntime#ToolUseBlock", + "traits": { + "smithy.api#documentation": "

Information about a tool use request from a model.

" + } + }, + "toolResult": { + "target": "com.amazonaws.bedrockruntime#ToolResultBlock", + "traits": { + "smithy.api#documentation": "

The result for a tool request that a model makes.

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

A block of content for a message.

" + } + }, + "com.amazonaws.bedrockruntime#ContentBlockDelta": { + "type": "union", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The content text.

" + } }, - "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + "toolUse": { + "target": "com.amazonaws.bedrockruntime#ToolUseBlockDelta", + "traits": { + "smithy.api#documentation": "

Information about a tool that the model is requesting to use.

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

A bock of content in a streaming response.

" } }, - "com.amazonaws.bedrockruntime#GuardrailVersion": { - "type": "string", + "com.amazonaws.bedrockruntime#ContentBlockDeltaEvent": { + "type": "structure", + "members": { + "delta": { + "target": "com.amazonaws.bedrockruntime#ContentBlockDelta", + "traits": { + "smithy.api#documentation": "

The delta for a content block delta event.

", + "smithy.api#required": {} + } + }, + "contentBlockIndex": { + "target": "com.amazonaws.bedrockruntime#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The block index for a content block delta event.

", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + "smithy.api#documentation": "

The content block delta event.

" } }, - "com.amazonaws.bedrockruntime#InferenceResource": { - "type": "resource", - "operations": [ - { - "target": "com.amazonaws.bedrockruntime#InvokeModel" + "com.amazonaws.bedrockruntime#ContentBlockStart": { + "type": "union", + "members": { + "toolUse": { + "target": "com.amazonaws.bedrockruntime#ToolUseBlockStart", + "traits": { + "smithy.api#documentation": "

Information about a tool that the model is requesting to use.

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

Content block start information.

" + } + }, + "com.amazonaws.bedrockruntime#ContentBlockStartEvent": { + "type": "structure", + "members": { + "start": { + "target": "com.amazonaws.bedrockruntime#ContentBlockStart", + "traits": { + "smithy.api#documentation": "

Start information about a content block start event.

", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.bedrockruntime#InvokeModelWithResponseStream" + "contentBlockIndex": { + "target": "com.amazonaws.bedrockruntime#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The index for a content block start event.

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

Content block start event.

" + } }, - "com.amazonaws.bedrockruntime#InternalServerException": { + "com.amazonaws.bedrockruntime#ContentBlockStopEvent": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.bedrockruntime#NonBlankString" + "contentBlockIndex": { + "target": "com.amazonaws.bedrockruntime#NonNegativeInteger", + "traits": { + "smithy.api#documentation": "

The index for a content block.

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

An internal server error occurred. Retry your request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 + "smithy.api#documentation": "

A content block stop event.

" } }, - "com.amazonaws.bedrockruntime#InvokeModel": { + "com.amazonaws.bedrockruntime#ContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#ContentBlock" + } + }, + "com.amazonaws.bedrockruntime#ConversationRole": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "user" + } + }, + "ASSISTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "assistant" + } + } + } + }, + "com.amazonaws.bedrockruntime#ConversationalModelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrockruntime#Converse": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockruntime#InvokeModelRequest" + "target": "com.amazonaws.bedrockruntime#ConverseRequest" }, "output": { - "target": "com.amazonaws.bedrockruntime#InvokeModelResponse" + "target": "com.amazonaws.bedrockruntime#ConverseResponse" }, "errors": [ { @@ -775,9 +925,6 @@ { "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" }, - { - "target": "com.amazonaws.bedrockruntime#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.bedrockruntime#ThrottlingException" }, @@ -786,76 +933,92 @@ } ], "traits": { - "smithy.api#documentation": "

Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. \n You use model inference to generate text, images, and embeddings.

\n

For example code, see Invoke model code examples in the Amazon Bedrock User Guide.\n

\n

This operation requires permission for the bedrock:InvokeModel action.

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

Sends messages to the specified Amazon Bedrock model. Converse provides\n a consistent interface that works with all models that\n support messages. This allows you to write code once and use it with different models.\n Should a model have unique inference parameters, you can also pass those unique parameters\n to the model. For more information, see Run inference in the Bedrock User Guide.

\n

This operation requires permission for the bedrock:InvokeModel action.

", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/model/{modelId}/invoke" + "uri": "/model/{modelId}/converse" } } }, - "com.amazonaws.bedrockruntime#InvokeModelIdentifier": { - "type": "string", + "com.amazonaws.bedrockruntime#ConverseMetrics": { + "type": "structure", + "members": { + "latencyMs": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The latency of the call to Converse, in milliseconds.\n

", + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#documentation": "

Metrics for a call to Converse.

" } }, - "com.amazonaws.bedrockruntime#InvokeModelRequest": { + "com.amazonaws.bedrockruntime#ConverseOutput": { + "type": "union", + "members": { + "message": { + "target": "com.amazonaws.bedrockruntime#Message", + "traits": { + "smithy.api#documentation": "

The message that the model generates.

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

The output from a call to Converse.

" + } + }, + "com.amazonaws.bedrockruntime#ConverseRequest": { "type": "structure", "members": { - "body": { - "target": "com.amazonaws.bedrockruntime#Body", + "modelId": { + "target": "com.amazonaws.bedrockruntime#ConversationalModelId", "traits": { - "smithy.api#documentation": "

The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

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

The identifier for the model that you want to call.

\n

The modelId to provide depends on the type of model that you use:

\n ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.bedrockruntime#MimeType", + "messages": { + "target": "com.amazonaws.bedrockruntime#Messages", "traits": { - "smithy.api#documentation": "

The MIME type of the input data in the request. The default value is\n application/json.

", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

The messages that you want to send to the model.

", + "smithy.api#required": {} } }, - "accept": { - "target": "com.amazonaws.bedrockruntime#MimeType", + "system": { + "target": "com.amazonaws.bedrockruntime#SystemContentBlocks", "traits": { - "smithy.api#documentation": "

The desired MIME type of the inference body in the response. The default value is application/json.

", - "smithy.api#httpHeader": "Accept" + "smithy.api#documentation": "

A system prompt to pass to the model.

" } }, - "modelId": { - "target": "com.amazonaws.bedrockruntime#InvokeModelIdentifier", + "inferenceConfig": { + "target": "com.amazonaws.bedrockruntime#InferenceConfiguration", "traits": { - "smithy.api#documentation": "

The unique identifier of the model to invoke to run inference.

\n

The modelId to provide depends on the type of model that you use:

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

Inference parameters to pass to the model. Converse supports a base\n set of inference parameters. If you need to pass additional parameters that the model\n supports, use the additionalModelRequestFields request field.

" } }, - "trace": { - "target": "com.amazonaws.bedrockruntime#Trace", + "toolConfig": { + "target": "com.amazonaws.bedrockruntime#ToolConfiguration", "traits": { - "smithy.api#documentation": "

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

", - "smithy.api#httpHeader": "X-Amzn-Bedrock-Trace" + "smithy.api#documentation": "

Configuration information for the tools that the model can use when generating a response.

\n \n

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

\n
" } }, - "guardrailIdentifier": { - "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", + "additionalModelRequestFields": { + "target": "smithy.api#Document", "traits": { - "smithy.api#documentation": "

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied\n to the invocation.

\n

An error will be thrown in the following situations.

\n
    \n
  • \n

    You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.

    \n
  • \n
  • \n

    You enable the guardrail but the contentType isn't application/json.

    \n
  • \n
  • \n

    You provide a guardrail identifier, but guardrailVersion isn't specified.

    \n
  • \n
", - "smithy.api#httpHeader": "X-Amzn-Bedrock-GuardrailIdentifier" + "smithy.api#documentation": "

Additional inference parameters that the model supports, beyond the\n base set of inference parameters that Converse supports in the inferenceConfig\n field. For more information, see Model parameters.

" } }, - "guardrailVersion": { - "target": "com.amazonaws.bedrockruntime#GuardrailVersion", + "additionalModelResponseFieldPaths": { + "target": "com.amazonaws.bedrockruntime#AdditionalModelResponseFieldPaths", "traits": { - "smithy.api#documentation": "

The version number for the guardrail. The value can also be DRAFT.

", - "smithy.api#httpHeader": "X-Amzn-Bedrock-GuardrailVersion" + "smithy.api#documentation": "

Additional model parameters field paths to return in the\n response. Converse returns the requested fields as a JSON Pointer object in the\n additionalModelResultFields field. The following is example JSON for additionalModelResponseFieldPaths.

\n

\n [\n \"/stop_sequence\"\n ]\n

\n

For information about the JSON Pointer syntax, see the\n Internet Engineering Task Force (IETF) documentation.

\n

\n Converse rejects an empty JSON Pointer or incorrectly structured\n JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested\n field is not in the model response, it is ignored by Converse.

", + "smithy.api#length": { + "max": 10 + } } } }, @@ -863,37 +1026,55 @@ "smithy.api#input": {} } }, - "com.amazonaws.bedrockruntime#InvokeModelResponse": { + "com.amazonaws.bedrockruntime#ConverseResponse": { "type": "structure", "members": { - "body": { - "target": "com.amazonaws.bedrockruntime#Body", + "output": { + "target": "com.amazonaws.bedrockruntime#ConverseOutput", "traits": { - "smithy.api#documentation": "

Inference response from the model in the format specified in the contentType header. To see the format and content of the request and response bodies for different models, refer to Inference parameters.

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

The result from the call to Converse.

", "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.bedrockruntime#MimeType", + "stopReason": { + "target": "com.amazonaws.bedrockruntime#StopReason", "traits": { - "smithy.api#documentation": "

The MIME type of the inference result.

", - "smithy.api#httpHeader": "Content-Type", + "smithy.api#documentation": "

The reason why the model stopped generating output.

", + "smithy.api#required": {} + } + }, + "usage": { + "target": "com.amazonaws.bedrockruntime#TokenUsage", + "traits": { + "smithy.api#documentation": "

The total number of tokens used in the call to Converse. The total includes\n the tokens input to the model and the tokens generated by the model.

", "smithy.api#required": {} } + }, + "metrics": { + "target": "com.amazonaws.bedrockruntime#ConverseMetrics", + "traits": { + "smithy.api#documentation": "

Metrics for the call to Converse.

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

Additional fields in the response that are unique to the model.

" + } } }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.bedrockruntime#InvokeModelWithResponseStream": { + "com.amazonaws.bedrockruntime#ConverseStream": { "type": "operation", "input": { - "target": "com.amazonaws.bedrockruntime#InvokeModelWithResponseStreamRequest" + "target": "com.amazonaws.bedrockruntime#ConverseStreamRequest" }, "output": { - "target": "com.amazonaws.bedrockruntime#InvokeModelWithResponseStreamResponse" + "target": "com.amazonaws.bedrockruntime#ConverseStreamResponse" }, "errors": [ { @@ -908,18 +1089,12 @@ { "target": "com.amazonaws.bedrockruntime#ModelNotReadyException" }, - { - "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException" - }, { "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" }, { "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" }, - { - "target": "com.amazonaws.bedrockruntime#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.bedrockruntime#ThrottlingException" }, @@ -928,45 +1103,569 @@ } ], "traits": { - "smithy.api#documentation": "

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

\n

To see if a model supports streaming, call GetFoundationModel\n and check the responseStreamingSupported field in the response.

\n \n

The CLI doesn't support InvokeModelWithResponseStream.

\n
\n

For example code, see Invoke model with streaming code\n example in the Amazon Bedrock User Guide.\n

\n

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

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

Sends messages to the specified Amazon Bedrock model and returns\n the response in a stream. ConverseStream provides a consistent API\n that works with all Amazon Bedrock models that support messages.\n This allows you to write code once and use it with different models. Should a\n model have unique inference parameters, you can also pass those unique parameters to the\n model. For more information, see Run inference in the Bedrock User Guide.

\n

To find out if a model supports streaming, call GetFoundationModel\n and check the responseStreamingSupported field in the response.

\n

For example code, see Invoke model with streaming code\n example in the Amazon Bedrock User Guide.\n

\n

This operation requires permission for the bedrock:InvokeModelWithResponseStream action.

", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/model/{modelId}/invoke-with-response-stream" + "uri": "/model/{modelId}/converse-stream" } } }, - "com.amazonaws.bedrockruntime#InvokeModelWithResponseStreamRequest": { + "com.amazonaws.bedrockruntime#ConverseStreamMetadataEvent": { "type": "structure", "members": { - "body": { - "target": "com.amazonaws.bedrockruntime#Body", + "usage": { + "target": "com.amazonaws.bedrockruntime#TokenUsage", "traits": { - "smithy.api#documentation": "

The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

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

Usage information for the conversation stream event.

", "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.bedrockruntime#MimeType", + "metrics": { + "target": "com.amazonaws.bedrockruntime#ConverseStreamMetrics", "traits": { - "smithy.api#documentation": "

The MIME type of the input data in the request. The default value is\n application/json.

", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "

The metrics for the conversation stream metadata event.

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

A conversation stream metadata event.

" + } + }, + "com.amazonaws.bedrockruntime#ConverseStreamMetrics": { + "type": "structure", + "members": { + "latencyMs": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The latency for the streaming request, in milliseconds.

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

Metrics for the stream.

" + } + }, + "com.amazonaws.bedrockruntime#ConverseStreamOutput": { + "type": "union", + "members": { + "messageStart": { + "target": "com.amazonaws.bedrockruntime#MessageStartEvent", + "traits": { + "smithy.api#documentation": "

Message start information.

" } }, - "accept": { - "target": "com.amazonaws.bedrockruntime#MimeType", + "contentBlockStart": { + "target": "com.amazonaws.bedrockruntime#ContentBlockStartEvent", "traits": { - "smithy.api#documentation": "

The desired MIME type of the inference body in the response. The default value is\n application/json.

", - "smithy.api#httpHeader": "X-Amzn-Bedrock-Accept" + "smithy.api#documentation": "

Start information for a content block.

" } }, - "modelId": { - "target": "com.amazonaws.bedrockruntime#InvokeModelIdentifier", + "contentBlockDelta": { + "target": "com.amazonaws.bedrockruntime#ContentBlockDeltaEvent", "traits": { - "smithy.api#documentation": "

The unique identifier of the model to invoke to run inference.

\n

The modelId to provide depends on the type of model that you use:

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

The messages output content block delta.

" + } + }, + "contentBlockStop": { + "target": "com.amazonaws.bedrockruntime#ContentBlockStopEvent", + "traits": { + "smithy.api#documentation": "

Stop information for a content block.

" + } + }, + "messageStop": { + "target": "com.amazonaws.bedrockruntime#MessageStopEvent", + "traits": { + "smithy.api#documentation": "

Message stop information.

" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockruntime#ConverseStreamMetadataEvent", + "traits": { + "smithy.api#documentation": "

Metadata for the converse output stream.

" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

" + } + }, + "modelStreamErrorException": { + "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException", + "traits": { + "smithy.api#documentation": "

A streaming error occurred. Retry your request.

" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockruntime#ValidationException", + "traits": { + "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

" + } + }, + "throttlingException": { + "target": "com.amazonaws.bedrockruntime#ThrottlingException", + "traits": { + "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

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

The messages output stream

", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.bedrockruntime#ConverseStreamRequest": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.bedrockruntime#ConversationalModelId", + "traits": { + "smithy.api#documentation": "

The ID for the model.

\n

The modelId to provide depends on the type of model that you use:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "messages": { + "target": "com.amazonaws.bedrockruntime#Messages", + "traits": { + "smithy.api#documentation": "

The messages that you want to send to the model.

", + "smithy.api#required": {} + } + }, + "system": { + "target": "com.amazonaws.bedrockruntime#SystemContentBlocks", + "traits": { + "smithy.api#documentation": "

A system prompt to send to the model.

" + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrockruntime#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "

Inference parameters to pass to the model. ConverseStream supports a base\n set of inference parameters. If you need to pass additional parameters that the model\n supports, use the additionalModelRequestFields request field.

" + } + }, + "toolConfig": { + "target": "com.amazonaws.bedrockruntime#ToolConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information for the tools that the model can use when generating a response.

\n \n

This field is only supported by Anthropic Claude 3 models.

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

Additional inference parameters that the model supports, beyond the\n base set of inference parameters that ConverseStream supports in the inferenceConfig\n field.

" + } + }, + "additionalModelResponseFieldPaths": { + "target": "com.amazonaws.bedrockruntime#AdditionalModelResponseFieldPaths", + "traits": { + "smithy.api#documentation": "

Additional model parameters field paths to return in the\n response. ConverseStream returns the requested fields as a JSON Pointer object in the\n additionalModelResultFields field. The following is example JSON for additionalModelResponseFieldPaths.

\n

\n [\n \"/stop_sequence\"\n ]\n

\n

For information about the JSON Pointer syntax, see the\n Internet Engineering Task Force (IETF) documentation.

\n

\n ConverseStream rejects an empty JSON Pointer or incorrectly structured\n JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested\n field is not in the model response, it is ignored by ConverseStream.

", + "smithy.api#length": { + "max": 10 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockruntime#ConverseStreamResponse": { + "type": "structure", + "members": { + "stream": { + "target": "com.amazonaws.bedrockruntime#ConverseStreamOutput", + "traits": { + "smithy.api#documentation": "

The output stream that the model generated.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockruntime#GuardrailIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" + } + }, + "com.amazonaws.bedrockruntime#GuardrailVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" + } + }, + "com.amazonaws.bedrockruntime#ImageBlock": { + "type": "structure", + "members": { + "format": { + "target": "com.amazonaws.bedrockruntime#ImageFormat", + "traits": { + "smithy.api#documentation": "

The format of the image.

", + "smithy.api#required": {} + } + }, + "source": { + "target": "com.amazonaws.bedrockruntime#ImageSource", + "traits": { + "smithy.api#documentation": "

The source for the image.

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

Image content for a message.

" + } + }, + "com.amazonaws.bedrockruntime#ImageFormat": { + "type": "enum", + "members": { + "PNG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "png" + } + }, + "JPEG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jpeg" + } + }, + "GIF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gif" + } + }, + "WEBP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "webp" + } + } + } + }, + "com.amazonaws.bedrockruntime#ImageSource": { + "type": "union", + "members": { + "bytes": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "

The raw image bytes for the image. If you use an AWS SDK, you don't need to base64 encode the image bytes.

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

The source for an image.

" + } + }, + "com.amazonaws.bedrockruntime#InferenceConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens to allow in the generated response. The default value is\n the maximum allowed value for the model that you are using. For more information, see\n Inference parameters for foundatio{\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"text\": \"what's the weather in Queens, NY and Austin, TX?\"\n }\n ]\n },\n {\n \"role\": \"assistant\",\n \"content\": [\n {\n \"toolUse\": {\n \"toolUseId\": \"1\",\n \"name\": \"get_weather\",\n \"input\": {\n \"city\": \"Queens\",\n \"state\": \"NY\"\n }\n }\n },\n {\n \"toolUse\": {\n \"toolUseId\": \"2\",\n \"name\": \"get_weather\",\n \"input\": {\n \"city\": \"Austin\",\n \"state\": \"TX\"\n }\n }\n }\n ]\n },\n {\n \"role\": \"user\",\n \"content\": [\n {\n \"toolResult\": {\n \"toolUseId\": \"2\",\n \"content\": [\n {\n \"json\": {\n \"weather\": \"40\"\n }\n }\n ]\n }\n },\n {\n \"text\": \"...\"\n },\n {\n \"toolResult\": {\n \"toolUseId\": \"1\",\n \"content\": [\n {\n \"text\": \"result text\"\n }\n ]\n }\n }\n ]\n }\n ],\n \"toolConfig\": {\n \"tools\": [\n {\n \"name\": \"get_weather\",\n \"description\": \"Get weather\",\n \"inputSchema\": {\n \"type\": \"object\",\n \"properties\": {\n \"city\": {\n \"type\": \"string\",\n \"description\": \"City of location\"\n },\n \"state\": {\n \"type\": \"string\",\n \"description\": \"State of location\"\n }\n },\n \"required\": [\"city\", \"state\"]\n }\n }\n ]\n }\n }\n n models.

", + "smithy.api#range": { + "min": 1 + } + } + }, + "temperature": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "

The likelihood of the model selecting higher-probability options while generating a\n response. A lower value makes the model more likely to choose higher-probability options,\n while a higher value makes the model more likely to choose lower-probability\n options.

\n

The default value is the default value for the model that\n you are using. For more information, see Inference parameters for foundation\n models.

", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "topP": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "

The percentage of most-likely candidates that the model considers for the next token. For\n example, if you choose a value of 0.8 for topP, the model selects from the top 80% of the\n probability distribution of tokens that could be next in the sequence.

\n

The default value is the default value for the model that you are using. For more information, see\n Inference parameters for foundation models.

", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "stopSequences": { + "target": "com.amazonaws.bedrockruntime#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of stop sequences. A stop sequence is a sequence of characters that causes the\n model to stop generating the response.

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

Base inference parameters to pass to a model in a call to Converse or ConverseStream. For more information,\n see Inference parameters for foundation models.

\n

If you need to pass additional parameters that the model\n supports, use the additionalModelRequestFields request field in the call to Converse\n or ConverseStream.\n For more information, see Model parameters.

" + } + }, + "com.amazonaws.bedrockruntime#InferenceResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockruntime#Converse" + }, + { + "target": "com.amazonaws.bedrockruntime#ConverseStream" + }, + { + "target": "com.amazonaws.bedrockruntime#InvokeModel" + }, + { + "target": "com.amazonaws.bedrockruntime#InvokeModelWithResponseStream" + } + ] + }, + "com.amazonaws.bedrockruntime#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bedrockruntime#InvokeModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#InvokeModelRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#InvokeModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelErrorException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelNotReadyException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" + }, + { + "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. \n You use model inference to generate text, images, and embeddings.

\n

For example code, see Invoke model code examples in the Amazon Bedrock User Guide.\n

\n

This operation requires permission for the bedrock:InvokeModel action.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model/{modelId}/invoke" + } + } + }, + "com.amazonaws.bedrockruntime#InvokeModelIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + } + }, + "com.amazonaws.bedrockruntime#InvokeModelRequest": { + "type": "structure", + "members": { + "body": { + "target": "com.amazonaws.bedrockruntime#Body", + "traits": { + "smithy.api#documentation": "

The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockruntime#MimeType", + "traits": { + "smithy.api#documentation": "

The MIME type of the input data in the request. The default value is\n application/json.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "accept": { + "target": "com.amazonaws.bedrockruntime#MimeType", + "traits": { + "smithy.api#documentation": "

The desired MIME type of the inference body in the response. The default value is application/json.

", + "smithy.api#httpHeader": "Accept" + } + }, + "modelId": { + "target": "com.amazonaws.bedrockruntime#InvokeModelIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the model to invoke to run inference.

\n

The modelId to provide depends on the type of model that you use:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "trace": { + "target": "com.amazonaws.bedrockruntime#Trace", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

", + "smithy.api#httpHeader": "X-Amzn-Bedrock-Trace" + } + }, + "guardrailIdentifier": { + "target": "com.amazonaws.bedrockruntime#GuardrailIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied\n to the invocation.

\n

An error will be thrown in the following situations.

\n
    \n
  • \n

    You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.

    \n
  • \n
  • \n

    You enable the guardrail but the contentType isn't application/json.

    \n
  • \n
  • \n

    You provide a guardrail identifier, but guardrailVersion isn't specified.

    \n
  • \n
", + "smithy.api#httpHeader": "X-Amzn-Bedrock-GuardrailIdentifier" + } + }, + "guardrailVersion": { + "target": "com.amazonaws.bedrockruntime#GuardrailVersion", + "traits": { + "smithy.api#documentation": "

The version number for the guardrail. The value can also be DRAFT.

", + "smithy.api#httpHeader": "X-Amzn-Bedrock-GuardrailVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockruntime#InvokeModelResponse": { + "type": "structure", + "members": { + "body": { + "target": "com.amazonaws.bedrockruntime#Body", + "traits": { + "smithy.api#documentation": "

Inference response from the model in the format specified in the contentType header. To see the format and content of the request and response bodies for different models, refer to Inference parameters.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockruntime#MimeType", + "traits": { + "smithy.api#documentation": "

The MIME type of the inference result.

", + "smithy.api#httpHeader": "Content-Type", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockruntime#InvokeModelWithResponseStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockruntime#InvokeModelWithResponseStreamRequest" + }, + "output": { + "target": "com.amazonaws.bedrockruntime#InvokeModelWithResponseStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelErrorException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelNotReadyException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelStreamErrorException" + }, + { + "target": "com.amazonaws.bedrockruntime#ModelTimeoutException" + }, + { + "target": "com.amazonaws.bedrockruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

\n

To see if a model supports streaming, call GetFoundationModel\n and check the responseStreamingSupported field in the response.

\n \n

The CLI doesn't support InvokeModelWithResponseStream.

\n
\n

For example code, see Invoke model with streaming code\n example in the Amazon Bedrock User Guide.\n

\n

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/model/{modelId}/invoke-with-response-stream" + } + } + }, + "com.amazonaws.bedrockruntime#InvokeModelWithResponseStreamRequest": { + "type": "structure", + "members": { + "body": { + "target": "com.amazonaws.bedrockruntime#Body", + "traits": { + "smithy.api#documentation": "

The prompt and inference parameters in the format specified in the contentType in the header. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.bedrockruntime#MimeType", + "traits": { + "smithy.api#documentation": "

The MIME type of the input data in the request. The default value is\n application/json.

", + "smithy.api#httpHeader": "Content-Type" + } + }, + "accept": { + "target": "com.amazonaws.bedrockruntime#MimeType", + "traits": { + "smithy.api#documentation": "

The desired MIME type of the inference body in the response. The default value is\n application/json.

", + "smithy.api#httpHeader": "X-Amzn-Bedrock-Accept" + } + }, + "modelId": { + "target": "com.amazonaws.bedrockruntime#InvokeModelIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the model to invoke to run inference.

\n

The modelId to provide depends on the type of model that you use:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "trace": { @@ -1006,17 +1705,81 @@ "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.bedrockruntime#MimeType", + "contentType": { + "target": "com.amazonaws.bedrockruntime#MimeType", + "traits": { + "smithy.api#documentation": "

The MIME type of the inference result.

", + "smithy.api#httpHeader": "X-Amzn-Bedrock-Content-Type", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockruntime#Message": { + "type": "structure", + "members": { + "role": { + "target": "com.amazonaws.bedrockruntime#ConversationRole", + "traits": { + "smithy.api#documentation": "

The role that the message plays in the message.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockruntime#ContentBlocks", + "traits": { + "smithy.api#documentation": "

The message content.

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

A message in the Message field. Use to send a message in a call to \n Converse.

" + } + }, + "com.amazonaws.bedrockruntime#MessageStartEvent": { + "type": "structure", + "members": { + "role": { + "target": "com.amazonaws.bedrockruntime#ConversationRole", + "traits": { + "smithy.api#documentation": "

The role for the message.

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

The start of a message.

" + } + }, + "com.amazonaws.bedrockruntime#MessageStopEvent": { + "type": "structure", + "members": { + "stopReason": { + "target": "com.amazonaws.bedrockruntime#StopReason", + "traits": { + "smithy.api#documentation": "

The reason why the model stopped generating output.

", + "smithy.api#required": {} + } + }, + "additionalModelResponseFields": { + "target": "smithy.api#Document", "traits": { - "smithy.api#documentation": "

The MIME type of the inference result.

", - "smithy.api#httpHeader": "X-Amzn-Bedrock-Content-Type", - "smithy.api#required": {} + "smithy.api#documentation": "

The additional model response fields.

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

The stop event for a message.

" + } + }, + "com.amazonaws.bedrockruntime#Messages": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#Message" } }, "com.amazonaws.bedrockruntime#MimeType": { @@ -1104,6 +1867,28 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.bedrockruntime#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.bedrockruntime#NonEmptyStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#NonEmptyString" + } + }, + "com.amazonaws.bedrockruntime#NonNegativeInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.bedrockruntime#PartBody": { "type": "blob", "traits": { @@ -1199,6 +1984,21 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.bedrockruntime#SpecificToolChoice": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockruntime#ToolName", + "traits": { + "smithy.api#documentation": "

The name of the tool that the model must request.

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

The model must request a specific tool.

\n \n

This field is only supported by Anthropic Claude 3 models.

\n
" + } + }, "com.amazonaws.bedrockruntime#StatusCode": { "type": "integer", "traits": { @@ -1208,6 +2008,61 @@ } } }, + "com.amazonaws.bedrockruntime#StopReason": { + "type": "enum", + "members": { + "END_TURN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "end_turn" + } + }, + "TOOL_USE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tool_use" + } + }, + "MAX_TOKENS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "max_tokens" + } + }, + "STOP_SEQUENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "stop_sequence" + } + }, + "CONTENT_FILTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "content_filtered" + } + } + } + }, + "com.amazonaws.bedrockruntime#SystemContentBlock": { + "type": "union", + "members": { + "text": { + "target": "com.amazonaws.bedrockruntime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A system prompt for the model.

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

A system content block

" + } + }, + "com.amazonaws.bedrockruntime#SystemContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#SystemContentBlock" + } + }, "com.amazonaws.bedrockruntime#ThrottlingException": { "type": "structure", "members": { @@ -1221,6 +2076,319 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.bedrockruntime#TokenUsage": { + "type": "structure", + "members": { + "inputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of tokens sent in the request to the model.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "outputTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of tokens that the model generated for the request.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "totalTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total of input tokens and tokens generated by the model.

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

The tokens used in a message API inference call.

" + } + }, + "com.amazonaws.bedrockruntime#Tool": { + "type": "union", + "members": { + "toolSpec": { + "target": "com.amazonaws.bedrockruntime#ToolSpecification", + "traits": { + "smithy.api#documentation": "

The specfication for the tool.

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

Information about a tool that you can use with the Converse API.

" + } + }, + "com.amazonaws.bedrockruntime#ToolChoice": { + "type": "union", + "members": { + "auto": { + "target": "com.amazonaws.bedrockruntime#AutoToolChoice", + "traits": { + "smithy.api#documentation": "

The Model automatically decides if a tool should be called or to whether to generate text instead.

" + } + }, + "any": { + "target": "com.amazonaws.bedrockruntime#AnyToolChoice", + "traits": { + "smithy.api#documentation": "

The model must request at least one tool (no text is generated).

" + } + }, + "tool": { + "target": "com.amazonaws.bedrockruntime#SpecificToolChoice", + "traits": { + "smithy.api#documentation": "

The Model must request the specified tool.

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

Forces a model to use a tool.

" + } + }, + "com.amazonaws.bedrockruntime#ToolConfiguration": { + "type": "structure", + "members": { + "tools": { + "target": "com.amazonaws.bedrockruntime#Tools", + "traits": { + "smithy.api#documentation": "

An array of tools that you want to pass to a model.

", + "smithy.api#length": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "toolChoice": { + "target": "com.amazonaws.bedrockruntime#ToolChoice", + "traits": { + "smithy.api#documentation": "

If supported by model, forces the model to request a tool.

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

Configuration information for the tools that you pass to a model.

\n \n

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

\n
" + } + }, + "com.amazonaws.bedrockruntime#ToolInputSchema": { + "type": "union", + "members": { + "json": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The JSON schema for the tool. For more information, see JSON Schema Reference.

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

The schema for the tool. The top level schema type must be object.

" + } + }, + "com.amazonaws.bedrockruntime#ToolName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" + } + }, + "com.amazonaws.bedrockruntime#ToolResultBlock": { + "type": "structure", + "members": { + "toolUseId": { + "target": "com.amazonaws.bedrockruntime#ToolUseId", + "traits": { + "smithy.api#documentation": "

The ID of the tool request that this is the result for.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockruntime#ToolResultContentBlocks", + "traits": { + "smithy.api#documentation": "

The content for tool result content block.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockruntime#ToolResultStatus", + "traits": { + "smithy.api#documentation": "

The status for the tool result content block.

\n \n

This field is only supported Anthropic Claude 3 models.

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

A tool result block that contains the results for a tool request that\n the model previously made.

" + } + }, + "com.amazonaws.bedrockruntime#ToolResultContentBlock": { + "type": "union", + "members": { + "json": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

A tool result that is JSON format data.

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

A tool result that is text.

" + } + }, + "image": { + "target": "com.amazonaws.bedrockruntime#ImageBlock", + "traits": { + "smithy.api#documentation": "

A tool result that is an image.

\n \n

This field is only supported by Anthropic Claude 3 models.

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

The tool result content block.

" + } + }, + "com.amazonaws.bedrockruntime#ToolResultContentBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#ToolResultContentBlock" + } + }, + "com.amazonaws.bedrockruntime#ToolResultStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "success" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "error" + } + } + } + }, + "com.amazonaws.bedrockruntime#ToolSpecification": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockruntime#ToolName", + "traits": { + "smithy.api#documentation": "

The name for the tool.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.bedrockruntime#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description for the tool.

" + } + }, + "inputSchema": { + "target": "com.amazonaws.bedrockruntime#ToolInputSchema", + "traits": { + "smithy.api#documentation": "

The input schema for the tool in JSON format.

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

The specification for the tool.

" + } + }, + "com.amazonaws.bedrockruntime#ToolUseBlock": { + "type": "structure", + "members": { + "toolUseId": { + "target": "com.amazonaws.bedrockruntime#ToolUseId", + "traits": { + "smithy.api#documentation": "

The ID for the tool request.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockruntime#ToolName", + "traits": { + "smithy.api#documentation": "

The name of the tool that the model wants to use.

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

The input to pass to the tool.

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

A tool use content block. Contains information about a tool that the model\n is requesting be run., The model uses the result from the tool to generate a response.

" + } + }, + "com.amazonaws.bedrockruntime#ToolUseBlockDelta": { + "type": "structure", + "members": { + "input": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The input for a requested tool.

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

The delta for a tool use block.

" + } + }, + "com.amazonaws.bedrockruntime#ToolUseBlockStart": { + "type": "structure", + "members": { + "toolUseId": { + "target": "com.amazonaws.bedrockruntime#ToolUseId", + "traits": { + "smithy.api#documentation": "

The ID for the tool request.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.bedrockruntime#ToolName", + "traits": { + "smithy.api#documentation": "

The name of the tool that the model is requesting to use.

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

The start of a tool use block.

" + } + }, + "com.amazonaws.bedrockruntime#ToolUseId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.bedrockruntime#Tools": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockruntime#Tool" + } + }, "com.amazonaws.bedrockruntime#Trace": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/cloudtrail.json b/codegen/sdk/aws-models/cloudtrail.json index 20883be5d27..a93850b4e4f 100644 --- a/codegen/sdk/aws-models/cloudtrail.json +++ b/codegen/sdk/aws-models/cloudtrail.json @@ -266,7 +266,7 @@ "Field": { "target": "com.amazonaws.cloudtrail#SelectorField", "traits": { - "smithy.api#documentation": "

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.

\n

For CloudTrail management events, supported fields include readOnly,\n eventCategory, and eventSource.

\n

For CloudTrail data events, supported fields include readOnly,\n eventCategory, eventName, resources.type, and resources.ARN.

\n

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.

\n
    \n
  • \n

    \n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.

    \n
  • \n
  • \n

    \n \n eventSource\n - For filtering\n management events only. This can be set to NotEquals\n kms.amazonaws.com or NotEquals\n rdsdata.amazonaws.com.

    \n
  • \n
  • \n

    \n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.

    \n
  • \n
  • \n

    \n \n eventCategory\n - This is required and\n must be set to Equals. \n

    \n
      \n
    • \n

      \n For CloudTrail management events, the value\n must be Management. \n

      \n
    • \n
    • \n

      \n For CloudTrail data events, the value\n must be Data. \n

      \n
    • \n
    \n

    The following are used only for event data stores:

    \n
      \n
    • \n

      \n For CloudTrail Insights events, the value\n must be Insight. \n

      \n
    • \n
    • \n

      \n For Config\n configuration items, the value must be ConfigurationItem.\n

      \n
    • \n
    • \n

      \n For Audit Manager evidence, the value must be Evidence.\n

      \n
    • \n
    • \n

      \n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n

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

    \n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:

    \n
      \n
    • \n

      \n AWS::DynamoDB::Table\n

      \n
    • \n
    • \n

      \n AWS::Lambda::Function\n

      \n
    • \n
    • \n

      \n AWS::S3::Object\n

      \n
    • \n
    • \n

      \n AWS::AppConfig::Configuration\n

      \n
    • \n
    • \n

      \n AWS::B2BI::Transformer\n

      \n
    • \n
    • \n

      \n AWS::Bedrock::AgentAlias\n

      \n
    • \n
    • \n

      \n AWS::Bedrock::KnowledgeBase\n

      \n
    • \n
    • \n

      \n AWS::Cassandra::Table\n

      \n
    • \n
    • \n

      \n AWS::CloudFront::KeyValueStore\n

      \n
    • \n
    • \n

      \n AWS::CloudTrail::Channel\n

      \n
    • \n
    • \n

      \n AWS::CodeWhisperer::Customization\n

      \n
    • \n
    • \n

      \n AWS::CodeWhisperer::Profile\n

      \n
    • \n
    • \n

      \n AWS::Cognito::IdentityPool\n

      \n
    • \n
    • \n

      \n AWS::DynamoDB::Stream\n

      \n
    • \n
    • \n

      \n AWS::EC2::Snapshot\n

      \n
    • \n
    • \n

      \n AWS::EMRWAL::Workspace\n

      \n
    • \n
    • \n

      \n AWS::FinSpace::Environment\n

      \n
    • \n
    • \n

      \n AWS::Glue::Table\n

      \n
    • \n
    • \n

      \n AWS::GreengrassV2::ComponentVersion\n

      \n
    • \n
    • \n

      \n AWS::GreengrassV2::Deployment\n

      \n
    • \n
    • \n

      \n AWS::GuardDuty::Detector\n

      \n
    • \n
    • \n

      \n AWS::IoT::Certificate\n

      \n
    • \n
    • \n

      \n AWS::IoT::Thing\n

      \n
    • \n
    • \n

      \n AWS::IoTSiteWise::Asset\n

      \n
    • \n
    • \n

      \n AWS::IoTSiteWise::TimeSeries\n

      \n
    • \n
    • \n

      \n AWS::IoTTwinMaker::Entity\n

      \n
    • \n
    • \n

      \n AWS::IoTTwinMaker::Workspace\n

      \n
    • \n
    • \n

      \n AWS::KendraRanking::ExecutionPlan\n

      \n
    • \n
    • \n

      \n AWS::KinesisVideo::Stream\n

      \n
    • \n
    • \n

      \n AWS::ManagedBlockchain::Network\n

      \n
    • \n
    • \n

      \n AWS::ManagedBlockchain::Node\n

      \n
    • \n
    • \n

      \n AWS::MedicalImaging::Datastore\n

      \n
    • \n
    • \n

      \n AWS::NeptuneGraph::Graph\n

      \n
    • \n
    • \n

      \n AWS::PCAConnectorAD::Connector\n

      \n
    • \n
    • \n

      \n AWS::QBusiness::Application\n

      \n
    • \n
    • \n

      \n AWS::QBusiness::DataSource\n

      \n
    • \n
    • \n

      \n AWS::QBusiness::Index\n

      \n
    • \n
    • \n

      \n AWS::QBusiness::WebExperience\n

      \n
    • \n
    • \n

      \n AWS::RDS::DBCluster\n

      \n
    • \n
    • \n

      \n AWS::S3::AccessPoint\n

      \n
    • \n
    • \n

      \n AWS::S3ObjectLambda::AccessPoint\n

      \n
    • \n
    • \n

      \n AWS::S3Outposts::Object\n

      \n
    • \n
    • \n

      \n AWS::SageMaker::Endpoint\n

      \n
    • \n
    • \n

      \n AWS::SageMaker::ExperimentTrialComponent\n

      \n
    • \n
    • \n

      \n AWS::SageMaker::FeatureGroup\n

      \n
    • \n
    • \n

      \n AWS::ServiceDiscovery::Namespace \n

      \n
    • \n
    • \n

      \n AWS::ServiceDiscovery::Service\n

      \n
    • \n
    • \n

      \n AWS::SCN::Instance\n

      \n
    • \n
    • \n

      \n AWS::SNS::PlatformEndpoint\n

      \n
    • \n
    • \n

      \n AWS::SNS::Topic\n

      \n
    • \n
    • \n

      \n AWS::SWF::Domain\n

      \n
    • \n
    • \n

      \n AWS::SQS::Queue\n

      \n
    • \n
    • \n

      \n AWS::SSMMessages::ControlChannel\n

      \n
    • \n
    • \n

      \n AWS::ThinClient::Device\n

      \n
    • \n
    • \n

      \n AWS::ThinClient::Environment\n

      \n
    • \n
    • \n

      \n AWS::Timestream::Database\n

      \n
    • \n
    • \n

      \n AWS::Timestream::Table\n

      \n
    • \n
    • \n

      \n AWS::VerifiedPermissions::PolicyStore\n

      \n
    • \n
    \n

    You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.

    \n
  • \n
  • \n

    \n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. For\n example, if resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.

    \n

    The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.

    \n
      \n
    • \n

      \n arn::s3:::/\n

      \n
    • \n
    • \n

      \n arn::s3::://\n

      \n
    • \n
    \n

    When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::dynamodb:::table/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::lambda:::function:\n

      \n
    • \n
    \n

    When resources.type equals AWS::AppConfig::Configuration, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::appconfig:::application//environment//configuration/\n

      \n
    • \n
    \n

    When resources.type equals AWS::B2BI::Transformer, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::b2bi:::transformer/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Bedrock::AgentAlias, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::bedrock:::agent-alias//\n

      \n
    • \n
    \n

    When resources.type equals AWS::Bedrock::KnowledgeBase, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::bedrock:::knowledge-base/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Cassandra::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cassandra:::/keyspace//table/\n

      \n
    • \n
    \n

    When resources.type equals AWS::CloudFront::KeyValueStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cloudfront:::key-value-store/\n

      \n
    • \n
    \n

    When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cloudtrail:::channel/\n

      \n
    • \n
    \n

    When resources.type equals AWS::CodeWhisperer::Customization, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::codewhisperer:::customization/\n

      \n
    • \n
    \n

    When resources.type equals AWS::CodeWhisperer::Profile, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::codewhisperer:::profile/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cognito-identity:::identitypool/\n

      \n
    • \n
    \n

    When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::dynamodb:::table//stream/\n

      \n
    • \n
    \n

    When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::ec2:::snapshot/\n

      \n
    • \n
    \n

    When resources.type equals AWS::EMRWAL::Workspace, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::emrwal:::workspace/\n

      \n
    • \n
    \n

    When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::finspace:::environment/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::glue:::table//\n

      \n
    • \n
    \n

    When resources.type equals AWS::GreengrassV2::ComponentVersion, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::greengrass:::components/\n

      \n
    • \n
    \n

    When resources.type equals AWS::GreengrassV2::Deployment, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::greengrass:::deployments/\n

      \n
    • \n
    \n

    When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::guardduty:::detector/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoT::Certificate,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iot:::cert/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoT::Thing,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iot:::thing/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoTSiteWise::Asset,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iotsitewise:::asset/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoTSiteWise::TimeSeries,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iotsitewise:::timeseries/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoTTwinMaker::Entity,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iottwinmaker:::workspace//entity/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoTTwinMaker::Workspace,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iottwinmaker:::workspace/\n

      \n
    • \n
    \n

    When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::kendra-ranking:::rescore-execution-plan/\n

      \n
    • \n
    \n

    When resources.type equals AWS::KinesisVideo::Stream, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::kinesisvideo:::stream//\n

      \n
    • \n
    \n

    When resources.type equals AWS::ManagedBlockchain::Network,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::managedblockchain:::networks/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::managedblockchain:::nodes/\n

      \n
    • \n
    \n

    When resources.type equals AWS::MedicalImaging::Datastore,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::medical-imaging:::datastore/\n

      \n
    • \n
    \n

    When resources.type equals AWS::NeptuneGraph::Graph,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::neptune-graph:::graph/\n

      \n
    • \n
    \n

    When resources.type equals AWS::PCAConnectorAD::Connector,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::pca-connector-ad:::connector/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QBusiness::Application,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QBusiness::DataSource,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//index//data-source/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QBusiness::Index,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//index/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QBusiness::WebExperience,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//web-experience/\n

      \n
    • \n
    \n

    When resources.type equals AWS::RDS::DBCluster,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::rds:::cluster/\n

      \n
    • \n
    \n

    When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.

    \n
      \n
    • \n

      \n arn::s3:::accesspoint/\n

      \n
    • \n
    • \n

      \n arn::s3:::accesspoint//object/\n

      \n
    • \n
    \n

    When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:

    \n
      \n
    • \n

      \n arn::s3-object-lambda:::accesspoint/\n

      \n
    • \n
    \n

    When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::s3-outposts:::\n

      \n
    • \n
    \n

    When resources.type equals AWS::SageMaker::Endpoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::endpoint/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::experiment-trial-component/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::feature-group/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SCN::Instance, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::scn:::instance/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ServiceDiscovery::Namespace, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::servicediscovery:::namespace/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ServiceDiscovery::Service, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::servicediscovery:::service/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SNS::PlatformEndpoint,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sns:::endpoint///\n

      \n
    • \n
    \n

    When resources.type equals AWS::SNS::Topic,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sns:::\n

      \n
    • \n
    \n

    When resources.type equals AWS::SWF::Domain,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::swf:::domain/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SQS::Queue,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sqs:::\n

      \n
    • \n
    \n

    When resources.type equals AWS::SSMMessages::ControlChannel, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::ssmmessages:::control-channel/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ThinClient::Device, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::thinclient:::device/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ThinClient::Environment, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::thinclient:::environment/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Timestream::Database,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::timestream:::database/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Timestream::Table,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::timestream:::database//table/\n

      \n
    • \n
    \n

    When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::verifiedpermissions:::policy-store/\n

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

A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for\n selecting events as filtering is not supported.

\n

For CloudTrail management events, supported fields include readOnly,\n eventCategory, and eventSource.

\n

For CloudTrail data events, supported fields include readOnly,\n eventCategory, eventName, resources.type, and resources.ARN.

\n

For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the only supported field is\n eventCategory.

\n
    \n
  • \n

    \n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.

    \n
  • \n
  • \n

    \n \n eventSource\n - For filtering\n management events only. This can be set to NotEquals\n kms.amazonaws.com or NotEquals\n rdsdata.amazonaws.com.

    \n
  • \n
  • \n

    \n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.

    \n
  • \n
  • \n

    \n \n eventCategory\n - This is required and\n must be set to Equals. \n

    \n
      \n
    • \n

      \n For CloudTrail management events, the value\n must be Management. \n

      \n
    • \n
    • \n

      \n For CloudTrail data events, the value\n must be Data. \n

      \n
    • \n
    \n

    The following are used only for event data stores:

    \n
      \n
    • \n

      \n For CloudTrail Insights events, the value\n must be Insight. \n

      \n
    • \n
    • \n

      \n For Config\n configuration items, the value must be ConfigurationItem.\n

      \n
    • \n
    • \n

      \n For Audit Manager evidence, the value must be Evidence.\n

      \n
    • \n
    • \n

      \n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n

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

    \n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:

    \n
      \n
    • \n

      \n AWS::DynamoDB::Table\n

      \n
    • \n
    • \n

      \n AWS::Lambda::Function\n

      \n
    • \n
    • \n

      \n AWS::S3::Object\n

      \n
    • \n
    • \n

      \n AWS::AppConfig::Configuration\n

      \n
    • \n
    • \n

      \n AWS::B2BI::Transformer\n

      \n
    • \n
    • \n

      \n AWS::Bedrock::AgentAlias\n

      \n
    • \n
    • \n

      \n AWS::Bedrock::KnowledgeBase\n

      \n
    • \n
    • \n

      \n AWS::Cassandra::Table\n

      \n
    • \n
    • \n

      \n AWS::CloudFront::KeyValueStore\n

      \n
    • \n
    • \n

      \n AWS::CloudTrail::Channel\n

      \n
    • \n
    • \n

      \n AWS::CodeWhisperer::Customization\n

      \n
    • \n
    • \n

      \n AWS::CodeWhisperer::Profile\n

      \n
    • \n
    • \n

      \n AWS::Cognito::IdentityPool\n

      \n
    • \n
    • \n

      \n AWS::DynamoDB::Stream\n

      \n
    • \n
    • \n

      \n AWS::EC2::Snapshot\n

      \n
    • \n
    • \n

      \n AWS::EMRWAL::Workspace\n

      \n
    • \n
    • \n

      \n AWS::FinSpace::Environment\n

      \n
    • \n
    • \n

      \n AWS::Glue::Table\n

      \n
    • \n
    • \n

      \n AWS::GreengrassV2::ComponentVersion\n

      \n
    • \n
    • \n

      \n AWS::GreengrassV2::Deployment\n

      \n
    • \n
    • \n

      \n AWS::GuardDuty::Detector\n

      \n
    • \n
    • \n

      \n AWS::IoT::Certificate\n

      \n
    • \n
    • \n

      \n AWS::IoT::Thing\n

      \n
    • \n
    • \n

      \n AWS::IoTSiteWise::Asset\n

      \n
    • \n
    • \n

      \n AWS::IoTSiteWise::TimeSeries\n

      \n
    • \n
    • \n

      \n AWS::IoTTwinMaker::Entity\n

      \n
    • \n
    • \n

      \n AWS::IoTTwinMaker::Workspace\n

      \n
    • \n
    • \n

      \n AWS::KendraRanking::ExecutionPlan\n

      \n
    • \n
    • \n

      \n AWS::KinesisVideo::Stream\n

      \n
    • \n
    • \n

      \n AWS::ManagedBlockchain::Network\n

      \n
    • \n
    • \n

      \n AWS::ManagedBlockchain::Node\n

      \n
    • \n
    • \n

      \n AWS::MedicalImaging::Datastore\n

      \n
    • \n
    • \n

      \n AWS::NeptuneGraph::Graph\n

      \n
    • \n
    • \n

      \n AWS::PCAConnectorAD::Connector\n

      \n
    • \n
    • \n

      \n AWS::QApps:QApp\n

      \n
    • \n
    • \n

      \n AWS::QBusiness::Application\n

      \n
    • \n
    • \n

      \n AWS::QBusiness::DataSource\n

      \n
    • \n
    • \n

      \n AWS::QBusiness::Index\n

      \n
    • \n
    • \n

      \n AWS::QBusiness::WebExperience\n

      \n
    • \n
    • \n

      \n AWS::RDS::DBCluster\n

      \n
    • \n
    • \n

      \n AWS::S3::AccessPoint\n

      \n
    • \n
    • \n

      \n AWS::S3ObjectLambda::AccessPoint\n

      \n
    • \n
    • \n

      \n AWS::S3Outposts::Object\n

      \n
    • \n
    • \n

      \n AWS::SageMaker::Endpoint\n

      \n
    • \n
    • \n

      \n AWS::SageMaker::ExperimentTrialComponent\n

      \n
    • \n
    • \n

      \n AWS::SageMaker::FeatureGroup\n

      \n
    • \n
    • \n

      \n AWS::ServiceDiscovery::Namespace \n

      \n
    • \n
    • \n

      \n AWS::ServiceDiscovery::Service\n

      \n
    • \n
    • \n

      \n AWS::SCN::Instance\n

      \n
    • \n
    • \n

      \n AWS::SNS::PlatformEndpoint\n

      \n
    • \n
    • \n

      \n AWS::SNS::Topic\n

      \n
    • \n
    • \n

      \n AWS::SQS::Queue\n

      \n
    • \n
    • \n

      \n AWS::SSM::ManagedNode\n

      \n
    • \n
    • \n

      \n AWS::SSMMessages::ControlChannel\n

      \n
    • \n
    • \n

      \n AWS::SWF::Domain\n

      \n
    • \n
    • \n

      \n AWS::ThinClient::Device\n

      \n
    • \n
    • \n

      \n AWS::ThinClient::Environment\n

      \n
    • \n
    • \n

      \n AWS::Timestream::Database\n

      \n
    • \n
    • \n

      \n AWS::Timestream::Table\n

      \n
    • \n
    • \n

      \n AWS::VerifiedPermissions::PolicyStore\n

      \n
    • \n
    • \n

      \n AWS::XRay::Trace\n

      \n
    • \n
    \n

    You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.

    \n
  • \n
  • \n

    \n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type.

    \n \n

    You can't use the resources.ARN field to filter resource types that do not have ARNs.

    \n
    \n

    The resources.ARN field can be set one of the following.

    \n

    If resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.

    \n

    The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.

    \n
      \n
    • \n

      \n arn::s3:::/\n

      \n
    • \n
    • \n

      \n arn::s3::://\n

      \n
    • \n
    \n

    When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::dynamodb:::table/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::lambda:::function:\n

      \n
    • \n
    \n

    When resources.type equals AWS::AppConfig::Configuration, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::appconfig:::application//environment//configuration/\n

      \n
    • \n
    \n

    When resources.type equals AWS::B2BI::Transformer, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::b2bi:::transformer/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Bedrock::AgentAlias, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::bedrock:::agent-alias//\n

      \n
    • \n
    \n

    When resources.type equals AWS::Bedrock::KnowledgeBase, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::bedrock:::knowledge-base/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Cassandra::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cassandra:::/keyspace//table/\n

      \n
    • \n
    \n

    When resources.type equals AWS::CloudFront::KeyValueStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cloudfront:::key-value-store/\n

      \n
    • \n
    \n

    When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cloudtrail:::channel/\n

      \n
    • \n
    \n

    When resources.type equals AWS::CodeWhisperer::Customization, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::codewhisperer:::customization/\n

      \n
    • \n
    \n

    When resources.type equals AWS::CodeWhisperer::Profile, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::codewhisperer:::profile/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cognito-identity:::identitypool/\n

      \n
    • \n
    \n

    When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::dynamodb:::table//stream/\n

      \n
    • \n
    \n

    When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::ec2:::snapshot/\n

      \n
    • \n
    \n

    When resources.type equals AWS::EMRWAL::Workspace, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::emrwal:::workspace/\n

      \n
    • \n
    \n

    When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::finspace:::environment/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::glue:::table//\n

      \n
    • \n
    \n

    When resources.type equals AWS::GreengrassV2::ComponentVersion, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::greengrass:::components/\n

      \n
    • \n
    \n

    When resources.type equals AWS::GreengrassV2::Deployment, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::greengrass:::deployments/\n

      \n
    • \n
    \n

    When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::guardduty:::detector/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoT::Certificate,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iot:::cert/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoT::Thing,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iot:::thing/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoTSiteWise::Asset,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iotsitewise:::asset/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoTSiteWise::TimeSeries,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iotsitewise:::timeseries/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoTTwinMaker::Entity,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iottwinmaker:::workspace//entity/\n

      \n
    • \n
    \n

    When resources.type equals AWS::IoTTwinMaker::Workspace,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iottwinmaker:::workspace/\n

      \n
    • \n
    \n

    When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::kendra-ranking:::rescore-execution-plan/\n

      \n
    • \n
    \n

    When resources.type equals AWS::KinesisVideo::Stream, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::kinesisvideo:::stream//\n

      \n
    • \n
    \n

    When resources.type equals AWS::ManagedBlockchain::Network,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::managedblockchain:::networks/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::managedblockchain:::nodes/\n

      \n
    • \n
    \n

    When resources.type equals AWS::MedicalImaging::Datastore,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::medical-imaging:::datastore/\n

      \n
    • \n
    \n

    When resources.type equals AWS::NeptuneGraph::Graph,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::neptune-graph:::graph/\n

      \n
    • \n
    \n

    When resources.type equals AWS::PCAConnectorAD::Connector,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::pca-connector-ad:::connector/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QApps:QApp,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qapps:::application//qapp/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QBusiness::Application,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QBusiness::DataSource,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//index//data-source/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QBusiness::Index,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//index/\n

      \n
    • \n
    \n

    When resources.type equals AWS::QBusiness::WebExperience,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//web-experience/\n

      \n
    • \n
    \n

    When resources.type equals AWS::RDS::DBCluster,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::rds:::cluster/\n

      \n
    • \n
    \n

    When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.

    \n
      \n
    • \n

      \n arn::s3:::accesspoint/\n

      \n
    • \n
    • \n

      \n arn::s3:::accesspoint//object/\n

      \n
    • \n
    \n

    When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:

    \n
      \n
    • \n

      \n arn::s3-object-lambda:::accesspoint/\n

      \n
    • \n
    \n

    When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::s3-outposts:::\n

      \n
    • \n
    \n

    When resources.type equals AWS::SageMaker::Endpoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::endpoint/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::experiment-trial-component/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::feature-group/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SCN::Instance, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::scn:::instance/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ServiceDiscovery::Namespace, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::servicediscovery:::namespace/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ServiceDiscovery::Service, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::servicediscovery:::service/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SNS::PlatformEndpoint,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sns:::endpoint///\n

      \n
    • \n
    \n

    When resources.type equals AWS::SNS::Topic,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sns:::\n

      \n
    • \n
    \n

    When resources.type equals AWS::SQS::Queue,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sqs:::\n

      \n
    • \n
    \n

    When resources.type equals AWS::SSM::ManagedNode, and\n the operator is set to Equals or NotEquals, the ARN must be\n in one of the following formats:

    \n
      \n
    • \n

      \n arn::ssm:::managed-instance/\n

      \n
    • \n
    • \n

      \n arn::ec2:::instance/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SSMMessages::ControlChannel, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::ssmmessages:::control-channel/\n

      \n
    • \n
    \n

    When resources.type equals AWS::SWF::Domain,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::swf:::domain/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ThinClient::Device, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::thinclient:::device/\n

      \n
    • \n
    \n

    When resources.type equals AWS::ThinClient::Environment, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::thinclient:::environment/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Timestream::Database,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::timestream:::database/\n

      \n
    • \n
    \n

    When resources.type equals AWS::Timestream::Table,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::timestream:::database//table/\n

      \n
    • \n
    \n

    When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::verifiedpermissions:::policy-store/\n

      \n
    • \n
    \n
  • \n
", "smithy.api#required": {} } }, @@ -637,7 +637,7 @@ "code": "CloudTrailAccessNotEnabled", "httpResponseCode": 400 }, - "smithy.api#documentation": "

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.

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

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see How to enable or disable trusted access in the Organizations User Guide and Prepare For Creating a Trail For Your Organization in the CloudTrail User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2121,7 +2121,7 @@ "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { - "smithy.api#documentation": "

The advanced event selectors to use to select the events for the data store. You can\n configure up to five advanced event selectors for each event data store.

\n

For more information about how to use advanced event selectors to log CloudTrail\n events, see Log events by using advanced event selectors in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration\n items in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include non-Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

" + "smithy.api#documentation": "

The advanced event selectors to use to select the events for the data store. You can\n configure up to five advanced event selectors for each event data store.

\n

For more information about how to use advanced event selectors to log CloudTrail\n events, see Log events by using advanced event selectors in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include Config configuration items in your event data store, see Create an event data store for Config configuration\n items in the CloudTrail User Guide.

\n

For more information about how to use advanced event selectors to include events outside of Amazon Web Services events in your event data store, see Create an integration to log events from outside Amazon Web Services in the CloudTrail User Guide.

" } }, "MultiRegionEnabled": { @@ -2384,14 +2384,14 @@ "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket Naming Requirements.

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

Specifies the name of the Amazon S3 bucket designated for publishing log files. \n For information about bucket naming rules, see Bucket naming rules \n in the Amazon Simple Storage Service User Guide.\n

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

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" } }, "SnsTopicName": { @@ -2469,7 +2469,7 @@ "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" } }, "SnsTopicName": { @@ -2551,12 +2551,12 @@ "Values": { "target": "com.amazonaws.cloudtrail#DataResourceValues", "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\n objects.

\n
    \n
  • \n

    To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.

    \n \n

    This also enables logging of data event activity performed by any user or role\n in your Amazon Web Services account, even if that activity is performed on a bucket\n that belongs to another Amazon Web Services account.

    \n
    \n
  • \n
  • \n

    To log data events for all objects in an S3 bucket, specify the bucket and an\n empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data\n events for all objects in this S3 bucket.

    \n
  • \n
  • \n

    To log data events for specific objects, specify the S3 bucket and object prefix\n such as arn:aws:s3:::bucket-1/example-images. The trail logs data events\n for objects in this S3 bucket that match the prefix.

    \n
  • \n
  • \n

    To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.

    \n \n

    This also enables logging of Invoke activity performed by any user\n or role in your Amazon Web Services account, even if that activity is performed on\n a function that belongs to another Amazon Web Services account.

    \n
    \n
  • \n
  • \n

    To log data events for a specific Lambda function, specify the\n function ARN.

    \n \n

    Lambda function ARNs are exact. For example, if you specify a\n function ARN\n arn:aws:lambda:us-west-2:111111111111:function:helloworld,\n data events will only be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld.\n They will not be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld2.

    \n
    \n
  • \n
  • \n

    To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.

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

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\n resource type.

\n
    \n
  • \n

    To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.

    \n \n

    This also enables logging of data event activity performed by any user or role\n in your Amazon Web Services account, even if that activity is performed on a bucket\n that belongs to another Amazon Web Services account.

    \n
    \n
  • \n
  • \n

    To log data events for all objects in an S3 bucket, specify the bucket and an\n empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data\n events for all objects in this S3 bucket.

    \n
  • \n
  • \n

    To log data events for specific objects, specify the S3 bucket and object prefix\n such as arn:aws:s3:::bucket-1/example-images. The trail logs data events\n for objects in this S3 bucket that match the prefix.

    \n
  • \n
  • \n

    To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.

    \n \n

    This also enables logging of Invoke activity performed by any user\n or role in your Amazon Web Services account, even if that activity is performed on\n a function that belongs to another Amazon Web Services account.

    \n
    \n
  • \n
  • \n

    To log data events for a specific Lambda function, specify the\n function ARN.

    \n \n

    Lambda function ARNs are exact. For example, if you specify a\n function ARN\n arn:aws:lambda:us-west-2:111111111111:function:helloworld,\n data events will only be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld.\n They will not be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld2.

    \n
    \n
  • \n
  • \n

    To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.

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

The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data\n events provide information about the resource operations performed on or within a resource\n itself. These are also known as data plane operations. You can specify up to 250 data\n resources for a trail.

\n \n

The total number of allowed data resources is 250. This number can be distributed\n between 1 and 5 event selectors, but the total cannot exceed 250 across all\n selectors for the trail.

\n

If you are using advanced event selectors, the maximum total number of values for\n all conditions, across all advanced event selectors for the trail, is 500.

\n
\n

The following example demonstrates how logging works when you configure logging of all\n data events for an S3 bucket named bucket-1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read\n and Write data events.

\n
    \n
  1. \n

    A user uploads an image file to bucket-1.

    \n
  2. \n
  3. \n

    The PutObject API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.

    \n
  4. \n
  5. \n

    A user uploads an object to an Amazon S3 bucket named\n arn:aws:s3:::bucket-2.

    \n
  6. \n
  7. \n

    The PutObject API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn’t log\n the event.

    \n
  8. \n
\n

The following example demonstrates how logging works when you configure logging of\n Lambda data events for a Lambda function named\n MyLambdaFunction, but not for all Lambda\n functions.

\n
    \n
  1. \n

    A user runs a script that includes a call to the\n MyLambdaFunction function and the\n MyOtherLambdaFunction function.

    \n
  2. \n
  3. \n

    The Invoke API operation on MyLambdaFunction is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n MyLambdaFunction, any invocations of that function are\n logged. The trail processes and logs the event.

    \n
  4. \n
  5. \n

    The Invoke API operation on\n MyOtherLambdaFunction is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for\n MyOtherLambdaFunction does not match the function specified\n for the trail. The trail doesn’t log the event.

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

Data events provide information about the resource operations performed on or within a resource\n itself. These are also known as data plane operations. You can specify up to 250 data\n resources for a trail.

\n

Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.

\n

You can specify the following resource types in your event selectors for your trail:

\n
    \n
  • \n

    \n AWS::DynamoDB::Table\n

    \n
  • \n
  • \n

    \n AWS::Lambda::Function\n

    \n
  • \n
  • \n

    \n AWS::S3::Object\n

    \n
  • \n
\n \n

The total number of allowed data resources is 250. This number can be distributed\n between 1 and 5 event selectors, but the total cannot exceed 250 across all\n selectors for the trail.

\n

If you are using advanced event selectors, the maximum total number of values for\n all conditions, across all advanced event selectors for the trail, is 500.

\n
\n

The following example demonstrates how logging works when you configure logging of all\n data events for an S3 bucket named bucket-1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read\n and Write data events.

\n
    \n
  1. \n

    A user uploads an image file to bucket-1.

    \n
  2. \n
  3. \n

    The PutObject API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.

    \n
  4. \n
  5. \n

    A user uploads an object to an Amazon S3 bucket named\n arn:aws:s3:::bucket-2.

    \n
  6. \n
  7. \n

    The PutObject API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn’t log\n the event.

    \n
  8. \n
\n

The following example demonstrates how logging works when you configure logging of\n Lambda data events for a Lambda function named\n MyLambdaFunction, but not for all Lambda\n functions.

\n
    \n
  1. \n

    A user runs a script that includes a call to the\n MyLambdaFunction function and the\n MyOtherLambdaFunction function.

    \n
  2. \n
  3. \n

    The Invoke API operation on MyLambdaFunction is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n MyLambdaFunction, any invocations of that function are\n logged. The trail processes and logs the event.

    \n
  4. \n
  5. \n

    The Invoke API operation on\n MyOtherLambdaFunction is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for\n MyOtherLambdaFunction does not match the function specified\n for the trail. The trail doesn’t log the event.

    \n
  6. \n
" } }, "com.amazonaws.cloudtrail#DataResourceValues": { @@ -3606,7 +3606,7 @@ } }, "traits": { - "smithy.api#documentation": "

A storage lake of event data against which you can run complex SQL-based queries. An\n event data store can include events that you have logged on your account. To select events for an event data\n store, use advanced event selectors.

" + "smithy.api#documentation": "

A storage lake of event data against which you can run complex SQL-based queries. An\n event data store can include events that you have logged on your account. To select events for an event data\n store, use advanced event selectors.

" } }, "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException": { @@ -4155,6 +4155,12 @@ "traits": { "smithy.api#documentation": "

\n If Lake query federation is enabled, provides the ARN of the federation role used to access the resources for the federated event data store.\n

" } + }, + "PartitionKeys": { + "target": "com.amazonaws.cloudtrail#PartitionKeyList", + "traits": { + "smithy.api#documentation": "

The partition keys for the event data store. To improve query performance and efficiency, CloudTrail Lake organizes \n event data into partitions based on values derived from partition keys.

" + } } }, "traits": { @@ -4742,7 +4748,7 @@ "LatestDeliveryError": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver log files to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, create a new bucket,\n and then call UpdateTrail to specify the new bucket; or fix the existing\n objects so that CloudTrail can again write to the bucket.

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

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver log files to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, \n fix the bucket policy so that CloudTrail \n can write to the bucket; or create a new bucket and call UpdateTrail to specify the new bucket.

\n
" } }, "LatestNotificationError": { @@ -4796,7 +4802,7 @@ "LatestDigestDeliveryError": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver a digest file to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, create a new bucket,\n and then call UpdateTrail to specify the new bucket; or fix the existing\n objects so that CloudTrail can again write to the bucket.

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

Displays any Amazon S3 error that CloudTrail encountered when attempting\n to deliver a digest file to the designated bucket. For more information, see Error\n Responses in the Amazon S3 API Reference.

\n \n

This error occurs only when there is a problem with the destination S3 bucket, and\n does not occur for requests that time out. To resolve the issue, \n fix the bucket policy so that CloudTrail \n can write to the bucket; or create a new bucket and call UpdateTrail to specify the new bucket.

\n
" } }, "LatestDeliveryAttemptTime": { @@ -7112,7 +7118,7 @@ "code": "NotOrganizationMasterAccount", "httpResponseCode": 400 }, - "smithy.api#documentation": "

This exception is thrown when the Amazon Web Services account making the request to\n create or update an organization trail or event data store is not the management account\n for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.

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

This exception is thrown when the Amazon Web Services account making the request to\n create or update an organization trail or event data store is not the management account\n for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Organization event data stores.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7208,6 +7214,60 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.cloudtrail#PartitionKey": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#PartitionKeyName", + "traits": { + "smithy.api#documentation": "

The name of the partition key.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.cloudtrail#PartitionKeyType", + "traits": { + "smithy.api#documentation": "

The data type of the partition key. For example, bigint or string.

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

Contains information about a partition key for an event data store.

" + } + }, + "com.amazonaws.cloudtrail#PartitionKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#PartitionKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.cloudtrail#PartitionKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.cloudtrail#PartitionKeyType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, "com.amazonaws.cloudtrail#PublicKey": { "type": "structure", "members": { @@ -7293,7 +7353,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures an event selector or advanced event selectors for your trail. Use event\n selectors or advanced event selectors to specify management and data event settings for\n your trail. If you want your trail to log Insights events, be sure the event selector \n enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events for trails in the CloudTrail User Guide.\n By default, trails created without specific event selectors are configured to\n log all read and write management events, and no data events.

\n

When an event occurs in your account, CloudTrail evaluates the event selectors or\n advanced event selectors in all trails. For each trail, if the event matches any event\n selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.

\n

Example

\n
    \n
  1. \n

    You create an event selector for a trail and specify that you want write-only\n events.

    \n
  2. \n
  3. \n

    The EC2 GetConsoleOutput and RunInstances API operations\n occur in your account.

    \n
  4. \n
  5. \n

    CloudTrail evaluates whether the events match your event selectors.

    \n
  6. \n
  7. \n

    The RunInstances is a write-only event and it matches your event\n selector. The trail logs the event.

    \n
  8. \n
  9. \n

    The GetConsoleOutput is a read-only event that doesn't match your\n event selector. The trail doesn't log the event.

    \n
  10. \n
\n

The PutEventSelectors operation must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.

\n

You can configure up to five event selectors for each trail. For more information, see\n Logging management events, Logging\n data events, and Quotas in CloudTrail in the CloudTrail User\n Guide.

\n

You can add advanced event selectors, and conditions for your advanced event selectors,\n up to a maximum of 500 values for all conditions and selectors on a trail. You can use\n either AdvancedEventSelectors or EventSelectors, but not both. If\n you apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events in the CloudTrail User Guide.

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

Configures an event selector or advanced event selectors for your trail. Use event\n selectors or advanced event selectors to specify management and data event settings for\n your trail. If you want your trail to log Insights events, be sure the event selector \n enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide.\n By default, trails created without specific event selectors are configured to\n log all read and write management events, and no data events.

\n

When an event occurs in your account, CloudTrail evaluates the event selectors or\n advanced event selectors in all trails. For each trail, if the event matches any event\n selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.

\n

Example

\n
    \n
  1. \n

    You create an event selector for a trail and specify that you want write-only\n events.

    \n
  2. \n
  3. \n

    The EC2 GetConsoleOutput and RunInstances API operations\n occur in your account.

    \n
  4. \n
  5. \n

    CloudTrail evaluates whether the events match your event selectors.

    \n
  6. \n
  7. \n

    The RunInstances is a write-only event and it matches your event\n selector. The trail logs the event.

    \n
  8. \n
  9. \n

    The GetConsoleOutput is a read-only event that doesn't match your\n event selector. The trail doesn't log the event.

    \n
  10. \n
\n

The PutEventSelectors operation must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.

\n

You can configure up to five event selectors for each trail. For more information, see\n Logging management events, Logging\n data events, and Quotas in CloudTrail in the CloudTrail User\n Guide.

\n

You can add advanced event selectors, and conditions for your advanced event selectors,\n up to a maximum of 500 values for all conditions and selectors on a trail. You can use\n either AdvancedEventSelectors or EventSelectors, but not both. If\n you apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events in the CloudTrail User Guide.

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

Starts an import of logged trail events from a source S3 bucket to a destination event\n data store. By default, CloudTrail only imports events contained in the S3 bucket's\n CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services\n services. If you want to import CloudTrail events contained in another prefix, you\n must include the prefix in the S3LocationUri. For more considerations about\n importing trail events, see Considerations.

\n

When you start a new import, the Destinations and\n ImportSource parameters are required. Before starting a new import, disable\n any access control lists (ACLs) attached to the source S3 bucket. For more information\n about disabling ACLs, see Controlling ownership of\n objects and disabling ACLs for your bucket.

\n

When you retry an import, the ImportID parameter is required.

\n \n

If the destination event data store is for an organization, you must use the\n management account to import trail events. You cannot use the delegated administrator\n account for the organization.

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

Starts an import of logged trail events from a source S3 bucket to a destination event\n data store. By default, CloudTrail only imports events contained in the S3 bucket's\n CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services\n services. If you want to import CloudTrail events contained in another prefix, you\n must include the prefix in the S3LocationUri. For more considerations about\n importing trail events, see Considerations for copying trail events in the CloudTrail User Guide.

\n

When you start a new import, the Destinations and\n ImportSource parameters are required. Before starting a new import, disable\n any access control lists (ACLs) attached to the source S3 bucket. For more information\n about disabling ACLs, see Controlling ownership of\n objects and disabling ACLs for your bucket.

\n

When you retry an import, the ImportID parameter is required.

\n \n

If the destination event data store is for an organization, you must use the\n management account to import trail events. You cannot use the delegated administrator\n account for the organization.

\n
" } }, "com.amazonaws.cloudtrail#StartImportRequest": { @@ -9146,13 +9206,13 @@ "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Name of the Amazon S3 bucket into which CloudTrail delivers your trail\n files. See Amazon S3\n Bucket Naming Requirements.

" + "smithy.api#documentation": "

Name of the Amazon S3 bucket into which CloudTrail delivers your trail\n files. See Amazon S3\n Bucket naming rules.

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

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" } }, "SnsTopicName": { @@ -9834,13 +9894,13 @@ "S3BucketName": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket Naming Requirements.

" + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket designated for publishing log files.\n See Amazon S3\n Bucket naming rules.

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

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200\n characters.

" } }, "SnsTopicName": { @@ -9915,7 +9975,7 @@ "S3KeyPrefix": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your IAM Log Files.

" + "smithy.api#documentation": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you\n have designated for log file delivery. For more information, see Finding Your IAM Log Files.

" } }, "SnsTopicName": { diff --git a/codegen/sdk/aws-models/connect.json b/codegen/sdk/aws-models/connect.json index f607dec1042..415c13eeafd 100644 --- a/codegen/sdk/aws-models/connect.json +++ b/codegen/sdk/aws-models/connect.json @@ -3573,6 +3573,12 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#AssociatedQueueIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueId" + } + }, "com.amazonaws.connect#AssociationId": { "type": "string", "traits": { @@ -28917,6 +28923,12 @@ "smithy.api#default": false, "smithy.api#documentation": "

Whether this a default routing profile.

" } + }, + "AssociatedQueueIds": { + "target": "com.amazonaws.connect#AssociatedQueueIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the associated queue.

" + } } }, "traits": { @@ -29121,7 +29133,7 @@ "StringCondition": { "target": "com.amazonaws.connect#StringCondition", "traits": { - "smithy.api#documentation": "

A leaf node condition which can be used to specify a string condition.

\n \n

The currently supported values for FieldName are name,\n description, and resourceID.

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

A leaf node condition which can be used to specify a string condition.

\n \n

The currently supported values for FieldName are\n associatedQueueIds, name, description, and resourceID.

\n
" } } }, diff --git a/codegen/sdk/aws-models/emr-serverless.json b/codegen/sdk/aws-models/emr-serverless.json index f247780feeb..c6bd0f79d18 100644 --- a/codegen/sdk/aws-models/emr-serverless.json +++ b/codegen/sdk/aws-models/emr-serverless.json @@ -351,6 +351,14 @@ ] } }, + "com.amazonaws.emrserverless#AttemptNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.emrserverless#AutoStartConfig": { "type": "structure", "members": { @@ -1739,6 +1747,13 @@ "smithy.api#required": {}, "smithy.api#resourceIdentifier": "jobRunId" } + }, + "attempt": { + "target": "com.amazonaws.emrserverless#AttemptNumber", + "traits": { + "smithy.api#documentation": "

An optimal parameter that indicates the amount of attempts for the job. If not specified,\n this value defaults to the attempt of the latest job.

", + "smithy.api#httpQuery": "attempt" + } } } }, @@ -1801,6 +1816,13 @@ "smithy.api#required": {}, "smithy.api#resourceIdentifier": "jobRunId" } + }, + "attempt": { + "target": "com.amazonaws.emrserverless#AttemptNumber", + "traits": { + "smithy.api#documentation": "

An optimal parameter that indicates the amount of attempts for the job. If not specified,\n this value defaults to the attempt of the latest job.

", + "smithy.api#httpQuery": "attempt" + } } } }, @@ -2160,12 +2182,159 @@ "traits": { "smithy.api#documentation": "

The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the job\n run. The billed resources include a 1-minute minimum usage for workers, plus additional\n storage over 20 GB per worker. Note that billed resources do not include usage for idle\n pre-initialized workers.

" } + }, + "mode": { + "target": "com.amazonaws.emrserverless#JobRunMode", + "traits": { + "smithy.api#documentation": "

The mode of the job run.

" + } + }, + "retryPolicy": { + "target": "com.amazonaws.emrserverless#RetryPolicy", + "traits": { + "smithy.api#documentation": "

The retry policy of the job run.

" + } + }, + "attempt": { + "target": "com.amazonaws.emrserverless#AttemptNumber", + "traits": { + "smithy.api#documentation": "

The attempt of the job run.

" + } + }, + "attemptCreatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time of when the job run attempt was created.

" + } + }, + "attemptUpdatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time of when the job run attempt was last updated.

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

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive\n query, or SparkSQL query, that you submit to an Amazon EMR Serverless\n application.

" } }, + "com.amazonaws.emrserverless#JobRunAttemptSummary": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application the job is running on.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "id": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run attempt.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The name of the job run attempt.

" + } + }, + "mode": { + "target": "com.amazonaws.emrserverless#JobRunMode", + "traits": { + "smithy.api#documentation": "

The mode of the job run attempt.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the job run.

", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

", + "smithy.api#required": {} + } + }, + "jobCreatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time of when the job run was created.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run attempt was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time of when the job run attempt was last updated.

", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role of the job run..

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#JobRunState", + "traits": { + "smithy.api#documentation": "

The state of the job run attempt.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the job run attempt.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release label of the job run attempt.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#JobRunType", + "traits": { + "smithy.api#documentation": "

The type of the job run, such as Spark or Hive.

" + } + }, + "attempt": { + "target": "com.amazonaws.emrserverless#AttemptNumber", + "traits": { + "smithy.api#documentation": "

The attempt number of the job run execution.

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

The summary of attributes associated with a job run attempt.

" + } + }, + "com.amazonaws.emrserverless#JobRunAttempts": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#JobRunAttemptSummary" + } + }, "com.amazonaws.emrserverless#JobRunId": { "type": "string", "traits": { @@ -2176,6 +2345,21 @@ "smithy.api#pattern": "^[0-9a-z]+$" } }, + "com.amazonaws.emrserverless#JobRunMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BATCH", + "name": "BATCH" + }, + { + "value": "STREAMING", + "name": "STREAMING" + } + ] + } + }, "com.amazonaws.emrserverless#JobRunResource": { "type": "resource", "identifiers": { @@ -2201,6 +2385,9 @@ "operations": [ { "target": "com.amazonaws.emrserverless#GetDashboardForJobRun" + }, + { + "target": "com.amazonaws.emrserverless#ListJobRunAttempts" } ] }, @@ -2281,6 +2468,12 @@ "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" } }, + "mode": { + "target": "com.amazonaws.emrserverless#JobRunMode", + "traits": { + "smithy.api#documentation": "

The mode of the job run.

" + } + }, "arn": { "target": "com.amazonaws.emrserverless#JobArn", "traits": { @@ -2342,6 +2535,24 @@ "traits": { "smithy.api#documentation": "

The type of job run, such as Spark or Hive.

" } + }, + "attempt": { + "target": "com.amazonaws.emrserverless#AttemptNumber", + "traits": { + "smithy.api#documentation": "

The attempt number of the job run execution.

" + } + }, + "attemptCreatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time of when the job run attempt was created.

" + } + }, + "attemptUpdatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time of when the job run attempt was last updated.

" + } } }, "traits": { @@ -2437,6 +2648,106 @@ } } }, + "com.amazonaws.emrserverless#ListJobRunAttempts": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListJobRunAttemptsRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListJobRunAttemptsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all attempt of a job run.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}/attempts" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobRunAttempts" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListJobRunAttemptsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application for which to list job runs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of job run attempt results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of job run attempts to list.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.emrserverless#ListJobRunAttemptsResponse": { + "type": "structure", + "members": { + "jobRunAttempts": { + "target": "com.amazonaws.emrserverless#JobRunAttempts", + "traits": { + "smithy.api#documentation": "

The array of the listed job run attempt objects.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "

The output displays the token for the next set of application results. \n This is required for pagination and is available as a response of the previous request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.emrserverless#ListJobRuns": { "type": "operation", "input": { @@ -2519,6 +2830,13 @@ "smithy.api#documentation": "

An optional filter for job run states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", "smithy.api#httpQuery": "states" } + }, + "mode": { + "target": "com.amazonaws.emrserverless#JobRunMode", + "traits": { + "smithy.api#documentation": "

The mode of the job runs to list.

", + "smithy.api#httpQuery": "mode" + } } } }, @@ -2877,6 +3195,30 @@ "smithy.api#documentation": "

The resource utilization for memory, storage, and vCPU for jobs.

" } }, + "com.amazonaws.emrserverless#RetryPolicy": { + "type": "structure", + "members": { + "maxAttempts": { + "target": "com.amazonaws.emrserverless#AttemptNumber", + "traits": { + "smithy.api#documentation": "

Maximum number of attempts for the job run. This parameter is only applicable for BATCH mode.

" + } + }, + "maxFailedAttemptsPerHour": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Maximum number of failed attempts per hour. This [arameter is only applicable for STREAMING mode.

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

The retry policy to use for a job run.

" + } + }, "com.amazonaws.emrserverless#S3MonitoringConfiguration": { "type": "structure", "members": { @@ -3126,6 +3468,18 @@ "traits": { "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" } + }, + "mode": { + "target": "com.amazonaws.emrserverless#JobRunMode", + "traits": { + "smithy.api#documentation": "

The mode of the job run when it starts.

" + } + }, + "retryPolicy": { + "target": "com.amazonaws.emrserverless#RetryPolicy", + "traits": { + "smithy.api#documentation": "

The retry policy when job run starts.

" + } } } }, diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index c7a91a17839..fe455b6a4e9 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -419,7 +419,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

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

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

\n

For an overview on tagging your relational database resources, \n see Tagging Amazon RDS Resources\n or Tagging Amazon Aurora and Amazon RDS Resources.\n

", "smithy.api#examples": [ { "title": "To add tags to a resource", @@ -4195,7 +4195,7 @@ "DatabaseName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. If you don't\n provide a name, Amazon RDS doesn't create a database in the DB cluster you are\n creating.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" + "smithy.api#documentation": "

The name for your database of up to 64 alphanumeric characters. \n A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "DBClusterIdentifier": { @@ -4903,7 +4903,7 @@ "DBName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n
\n
Amazon Aurora MySQL
\n
\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 alphanumeric characters.

    \n
  • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
  • \n
\n
\n
Amazon Aurora PostgreSQL
\n
\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
  • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
  • \n
\n
\n
Amazon RDS Custom for Oracle
\n
\n

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 8 alphanumeric characters.

    \n
  • \n
  • \n

    Must contain a letter.

    \n
  • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
  • \n
\n
\n
Amazon RDS Custom for SQL Server
\n
\n

Not applicable. Must be null.

\n
\n
RDS for Db2
\n
\n

The name of the database to create when the DB instance is created. If\n this parameter isn't specified, no database is created in the DB instance.\n In some cases, we recommend that you don't add a database name. For more\n information, see Additional considerations in the Amazon RDS User\n Guide.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters,\n underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
  • \n
\n
\n
RDS for MariaDB
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
  • \n
\n
\n
RDS for MySQL
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
  • \n
\n
\n
RDS for Oracle
\n
\n

The Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters.

    \n
  • \n
\n
\n
RDS for PostgreSQL
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
  • \n
\n
\n
RDS for SQL Server
\n
\n

Not applicable. Must be null.

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

The meaning of this parameter differs according to the database engine you use.

\n
\n
Amazon Aurora MySQL
\n
\n

The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 alphanumeric characters.

    \n
  • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
  • \n
\n
\n
Amazon Aurora PostgreSQL
\n
\n

The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

\n

Constraints:

\n
    \n
  • \n

    It must contain 1 to 63 alphanumeric characters.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits\n (0 to 9).

    \n
  • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
  • \n
\n
\n
Amazon RDS Custom for Oracle
\n
\n

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL for non-CDBs and\n RDSCDB for CDBs.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 8 alphanumeric characters.

    \n
  • \n
  • \n

    Must contain a letter.

    \n
  • \n
  • \n

    Can't be a word reserved by the database engine.

    \n
  • \n
\n
\n
Amazon RDS Custom for SQL Server
\n
\n

Not applicable. Must be null.

\n
\n
RDS for Db2
\n
\n

The name of the database to create when the DB instance is created. If\n this parameter isn't specified, no database is created in the DB instance.\n In some cases, we recommend that you don't add a database name. For more\n information, see Additional considerations in the Amazon RDS User\n Guide.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters,\n underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
  • \n
\n
\n
RDS for MariaDB
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
  • \n
\n
\n
RDS for MySQL
\n
\n

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 64 letters or numbers.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
  • \n
\n
\n
RDS for Oracle
\n
\n

The Oracle System ID (SID) of the created DB instance. If you don't specify a value, \n the default value is ORCL. You can't specify the \n string null, or any other reserved word, for DBName.

\n

Default: ORCL\n

\n

Constraints:

\n
    \n
  • \n

    Can't be longer than 8 characters.

    \n
  • \n
\n
\n
RDS for PostgreSQL
\n
\n

The name of the database to create when the DB instance is created. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

\n

Constraints:

\n
    \n
  • \n

    Must contain 1 to 63 letters, numbers, or underscores.

    \n
  • \n
  • \n

    Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

    \n
  • \n
  • \n

    Can't be a word reserved by the specified database engine.

    \n
  • \n
\n
\n
RDS for SQL Server
\n
\n

Not applicable. Must be null.

\n
\n
" } }, "DBInstanceIdentifier": { @@ -28355,7 +28355,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

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

An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. \n For information about this role,\n see \n Creating an IAM role manually in the Amazon RDS User Guide.\n

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

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see Tagging \n Amazon RDS Resources in the Amazon RDS User Guide.\n

" + "smithy.api#documentation": "

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n

For more information, see\n Tagging Amazon RDS Resources in the Amazon RDS User Guide\n or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide.\n

" } }, "com.amazonaws.rds#TagList": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index 12100f3a0f7..b95df6ef8d7 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -2906,6 +2906,42 @@ "traits": { "smithy.api#enumValue": "fastai" } + }, + "CNN_QR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cnn-qr" + } + }, + "DEEPAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deepar" + } + }, + "PROPHET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "prophet" + } + }, + "NPTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "npts" + } + }, + "ARIMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "arima" + } + }, + "ETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ets" + } } } }, @@ -2916,13 +2952,13 @@ "target": "com.amazonaws.sagemaker#AutoMLAlgorithms", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The selection of algorithms run on a dataset to train the model candidates of an Autopilot\n job.

\n \n

Selected algorithms must belong to the list corresponding to the training mode set in\n AutoMLJobConfig.Mode (ENSEMBLING or\n HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

\n
\n
    \n
  • \n

    In ENSEMBLING mode:

    \n
      \n
    • \n

      \"catboost\"

      \n
    • \n
    • \n

      \"extra-trees\"

      \n
    • \n
    • \n

      \"fastai\"

      \n
    • \n
    • \n

      \"lightgbm\"

      \n
    • \n
    • \n

      \"linear-learner\"

      \n
    • \n
    • \n

      \"nn-torch\"

      \n
    • \n
    • \n

      \"randomforest\"

      \n
    • \n
    • \n

      \"xgboost\"

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

    In HYPERPARAMETER_TUNING mode:

    \n
      \n
    • \n

      \"linear-learner\"

      \n
    • \n
    • \n

      \"mlp\"

      \n
    • \n
    • \n

      \"xgboost\"

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

The selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.

\n
    \n
  • \n

    \n For the tabular problem type TabularJobConfig:\n

    \n \n

    Selected algorithms must belong to the list corresponding to the training mode\n set in AutoMLJobConfig.Mode (ENSEMBLING or\n HYPERPARAMETER_TUNING). Choose a minimum of 1 algorithm.

    \n
    \n
      \n
    • \n

      In ENSEMBLING mode:

      \n
        \n
      • \n

        \"catboost\"

        \n
      • \n
      • \n

        \"extra-trees\"

        \n
      • \n
      • \n

        \"fastai\"

        \n
      • \n
      • \n

        \"lightgbm\"

        \n
      • \n
      • \n

        \"linear-learner\"

        \n
      • \n
      • \n

        \"nn-torch\"

        \n
      • \n
      • \n

        \"randomforest\"

        \n
      • \n
      • \n

        \"xgboost\"

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

      In HYPERPARAMETER_TUNING mode:

      \n
        \n
      • \n

        \"linear-learner\"

        \n
      • \n
      • \n

        \"mlp\"

        \n
      • \n
      • \n

        \"xgboost\"

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

    \n For the time-series forecasting problem type TimeSeriesForecastingJobConfig:\n

    \n
      \n
    • \n

      Choose your algorithms from this list.

      \n
        \n
      • \n

        \"cnn-qr\"

        \n
      • \n
      • \n

        \"deepar\"

        \n
      • \n
      • \n

        \"prophet\"

        \n
      • \n
      • \n

        \"arima\"

        \n
      • \n
      • \n

        \"npts\"

        \n
      • \n
      • \n

        \"ets\"

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

The collection of algorithms run on a dataset for training the model candidates of an\n Autopilot job.

" + "smithy.api#documentation": "

The selection of algorithms trained on your dataset to generate the model candidates for\n an Autopilot job.

" } }, "com.amazonaws.sagemaker#AutoMLAlgorithms": { @@ -3044,13 +3080,13 @@ "FeatureSpecificationS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

A URL to the Amazon S3 data source containing selected features from the input data source to\n run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON\n format as shown below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n \n

These column keys may not include the target column.

\n
\n

In ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.

\n

If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.

\n

If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.

\n

The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.

" + "smithy.api#documentation": "

A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n \n

These column keys may not include the target column.

\n
\n

In ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.

\n

If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.

\n

If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.

\n

The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.

" } }, "AlgorithmsConfig": { "target": "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig", "traits": { - "smithy.api#documentation": "

Stores the configuration information for the selection of algorithms used to train the\n model candidates.

\n

The list of available algorithms to choose from depends on the training mode set in\n \n AutoMLJobConfig.Mode\n .

\n
    \n
  • \n

    \n AlgorithmsConfig should not be set in AUTO training\n mode.

    \n
  • \n
  • \n

    When AlgorithmsConfig is provided, one AutoMLAlgorithms\n attribute must be set and one only.

    \n

    If the list of algorithms provided as values for AutoMLAlgorithms is\n empty, AutoMLCandidateGenerationConfig uses the full set of algorithms\n for the given training mode.

    \n
  • \n
  • \n

    When AlgorithmsConfig is not provided,\n AutoMLCandidateGenerationConfig uses the full set of algorithms for\n the given training mode.

    \n
  • \n
\n

For the list of all algorithms per training mode, see \n AutoMLAlgorithmConfig.

\n

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

" + "smithy.api#documentation": "

Stores the configuration information for the selection of algorithms trained on tabular data.

\n

The list of available algorithms to choose from depends on the training mode set in\n \n TabularJobConfig.Mode\n .

\n
    \n
  • \n

    \n AlgorithmsConfig should not be set if the training mode is set on AUTO.

    \n
  • \n
  • \n

    When AlgorithmsConfig is provided, one AutoMLAlgorithms\n attribute must be set and one only.

    \n

    If the list of algorithms provided as values for AutoMLAlgorithms is\n empty, CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.

    \n
  • \n
  • \n

    When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.

    \n
  • \n
\n

For the list of all algorithms per problem type and training mode, see \n AutoMLAlgorithmConfig.

\n

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

" } } }, @@ -3429,7 +3465,7 @@ "target": "com.amazonaws.sagemaker#AutoMLMetricEnum", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.

\n

The list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.

\n
    \n
  • \n

    For tabular problem types:

    \n
      \n
    • \n

      List of available metrics:

      \n
        \n
      • \n

        Regression: MAE,\n MSE, R2, RMSE\n

        \n
      • \n
      • \n

        Binary classification: Accuracy, AUC,\n BalancedAccuracy, F1,\n Precision, Recall\n

        \n
      • \n
      • \n

        Multiclass classification: Accuracy,\n BalancedAccuracy, F1macro,\n PrecisionMacro, RecallMacro\n

        \n
      • \n
      \n

      For a description of each metric, see Autopilot metrics for classification and regression.

      \n
    • \n
    • \n

      Default objective metrics:

      \n
        \n
      • \n

        Regression: MSE.

        \n
      • \n
      • \n

        Binary classification: F1.

        \n
      • \n
      • \n

        Multiclass classification: Accuracy.

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

    For image or text classification problem types:

    \n \n
  • \n
  • \n

    For time-series forecasting problem types:

    \n
      \n
    • \n

      List of available metrics: RMSE, wQL,\n Average wQL, MASE, MAPE,\n WAPE\n

      \n

      For a description of each metric, see Autopilot metrics for\n time-series forecasting.

      \n
    • \n
    • \n

      Default objective metrics: AverageWeightedQuantileLoss\n

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

    For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.

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

The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.

\n

The list of available metrics supported by Autopilot and the default metric applied when you\n do not specify a metric name explicitly depend on the problem type.

\n
    \n
  • \n

    For tabular problem types:

    \n
      \n
    • \n

      List of available metrics:

      \n
        \n
      • \n

        Regression: MAE, MSE, R2,\n RMSE\n

        \n
      • \n
      • \n

        Binary classification: Accuracy, AUC,\n BalancedAccuracy, F1,\n Precision, Recall\n

        \n
      • \n
      • \n

        Multiclass classification: Accuracy,\n BalancedAccuracy, F1macro,\n PrecisionMacro, RecallMacro\n

        \n
      • \n
      \n

      For a description of each metric, see Autopilot metrics for classification and regression.

      \n
    • \n
    • \n

      Default objective metrics:

      \n
        \n
      • \n

        Regression: MSE.

        \n
      • \n
      • \n

        Binary classification: F1.

        \n
      • \n
      • \n

        Multiclass classification: Accuracy.

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

    For image or text classification problem types:

    \n \n
  • \n
  • \n

    For time-series forecasting problem types:

    \n
      \n
    • \n

      List of available metrics: RMSE, wQL,\n Average wQL, MASE, MAPE,\n WAPE\n

      \n

      For a description of each metric, see Autopilot metrics for\n time-series forecasting.

      \n
    • \n
    • \n

      Default objective metrics: AverageWeightedQuantileLoss\n

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

    For text generation problem types (LLMs fine-tuning): \n Fine-tuning language models in Autopilot does not\n require setting the AutoMLJobObjective field. Autopilot fine-tunes LLMs\n without requiring multiple candidates to be trained and evaluated. \n Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a\n default objective metric, the cross-entropy loss. After fine-tuning a language model,\n you can evaluate the quality of its generated text using different metrics. \n For a list of the available metrics, see Metrics for\n fine-tuning LLMs in Autopilot.

    \n
  • \n
", "smithy.api#required": {} } } @@ -4207,7 +4243,7 @@ "target": "com.amazonaws.sagemaker#AutoMLS3DataType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The data type.

\n
    \n
  • \n

    If you choose S3Prefix, S3Uri identifies a key name\n prefix. SageMaker uses all objects that match the specified key name prefix for model\n training.

    \n

    The S3Prefix should have the following format:

    \n

    \n s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE\n

    \n
  • \n
  • \n

    If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want SageMaker to use\n for model training.

    \n

    A ManifestFile should have the format shown below:

    \n

    \n [ {\"prefix\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"}, \n

    \n

    \n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",\n

    \n

    \n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",\n

    \n

    \n ... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]\n

    \n
  • \n
  • \n

    If you choose AugmentedManifestFile, S3Uri identifies an\n object that is an augmented manifest file in JSON lines format. This file contains\n the data you want to use for model training. AugmentedManifestFile is\n available for V2 API jobs only (for example, for jobs created by calling\n CreateAutoMLJobV2).

    \n

    Here is a minimal, single-record example of an\n AugmentedManifestFile:

    \n

    \n {\"source-ref\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",\n

    \n

    \n \"label-metadata\": {\"class-name\": \"cat\" }

    \n

    For more information on AugmentedManifestFile, see Provide\n Dataset Metadata to Training Jobs with an Augmented Manifest File.

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

The data type.

\n
    \n
  • \n

    If you choose S3Prefix, S3Uri identifies a key name\n prefix. SageMaker uses all objects that match the specified key name prefix\n for model training.

    \n

    The S3Prefix should have the following format:

    \n

    \n s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE\n

    \n
  • \n
  • \n

    If you choose ManifestFile, S3Uri identifies an object\n that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

    \n

    A ManifestFile should have the format shown below:

    \n

    \n [ {\"prefix\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/\"}, \n

    \n

    \n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1\",\n

    \n

    \n \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2\",\n

    \n

    \n ... \"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N\" ]\n

    \n
  • \n
  • \n

    If you choose AugmentedManifestFile, S3Uri identifies an\n object that is an augmented manifest file in JSON lines format. This file contains\n the data you want to use for model training. AugmentedManifestFile is\n available for V2 API jobs only (for example, for jobs created by calling\n CreateAutoMLJobV2).

    \n

    Here is a minimal, single-record example of an\n AugmentedManifestFile:

    \n

    \n {\"source-ref\":\n \"s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg\",\n

    \n

    \n \"label-metadata\": {\"class-name\": \"cat\" }

    \n

    For more information on AugmentedManifestFile, see Provide\n Dataset Metadata to Training Jobs with an Augmented Manifest File.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -4215,7 +4251,7 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile\n depending on the data type.

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

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3\n prefix or ManifestFile depending on the data type.

", "smithy.api#required": {} } } @@ -4891,13 +4927,13 @@ "ModelInsights": { "target": "com.amazonaws.sagemaker#ModelInsightsLocation", "traits": { - "smithy.api#documentation": "

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

" + "smithy.api#documentation": "

The Amazon S3 prefix to the model insight artifacts generated for the AutoML\n candidate.

" } }, "BacktestResults": { "target": "com.amazonaws.sagemaker#BacktestResultsLocation", "traits": { - "smithy.api#documentation": "

The Amazon S3 prefix to the accuracy metrics and the inference results observed over the\n testing window. Available only for the time-series forecasting problem type.

" + "smithy.api#documentation": "

The Amazon S3 prefix to the accuracy metrics and the inference results observed\n over the testing window. Available only for the time-series forecasting problem\n type.

" } } }, @@ -4919,7 +4955,7 @@ "AlgorithmsConfig": { "target": "com.amazonaws.sagemaker#AutoMLAlgorithmsConfig", "traits": { - "smithy.api#documentation": "

Stores the configuration information for the selection of algorithms used to train model\n candidates on tabular data.

\n

The list of available algorithms to choose from depends on the training mode set in\n \n TabularJobConfig.Mode\n .

\n
    \n
  • \n

    \n AlgorithmsConfig should not be set in AUTO training\n mode.

    \n
  • \n
  • \n

    When AlgorithmsConfig is provided, one AutoMLAlgorithms\n attribute must be set and one only.

    \n

    If the list of algorithms provided as values for AutoMLAlgorithms is\n empty, CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.

    \n
  • \n
  • \n

    When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.

    \n
  • \n
\n

For the list of all algorithms per problem type and training mode, see \n AutoMLAlgorithmConfig.

\n

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

" + "smithy.api#documentation": "

Your Autopilot job trains a default set of algorithms on your dataset. For tabular and\n time-series data, you can customize the algorithm list by selecting a subset of algorithms\n for your problem type.

\n

\n AlgorithmsConfig stores the customized selection of algorithms to train on\n your data.

\n
    \n
  • \n

    \n For the tabular problem type TabularJobConfig,\n the list of available algorithms to choose from depends on the training mode set\n in \n AutoMLJobConfig.Mode\n .

    \n
      \n
    • \n

      \n AlgorithmsConfig should not be set when the training mode\n AutoMLJobConfig.Mode is set to AUTO.

      \n
    • \n
    • \n

      When AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.

      \n

      If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.

      \n
    • \n
    • \n

      When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n the given training mode.

      \n
    • \n
    \n

    For the list of all algorithms per training mode, see \n AlgorithmConfig.

    \n

    For more information on each algorithm, see the Algorithm support section in the Autopilot developer guide.

    \n
  • \n
  • \n

    \n For the time-series forecasting problem type TimeSeriesForecastingJobConfig,\n choose your algorithms from the list provided in\n \n AlgorithmConfig.

    \n

    For more information on each algorithm, see the Algorithms support for time-series forecasting section in the Autopilot developer guide.

    \n
      \n
    • \n

      When AlgorithmsConfig is provided, one\n AutoMLAlgorithms attribute must be set and one only.

      \n

      If the list of algorithms provided as values for\n AutoMLAlgorithms is empty,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.

      \n
    • \n
    • \n

      When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for\n time-series forecasting.

      \n
    • \n
    \n
  • \n
" } } }, @@ -8660,7 +8696,7 @@ "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Provides information about encryption and the Amazon S3 output path needed to store artifacts\n from an AutoML job. Format(s) supported: CSV.

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

Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job. Format(s) supported: CSV.

", "smithy.api#required": {} } }, @@ -8772,7 +8808,7 @@ "target": "com.amazonaws.sagemaker#AutoMLOutputDataConfig", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Provides information about encryption and the Amazon S3 output path needed to store artifacts\n from an AutoML job.

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

Provides information about encryption and the Amazon S3 output path needed to\n store artifacts from an AutoML job.

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

The URI of the source for the model package. If you want to clone a model package,\n set it to the model package Amazon Resource Name (ARN). If you want to register a model,\n set it to the model ARN.

" } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", + "traits": { + "smithy.api#documentation": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard", + "traits": { + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + } } }, "traits": { @@ -17083,7 +17131,7 @@ "BestCandidate": { "target": "com.amazonaws.sagemaker#AutoMLCandidate", "traits": { - "smithy.api#documentation": "

The best model candidate selected by SageMaker Autopilot using both the best objective metric and\n lowest InferenceLatency for\n an experiment.

" + "smithy.api#documentation": "

The best model candidate selected by SageMaker Autopilot using both the best\n objective metric and lowest InferenceLatency for\n an experiment.

" } }, "AutoMLJobStatus": { @@ -17209,7 +17257,7 @@ "target": "com.amazonaws.sagemaker#RoleArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the IAM role that has read permission to the input data location and\n write permission to the output data location in Amazon S3.

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

The ARN of the IAM role that has read permission to the input data\n location and write permission to the output data location in Amazon S3.

", "smithy.api#required": {} } }, @@ -17317,7 +17365,7 @@ "SecurityConfig": { "target": "com.amazonaws.sagemaker#AutoMLSecurityConfig", "traits": { - "smithy.api#documentation": "

Returns the security configuration for traffic encryption or Amazon VPC settings.

" + "smithy.api#documentation": "

Returns the security configuration for traffic encryption or Amazon VPC\n settings.

" } } }, @@ -21551,7 +21599,7 @@ "target": "com.amazonaws.sagemaker#DescribeModelPackageOutput" }, "traits": { - "smithy.api#documentation": "

Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.

\n

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.

" + "smithy.api#documentation": "

Returns a description of the specified model package, which is used to create SageMaker\n models or list them on Amazon Web Services Marketplace.

\n \n

If you provided a KMS Key ID when you created your model package,\n you will see the KMS\n Decrypt API call in your CloudTrail logs when you use this API.

\n
\n

To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services\n Marketplace.

" } }, "com.amazonaws.sagemaker#DescribeModelPackageGroup": { @@ -21816,6 +21864,18 @@ "traits": { "smithy.api#documentation": "

The URI of the source for the model package.

" } + }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig", + "traits": { + "smithy.api#documentation": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

" + } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard", + "traits": { + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + } } }, "traits": { @@ -35196,7 +35256,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" } }, "SortOrder": { @@ -36521,7 +36581,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" } } }, @@ -41047,7 +41107,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" } }, "SortOrder": { @@ -41985,7 +42045,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "

This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" + "smithy.api#documentation": "

This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.

" } }, "SortOrder": { @@ -44395,6 +44455,12 @@ "smithy.api#documentation": "

The URI of the source for the model package.

" } }, + "SecurityConfig": { + "target": "com.amazonaws.sagemaker#ModelPackageSecurityConfig" + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard" + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -44717,6 +44783,42 @@ "target": "com.amazonaws.sagemaker#ModelPackageGroupSummary" } }, + "com.amazonaws.sagemaker#ModelPackageModelCard": { + "type": "structure", + "members": { + "ModelCardContent": { + "target": "com.amazonaws.sagemaker#ModelCardContent", + "traits": { + "smithy.api#documentation": "

The content of the model card.

" + } + }, + "ModelCardStatus": { + "target": "com.amazonaws.sagemaker#ModelCardStatus", + "traits": { + "smithy.api#documentation": "

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

\n
    \n
  • \n

    \n Draft: The model card is a work in progress.

    \n
  • \n
  • \n

    \n PendingReview: The model card is pending review.

    \n
  • \n
  • \n

    \n Approved: The model card is approved.

    \n
  • \n
  • \n

    \n Archived: The model card is archived. No more updates can be made to the model\n card content. If you try to update the model card content, you will receive the message Model Card\n \t is in Archived state.

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

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + } + }, + "com.amazonaws.sagemaker#ModelPackageSecurityConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The KMS Key ID (KMSKeyId) used for encryption of model package information.

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

An optional Key Management Service\n key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with\n highly sensitive data.

" + } + }, "com.amazonaws.sagemaker#ModelPackageSortBy": { "type": "enum", "members": { @@ -59807,7 +59909,7 @@ "FeatureSpecificationS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

A URL to the Amazon S3 data source containing selected features from the input data source to\n run an Autopilot job V2. You can input FeatureAttributeNames (optional) in JSON\n format as shown below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n \n

These column keys may not include the target column.

\n
\n

In ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.

\n

If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.

\n

If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.

\n

The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.

" + "smithy.api#documentation": "

A URL to the Amazon S3 data source containing selected features from the input\n data source to run an Autopilot job V2. You can input FeatureAttributeNames\n (optional) in JSON format as shown below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n \n

These column keys may not include the target column.

\n
\n

In ensembling mode, Autopilot only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.

\n

If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.

\n

If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.

\n

The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.

" } }, "Mode": { @@ -60726,7 +60828,7 @@ "FeatureSpecificationS3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "

A URL to the Amazon S3 data source containing additional selected features that complement\n the target, itemID, timestamp, and grouped columns set in TimeSeriesConfig.\n When not provided, the AutoML job V2 includes all the columns from the original dataset\n that are not already declared in TimeSeriesConfig. If provided, the AutoML job\n V2 only considers these additional columns as a complement to the ones declared in\n TimeSeriesConfig.

\n

You can input FeatureAttributeNames (optional) in JSON format as shown\n below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n

Autopilot supports the following data types: numeric, categorical,\n text, and datetime.

\n \n

These column keys must not include any column set in\n TimeSeriesConfig.

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

A URL to the Amazon S3 data source containing additional selected features that\n complement the target, itemID, timestamp, and grouped columns set in\n TimeSeriesConfig. When not provided, the AutoML job V2 includes all the\n columns from the original dataset that are not already declared in\n TimeSeriesConfig. If provided, the AutoML job V2 only considers these\n additional columns as a complement to the ones declared in\n TimeSeriesConfig.

\n

You can input FeatureAttributeNames (optional) in JSON format as shown\n below:

\n

\n { \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

\n

You can also specify the data type of the feature (optional) in the format shown\n below:

\n

\n { \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }\n

\n

Autopilot supports the following data types: numeric, categorical,\n text, and datetime.

\n \n

These column keys must not include any column set in\n TimeSeriesConfig.

\n
" } }, "CompletionCriteria": { @@ -60773,6 +60875,9 @@ "traits": { "smithy.api#documentation": "

The collection of holiday featurization attributes used to incorporate national holiday\n information into your forecasting model.

" } + }, + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#CandidateGenerationConfig" } }, "traits": { @@ -65664,6 +65769,12 @@ "traits": { "smithy.api#documentation": "

The URI of the source for the model package.

" } + }, + "ModelCard": { + "target": "com.amazonaws.sagemaker#ModelPackageModelCard", + "traits": { + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + } } }, "traits": { From cc72ad5e920b29c3e175b6b3441e88045a8299c4 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 30 May 2024 18:06:56 +0000 Subject: [PATCH 11/41] feat: update AWS service endpoints metadata --- .../src/main/resources/aws/sdk/kotlin/codegen/endpoints.json | 5 ----- 1 file changed, 5 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 06ea8df845f..20db4ac34e3 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 @@ -112,11 +112,6 @@ } }, "services" : { - "a4b" : { - "endpoints" : { - "us-east-1" : { } - } - }, "access-analyzer" : { "endpoints" : { "af-south-1" : { }, From 23cebdd55fd7554216a6caa80dfdcb3604431152 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 30 May 2024 18:09:45 +0000 Subject: [PATCH 12/41] chore: release 1.2.23 --- CHANGELOG.md | 14 ++++++++++++++ gradle.properties | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f168fddf9d..82f69256438 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Changelog +## [1.2.23] - 05/30/2024 + +### Features +* (**acm**) add v2 smoke tests and smithy smokeTests trait for SDK testing. +* (**bedrockagent**) With this release, Knowledge bases for Bedrock adds support for Titan Text Embedding v2. +* (**bedrockruntime**) This release adds Converse and ConverseStream APIs to Bedrock Runtime +* (**cloudtrail**) CloudTrail Lake returns PartitionKeys in the GetEventDataStore API response. Events are grouped into partitions based on these keys for better query performance. For example, the calendarday key groups events by day, while combining the calendarday key with the hour key groups them by day and hour. +* (**connect**) Adding associatedQueueIds as a SearchCriteria and response field to the SearchRoutingProfiles API +* (**emrserverless**) The release adds support for spark structured streaming. +* (**sagemaker**) Adds Model Card information as a new component to Model Package. Autopilot launches algorithm selection for TimeSeries modality to generate AutoML candidates per algorithm. + +### Documentation +* (**rds**) Updates Amazon RDS documentation for Aurora Postgres DBname. + ## [1.2.22] - 05/29/2024 ### Features diff --git a/gradle.properties b/gradle.properties index b97e10d8191..d24bb85e2bb 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.2.23-SNAPSHOT +sdkVersion=1.2.23 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 953e69e3e79077c10c6def8be916b77484ad70e7 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 30 May 2024 18:09:47 +0000 Subject: [PATCH 13/41] chore: bump snapshot version to 1.2.24-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index d24bb85e2bb..89d9d3c354e 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.2.23 +sdkVersion=1.2.24-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 15c8515da258be6deb185d4704935fd46174bc1c Mon Sep 17 00:00:00 2001 From: Matas Date: Thu, 30 May 2024 16:27:57 -0400 Subject: [PATCH 14/41] fix: add trailing slash to endpoint and disable proxying of requests to IMDS (#1320) --- .changes/16007c74-7831-42d2-8a3b-01e4868da600.json | 8 ++++++++ .changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json | 8 ++++++++ .../runtime/auth/credentials/ImdsCredentialsProvider.kt | 4 ++-- .../src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt | 6 +++++- .../auth/credentials/ImdsCredentialsProviderTest.kt | 6 +++--- 5 files changed, 26 insertions(+), 6 deletions(-) create mode 100644 .changes/16007c74-7831-42d2-8a3b-01e4868da600.json create mode 100644 .changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json diff --git a/.changes/16007c74-7831-42d2-8a3b-01e4868da600.json b/.changes/16007c74-7831-42d2-8a3b-01e4868da600.json new file mode 100644 index 00000000000..516ada527d3 --- /dev/null +++ b/.changes/16007c74-7831-42d2-8a3b-01e4868da600.json @@ -0,0 +1,8 @@ +{ + "id": "16007c74-7831-42d2-8a3b-01e4868da600", + "type": "bugfix", + "description": "Disable proxying of requests made to EC2 IMDS", + "issues": [ + "https://github.com/awslabs/aws-sdk-kotlin/issues/1315" + ] +} \ No newline at end of file diff --git a/.changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json b/.changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json new file mode 100644 index 00000000000..18b8707c3a7 --- /dev/null +++ b/.changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json @@ -0,0 +1,8 @@ +{ + "id": "8248143a-7a11-46c0-a44d-7bbeabe34c82", + "type": "misc", + "description": "Add trailing slash to base IMDS endpoint", + "issues": [ + "https://github.com/awslabs/aws-sdk-kotlin/issues/1303" + ] +} \ No newline at end of file diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProvider.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProvider.kt index 96a52ac3e52..8c969a42927 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProvider.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProvider.kt @@ -30,7 +30,7 @@ import kotlinx.coroutines.sync.withLock import kotlin.coroutines.coroutineContext import kotlin.time.Duration.Companion.seconds -private const val CREDENTIALS_BASE_PATH: String = "/latest/meta-data/iam/security-credentials" +private const val CREDENTIALS_BASE_PATH: String = "/latest/meta-data/iam/security-credentials/" private const val CODE_ASSUME_ROLE_UNAUTHORIZED_ACCESS: String = "AssumeRoleUnauthorizedAccess" private const val PROVIDER_NAME = "IMDSv2" @@ -43,7 +43,7 @@ private const val PROVIDER_NAME = "IMDSv2" * information. * * @param profileOverride override the instance profile name. When retrieving credentials, a call must first be made to - * `/latest/meta-data/iam/security-credentials`. This returns the instance profile used. If + * `/latest/meta-data/iam/security-credentials/`. This returns the instance profile used. If * [profileOverride] is set, the initial call to retrieve the profile is skipped and the provided value is used instead. * @param client the IMDS client to use to resolve credentials information with. This provider takes ownership over * the lifetime of the given [ImdsClient] and will close it when the provider is closed. diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt index ab5a2ba085c..61de7692d3b 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/imds/ImdsClient.kt @@ -16,6 +16,7 @@ import aws.smithy.kotlin.runtime.http.* import aws.smithy.kotlin.runtime.http.HttpCall import aws.smithy.kotlin.runtime.http.engine.DefaultHttpEngine import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine +import aws.smithy.kotlin.runtime.http.engine.ProxySelector import aws.smithy.kotlin.runtime.http.operation.* import aws.smithy.kotlin.runtime.io.Closeable import aws.smithy.kotlin.runtime.io.closeIfCloseable @@ -72,6 +73,9 @@ public class ImdsClient private constructor(builder: Builder) : InstanceMetadata engine = builder.engine ?: DefaultHttpEngine { connectTimeout = 1.seconds socketReadTimeout = 1.seconds + + // don't proxy IMDS requests. https://github.com/awslabs/aws-sdk-kotlin/issues/1315 + proxySelector = ProxySelector.NoProxy } httpClient = SdkHttpClient(engine) @@ -114,7 +118,7 @@ public class ImdsClient private constructor(builder: Builder) : InstanceMetadata val payload = response.body.readAll() ?: throw EC2MetadataError(response.status.value, "no metadata payload") return payload.decodeToString() } else { - throw EC2MetadataError(response.status.value, "error retrieving instance metadata") + throw EC2MetadataError(response.status.value, "error retrieving instance metadata: ${response.status.description}") } } } diff --git a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProviderTest.kt b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProviderTest.kt index 762735662e8..f7c17a1c4b9 100644 --- a/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProviderTest.kt +++ b/aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/auth/credentials/ImdsCredentialsProviderTest.kt @@ -59,7 +59,7 @@ class ImdsCredentialsProviderTest { tokenResponse(DEFAULT_TOKEN_TTL_SECONDS, "TOKEN_A"), ) expect( - imdsRequest("http://169.254.169.254/latest/meta-data/iam/security-credentials", "TOKEN_A"), + imdsRequest("http://169.254.169.254/latest/meta-data/iam/security-credentials/", "TOKEN_A"), imdsResponse("imds-test-role"), ) expect( @@ -84,7 +84,7 @@ class ImdsCredentialsProviderTest { // verify that profile is re-retrieved after credentials expiration expect( - imdsRequest("http://169.254.169.254/latest/meta-data/iam/security-credentials", "TOKEN_A"), + imdsRequest("http://169.254.169.254/latest/meta-data/iam/security-credentials/", "TOKEN_A"), imdsResponse("imds-test-role-2"), ) expect( @@ -235,7 +235,7 @@ class ImdsCredentialsProviderTest { tokenResponse(DEFAULT_TOKEN_TTL_SECONDS, "TOKEN_A"), ) expect( - imdsRequest("http://169.254.169.254/latest/meta-data/iam/security-credentials", "TOKEN_A"), + imdsRequest("http://169.254.169.254/latest/meta-data/iam/security-credentials/", "TOKEN_A"), HttpResponse( HttpStatusCode.NotFound, Headers.Empty, From 849e67802c0191007dfb76a4e678e2a826d1d7ae Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 31 May 2024 18:15:59 +0000 Subject: [PATCH 15/41] feat: update AWS API models --- codegen/sdk/aws-models/codebuild.json | 4 +- codegen/sdk/aws-models/codeguru-security.json | 134 ++-- codegen/sdk/aws-models/elasticache.json | 10 +- codegen/sdk/aws-models/launch-wizard.json | 607 +++++++++++++++++- 4 files changed, 677 insertions(+), 78 deletions(-) diff --git a/codegen/sdk/aws-models/codebuild.json b/codegen/sdk/aws-models/codebuild.json index ed74781a2b9..bdb108fd8fd 100644 --- a/codegen/sdk/aws-models/codebuild.json +++ b/codegen/sdk/aws-models/codebuild.json @@ -3232,7 +3232,7 @@ "manualCreation": { "target": "com.amazonaws.codebuild#WrapperBoolean", "traits": { - "smithy.api#documentation": "

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and \n secret values for the webhook. The payloadUrl and secret values in the output can be \n used to manually create a webhook within GitHub.

\n \n

manualCreation is only available for GitHub webhooks.

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

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and \n secret values for the webhook. The payloadUrl and secret values in the output can be \n used to manually create a webhook within GitHub.

\n \n

\n manualCreation is only available for GitHub webhooks.

\n
" } } }, @@ -9010,7 +9010,7 @@ "type": { "target": "com.amazonaws.codebuild#WebhookFilterType", "traits": { - "smithy.api#documentation": "

The type of webhook filter. There are nine webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, \n and WORKFLOW_NAME.

\n
    \n
  • \n

    \n EVENT\n

    \n
      \n
    • \n

      A webhook event triggers a build when the provided pattern\n matches one of nine event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, \n PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, \n PULL_REQUEST_MERGED, RELEASED, PRERELEASED, \n and WORKFLOW_JOB_QUEUED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.

      \n \n

      The PULL_REQUEST_REOPENED works with GitHub and GitHub\n Enterprise only. The RELEASED, PRERELEASED, \n and WORKFLOW_JOB_QUEUED work with GitHub only.

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

    ACTOR_ACCOUNT_ID

    \n
      \n
    • \n

      A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n

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

    HEAD_REF

    \n
      \n
    • \n

      A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.

      \n \n

      Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.

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

    BASE_REF

    \n
      \n
    • \n

      A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.

      \n \n

      Works with pull request events only.

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

    FILE_PATH

    \n
      \n
    • \n

      A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.

      \n \n

      Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

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

    COMMIT_MESSAGE

    \n
      \n
    • \n

      A webhook triggers a build when the head commit message matches the\n regular expression pattern.

      \n \n

      Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

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

    TAG_NAME

    \n
      \n
    • \n

      A webhook triggers a build when the tag name of the release matches the \n regular expression pattern.

      \n \n

      Works with RELEASED and PRERELEASED events only.

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

    RELEASE_NAME

    \n
      \n
    • \n

      A webhook triggers a build when the release name matches the \n regular expression pattern.

      \n \n

      Works with RELEASED and PRERELEASED events only.

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

    WORKFLOW_NAME

    \n
      \n
    • \n

      A webhook triggers a build when the workflow name matches the \n regular expression pattern.

      \n \n

      Works with WORKFLOW_JOB_QUEUED events only.

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

The type of webhook filter. There are nine webhook filter types: EVENT,\n ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF,\n FILE_PATH, COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, \n and WORKFLOW_NAME.

\n
    \n
  • \n

    \n EVENT\n

    \n
      \n
    • \n

      A webhook event triggers a build when the provided pattern\n matches one of nine event types: PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, \n PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, \n PULL_REQUEST_MERGED, RELEASED, PRERELEASED, \n and WORKFLOW_JOB_QUEUED. The EVENT patterns are\n specified as a comma-separated string. For example, PUSH,\n PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull\n request created, and pull request updated events.

      \n \n

      Types PULL_REQUEST_REOPENED and WORKFLOW_JOB_QUEUED \n work with GitHub and GitHub Enterprise only. Types RELEASED and \n PRERELEASED work with GitHub only.

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

    ACTOR_ACCOUNT_ID

    \n
      \n
    • \n

      A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n Bitbucket account ID matches the regular expression pattern.\n

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

    HEAD_REF

    \n
      \n
    • \n

      A webhook event triggers a build when the head reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name and refs/tags/tag-name.

      \n \n

      Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n Enterprise pull request, Bitbucket push, and Bitbucket pull request events.

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

    BASE_REF

    \n
      \n
    • \n

      A webhook event triggers a build when the base reference matches the\n regular expression pattern. For example,\n refs/heads/branch-name.

      \n \n

      Works with pull request events only.

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

    FILE_PATH

    \n
      \n
    • \n

      A webhook triggers a build when the path of a changed file matches the\n regular expression pattern.

      \n \n

      Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

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

    COMMIT_MESSAGE

    \n
      \n
    • \n

      A webhook triggers a build when the head commit message matches the\n regular expression pattern.

      \n \n

      Works with GitHub and Bitbucket events push and pull requests events.\n Also works with GitHub Enterprise push events, but does not work with\n GitHub Enterprise pull request events.

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

    TAG_NAME

    \n
      \n
    • \n

      A webhook triggers a build when the tag name of the release matches the \n regular expression pattern.

      \n \n

      Works with RELEASED and PRERELEASED events only.

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

    RELEASE_NAME

    \n
      \n
    • \n

      A webhook triggers a build when the release name matches the \n regular expression pattern.

      \n \n

      Works with RELEASED and PRERELEASED events only.

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

    WORKFLOW_NAME

    \n
      \n
    • \n

      A webhook triggers a build when the workflow name matches the \n regular expression pattern.

      \n \n

      Works with WORKFLOW_JOB_QUEUED events only.

      \n
      \n
    • \n
    \n
  • \n
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/codeguru-security.json b/codegen/sdk/aws-models/codeguru-security.json index 0d27e094f7d..e9ed31793ce 100644 --- a/codegen/sdk/aws-models/codeguru-security.json +++ b/codegen/sdk/aws-models/codeguru-security.json @@ -43,36 +43,36 @@ "date": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date from which the finding metrics were retrieved.

" + "smithy.api#documentation": "

The date from which the findings metrics were retrieved.

" } }, "newFindings": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The number of new findings of each severity in account on the specified date.

" + "smithy.api#documentation": "

The number of new findings of each severity on the specified date.

" } }, "closedFindings": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The number of closed findings of each severity in an account on the specified date.

" + "smithy.api#documentation": "

The number of closed findings of each severity on the specified date.

" } }, "openFindings": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The number of open findings of each severity in an account as of the specified date.

" + "smithy.api#documentation": "

The number of open findings of each severity as of the specified date.

" } }, "meanTimeToClose": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The average time it takes to close findings of each severity in days.

" + "smithy.api#documentation": "

The average time in days it takes to close findings of each severity as of a specified\n date.

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

A summary of findings metrics in an account.

" + "smithy.api#documentation": "

A summary of findings metrics for an account on a specified date.

" } }, "com.amazonaws.codegurusecurity#AnalysisType": { @@ -167,7 +167,7 @@ ], "origin": "*" }, - "smithy.api#documentation": "\n

Amazon CodeGuru Security is in preview release and is subject to\n change.

\n
\n

This section provides documentation for the Amazon CodeGuru Security API operations.\n CodeGuru Security is a service that uses program analysis and machine learning to detect\n security policy violations and vulnerabilities, and recommends ways to address these security\n risks.

\n

By proactively detecting and providing recommendations for addressing security risks,\n CodeGuru Security improves the overall security of your application code. For more information\n about CodeGuru Security, see the \n Amazon CodeGuru Security User Guide.

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

Amazon CodeGuru Security is in preview release and is subject to change.

\n
\n

This section provides documentation for the Amazon CodeGuru Security API operations.\n CodeGuru Security is a service that uses program analysis and machine learning to detect\n security policy violations and vulnerabilities, and recommends ways to address these security\n risks.

\n

By proactively detecting and providing recommendations for addressing security risks,\n CodeGuru Security improves the overall security of your application code. For more information\n about CodeGuru Security, see the \n Amazon CodeGuru Security User Guide.

", "smithy.api#title": "Amazon CodeGuru Security", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -858,7 +858,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all requested findings.

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

Returns a list of requested findings from standard scans.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -930,7 +930,7 @@ "findings": { "target": "com.amazonaws.codegurusecurity#Findings", "traits": { - "smithy.api#documentation": "

A list of all requested findings.

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

A list of all findings which were successfully fetched.

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

Use to create a scan using code uploaded to an S3 bucket.

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

Use to create a scan using code uploaded to an Amazon S3 bucket.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1101,14 +1101,14 @@ "resourceId": { "target": "com.amazonaws.codegurusecurity#ResourceId", "traits": { - "smithy.api#documentation": "

The identifier for an input resource used to create a scan.

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

The identifier for the resource object to be scanned.

", "smithy.api#required": {} } }, "scanName": { "target": "com.amazonaws.codegurusecurity#ScanName", "traits": { - "smithy.api#documentation": "

The unique name that CodeGuru Security uses to track revisions across multiple\n scans of the same resource. Only allowed for a STANDARD scan type. If not\n specified, it will be auto generated.

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

The unique name that CodeGuru Security uses to track revisions across multiple scans of\n the same resource. Only allowed for a STANDARD scan type.

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

Generates a pre-signed URL and request headers used to upload a code resource.

\n

You can upload your code resource to the URL and add the request headers using any HTTP\n client.

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

Generates a pre-signed URL, request headers used to upload a code resource, and code\n artifact identifier for the uploaded resource.

\n

You can upload your code resource to the URL with the request headers using any HTTP\n client.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1229,7 +1229,7 @@ "s3Url": { "target": "com.amazonaws.codegurusecurity#S3Url", "traits": { - "smithy.api#documentation": "

A pre-signed S3 URL. You can upload the code file you want to scan and add the required\n requestHeaders using any HTTP client.

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

A pre-signed S3 URL. You can upload the code file you want to scan with the required\n requestHeaders using any HTTP client.

", "smithy.api#required": {} } }, @@ -1243,7 +1243,7 @@ "codeArtifactId": { "target": "com.amazonaws.codegurusecurity#Uuid", "traits": { - "smithy.api#documentation": "

The identifier for the uploaded code resource.

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

The identifier for the uploaded code resource. Pass this to CreateScan to use\n the uploaded resources.

", "smithy.api#required": {} } } @@ -1264,12 +1264,12 @@ "kmsKeyArn": { "target": "com.amazonaws.codegurusecurity#KmsKeyArn", "traits": { - "smithy.api#documentation": "

The KMS key ARN to use for encryption. This must be provided as a header when uploading\n your code resource.

" + "smithy.api#documentation": "

The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption,\n returns empty.

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

Information about account-level configuration.

" + "smithy.api#documentation": "

Information about the encryption configuration for an account. Required to call\n UpdateAccountConfiguration.

" } }, "com.amazonaws.codegurusecurity#ErrorCode": { @@ -1307,6 +1307,14 @@ } } }, + "com.amazonaws.codegurusecurity#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.codegurusecurity#FilePath": { "type": "structure", "members": { @@ -1363,7 +1371,7 @@ "generatorId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier for the component that generated a finding such as AWSCodeGuruSecurity or\n AWSInspector.

" + "smithy.api#documentation": "

The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.

" } }, "id": { @@ -1405,7 +1413,7 @@ "severity": { "target": "com.amazonaws.codegurusecurity#Severity", "traits": { - "smithy.api#documentation": "

The severity of the finding.

" + "smithy.api#documentation": "

The severity of the finding. Severity can be critical, high, medium, low, or\n informational. For information on severity levels, see \n Finding severity in the \n Amazon CodeGuru Security User Guide.

" } }, "remediation": { @@ -1489,36 +1497,36 @@ "info": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The finding is related to quality or readability improvements and not considered\n actionable.

" + "smithy.api#documentation": "

A numeric value corresponding to an informational finding.

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

The severity of the finding is low and does require action on its own.

" + "smithy.api#documentation": "

A numeric value corresponding to a low severity finding.

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

The severity of the finding is medium and should be addressed as a mid-term priority.

" + "smithy.api#documentation": "

A numeric value corresponding to a medium severity finding.

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

The severity of the finding is high and should be addressed as a near-term priority.

" + "smithy.api#documentation": "

A numeric value corresponding to a high severity finding.

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

The severity of the finding is critical and should be addressed immediately.

" + "smithy.api#documentation": "

A numeric value corresponding to a critical finding.

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

The severity of the issue in the code that generated a finding.

" + "smithy.api#documentation": "

A numeric value corresponding to the severity of a finding, such as the number of open\n findings or the average time it takes to close findings of a given severity.

" } }, "com.amazonaws.codegurusecurity#Findings": { @@ -1556,7 +1564,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use to get account level configuration.

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

Use to get the encryption configuration for an account.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1578,7 +1586,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN to use for\n encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify\n your own key, call UpdateAccountConfiguration.

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

An EncryptionConfig object that contains the KMS key ARN that is used for\n encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify\n your own key, call UpdateAccountConfiguration. If you do not specify a\n customer-managed key, returns empty.

", "smithy.api#required": {} } } @@ -1652,11 +1660,11 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

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

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 1000 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, - "max": 100 + "max": 1000 } } }, @@ -1715,7 +1723,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns top level metrics about an account from a specified date, including number of open\n findings, the categories with most findings, the scans with most open findings, and scans with\n most open critical findings.

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

Returns a summary of metrics for an account from a specified date, including number of open\n findings, the categories with most findings, the scans with most open findings, and scans with\n most open critical findings.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -1730,7 +1738,7 @@ "date": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date you want to retrieve summary metrics from, rounded to the nearest day. The date\n must be within the past two years since metrics data is only stored for two years. If a date\n outside of this range is passed, the response will be empty.

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

The date you want to retrieve summary metrics from, rounded to the nearest day. The date\n must be within the past two years.

", "smithy.api#httpQuery": "date", "smithy.api#required": {} } @@ -1774,6 +1782,9 @@ }, { "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" } ], "traits": { @@ -1829,7 +1840,7 @@ "scanState": { "target": "com.amazonaws.codegurusecurity#ScanState", "traits": { - "smithy.api#documentation": "

The current state of the scan. Pass either InProgress,\n Successful, or Failed.

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

The current state of the scan. Returns either InProgress,\n Successful, or Failed.

", "smithy.api#required": {} } }, @@ -1864,6 +1875,12 @@ "traits": { "smithy.api#documentation": "

The ARN for the scan name.

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

Details about the error that causes a scan to fail to be retrieved.

" + } } }, "traits": { @@ -1970,7 +1987,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

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

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 1000 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -1981,7 +1998,7 @@ "startDate": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The start date of the interval which you want to retrieve metrics from.

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

The start date of the interval which you want to retrieve metrics from. Rounds to the\n nearest day.

", "smithy.api#httpQuery": "startDate", "smithy.api#required": {} } @@ -1989,7 +2006,7 @@ "endDate": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The end date of the interval which you want to retrieve metrics from.

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

The end date of the interval which you want to retrieve metrics from. Round to the nearest\n day.

", "smithy.api#httpQuery": "endDate", "smithy.api#required": {} } @@ -2042,7 +2059,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all the standard scans in an account. Does not return express\n scans.

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

Returns a list of all scans in an account. Does not return EXPRESS\n scans.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -2070,7 +2087,7 @@ "maxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.

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

The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results. If not specified, returns 100 results.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, @@ -2147,7 +2164,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

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

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2183,30 +2200,30 @@ "openFindings": { "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", "traits": { - "smithy.api#documentation": "

The number of open findings of each severity in an account.

" + "smithy.api#documentation": "

The number of open findings of each severity.

" } }, "categoriesWithMostFindings": { "target": "com.amazonaws.codegurusecurity#CategoriesWithMostFindings", "traits": { - "smithy.api#documentation": "

A list of CategoryWithFindingNum objects for the top 5 finding categories\n with the most open findings in an account.

" + "smithy.api#documentation": "

A list of CategoryWithFindingNum objects for the top 5 finding categories\n with the most findings.

" } }, "scansWithMostOpenFindings": { "target": "com.amazonaws.codegurusecurity#ScansWithMostOpenFindings", "traits": { - "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open critical findings in an account.

" + "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open findings.

" } }, "scansWithMostOpenCriticalFindings": { "target": "com.amazonaws.codegurusecurity#ScansWithMostOpenCriticalFindings", "traits": { - "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open findings in an account.

" + "smithy.api#documentation": "

A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open critical findings.

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

Information about summary metrics in an account.

" + "smithy.api#documentation": "

A summary of metrics for an account as of a specified date.

" } }, "com.amazonaws.codegurusecurity#NextToken": { @@ -2289,18 +2306,18 @@ "id": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier for the resource.

" + "smithy.api#documentation": "

The scanName of the scan that was run on the resource.

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

The identifier for a section of the resource, such as an AWS Lambda layer.

" + "smithy.api#documentation": "

The identifier for a section of the resource.

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

Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that\n contains a finding.

" + "smithy.api#documentation": "

Information about a resource that contains a finding.

" } }, "com.amazonaws.codegurusecurity#ResourceId": { @@ -2309,12 +2326,12 @@ "codeArtifactId": { "target": "com.amazonaws.codegurusecurity#Uuid", "traits": { - "smithy.api#documentation": "

The identifier for the code file uploaded to the resource where a finding was detected.

" + "smithy.api#documentation": "

The identifier for the code file uploaded to the resource object. Returned by\n CreateUploadUrl when you upload resources to be scanned.

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

The identifier for a resource object that contains resources where a finding was detected.

" + "smithy.api#documentation": "

The identifier for a resource object that contains resources to scan. Specifying a\n codeArtifactId is required to create a scan.

" } }, "com.amazonaws.codegurusecurity#ResourceNotFoundException": { @@ -2396,12 +2413,12 @@ "findingNumber": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of open findings generated by a scan.

" + "smithy.api#documentation": "

The number of findings generated by a scan.

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

Information about a scan with open findings.

" + "smithy.api#documentation": "

Information about the number of findings generated by a scan.

" } }, "com.amazonaws.codegurusecurity#ScanState": { @@ -2590,7 +2607,7 @@ "code": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The suggested code to add to your file.

" + "smithy.api#documentation": "

The suggested code fix. If applicable, includes code patch to replace your source code.

" } } }, @@ -2683,7 +2700,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

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

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2799,7 +2816,7 @@ "resourceArn": { "target": "com.amazonaws.codegurusecurity#ScanNameArn", "traits": { - "smithy.api#documentation": "

The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.

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

The ARN of the ScanName object. You can retrieve this ARN by calling\n CreateScan, ListScans, or GetScan.

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

Use to update account-level configuration with an encryption key.

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

Use to update the encryption configuration for an account.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2864,7 +2881,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.

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

The customer-managed KMS key ARN you want to use for encryption. If not specified,\n CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a\n customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption\n instead, pass nothing.

", "smithy.api#required": {} } } @@ -2879,7 +2896,7 @@ "encryptionConfig": { "target": "com.amazonaws.codegurusecurity#EncryptionConfig", "traits": { - "smithy.api#documentation": "

An EncryptionConfig object that contains the KMS key ARN to use for\n encryption.

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

An EncryptionConfig object that contains the KMS key ARN that is used for\n encryption. If you did not specify a customer-managed KMS key in the request, returns empty.\n

", "smithy.api#required": {} } } @@ -3024,7 +3041,10 @@ "itemCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of times the vulnerability appears in your code.

" + "smithy.api#deprecated": { + "message": "This shape is not used." + }, + "smithy.api#documentation": "

The number of times the vulnerability appears in your code.

" } } }, diff --git a/codegen/sdk/aws-models/elasticache.json b/codegen/sdk/aws-models/elasticache.json index 7b2ef05d55f..61f28a3ccf6 100644 --- a/codegen/sdk/aws-models/elasticache.json +++ b/codegen/sdk/aws-models/elasticache.json @@ -9461,7 +9461,7 @@ "Marker": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords. >

" + "smithy.api#documentation": "

An optional marker returned from a prior request. Use this marker for pagination of\n results from this operation. If this parameter is specified, the response includes only\n records beyond the marker, up to the value specified by MaxRecords.>

" } } }, @@ -11370,7 +11370,7 @@ "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    Rotate

    \n
  • \n
  • \n

    Set

    \n
  • \n
\n

For more information, see Authenticating Users with Redis AUTH\n

" + "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    ROTATE - default, if no update strategy is provided

    \n
  • \n
  • \n

    SET - allowed only after ROTATE

    \n
  • \n
  • \n

    DELETE - allowed only when transitioning to RBAC

    \n
  • \n
\n

For more information, see Authenticating Users with Redis AUTH\n

" } }, "LogDeliveryConfigurations": { @@ -11947,7 +11947,7 @@ "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    Rotate

    \n
  • \n
  • \n

    Set

    \n
  • \n
\n

For more information, see Authenticating Users with Redis AUTH\n

" + "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    ROTATE - default, if no update strategy is provided

    \n
  • \n
  • \n

    SET - allowed only after ROTATE

    \n
  • \n
  • \n

    DELETE - allowed only when transitioning to RBAC

    \n
  • \n
\n

For more information, see Authenticating Users with Redis AUTH\n

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

Represents the input of a TestFailover operation which test automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).

\n

This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API.

\n

\n Note the following\n

\n
    \n
  • \n

    A customer can use this operation to test automatic failover on up to 5 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.

    \n
  • \n
  • \n

    If calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.

    \n

    \n
  • \n
  • \n

    If calling this operation multiple times on different shards in the same Redis\n (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.

    \n
  • \n
  • \n

    To determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node\n group \n

      \n
    2. \n
    3. \n

      Cache cluster message: Failover from primary node\n to replica node \n completed\n

      \n
    4. \n
    5. \n

      Replication group message: Failover from primary node\n to replica node \n completed\n

      \n
    6. \n
    7. \n

      Cache cluster message: Recovering cache nodes\n \n

      \n
    8. \n
    9. \n

      Cache cluster message: Finished recovery for cache nodes\n \n

      \n
    10. \n
    \n

    For more information see:

    \n \n
  • \n
\n

Also see, Testing\n Multi-AZ in the ElastiCache User Guide.

" + "smithy.api#documentation": "

Represents the input of a TestFailover operation which tests automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).

\n

This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API.

\n

\n Note the following\n

\n
    \n
  • \n

    A customer can use this operation to test automatic failover on up to 15 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.

    \n
  • \n
  • \n

    If calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.

    \n

    \n
  • \n
  • \n

    If calling this operation multiple times on different shards in the same Redis\n (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.

    \n
  • \n
  • \n

    To determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node\n group \n

      \n
    2. \n
    3. \n

      Cache cluster message: Failover from primary node\n to replica node \n completed\n

      \n
    4. \n
    5. \n

      Replication group message: Failover from primary node\n to replica node \n completed\n

      \n
    6. \n
    7. \n

      Cache cluster message: Recovering cache nodes\n \n

      \n
    8. \n
    9. \n

      Cache cluster message: Finished recovery for cache nodes\n \n

      \n
    10. \n
    \n

    For more information see:

    \n \n
  • \n
\n

Also see, Testing\n Multi-AZ in the ElastiCache User Guide.

" } }, "com.amazonaws.elasticache#TestFailoverMessage": { @@ -15757,7 +15757,7 @@ "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested. You may test automatic failover on up to 5\n node groups in any rolling 24-hour period.

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

The name of the node group (called shard in the console) in this replication group on\n which automatic failover is to be tested. You may test automatic failover on up to 15\n node groups in any rolling 24-hour period.

", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/launch-wizard.json b/codegen/sdk/aws-models/launch-wizard.json index be7ec639f3b..786835f03bc 100644 --- a/codegen/sdk/aws-models/launch-wizard.json +++ b/codegen/sdk/aws-models/launch-wizard.json @@ -1,6 +1,12 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.launchwizard#AllowedValues": { + "type": "list", + "member": { + "target": "com.amazonaws.launchwizard#ValueString" + } + }, "com.amazonaws.launchwizard#CreateDeployment": { "type": "operation", "input": { @@ -49,6 +55,34 @@ "output": { "deploymentId": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d" } + }, + { + "title": "Deploy a given workload with given settings and passing tags for Launch Wizard deployment resource.", + "input": { + "workloadName": "SAP", + "deploymentPatternName": "SapHanaSingle", + "name": "SapHanaSingleForTest", + "dryRun": false, + "specifications": { + "applicationName": "SapHanaSingleForTest", + "deploymentScenario": "SapHanaSingle", + "DisableDeploymentRollback": "true", + "saveDeploymentArtifacts": "Yes", + "saveArtifactsS3Uri": "s3://testbucket", + "KeyName": "testLinuxInstance", + "VPCID": "vpc-1234567", + "environmentType": "production", + "SAPTZ": "America/Vancouver", + "Encryption": "Yes" + }, + "tags": { + "key1": "val1", + "key2": "val2" + } + }, + "output": { + "deploymentId": "1111111-1111-1111-1111-111111111111" + } } ], "smithy.api#http": { @@ -64,7 +98,7 @@ "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { - "smithy.api#documentation": "

The name of the workload. You can use the \n ListWorkloadDeploymentPatterns\n operation to discover supported\n values for this parameter.

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

The name of the workload. You can use the \n ListWorkloads\n operation to discover supported\n values for this parameter.

", "smithy.api#required": {} } }, @@ -85,7 +119,7 @@ "specifications": { "target": "com.amazonaws.launchwizard#DeploymentSpecifications", "traits": { - "smithy.api#documentation": "

The settings specified for the deployment. For more information on the specifications\n required for creating a deployment, see Workload specifications.

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

The settings specified for the deployment. These settings define how to deploy and configure your\n resources created by the deployment. For more information about the specifications\n required for creating a deployment for a SAP workload, see SAP deployment\n specifications. To retrieve the specifications required to create a deployment for other workloads,\n use the \n GetWorkloadDeploymentPattern\n operation.

", "smithy.api#required": {} } }, @@ -95,6 +129,12 @@ "smithy.api#default": false, "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making\n the request, and provides an error response. If you have the required permissions, the\n error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

" } + }, + "tags": { + "target": "com.amazonaws.launchwizard#Tags", + "traits": { + "smithy.api#documentation": "

The tags to add to the deployment.

" + } } }, "traits": { @@ -127,6 +167,9 @@ { "target": "com.amazonaws.launchwizard#InternalServerException" }, + { + "target": "com.amazonaws.launchwizard#ResourceLimitException" + }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, @@ -216,6 +259,32 @@ } ] }, + "com.amazonaws.launchwizard#DeploymentConditionalField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the deployment condition.

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

The value of the condition.

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

The comparator of the condition.

\n

Valid values: Equal | NotEqual\n

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

A field that details a condition of the specifications for a deployment.

" + } + }, "com.amazonaws.launchwizard#DeploymentData": { "type": "structure", "members": { @@ -258,7 +327,7 @@ "specifications": { "target": "com.amazonaws.launchwizard#DeploymentSpecifications", "traits": { - "smithy.api#documentation": "

The specifications of the deployment. For more information on specifications for each\n deployment, see Workload specifications.

" + "smithy.api#documentation": "

The settings specified for the deployment. These settings define how to deploy and configure your\n resources created by the deployment. For more information about the specifications\n required for creating a deployment for a SAP workload, see SAP deployment\n specifications. To retrieve the specifications required to create a deployment for other workloads,\n use the \n GetWorkloadDeploymentPattern\n operation.

" } }, "resourceGroup": { @@ -272,6 +341,18 @@ "traits": { "smithy.api#documentation": "

The time the deployment was deleted.

" } + }, + "tags": { + "target": "com.amazonaws.launchwizard#Tags", + "traits": { + "smithy.api#documentation": "

Information about the tags attached to a deployment.

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

The Amazon Resource Name (ARN) of the deployment.

" + } } }, "traits": { @@ -461,9 +542,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 25 + "max": 50 }, - "smithy.api#pattern": "^[A-Za-z0-9_\\s\\.-]+$" + "smithy.api#pattern": "^[A-Za-z0-9_\\.-]+$" } }, "com.amazonaws.launchwizard#DeploymentPatternName": { @@ -473,7 +554,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^[A-Za-z0-9][a-zA-Z0-9-]*$" } }, "com.amazonaws.launchwizard#DeploymentSpecifications": { @@ -492,6 +573,56 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.launchwizard#DeploymentSpecificationsData": { + "type": "list", + "member": { + "target": "com.amazonaws.launchwizard#DeploymentSpecificationsField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.launchwizard#DeploymentSpecificationsField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the deployment specification.

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

The description of the deployment specification.

" + } + }, + "allowedValues": { + "target": "com.amazonaws.launchwizard#AllowedValues", + "traits": { + "smithy.api#documentation": "

The allowed values of the deployment specification.

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

Indicates if the deployment specification is required.

" + } + }, + "conditionals": { + "target": "com.amazonaws.launchwizard#SpecificationsConditionalData", + "traits": { + "smithy.api#documentation": "

The conditionals used for the deployment specification.

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

A field that details a specification of a deployment pattern.

" + } + }, "com.amazonaws.launchwizard#DeploymentStatus": { "type": "enum", "members": { @@ -638,12 +769,12 @@ { "title": "Get details about a given deployment.", "input": { - "deploymentId": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d" + "deploymentId": "1111111-1111-1111-1111-111111111111" }, "output": { "deployment": { "name": "SapHanaSingleForTest", - "id": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", + "id": "1111111-1111-1111-1111-111111111111", "workloadName": "SapHanaSingle", "status": "FAILED", "createdAt": "2023-04-24T13:10:09.857Z", @@ -658,6 +789,11 @@ "environmentType": "production", "SAPTZ": "America/Vancouver", "Encryption": "Yes" + }, + "deploymentArn": "arn:aws:launchwizard:us-east-1:123456789012:deployment/1111111-1111-1111-1111-111111111111", + "tags": { + "key1": "val1", + "key2": "val2" } } } @@ -747,6 +883,107 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.launchwizard#GetWorkloadDeploymentPattern": { + "type": "operation", + "input": { + "target": "com.amazonaws.launchwizard#GetWorkloadDeploymentPatternInput" + }, + "output": { + "target": "com.amazonaws.launchwizard#GetWorkloadDeploymentPatternOutput" + }, + "errors": [ + { + "target": "com.amazonaws.launchwizard#InternalServerException" + }, + { + "target": "com.amazonaws.launchwizard#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.launchwizard#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details for a given workload and deployment pattern, including the available\n specifications. You can use the ListWorkloads\n operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment\n pattern names of a given workload.

", + "smithy.api#examples": [ + { + "title": "Get details about a specific Workload deployment pattern", + "input": { + "workloadName": "MicrosoftActiveDirectory", + "deploymentPatternName": "adSelfManagedNewVpc" + }, + "output": { + "workloadDeploymentPattern": { + "workloadName": "MicrosoftActiveDirectory", + "deploymentPatternName": "adSelfManagedNewVpc", + "workloadVersionName": "2024-03-19-14-00-09", + "displayName": "Self-managed AD - new VPC", + "description": "Builds a new AWS environment (VPC and other components), and deploys AD DS into this new VPC.", + "status": "ACTIVE", + "specifications": [ + { + "name": "NumberOfAZs", + "description": "Number of Availability Zones to use in the VPC.", + "required": "Yes" + }, + { + "name": "AvailabilityZones", + "description": "List of Availability Zones (AZs) to use for the subnets in the VPC.", + "required": "Yes" + }, + { + "name": "VPCCIDR", + "description": "CIDR block for the VPC.", + "required": "Yes" + } + ] + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/getWorkloadDeploymentPattern" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.launchwizard#GetWorkloadDeploymentPatternInput": { + "type": "structure", + "members": { + "workloadName": { + "target": "com.amazonaws.launchwizard#WorkloadName", + "traits": { + "smithy.api#documentation": "

The name of the workload.

", + "smithy.api#required": {} + } + }, + "deploymentPatternName": { + "target": "com.amazonaws.launchwizard#DeploymentPatternName", + "traits": { + "smithy.api#documentation": "

The name of the deployment pattern.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.launchwizard#GetWorkloadDeploymentPatternOutput": { + "type": "structure", + "members": { + "workloadDeploymentPattern": { + "target": "com.amazonaws.launchwizard#WorkloadDeploymentPatternData", + "traits": { + "smithy.api#documentation": "

Details about the workload deployment pattern.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.launchwizard#GetWorkloadInput": { "type": "structure", "members": { @@ -802,6 +1039,17 @@ "com.amazonaws.launchwizard#LaunchWizard": { "type": "service", "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.launchwizard#ListTagsForResource" + }, + { + "target": "com.amazonaws.launchwizard#TagResource" + }, + { + "target": "com.amazonaws.launchwizard#UntagResource" + } + ], "resources": [ { "target": "com.amazonaws.launchwizard#Deployment" @@ -1668,7 +1916,7 @@ "filters": { "target": "com.amazonaws.launchwizard#DeploymentFilterList", "traits": { - "smithy.api#documentation": "

Filters to scope the results. The following filters are supported:

\n
    \n
  • \n

    \n WORKLOAD_NAME\n

    \n
  • \n
  • \n

    \n DEPLOYMENT_STATUS\n

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

Filters to scope the results. The following filters are supported:

\n
    \n
  • \n

    \n WORKLOAD_NAME - The name used in deployments.

    \n
  • \n
  • \n

    \n DEPLOYMENT_STATUS - COMPLETED | CREATING |\n DELETE_IN_PROGRESS | DELETE_INITIATING |\n DELETE_FAILED | DELETED | FAILED |\n IN_PROGRESS | VALIDATING\n

    \n
  • \n
" } }, "maxResults": { @@ -1709,6 +1957,78 @@ "smithy.api#output": {} } }, + "com.amazonaws.launchwizard#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.launchwizard#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.launchwizard#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.launchwizard#InternalServerException" + }, + { + "target": "com.amazonaws.launchwizard#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.launchwizard#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags associated with a specified resource.

", + "smithy.api#examples": [ + { + "title": "Listing tags on a Launch Wizard deployment resource.", + "input": { + "resourceArn": "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111" + }, + "output": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.launchwizard#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.launchwizard#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.launchwizard#Tags", + "traits": { + "smithy.api#documentation": "

Information about the tags.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.launchwizard#ListWorkloadDeploymentPatterns": { "type": "operation", "input": { @@ -1729,7 +2049,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the workload deployment patterns.

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

Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.

", "smithy.api#examples": [ { "title": "List all available workloads supported by AWS Launch Wizard.", @@ -1837,7 +2157,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the workloads.

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

Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.

", "smithy.api#examples": [ { "title": "List all available workloads supported by AWS Launch Wizard.", @@ -1996,6 +2316,206 @@ "smithy.api#pattern": "^[a-zA-Z0-9-]{2,50}$" } }, + "com.amazonaws.launchwizard#SpecificationsConditionalData": { + "type": "list", + "member": { + "target": "com.amazonaws.launchwizard#DeploymentConditionalField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.launchwizard#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.launchwizard#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.launchwizard#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.launchwizard#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.launchwizard#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.launchwizard#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.launchwizard#InternalServerException" + }, + { + "target": "com.amazonaws.launchwizard#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.launchwizard#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds the specified tags to the given resource.

", + "smithy.api#examples": [ + { + "title": "Adding tags to a Launch Wizard deployment resource.", + "input": { + "resourceArn": "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.launchwizard#TagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.launchwizard#Tags", + "traits": { + "smithy.api#documentation": "

One or more tags to attach to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.launchwizard#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.launchwizard#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.launchwizard#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.launchwizard#TagKey" + }, + "value": { + "target": "com.amazonaws.launchwizard#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.launchwizard#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.launchwizard#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.launchwizard#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.launchwizard#InternalServerException" + }, + { + "target": "com.amazonaws.launchwizard#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.launchwizard#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the given resource.

", + "smithy.api#examples": [ + { + "title": "Removing tags on a Launch Wizard deployment resource.", + "input": { + "resourceArn": "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111", + "tagKeys": [ + "key1", + "key2" + ] + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.launchwizard#UntagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.launchwizard#TagKeyList", + "traits": { + "smithy.api#documentation": "

Keys identifying the tags to remove.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.launchwizard#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.launchwizard#ValidationException": { "type": "structure", "members": { @@ -2123,10 +2643,69 @@ "target": "com.amazonaws.launchwizard#DeploymentPatternName" } }, + "read": { + "target": "com.amazonaws.launchwizard#GetWorkloadDeploymentPattern" + }, "list": { "target": "com.amazonaws.launchwizard#ListWorkloadDeploymentPatterns" } }, + "com.amazonaws.launchwizard#WorkloadDeploymentPatternData": { + "type": "structure", + "members": { + "workloadName": { + "target": "com.amazonaws.launchwizard#WorkloadName", + "traits": { + "smithy.api#documentation": "

The workload name of the deployment pattern.

" + } + }, + "deploymentPatternName": { + "target": "com.amazonaws.launchwizard#DeploymentPatternName", + "traits": { + "smithy.api#documentation": "

The name of the deployment pattern.

" + } + }, + "workloadVersionName": { + "target": "com.amazonaws.launchwizard#WorkloadVersionName", + "traits": { + "smithy.api#documentation": "

The workload version name of the deployment pattern.

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

The display name of the deployment pattern.

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

The description of the deployment pattern.

" + } + }, + "status": { + "target": "com.amazonaws.launchwizard#WorkloadDeploymentPatternStatus", + "traits": { + "smithy.api#documentation": "

The status of the deployment pattern.

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

The status message of the deployment pattern.

" + } + }, + "specifications": { + "target": "com.amazonaws.launchwizard#DeploymentSpecificationsData", + "traits": { + "smithy.api#documentation": "

The settings specified for the deployment. These settings define how to deploy and configure your\n resources created by the deployment. For more information about the specifications\n required for creating a deployment for a SAP workload, see SAP deployment\n specifications. To retrieve the specifications required to create a deployment for other workloads,\n use the \n GetWorkloadDeploymentPattern\n operation.

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

The data that details a workload deployment pattern.

" + } + }, "com.amazonaws.launchwizard#WorkloadDeploymentPatternDataSummary": { "type": "structure", "members": { @@ -2217,9 +2796,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 256 + "max": 100 }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^[A-Za-z][a-zA-Z0-9-_]*$" } }, "com.amazonaws.launchwizard#WorkloadStatus": { @@ -2258,7 +2837,7 @@ "min": 5, "max": 30 }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + "smithy.api#pattern": "^[A-Za-z0-9][a-zA-Z0-9-]*$" } } } From f3e6ffac0fd3e46c796819f3faa6e1236868e5f9 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 31 May 2024 18:18:52 +0000 Subject: [PATCH 16/41] chore: release 1.2.24 --- .../16007c74-7831-42d2-8a3b-01e4868da600.json | 8 -------- .../8248143a-7a11-46c0-a44d-7bbeabe34c82.json | 8 -------- CHANGELOG.md | 16 ++++++++++++++++ gradle.properties | 2 +- 4 files changed, 17 insertions(+), 17 deletions(-) delete mode 100644 .changes/16007c74-7831-42d2-8a3b-01e4868da600.json delete mode 100644 .changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json diff --git a/.changes/16007c74-7831-42d2-8a3b-01e4868da600.json b/.changes/16007c74-7831-42d2-8a3b-01e4868da600.json deleted file mode 100644 index 516ada527d3..00000000000 --- a/.changes/16007c74-7831-42d2-8a3b-01e4868da600.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "id": "16007c74-7831-42d2-8a3b-01e4868da600", - "type": "bugfix", - "description": "Disable proxying of requests made to EC2 IMDS", - "issues": [ - "https://github.com/awslabs/aws-sdk-kotlin/issues/1315" - ] -} \ No newline at end of file diff --git a/.changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json b/.changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json deleted file mode 100644 index 18b8707c3a7..00000000000 --- a/.changes/8248143a-7a11-46c0-a44d-7bbeabe34c82.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "id": "8248143a-7a11-46c0-a44d-7bbeabe34c82", - "type": "misc", - "description": "Add trailing slash to base IMDS endpoint", - "issues": [ - "https://github.com/awslabs/aws-sdk-kotlin/issues/1303" - ] -} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 82f69256438..e655e397e81 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # Changelog +## [1.2.24] - 05/31/2024 + +### Features +* (**codegurusecurity**) This release includes minor model updates and documentation updates. +* (**launchwizard**) This release adds support for describing workload deployment specifications, deploying additional workload types, and managing tags for Launch Wizard resources with API operations. + +### Fixes +* [#1315](https://github.com/awslabs/aws-sdk-kotlin/issues/1315) Disable proxying of requests made to EC2 IMDS + +### Documentation +* (**codebuild**) AWS CodeBuild now supports Self-hosted GitHub Actions runners for Github Enterprise +* (**elasticache**) Update to attributes of TestFailover and minor revisions. + +### Miscellaneous +* [#1303](https://github.com/awslabs/aws-sdk-kotlin/issues/1303) Add trailing slash to base IMDS endpoint + ## [1.2.23] - 05/30/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 89d9d3c354e..f417ae10b57 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.2.24-SNAPSHOT +sdkVersion=1.2.24 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 737e66622c3b226e79574821a8a64249ca9b5a2d Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 31 May 2024 18:18:54 +0000 Subject: [PATCH 17/41] chore: bump snapshot version to 1.2.25-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index f417ae10b57..8f7cf07032d 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.2.24 +sdkVersion=1.2.25-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 349b0e8f16b2f24d297d69bdf7fb148f4237aa93 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 3 Jun 2024 18:08:16 +0000 Subject: [PATCH 18/41] feat: update AWS API models --- codegen/sdk/aws-models/amplify.json | 22 +-- codegen/sdk/aws-models/batch.json | 106 +++++++++++- codegen/sdk/aws-models/eks.json | 205 ++++++++++++++++++----- codegen/sdk/aws-models/iottwinmaker.json | 4 + 4 files changed, 280 insertions(+), 57 deletions(-) diff --git a/codegen/sdk/aws-models/amplify.json b/codegen/sdk/aws-models/amplify.json index a3f1beea1c1..b3950ef5f84 100644 --- a/codegen/sdk/aws-models/amplify.json +++ b/codegen/sdk/aws-models/amplify.json @@ -1436,7 +1436,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the backend properties associated with an Amplify\n Branch.

" + "smithy.api#documentation": "

Describes the backend associated with an Amplify\n Branch.

\n

This property is available to Amplify Gen 2 apps only. When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

" } }, "com.amazonaws.amplify#BackendEnvironment": { @@ -1484,7 +1484,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

" + "smithy.api#documentation": "

Describes the backend environment associated with a Branch of a Gen 1\n Amplify app. Amplify Gen 1 applications are created\n using Amplify Studio or the Amplify command line\n interface (CLI).

" } }, "com.amazonaws.amplify#BackendEnvironmentArn": { @@ -1706,7 +1706,7 @@ "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

\n

This property is available to Amplify Gen 1 apps only. When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

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

Creates a new backend environment for an Amplify app.

\n

This API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn’t available to applications created using the\n Amplify Gen 2 public preview. When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

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

Creates a new backend environment for an Amplify app.

\n

This API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. \n When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/backendenvironments", @@ -2290,13 +2290,13 @@ "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify\n app.

\n

This field is available to Amplify Gen 1 apps only where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI).

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

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

" + "smithy.api#documentation": "

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

\n

This field is available to Amplify Gen 2 apps only. When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

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

Deletes a backend environment for an Amplify app.

\n

This API is available only to Amplify Gen 1 applications where the\n backend was created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn’t available to applications created using the\n Amplify Gen 2 public preview. When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

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

Deletes a backend environment for an Amplify app.

\n

This API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. \n When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/backendenvironments/{environmentName}", @@ -3719,7 +3719,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a backend environment for an Amplify app.

\n

This API is available only to Amplify Gen 1 applications where the\n backend was created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn’t available to applications created using the\n Amplify Gen 2 public preview. When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

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

Returns a backend environment for an Amplify app.

\n

This API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. \n When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments/{environmentName}", @@ -4497,7 +4497,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the backend environments for an Amplify app.

\n

This API is available only to Amplify Gen 1 applications where the\n backend was created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn’t available to applications created using the\n Amplify Gen 2 public preview. When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

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

Lists the backend environments for an Amplify app.

\n

This API is available only to Amplify Gen 1 applications where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. \n When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments", @@ -6324,13 +6324,13 @@ "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify\n app.

\n

This field is available to Amplify Gen 1 apps only where the\n backend is created using Amplify Studio or the Amplify\n command line interface (CLI).

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

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

" + "smithy.api#documentation": "

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

\n

This field is available to Amplify Gen 2 apps only. When you deploy an application with\n Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n code.

" } } }, diff --git a/codegen/sdk/aws-models/batch.json b/codegen/sdk/aws-models/batch.json index cc3d51ccfba..1555f8a449b 100644 --- a/codegen/sdk/aws-models/batch.json +++ b/codegen/sdk/aws-models/batch.json @@ -72,6 +72,9 @@ { "target": "com.amazonaws.batch#DescribeSchedulingPolicies" }, + { + "target": "com.amazonaws.batch#GetJobQueueSnapshot" + }, { "target": "com.amazonaws.batch#ListJobs" }, @@ -4843,6 +4846,107 @@ "com.amazonaws.batch#Float": { "type": "float" }, + "com.amazonaws.batch#FrontOfQueueDetail": { + "type": "structure", + "members": { + "jobs": { + "target": "com.amazonaws.batch#FrontOfQueueJobSummaryList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the first 100 RUNNABLE jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.

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

The Unix timestamp (in milliseconds) for when each of the first 100 RUNNABLE jobs were last updated.

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

Contains a list of the first 100 RUNNABLE jobs associated to a single job queue.

" + } + }, + "com.amazonaws.batch#FrontOfQueueJobSummary": { + "type": "structure", + "members": { + "jobArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The ARN for a job in a named job queue.

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

The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.

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

An object that represents summary details for the first 100 RUNNABLE jobs in a job queue.

" + } + }, + "com.amazonaws.batch#FrontOfQueueJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#FrontOfQueueJobSummary" + } + }, + "com.amazonaws.batch#GetJobQueueSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#GetJobQueueSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.batch#GetJobQueueSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/getjobqueuesnapshot", + "code": 200 + } + } + }, + "com.amazonaws.batch#GetJobQueueSnapshotRequest": { + "type": "structure", + "members": { + "jobQueue": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The job queue’s name or full queue Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.batch#GetJobQueueSnapshotResponse": { + "type": "structure", + "members": { + "frontOfQueue": { + "target": "com.amazonaws.batch#FrontOfQueueDetail", + "traits": { + "smithy.api#documentation": "

The list of the first 100 RUNNABLE jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.batch#Host": { "type": "structure", "members": { @@ -5880,7 +5984,7 @@ "maxResults": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of results returned by ListJobs in paginated output. When\n this parameter is used, ListJobs only returns maxResults results in\n a single page and a nextToken response element. The remaining results of the\n initial request can be seen by sending another ListJobs request with the returned\n nextToken value. This value can be between 1 and\n 100. If this parameter isn't used, then ListJobs returns up to\n 100 results and a nextToken value if applicable.

" + "smithy.api#documentation": "

The maximum number of results returned by ListJobs in a paginated output. When this parameter is used, ListJobs returns up to maxResults results in a single page and a nextToken response element, if applicable. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value.

\n

The following outlines key parameters and limitations:

\n
    \n
  • \n

    The minimum value is 1.

    \n
  • \n
  • \n

    When --job-status is used, Batch returns up to 1000 values.

    \n
  • \n
  • \n

    When --filters is used, Batch returns up to 100 values.

    \n
  • \n
  • \n

    If neither parameter is used, then ListJobs returns up to\n 1000 results (jobs that are in the RUNNING status) and a nextToken value, if applicable.

    \n
  • \n
" } }, "nextToken": { diff --git a/codegen/sdk/aws-models/eks.json b/codegen/sdk/aws-models/eks.json index 782f5ecdfb0..2f699e4540b 100644 --- a/codegen/sdk/aws-models/eks.json +++ b/codegen/sdk/aws-models/eks.json @@ -1592,6 +1592,12 @@ "traits": { "smithy.api#documentation": "

The configuration values that you provided.

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

An array of Pod Identity Assocations owned by the Addon. Each EKS Pod Identity association maps a role to a service account in a namespace in the cluster.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

" + } } }, "traits": { @@ -1732,6 +1738,18 @@ "traits": { "smithy.api#enumValue": "K8sResourceNotFound" } + }, + "ADDON_SUBSCRIPTION_NEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddonSubscriptionNeeded" + } + }, + "ADDON_PERMISSION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddonPermissionFailure" + } } } }, @@ -1741,6 +1759,60 @@ "target": "com.amazonaws.eks#AddonIssue" } }, + "com.amazonaws.eks#AddonPodIdentityAssociations": { + "type": "structure", + "members": { + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The name of a Kubernetes Service Account.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM Role.

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

A type of Pod Identity Association owned by an Amazon EKS Add-on.

\n

Each EKS Pod Identity Association maps a role to a service account in a namespace in the cluster.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

" + } + }, + "com.amazonaws.eks#AddonPodIdentityAssociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonPodIdentityAssociations" + } + }, + "com.amazonaws.eks#AddonPodIdentityConfiguration": { + "type": "structure", + "members": { + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "

The Kubernetes Service Account name used by the addon.

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

A suggested IAM Policy for the addon.

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

Information about how to configure IAM for an Addon.

" + } + }, + "com.amazonaws.eks#AddonPodIdentityConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonPodIdentityConfiguration" + } + }, "com.amazonaws.eks#AddonStatus": { "type": "enum", "members": { @@ -1821,6 +1893,13 @@ "smithy.api#default": false, "smithy.api#documentation": "

Whether the add-on requires configuration.

" } + }, + "requiresIamPermissions": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates if the Addon requires IAM Permissions to operate, such as networking permissions.

" + } } }, "traits": { @@ -2291,7 +2370,7 @@ "subscriptionId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" } }, "message": { @@ -2331,7 +2410,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about clients using the deprecated resources.

" + "smithy.api#documentation": "

Details about clients using the deprecated resources.

" } }, "com.amazonaws.eks#ClientStats": { @@ -2454,7 +2533,7 @@ "health": { "target": "com.amazonaws.eks#ClusterHealth", "traits": { - "smithy.api#documentation": "

An object representing the health of your local Amazon EKS cluster on an\n Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.

" + "smithy.api#documentation": "

An object representing the health of your Amazon EKS cluster.

" } }, "outpostConfig": { @@ -2480,12 +2559,12 @@ "issues": { "target": "com.amazonaws.eks#ClusterIssueList", "traits": { - "smithy.api#documentation": "

An object representing the health issues of your local Amazon EKS cluster on\n an Amazon Web Services Outpost.

" + "smithy.api#documentation": "

An object representing the health issues of your Amazon EKS cluster.

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

An object representing the health of your local Amazon EKS cluster on an\n Amazon Web Services Outpost. You can't use this API with an Amazon EKS\n cluster on the Amazon Web Services cloud.

" + "smithy.api#documentation": "

An object representing the health of your Amazon EKS cluster.

" } }, "com.amazonaws.eks#ClusterIssue": { @@ -2511,7 +2590,7 @@ } }, "traits": { - "smithy.api#documentation": "

An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost.\n You can't use this API with an Amazon EKS cluster on the Amazon Web Services\n cloud.

" + "smithy.api#documentation": "

An issue with your Amazon EKS cluster.

" } }, "com.amazonaws.eks#ClusterIssueCode": { @@ -2848,7 +2927,7 @@ "groupName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the placement group for the Kubernetes control plane instances. This\n setting can't be changed after cluster creation.

" + "smithy.api#documentation": "

The name of the placement group for the Kubernetes control plane instances. This setting\n can't be changed after cluster creation.

" } } }, @@ -2941,7 +3020,7 @@ "principalArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The ARN of the IAM principal for the AccessEntry. You can specify one ARN for each access entry. You can't specify the\n same ARN in more than one access entry. This value can't be changed after access entry\n creation.

\n

The valid principals differ depending on the type of the access entry in the type field.\n The only valid ARN is IAM roles for the types of access entries for nodes: \n . You can use every IAM principal type for STANDARD access entries.\n You can't use the STS session principal type with access entries because this is a temporary\n principal for each session and not a permanent identity that can be assigned permissions.

\n

\n IAM best practices recommend using IAM roles with\n temporary credentials, rather than IAM users with long-term credentials.\n

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

The ARN of the IAM principal for the AccessEntry. You can specify one ARN for each access entry. You can't specify the\n same ARN in more than one access entry. This value can't be changed after access entry\n creation.

\n

The valid principals differ depending on the type of the access entry in the\n type field. The only valid ARN is IAM roles for the types of access\n entries for nodes: \n . You can use every IAM principal type for STANDARD access entries.\n You can't use the STS session principal type with access entries because this is a\n temporary principal for each session and not a permanent identity that can be assigned\n permissions.

\n

\n IAM best practices recommend using IAM roles with\n temporary credentials, rather than IAM users with long-term credentials.\n

", "smithy.api#required": {} } }, @@ -2973,7 +3052,7 @@ "type": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The type of the new access entry. Valid values are Standard,\n FARGATE_LINUX, EC2_LINUX, and EC2_WINDOWS.

\n

If the principalArn is for an IAM role that's used for\n self-managed Amazon EC2 nodes, specify EC2_LINUX or\n EC2_WINDOWS. Amazon EKS grants the necessary permissions to the\n node for you. If the principalArn is for any other purpose, specify\n STANDARD. If you don't specify a value, Amazon EKS sets the\n value to STANDARD. It's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the\n aws-auth\n ConfigMap for the roles. You can't change this value once you've created\n the access entry.

\n

If you set the value to EC2_LINUX or EC2_WINDOWS, you can't\n specify values for kubernetesGroups, or associate an\n AccessPolicy to the access entry.

" + "smithy.api#documentation": "

The type of the new access entry. Valid values are Standard,\n FARGATE_LINUX, EC2_LINUX, and\n EC2_WINDOWS.

\n

If the principalArn is for an IAM role that's used for\n self-managed Amazon EC2 nodes, specify EC2_LINUX or\n EC2_WINDOWS. Amazon EKS grants the necessary permissions to the\n node for you. If the principalArn is for any other purpose, specify\n STANDARD. If you don't specify a value, Amazon EKS sets the\n value to STANDARD. It's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the\n aws-auth\n ConfigMap for the roles. You can't change this value once you've created\n the access entry.

\n

If you set the value to EC2_LINUX or EC2_WINDOWS, you can't\n specify values for kubernetesGroups, or associate an\n AccessPolicy to the access entry.

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

The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema returned by\n DescribeAddonConfiguration.

" } + }, + "podIdentityAssociations": { + "target": "com.amazonaws.eks#AddonPodIdentityAssociationsList", + "traits": { + "smithy.api#documentation": "

An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

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

Creates an Amazon EKS control plane.

\n

The Amazon EKS control plane consists of control plane instances that run the\n Kubernetes software, such as etcd and the API server. The control plane runs in\n an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is\n single tenant and unique. It runs on its own set of Amazon EC2 instances.

\n

The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in\n your VPC subnets to provide connectivity from the control plane instances to the nodes\n (for example, to support kubectl exec, logs, and\n proxy data flows).

\n

Amazon EKS nodes run in your Amazon Web Services account and connect to your\n cluster's control plane over the Kubernetes API server endpoint and a certificate file that\n is created for your cluster.

\n

You can use the endpointPublicAccess and\n endpointPrivateAccess parameters to enable or disable public and\n private access to your cluster's Kubernetes API server endpoint. By default, public access is\n enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the\n \n Amazon EKS User Guide\n .

\n

You can use the logging parameter to enable or disable exporting the\n Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster\n control plane logs aren't exported to CloudWatch Logs. For more information, see\n Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n
\n

In most cases, it takes several minutes to create a cluster. After you create an\n Amazon EKS cluster, you must configure your Kubernetes tooling to communicate\n with the API server and launch nodes into your cluster. For more information, see Managing Cluster\n Authentication and Launching Amazon EKS nodes in the\n Amazon EKS User Guide.

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

Creates an Amazon EKS control plane.

\n

The Amazon EKS control plane consists of control plane instances that run the\n Kubernetes software, such as etcd and the API server. The control plane runs in\n an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is\n single tenant and unique. It runs on its own set of Amazon EC2 instances.

\n

The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in\n your VPC subnets to provide connectivity from the control plane instances to the nodes\n (for example, to support kubectl exec, logs, and\n proxy data flows).

\n

Amazon EKS nodes run in your Amazon Web Services account and connect to your\n cluster's control plane over the Kubernetes API server endpoint and a certificate file that\n is created for your cluster.

\n

You can use the endpointPublicAccess and\n endpointPrivateAccess parameters to enable or disable public and\n private access to your cluster's Kubernetes API server endpoint. By default, public access is\n enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the\n \n Amazon EKS User Guide\n .

\n

You can use the logging parameter to enable or disable exporting the\n Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster\n control plane logs aren't exported to CloudWatch Logs. For more information, see\n Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n
\n

In most cases, it takes several minutes to create a cluster. After you create an\n Amazon EKS cluster, you must configure your Kubernetes tooling to communicate\n with the API server and launch nodes into your cluster. For more information, see Allowing users to\n access your cluster and Launching\n Amazon EKS nodes in the Amazon EKS User Guide.

", "smithy.api#examples": [ { "title": "To create a new cluster", @@ -3495,7 +3580,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a managed node group for an Amazon EKS cluster.

\n

You can only create a node group for your cluster that is equal to the current Kubernetes\n version for the cluster. All node groups are created with the latest AMI release version\n for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI\n using a launch template. For more information about using launch templates, see Launch\n template support.

\n

An Amazon EKS managed node group is an Amazon EC2\n Auto Scaling group and associated Amazon EC2 instances that are managed by\n Amazon Web Services for an Amazon EKS cluster. For more information, see\n Managed node groups in the Amazon EKS User Guide.

\n \n

Windows AMI types are only supported for commercial Amazon Web Services Regions\n that support Windows on Amazon EKS.

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

Creates a managed node group for an Amazon EKS cluster.

\n

You can only create a node group for your cluster that is equal to the current Kubernetes\n version for the cluster. All node groups are created with the latest AMI release version\n for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI\n using a launch template. For more information about using launch templates, see Customizing managed nodes with launch templates.

\n

An Amazon EKS managed node group is an Amazon EC2\n Auto Scaling group and associated Amazon EC2 instances that are managed by\n Amazon Web Services for an Amazon EKS cluster. For more information, see\n Managed node groups in the Amazon EKS User Guide.

\n \n

Windows AMI types are only supported for commercial Amazon Web Services Regions\n that support Windows on Amazon EKS.

\n
", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups", @@ -3530,38 +3615,38 @@ "diskSize": { "target": "com.amazonaws.eks#BoxedInteger", "traits": { - "smithy.api#documentation": "

The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows.\n If you specify launchTemplate, then don't specify diskSize, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows.\n If you specify launchTemplate, then don't specify diskSize, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

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

The subnets to use for the Auto Scaling group that is created for your node group.\n If you specify launchTemplate, then don't specify \n SubnetId\n in your launch template, or the node group deployment\n will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

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

The subnets to use for the Auto Scaling group that is created for your node group.\n If you specify launchTemplate, then don't specify \n SubnetId\n in your launch template, or the node group deployment\n will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

", "smithy.api#required": {} } }, "instanceTypes": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "

Specify the instance types for a node group. If you specify a GPU instance type, make\n sure to also specify an applicable GPU AMI type with the amiType parameter.\n If you specify launchTemplate, then you can specify zero or one instance\n type in your launch template or you can specify 0-20 instance types\n for instanceTypes. If however, you specify an instance type in your launch\n template and specify any instanceTypes, the node group\n deployment will fail. If you don't specify an instance type in a launch template or for\n instanceTypes, then t3.medium is used, by default. If you\n specify Spot for capacityType, then we recommend specifying\n multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in\n the Amazon EKS User Guide.

" + "smithy.api#documentation": "

Specify the instance types for a node group. If you specify a GPU instance type, make\n sure to also specify an applicable GPU AMI type with the amiType parameter.\n If you specify launchTemplate, then you can specify zero or one instance\n type in your launch template or you can specify 0-20 instance types\n for instanceTypes. If however, you specify an instance type in your launch\n template and specify any instanceTypes, the node group\n deployment will fail. If you don't specify an instance type in a launch template or for\n instanceTypes, then t3.medium is used, by default. If you\n specify Spot for capacityType, then we recommend specifying\n multiple values for instanceTypes. For more information, see Managed node group capacity types and Customizing managed nodes with launch templates in\n the Amazon EKS User Guide.

" } }, "amiType": { "target": "com.amazonaws.eks#AMITypes", "traits": { - "smithy.api#documentation": "

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI,\n then don't specify amiType, or the node group deployment\n will fail. If your launch template uses a Windows custom AMI, then add\n eks:kube-proxy-windows to your Windows nodes rolearn in\n the aws-auth\n ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI,\n then don't specify amiType, or the node group deployment\n will fail. If your launch template uses a Windows custom AMI, then add\n eks:kube-proxy-windows to your Windows nodes rolearn in\n the aws-auth\n ConfigMap. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" } }, "remoteAccess": { "target": "com.amazonaws.eks#RemoteAccessConfig", "traits": { - "smithy.api#documentation": "

The remote access configuration to use with your node group. For Linux, the protocol\n is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify \n remoteAccess, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The remote access configuration to use with your node group. For Linux, the protocol\n is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify \n remoteAccess, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

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

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The\n Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls\n through an IAM instance profile and associated policies. Before you can\n launch nodes and register them into a cluster, you must create an IAM\n role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the\n \n Amazon EKS User Guide\n . If you specify launchTemplate, then don't specify \n \n IamInstanceProfile\n in your launch template, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

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

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The\n Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls\n through an IAM instance profile and associated policies. Before you can\n launch nodes and register them into a cluster, you must create an IAM\n role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the\n \n Amazon EKS User Guide\n . If you specify launchTemplate, then don't specify \n \n IamInstanceProfile\n in your launch template, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

", "smithy.api#required": {} } }, @@ -3593,7 +3678,7 @@ "launchTemplate": { "target": "com.amazonaws.eks#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "

An object representing a node group's launch template specification. If specified,\n then do not specify instanceTypes, diskSize, or\n remoteAccess and make sure that the launch template meets the\n requirements in launchTemplateSpecification.

" + "smithy.api#documentation": "

An object representing a node group's launch template specification. When using this\n object, don't directly specify instanceTypes, diskSize, or\n remoteAccess. Make sure that\n the launch template meets the requirements in launchTemplateSpecification. Also refer to\n Customizing managed nodes with launch templates in\n the Amazon EKS User Guide.

" } }, "updateConfig": { @@ -3611,13 +3696,13 @@ "version": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the\n cluster is used, and this is the only accepted specified value. If you specify launchTemplate,\n and your launch template uses a custom AMI, then don't specify version, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the\n cluster is used, and this is the only accepted specified value. If you specify launchTemplate,\n and your launch template uses a custom AMI, then don't specify version, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

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

The AMI version of the Amazon EKS optimized AMI to use with your node group.\n By default, the latest available AMI version for the node group's current Kubernetes version\n is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use with your node group.\n By default, the latest available AMI version for the node group's current Kubernetes version\n is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" } } }, @@ -4242,13 +4327,13 @@ "stopServingVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The version of the software where the deprecated resource version will stop being served.

" + "smithy.api#documentation": "

The version of the software where the deprecated resource version will stop being\n served.

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

The version of the software where the newer resource version became available to migrate to if applicable.

" + "smithy.api#documentation": "

The version of the software where the newer resource version became available to\n migrate to if applicable.

" } }, "clientStats": { @@ -4562,6 +4647,12 @@ "traits": { "smithy.api#documentation": "

A JSON schema that's used to validate the configuration values you provide when an\n add-on is created or updated.

" } + }, + "podIdentityConfiguration": { + "target": "com.amazonaws.eks#AddonPodIdentityConfigurationList", + "traits": { + "smithy.api#documentation": "

The Kubernetes service account name used by the addon, and any suggested IAM policies. Use this information to create an IAM Role for the Addon.

" + } } }, "traits": { @@ -5794,7 +5885,7 @@ "target": "com.amazonaws.eks#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription.

" + "smithy.api#documentation": "

The duration of the subscription term. Valid values are 12 and 36, indicating a 12\n month or 36 month subscription.

" } }, "unit": { @@ -6223,7 +6314,7 @@ "lastRefreshTime": { "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "

The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.

" + "smithy.api#documentation": "

The time Amazon EKS last successfully completed a refresh of this insight check on the\n cluster.

" } }, "lastTransitionTime": { @@ -6235,7 +6326,7 @@ "description": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).

" + "smithy.api#documentation": "

The description of the insight which includes alert criteria, remediation\n recommendation, and additional resources (contains Markdown).

" } }, "insightStatus": { @@ -6270,7 +6361,7 @@ } }, "traits": { - "smithy.api#documentation": "

A check that provides recommendations to remedy potential upgrade-impacting issues.

" + "smithy.api#documentation": "

A check that provides recommendations to remedy potential upgrade-impacting\n issues.

" } }, "com.amazonaws.eks#InsightCategorySpecificSummary": { @@ -6410,7 +6501,7 @@ "lastRefreshTime": { "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "

The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.

" + "smithy.api#documentation": "

The time Amazon EKS last successfully completed a refresh of this insight check on the\n cluster.

" } }, "lastTransitionTime": { @@ -6422,7 +6513,7 @@ "description": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).

" + "smithy.api#documentation": "

The description of the insight which includes alert criteria, remediation\n recommendation, and additional resources (contains Markdown).

" } }, "insightStatus": { @@ -6498,7 +6589,7 @@ "subscriptionId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" } }, "message": { @@ -6538,7 +6629,7 @@ "subscriptionId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" } }, "message": { @@ -6672,7 +6763,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n can't include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API\n Reference. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

\n

You must specify either the launch template ID or the launch template name in the\n request, but not both.

" + "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n can't include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API\n Reference. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

\n

You must specify either the launch template ID or the launch template name in the\n request, but not both.

" } }, "com.amazonaws.eks#ListAccessEntries": { @@ -6948,7 +7039,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future ListAddons\n request. When the results of a ListAddons request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

\n \n

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

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

The nextToken value to include in a future ListAddons\n request. When the results of a ListAddons request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

\n \n

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

\n
" } } }, @@ -7226,7 +7317,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListEksAnywhereSubscriptions request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

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

The nextToken value returned from a previous paginated\n ListEksAnywhereSubscriptions request where maxResults was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value.

", "smithy.api#httpQuery": "nextToken" } }, @@ -7480,7 +7571,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.

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

Returns a list of all insights checked for against the specified cluster. You can\n filter which insights are returned by category, associated Kubernetes version, and\n status.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/insights", @@ -7517,7 +7608,7 @@ "filter": { "target": "com.amazonaws.eks#InsightsFilter", "traits": { - "smithy.api#documentation": "

The criteria to filter your list of insights for your cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.

" + "smithy.api#documentation": "

The criteria to filter your list of insights for your cluster. You can filter which\n insights are returned by category, associated Kubernetes version, and status.

" } }, "maxResults": { @@ -7529,7 +7620,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a previous paginated ListInsights\n request. When the results of a ListInsights request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + "smithy.api#documentation": "

The nextToken value returned from a previous paginated\n ListInsights request. When the results of a ListInsights\n request exceed maxResults, you can use this value to retrieve the next page\n of results. This value is null when there are no more results to\n return.

" } } }, @@ -7549,7 +7640,7 @@ "nextToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future ListInsights\n request. When the results of a ListInsights request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + "smithy.api#documentation": "

The nextToken value to include in a future ListInsights\n request. When the results of a ListInsights request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" } } }, @@ -7752,7 +7843,7 @@ "associations": { "target": "com.amazonaws.eks#PodIdentityAssociationSummaries", "traits": { - "smithy.api#documentation": "

The list of summarized descriptions of the associations that are in the cluster and match any\n filters that you provided.

\n

Each summary is simplified by removing these fields compared to the full \n PodIdentityAssociation\n :

\n
    \n
  • \n

    The IAM role: roleArn\n

    \n
  • \n
  • \n

    The timestamp that the association was created at: createdAt\n

    \n
  • \n
  • \n

    The most recent timestamp that the association was modified at:. modifiedAt\n

    \n
  • \n
  • \n

    The tags on the association: tags\n

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

The list of summarized descriptions of the associations that are in the cluster and match\n any filters that you provided.

\n

Each summary is simplified by removing these fields compared to the full \n PodIdentityAssociation\n :

\n
    \n
  • \n

    The IAM role: roleArn\n

    \n
  • \n
  • \n

    The timestamp that the association was created at: createdAt\n

    \n
  • \n
  • \n

    The most recent timestamp that the association was modified at:. modifiedAt\n

    \n
  • \n
  • \n

    The tags on the association: tags\n

    \n
  • \n
" } }, "nextToken": { @@ -8832,6 +8923,12 @@ "traits": { "smithy.api#documentation": "

The most recent timestamp that the association was modified at

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

If defined, the Pod Identity Association is owned by an Amazon EKS Addon.

" + } } }, "traits": { @@ -8862,7 +8959,7 @@ "serviceAccount": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

" + "smithy.api#documentation": "

The name of the Kubernetes service account inside the cluster to associate the IAM\n credentials with.

" } }, "associationArn": { @@ -8876,6 +8973,12 @@ "traits": { "smithy.api#documentation": "

The ID of the association.

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

If defined, the Pod Identity Association is owned by an Amazon EKS Addon.

" + } } }, "traits": { @@ -8888,7 +8991,7 @@ "keyArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be\n symmetric and created in the same Amazon Web Services Region as the cluster. If the\n KMS key was created in a different account, the IAM principal must\n have access to the KMS key. For more information, see Allowing\n users in other accounts to use a KMS key in the\n Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be\n symmetric and created in the same Amazon Web Services Region as the cluster. If the\n KMS key was created in a different account, the IAM principal must\n have access to the KMS key. For more information, see Allowing\n users in other accounts to use a KMS key in the\n Key Management Service Developer Guide.

" } } }, @@ -9080,7 +9183,7 @@ "subscriptionId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" } }, "message": { @@ -9126,7 +9229,7 @@ "subscriptionId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" } }, "message": { @@ -9191,7 +9294,7 @@ "subscriptionId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" + "smithy.api#documentation": "

The Amazon EKS subscription ID with the exception.

" } }, "message": { @@ -9709,6 +9812,12 @@ "traits": { "smithy.api#documentation": "

The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema returned by\n DescribeAddonConfiguration.

" } + }, + "podIdentityAssociations": { + "target": "com.amazonaws.eks#AddonPodIdentityAssociationsList", + "traits": { + "smithy.api#documentation": "

An array of Pod Identity Assocations to be updated. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role. If this value is left blank, no change. If an empty array is provided, existing Pod Identity Assocations owned by the Addon are deleted.

\n

For more information, see Attach an IAM Role to an Amazon EKS add-on using Pod Identity in the EKS User Guide.

" + } } }, "traits": { @@ -10154,13 +10263,13 @@ "version": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Kubernetes version to update to. If no version is specified, then the Kubernetes version of\n the node group does not change. You can specify the Kubernetes version of the cluster to\n update the node group to the latest AMI version of the cluster's Kubernetes version.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version,\n or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The Kubernetes version to update to. If no version is specified, then the Kubernetes version of\n the node group does not change. You can specify the Kubernetes version of the cluster to\n update the node group to the latest AMI version of the cluster's Kubernetes version.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version,\n or the node group update will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

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

The AMI version of the Amazon EKS optimized AMI to use for the update. By\n default, the latest available AMI version for the node group's Kubernetes version is used.\n For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group update will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" + "smithy.api#documentation": "

The AMI version of the Amazon EKS optimized AMI to use for the update. By\n default, the latest available AMI version for the node group's Kubernetes version is used.\n For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.

\n

If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group update will fail.\n For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.

" } }, "launchTemplate": { @@ -10383,6 +10492,12 @@ "traits": { "smithy.api#enumValue": "AuthenticationMode" } + }, + "POD_IDENTITY_ASSOCIATIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodIdentityAssociations" + } } } }, diff --git a/codegen/sdk/aws-models/iottwinmaker.json b/codegen/sdk/aws-models/iottwinmaker.json index 020fd0f2006..5e190b05ffe 100644 --- a/codegen/sdk/aws-models/iottwinmaker.json +++ b/codegen/sdk/aws-models/iottwinmaker.json @@ -6782,6 +6782,10 @@ { "name": "CREATE", "value": "CREATE" + }, + { + "name": "RESET_VALUE", + "value": "RESET_VALUE" } ] } From ce0e6520c2f10c70267a44f9e299263dc13ba35f Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 3 Jun 2024 18:08:16 +0000 Subject: [PATCH 19/41] feat: update AWS service endpoints metadata --- .../aws/sdk/kotlin/codegen/endpoints.json | 42 ++----------------- 1 file changed, 3 insertions(+), 39 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 20db4ac34e3..3d3288dc20b 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 @@ -27852,32 +27852,8 @@ }, "ram" : { "endpoints" : { - "fips-us-iso-east-1" : { - "credentialScope" : { - "region" : "us-iso-east-1" - }, - "deprecated" : true, - "hostname" : "ram-fips.us-iso-east-1.c2s.ic.gov" - }, - "fips-us-iso-west-1" : { - "credentialScope" : { - "region" : "us-iso-west-1" - }, - "deprecated" : true, - "hostname" : "ram-fips.us-iso-west-1.c2s.ic.gov" - }, - "us-iso-east-1" : { - "variants" : [ { - "hostname" : "ram-fips.us-iso-east-1.c2s.ic.gov", - "tags" : [ "fips" ] - } ] - }, - "us-iso-west-1" : { - "variants" : [ { - "hostname" : "ram-fips.us-iso-west-1.c2s.ic.gov", - "tags" : [ "fips" ] - } ] - } + "us-iso-east-1" : { }, + "us-iso-west-1" : { } } }, "rbin" : { @@ -28618,19 +28594,7 @@ }, "ram" : { "endpoints" : { - "fips-us-isob-east-1" : { - "credentialScope" : { - "region" : "us-isob-east-1" - }, - "deprecated" : true, - "hostname" : "ram-fips.us-isob-east-1.sc2s.sgov.gov" - }, - "us-isob-east-1" : { - "variants" : [ { - "hostname" : "ram-fips.us-isob-east-1.sc2s.sgov.gov", - "tags" : [ "fips" ] - } ] - } + "us-isob-east-1" : { } } }, "rbin" : { From 4e896511b046a3ced6dda8f656ec79551320ae87 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 3 Jun 2024 18:11:08 +0000 Subject: [PATCH 20/41] chore: release 1.2.25 --- CHANGELOG.md | 10 ++++++++++ gradle.properties | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e655e397e81..3044892c321 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## [1.2.25] - 06/03/2024 + +### Features +* (**batch**) This release adds support for the AWS Batch GetJobQueueSnapshot API operation. +* (**eks**) Adds support for EKS add-ons pod identity associations integration +* (**iottwinmaker**) Support RESET_VALUE UpdateType for PropertyUpdates to reset property value to default or null + +### Documentation +* (**amplify**) This doc-only update identifies fields that are specific to Gen 1 and Gen 2 applications. + ## [1.2.24] - 05/31/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 8f7cf07032d..a4ee52660c2 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.2.25-SNAPSHOT +sdkVersion=1.2.25 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 5c68d1dafa85746c57b5b59e4be2328426cd4a84 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 3 Jun 2024 18:11:09 +0000 Subject: [PATCH 21/41] chore: bump snapshot version to 1.2.26-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index a4ee52660c2..90d014fe79a 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.2.25 +sdkVersion=1.2.26-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 62a6d9f2c38f8368ac21bb404cec8bc331c0158a Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 4 Jun 2024 18:03:48 +0000 Subject: [PATCH 22/41] feat: update AWS API models --- codegen/sdk/aws-models/ec2.json | 54 + codegen/sdk/aws-models/pipes.json | 627 ++++- codegen/sdk/aws-models/sagemaker.json | 70 +- codegen/sdk/aws-models/taxsettings.json | 3122 +++++++++++++++++++++++ 4 files changed, 3745 insertions(+), 128 deletions(-) create mode 100644 codegen/sdk/aws-models/taxsettings.json diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 1819002c68c..d6d3cb7ad33 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -66041,6 +66041,60 @@ "traits": { "smithy.api#enumValue": "gr6.8xlarge" } + }, + "c7i_flex_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.large" + } + }, + "c7i_flex_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.xlarge" + } + }, + "c7i_flex_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.2xlarge" + } + }, + "c7i_flex_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.4xlarge" + } + }, + "c7i_flex_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "c7i-flex.8xlarge" + } + }, + "u7i_12tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7i-12tb.224xlarge" + } + }, + "u7in_16tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7in-16tb.224xlarge" + } + }, + "u7in_24tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7in-24tb.224xlarge" + } + }, + "u7in_32tb_224xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "u7in-32tb.224xlarge" + } } } }, diff --git a/codegen/sdk/aws-models/pipes.json b/codegen/sdk/aws-models/pipes.json index 3300c3d6e51..22208d65731 100644 --- a/codegen/sdk/aws-models/pipes.json +++ b/codegen/sdk/aws-models/pipes.json @@ -52,25 +52,25 @@ "Subnets": { "target": "com.amazonaws.pipes#Subnets", "traits": { - "smithy.api#documentation": "

Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

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

Specifies the subnets associated with the task. These subnets must all be in the same\n VPC. You can specify as many as 16 subnets.

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

Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many \n as five security groups. If you do not specify a security group, the default security group for the VPC is used.

" + "smithy.api#documentation": "

Specifies the security groups associated with the task. These security groups must all\n be in the same VPC. You can specify as many as five security groups. If you do not specify\n a security group, the default security group for the VPC is used.

" } }, "AssignPublicIp": { "target": "com.amazonaws.pipes#AssignPublicIp", "traits": { - "smithy.api#documentation": "

Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when \n LaunchType in EcsParameters is set to FARGATE.

" + "smithy.api#documentation": "

Specifies whether the task's elastic network interface receives a public IP address. You\n can specify ENABLED only when LaunchType in\n EcsParameters is set to FARGATE.

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

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. \n This structure is relevant only for ECS tasks that use the awsvpc network mode.

" + "smithy.api#documentation": "

This structure specifies the VPC subnets and security groups for the task, and whether a\n public IP address is to be used. This structure is relevant only for ECS tasks that use the\n awsvpc network mode.

" } }, "com.amazonaws.pipes#BatchArrayProperties": { @@ -102,25 +102,25 @@ "Command": { "target": "com.amazonaws.pipes#StringList", "traits": { - "smithy.api#documentation": "

The command to send to the container that overrides the default command from the Docker image or the task definition.

" + "smithy.api#documentation": "

The command to send to the container that overrides the default command from the Docker\n image or the task definition.

" } }, "Environment": { "target": "com.amazonaws.pipes#BatchEnvironmentVariableList", "traits": { - "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing \n environment variables from the Docker image or the task definition.

\n \n

Environment variables cannot start with \"Batch\". This naming convention is reserved for variables that Batch sets.

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

The environment variables to send to the container. You can add new environment\n variables, which are added to the container at launch, or you can override the existing\n environment variables from the Docker image or the task definition.

\n \n

Environment variables cannot start with \"Batch\". This\n naming convention is reserved for variables that Batch sets.

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

The instance type to use for a multi-node parallel job.

\n \n

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

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

The instance type to use for a multi-node parallel job.

\n \n

This parameter isn't applicable to single-node container jobs or jobs that run on\n Fargate resources, and shouldn't be provided.

\n
" } }, "ResourceRequirements": { "target": "com.amazonaws.pipes#BatchResourceRequirementsList", "traits": { - "smithy.api#documentation": "

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, \n and VCPU.

" + "smithy.api#documentation": "

The type and amount of resources to assign to a container. This overrides the settings\n in the job definition. The supported resources include GPU,\n MEMORY, and VCPU.

" } } }, @@ -146,18 +146,18 @@ "Name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the environment variable.

" + "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the\n environment variable.

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

The value of the key-value pair. For environment variables, this is the value of the environment variable.

" + "smithy.api#documentation": "

The value of the key-value pair. For environment variables, this is the value of the\n environment variable.

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

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing \n environment variables from the Docker image or the task definition.

\n \n

Environment variables cannot start with \"Batch\". This naming convention is reserved for variables that Batch sets.

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

The environment variables to send to the container. You can add new environment\n variables, which are added to the container at launch, or you can override the existing\n environment variables from the Docker image or the task definition.

\n \n

Environment variables cannot start with \"Batch\". This\n naming convention is reserved for variables that Batch sets.

\n
" } }, "com.amazonaws.pipes#BatchEnvironmentVariableList": { @@ -172,7 +172,7 @@ "JobId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The job ID of the Batch job that's associated with this dependency.

" + "smithy.api#documentation": "

The job ID of the Batch job that's associated with this\n dependency.

" } }, "Type": { @@ -216,20 +216,20 @@ "Type": { "target": "com.amazonaws.pipes#BatchResourceRequirementType", "traits": { - "smithy.api#documentation": "

The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

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

The type of resource to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.

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

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

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

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

\n \n

GPUs aren't available for jobs that are running on Fargate resources.

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

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

\n \n

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

\n
\n

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

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

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

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, 4, or 8

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

\n VCPU = 2 or 4

\n
\n
value = 16384
\n
\n

\n VCPU = 2, 4, or 8

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

\n VCPU = 4

\n
\n
value = 20480, 24576, or 28672
\n
\n

\n VCPU = 4 or 8

\n
\n
value = 36864, 45056, 53248, or 61440
\n
\n

\n VCPU = 8

\n
\n
value = 32768, 40960, 49152, or 57344
\n
\n

\n VCPU = 8 or 16

\n
\n
value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
\n
\n

\n VCPU = 16

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

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

\n

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about\n Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

\n

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

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

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

\n
\n
value = 1
\n
\n

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

\n
\n
value = 2
\n
\n

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

\n
\n
value = 4
\n
\n

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

\n
\n
value = 8
\n
\n

\n MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n

\n
\n
value = 16
\n
\n

\n MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n

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

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

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

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

\n \n

GPUs aren't available for jobs that are running on Fargate\n resources.

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

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

\n \n

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

\n
\n

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

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

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

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, 4, or 8

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

\n VCPU = 2 or 4

\n
\n
value = 16384
\n
\n

\n VCPU = 2, 4, or 8

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

\n VCPU = 4

\n
\n
value = 20480, 24576, or 28672
\n
\n

\n VCPU = 4 or 8

\n
\n
value = 36864, 45056, 53248, or 61440
\n
\n

\n VCPU = 8

\n
\n
value = 32768, 40960, 49152, or 57344
\n
\n

\n VCPU = 8 or 16

\n
\n
value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or\n 122880
\n
\n

\n VCPU = 16

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

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

\n

The default for the Fargate On-Demand vCPU resource count quota\n is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services\n General Reference.

\n

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

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

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

\n
\n
value = 1
\n
\n

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

\n
\n
value = 2
\n
\n

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

\n
\n
value = 4
\n
\n

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

\n
\n
value = 8
\n
\n

\n MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960,\n 45056, 49152, 53248, 57344, or 61440

\n
\n
value = 16
\n
\n

\n MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920,\n 90112, 98304, 106496, 114688, or 122880

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

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

" + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. The supported resources\n include GPU, MEMORY, and VCPU.

" } }, "com.amazonaws.pipes#BatchResourceRequirementType": { @@ -272,12 +272,12 @@ "Attempts": { "target": "com.amazonaws.pipes#BatchRetryAttempts", "traits": { - "smithy.api#documentation": "

The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on \n failure the same number of attempts as the value.

" + "smithy.api#documentation": "

The number of times to move a job to the RUNNABLE status. If the value of\n attempts is greater than one, the job is retried on failure the same number\n of attempts as the value.

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

The retry strategy that's associated with a job. For more information, see \n Automated job retries in the Batch User Guide.

" + "smithy.api#documentation": "

The retry strategy that's associated with a job. For more information, see Automated job\n retries in the Batch User Guide.

" } }, "com.amazonaws.pipes#Boolean": { @@ -322,14 +322,14 @@ "target": "com.amazonaws.pipes#CapacityProviderStrategyItemWeight", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The weight value designates the relative percentage of the total number of tasks launched\n that should use the specified capacity provider. The weight value is taken into consideration\n after the base value, if defined, is satisfied.

" + "smithy.api#documentation": "

The weight value designates the relative percentage of the total number of tasks\n launched that should use the specified capacity provider. The weight value is taken into\n consideration after the base value, if defined, is satisfied.

" } }, "base": { "target": "com.amazonaws.pipes#CapacityProviderStrategyItemBase", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on the specified capacity\n provider. Only one capacity provider in a capacity provider strategy can have a base defined.\n If no value is specified, the default value of 0 is used.

" + "smithy.api#documentation": "

The base value designates how many tasks, at a minimum, to run on the specified capacity\n provider. Only one capacity provider in a capacity provider strategy can have a base\n defined. If no value is specified, the default value of 0 is used.

" } } }, @@ -461,7 +461,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

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

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces\n the need for specialized knowledge and integration code.

", "smithy.api#http": { "method": "POST", "uri": "/v1/pipes/{Name}", @@ -634,7 +634,7 @@ } }, "traits": { - "smithy.api#documentation": "

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

" + "smithy.api#documentation": "

A DeadLetterConfig object that contains information about a dead-letter\n queue configuration.

" } }, "com.amazonaws.pipes#DeletePipe": { @@ -905,6 +905,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.pipes#DimensionMapping": { + "type": "structure", + "members": { + "DimensionValue": { + "target": "com.amazonaws.pipes#DimensionValue", + "traits": { + "smithy.api#documentation": "

Dynamic path to the dimension value in the source event.

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

The data type of the dimension for the time-series data.

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

The metadata attributes of the time series. For example, the name and Availability Zone\n of an Amazon EC2 instance or the name of the manufacturer of a wind turbine are\n dimensions.

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

Maps source data to a dimension in the target Timestream for LiveAnalytics\n table.

\n

For more information, see Amazon Timestream for LiveAnalytics concepts\n

" + } + }, + "com.amazonaws.pipes#DimensionMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#DimensionMapping" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.pipes#DimensionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.pipes#DimensionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.pipes#DimensionValueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VARCHAR", + "name": "VARCHAR" + } + ] + } + }, "com.amazonaws.pipes#DynamoDBStreamStartPosition": { "type": "string", "traits": { @@ -926,54 +996,54 @@ "Command": { "target": "com.amazonaws.pipes#StringList", "traits": { - "smithy.api#documentation": "

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

" + "smithy.api#documentation": "

The command to send to the container that overrides the default command from the Docker\n image or the task definition. You must also specify a container name.

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

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

" + "smithy.api#documentation": "

The number of cpu units reserved for the container, instead of the default\n value from the task definition. You must also specify a container name.

" } }, "Environment": { "target": "com.amazonaws.pipes#EcsEnvironmentVariableList", "traits": { - "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can \n override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

" + "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment\n variables, which are added to the container at launch, or you can override the existing\n environment variables from the Docker image or the task definition. You must also specify a\n container name.

" } }, "EnvironmentFiles": { "target": "com.amazonaws.pipes#EcsEnvironmentFileList", "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

" + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container, instead of\n the value from the container definition.

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

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. \n If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

" + "smithy.api#documentation": "

The hard limit (in MiB) of memory to present to the container, instead of the default\n value from the task definition. If your container attempts to exceed the memory specified\n here, the container is killed. You must also specify a container name.

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

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. \n You must also specify a container name.

" + "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container, instead of the default\n value from the task definition. You must also specify a container name.

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

The name of the container that receives the override. This parameter is required if any override is specified.

" + "smithy.api#documentation": "

The name of the container that receives the override. This parameter is required if any\n override is specified.

" } }, "ResourceRequirements": { "target": "com.amazonaws.pipes#EcsResourceRequirementsList", "traits": { - "smithy.api#documentation": "

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

" + "smithy.api#documentation": "

The type and amount of a resource to assign to a container, instead of the default value\n from the task definition. The only supported resource is a GPU.

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

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty \n container override is {\"containerOverrides\": [ ] }. If a non-empty container override is specified, the name parameter must be included.

" + "smithy.api#documentation": "

The overrides that are sent to a container. An empty container override can be passed\n in. An example of an empty container override is {\"containerOverrides\": [ ] }.\n If a non-empty container override is specified, the name parameter must be\n included.

" } }, "com.amazonaws.pipes#EcsContainerOverrideList": { @@ -995,13 +1065,13 @@ "value": { "target": "com.amazonaws.pipes#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

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

The Amazon Resource Name (ARN) of the Amazon S3 object containing the\n environment variable file.

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

A list of files containing the environment variables to pass to a container. You can\n specify up to ten environment files. The file must have a .env file\n extension. Each line in an environment file should contain an environment variable in\n VARIABLE=VALUE format. Lines beginning with # are treated\n as comments and are ignored. For more information about the environment variable file\n syntax, see Declare default\n environment variables in file.

\n

If there are environment variables specified using the environment\n parameter in a container definition, they take precedence over the variables contained\n within an environment file. If multiple environment files are specified that contain the\n same variable, they're processed from the top down. We recommend that you use unique\n variable names. For more information, see Specifying environment\n variables in the Amazon Elastic Container Service Developer Guide.

\n

This parameter is only supported for tasks hosted on Fargate using the\n following platform versions:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
  • \n
  • \n

    Windows platform version 1.0.0 or later.

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

A list of files containing the environment variables to pass to a container. You can\n specify up to ten environment files. The file must have a .env file extension.\n Each line in an environment file should contain an environment variable in\n VARIABLE=VALUE format. Lines beginning with # are treated as\n comments and are ignored. For more information about the environment variable file syntax,\n see Declare default environment\n variables in file.

\n

If there are environment variables specified using the environment\n parameter in a container definition, they take precedence over the variables contained\n within an environment file. If multiple environment files are specified that contain the\n same variable, they're processed from the top down. We recommend that you use unique\n variable names. For more information, see Specifying environment\n variables in the Amazon Elastic Container Service Developer\n Guide.

\n

This parameter is only supported for tasks hosted on Fargate using the\n following platform versions:

\n
    \n
  • \n

    Linux platform version 1.4.0 or later.

    \n
  • \n
  • \n

    Windows platform version 1.0.0 or later.

    \n
  • \n
" } }, "com.amazonaws.pipes#EcsEnvironmentFileList": { @@ -1027,18 +1097,18 @@ "name": { "target": "com.amazonaws.pipes#String", "traits": { - "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the environment variable.

" + "smithy.api#documentation": "

The name of the key-value pair. For environment variables, this is the name of the\n environment variable.

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

The value of the key-value pair. For environment variables, this is the value of the environment variable.

" + "smithy.api#documentation": "

The value of the key-value pair. For environment variables, this is the value of the\n environment variable.

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

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can \n override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

" + "smithy.api#documentation": "

The environment variables to send to the container. You can add new environment\n variables, which are added to the container at launch, or you can override the existing\n environment variables from the Docker image or the task definition. You must also specify a\n container name.

" } }, "com.amazonaws.pipes#EcsEnvironmentVariableList": { @@ -1053,13 +1123,13 @@ "sizeInGiB": { "target": "com.amazonaws.pipes#EphemeralStorageSize", "traits": { - "smithy.api#documentation": "

The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n supported value is 21 GiB and the maximum supported value is\n 200 GiB.

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

The total amount, in GiB, of ephemeral storage to set for the task. The minimum\n supported value is 21 GiB and the maximum supported value is 200\n GiB.

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

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

\n \n

This parameter is only supported for tasks hosted on Fargate using\n Linux platform version 1.4.0 or later. This parameter is not supported\n for Windows containers on Fargate.

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

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

\n \n

This parameter is only supported for tasks hosted on Fargate using\n Linux platform version 1.4.0 or later. This parameter is not supported for\n Windows containers on Fargate.

\n
" } }, "com.amazonaws.pipes#EcsInferenceAcceleratorOverride": { @@ -1068,7 +1138,7 @@ "deviceName": { "target": "com.amazonaws.pipes#String", "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

" + "smithy.api#documentation": "

The Elastic Inference accelerator device name to override for the task. This parameter\n must match a deviceName specified in the task definition.

" } }, "deviceType": { @@ -1079,7 +1149,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details on an Elastic Inference accelerator task override. This parameter is used to\n override the Elastic Inference accelerator specified in the task definition. For more\n information, see Working with Amazon\n Elastic Inference on Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Details on an Elastic Inference accelerator task override. This parameter is used to\n override the Elastic Inference accelerator specified in the task definition. For more\n information, see Working with Amazon Elastic\n Inference on Amazon ECS in the Amazon Elastic Container Service\n Developer Guide.

" } }, "com.amazonaws.pipes#EcsInferenceAcceleratorOverrideList": { @@ -1094,20 +1164,20 @@ "type": { "target": "com.amazonaws.pipes#EcsResourceRequirementType", "traits": { - "smithy.api#documentation": "

The type of resource to assign to a container. The supported values are\n GPU or InferenceAccelerator.

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

The type of resource to assign to a container. The supported values are GPU\n or InferenceAccelerator.

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

The value for the specified resource type.

\n

If the GPU type is used, the value is the number of physical\n GPUs the Amazon ECS container agent reserves for the container. The number\n of GPUs that's reserved for all containers in a task can't exceed the number of\n available GPUs on the container instance that the task is launched on.

\n

If the InferenceAccelerator type is used, the value matches\n the deviceName for an InferenceAccelerator specified in a\n task definition.

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

The value for the specified resource type.

\n

If the GPU type is used, the value is the number of physical\n GPUs the Amazon ECS container agent reserves for the container. The\n number of GPUs that's reserved for all containers in a task can't exceed the number of\n available GPUs on the container instance that the task is launched on.

\n

If the InferenceAccelerator type is used, the value matches\n the deviceName for an InferenceAccelerator specified in a task\n definition.

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

The type and amount of a resource to assign to a container. The supported resource\n types are GPUs and Elastic Inference accelerators. For more information, see Working with\n GPUs on Amazon ECS or Working with\n Amazon Elastic Inference on Amazon ECS in the\n Amazon Elastic Container Service Developer Guide\n

" + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. The supported resource types\n are GPUs and Elastic Inference accelerators. For more information, see Working with\n GPUs on Amazon ECS or Working with Amazon Elastic\n Inference on Amazon ECS in the Amazon Elastic Container Service\n Developer Guide\n

" } }, "com.amazonaws.pipes#EcsResourceRequirementType": { @@ -1149,13 +1219,13 @@ "EphemeralStorage": { "target": "com.amazonaws.pipes#EcsEphemeralStorage", "traits": { - "smithy.api#documentation": "

The ephemeral storage setting override for the task.

\n \n

This parameter is only supported for tasks hosted on Fargate that\n use the following platform versions:

\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 ephemeral storage setting override for the task.

\n \n

This parameter is only supported for tasks hosted on Fargate that use\n the following platform versions:

\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
" } }, "ExecutionRoleArn": { "target": "com.amazonaws.pipes#ArnOrJsonPath", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more\n information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For\n more information, see Amazon ECS\n task execution IAM role in the Amazon Elastic Container Service Developer\n Guide.

" } }, "InferenceAcceleratorOverrides": { @@ -1173,7 +1243,7 @@ "TaskRoleArn": { "target": "com.amazonaws.pipes#ArnOrJsonPath", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n in this task are granted the permissions that are specified in this role. For more\n information, see IAM Role for Tasks\n in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume.\n All containers in this task are granted the permissions that are specified in this role.\n For more information, see IAM Role for Tasks in\n the Amazon Elastic Container Service Developer Guide.

" } } }, @@ -1201,6 +1271,29 @@ } } }, + "com.amazonaws.pipes#EpochTimeUnit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MILLISECONDS", + "name": "MILLISECONDS" + }, + { + "value": "SECONDS", + "name": "SECONDS" + }, + { + "value": "MICROSECONDS", + "name": "MICROSECONDS" + }, + { + "value": "NANOSECONDS", + "name": "NANOSECONDS" + } + ] + } + }, "com.amazonaws.pipes#ErrorMessage": { "type": "string" }, @@ -1269,7 +1362,7 @@ } }, "traits": { - "smithy.api#documentation": "

Filter events using an event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

Filter events using an event pattern. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.pipes#FilterCriteria": { @@ -1314,12 +1407,12 @@ "DeliveryStreamArn": { "target": "com.amazonaws.pipes#FirehoseArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.

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

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + "smithy.api#documentation": "

The Amazon Data Firehose logging configuration settings for the pipe.

" } }, "com.amazonaws.pipes#FirehoseLogDestinationParameters": { @@ -1328,13 +1421,13 @@ "DeliveryStreamArn": { "target": "com.amazonaws.pipes#FirehoseArn", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.

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

Specifies the Amazon Resource Name (ARN) of the Firehose delivery stream to\n which EventBridge delivers the pipe log records.

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

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + "smithy.api#documentation": "

The Amazon Data Firehose logging configuration settings for the pipe.

" } }, "com.amazonaws.pipes#HeaderKey": { @@ -1409,7 +1502,7 @@ "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of seconds to wait before retrying the action that caused the exception.

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

The number of seconds to wait before retrying the action that caused the\n exception.

", "smithy.api#httpHeader": "Retry-After" } } @@ -1578,7 +1671,7 @@ "NamePrefix": { "target": "com.amazonaws.pipes#PipeName", "traits": { - "smithy.api#documentation": "

A value that will return a subset of the pipes associated with this account. For example, \"NamePrefix\": \"ABC\" will return \n all endpoints with \"ABC\" in the name.

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

A value that will return a subset of the pipes associated with this account. For\n example, \"NamePrefix\": \"ABC\" will return all endpoints with \"ABC\" in the\n name.

", "smithy.api#httpQuery": "NamePrefix" } }, @@ -1834,6 +1927,51 @@ } } }, + "com.amazonaws.pipes#MeasureName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.pipes#MeasureValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.pipes#MeasureValueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DOUBLE", + "name": "DOUBLE" + }, + { + "value": "BIGINT", + "name": "BIGINT" + }, + { + "value": "VARCHAR", + "name": "VARCHAR" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "TIMESTAMP", + "name": "TIMESTAMP" + } + ] + } + }, "com.amazonaws.pipes#MessageDeduplicationId": { "type": "string", "traits": { @@ -1854,18 +1992,111 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.pipes#MultiMeasureAttributeMapping": { + "type": "structure", + "members": { + "MeasureValue": { + "target": "com.amazonaws.pipes#MeasureValue", + "traits": { + "smithy.api#documentation": "

Dynamic path to the measurement attribute in the source event.

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

Data type of the measurement attribute in the source event.

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

Target measure name to be used.

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

A mapping of a source event data field to a measure in a Timestream for\n LiveAnalytics record.

" + } + }, + "com.amazonaws.pipes#MultiMeasureAttributeMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#MultiMeasureAttributeMapping" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.pipes#MultiMeasureAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.pipes#MultiMeasureMapping": { + "type": "structure", + "members": { + "MultiMeasureName": { + "target": "com.amazonaws.pipes#MultiMeasureName", + "traits": { + "smithy.api#documentation": "

The name of the multiple measurements per record (multi-measure).

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

Mappings that represent multiple source event fields mapped to measures in the same\n Timestream for LiveAnalytics record.

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

Maps multiple measures from the source event to the same Timestream for\n LiveAnalytics record.

\n

For more information, see Amazon Timestream for LiveAnalytics concepts\n

" + } + }, + "com.amazonaws.pipes#MultiMeasureMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#MultiMeasureMapping" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.pipes#MultiMeasureName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.pipes#NetworkConfiguration": { "type": "structure", "members": { "awsvpcConfiguration": { "target": "com.amazonaws.pipes#AwsVpcConfiguration", "traits": { - "smithy.api#documentation": "

Use this structure to specify the VPC subnets and security groups for the task, and\n whether a public IP address is to be used. This structure is relevant only for ECS tasks that\n use the awsvpc network mode.

" + "smithy.api#documentation": "

Use this structure to specify the VPC subnets and security groups for the task, and\n whether a public IP address is to be used. This structure is relevant only for ECS tasks\n that use the awsvpc network mode.

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

This structure specifies the network configuration for an Amazon ECS task.

" + "smithy.api#documentation": "

This structure specifies the network configuration for an Amazon ECS\n task.

" } }, "com.amazonaws.pipes#NextToken": { @@ -1991,7 +2222,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

" + "smithy.api#documentation": "

An object that represents a pipe. Amazon EventBridgePipes connect event sources to\n targets and reduces the need for specialized knowledge and integration code.

" } }, "com.amazonaws.pipes#PipeArn": { @@ -2021,24 +2252,24 @@ "PathParameterValues": { "target": "com.amazonaws.pipes#PathParameterList", "traits": { - "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or EventBridge\n ApiDestination path wildcards (\"*\").

" + "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\").

" } }, "HeaderParameters": { "target": "com.amazonaws.pipes#HeaderParametersMap", "traits": { - "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST API or\n EventBridge ApiDestination.

" + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST\n API or EventBridge ApiDestination.

" } }, "QueryStringParameters": { "target": "com.amazonaws.pipes#QueryStringParametersMap", "traits": { - "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API Gateway \n REST API or EventBridge ApiDestination.

" + "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the\n API Gateway REST API or EventBridge ApiDestination.

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

These are custom parameter to be used when the target is an API Gateway REST APIs or\n EventBridge ApiDestinations. In the latter case, these are merged with any\n InvocationParameters specified on the Connection, with any values from the Connection taking\n precedence.

" + "smithy.api#documentation": "

These are custom parameter to be used when the target is an API Gateway REST APIs\n or EventBridge ApiDestinations. In the latter case, these are merged with any\n InvocationParameters specified on the Connection, with any values from the Connection\n taking precedence.

" } }, "com.amazonaws.pipes#PipeEnrichmentParameters": { @@ -2047,13 +2278,13 @@ "InputTemplate": { "target": "com.amazonaws.pipes#InputTemplate", "traits": { - "smithy.api#documentation": "

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is\n passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

\n

To remove an input template, specify an empty string.

" + "smithy.api#documentation": "

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is\n passed to the enrichment. For more information, see The JavaScript Object Notation (JSON)\n Data Interchange Format.

\n

To remove an input template, specify an empty string.

" } }, "HttpParameters": { "target": "com.amazonaws.pipes#PipeEnrichmentHttpParameters", "traits": { - "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or\n EventBridge ApiDestination.

\n

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can\n use this parameter to specify headers, path parameters, and query string keys/values as part\n of your target invoking request. If you're using ApiDestinations, the corresponding Connection\n can also have these values configured. In case of any conflicting keys, values from the\n Connection take precedence.

" + "smithy.api#documentation": "

Contains the HTTP parameters to use when the target is a API Gateway REST\n endpoint or EventBridge ApiDestination.

\n

If you specify an API Gateway REST API or EventBridge ApiDestination as a\n target, you can use this parameter to specify headers, path parameters, and query string\n keys/values as part of your target invoking request. If you're using ApiDestinations, the\n corresponding Connection can also have these values configured. In case of any conflicting\n keys, values from the Connection take precedence.

" } } }, @@ -2079,7 +2310,7 @@ "FirehoseLogDestination": { "target": "com.amazonaws.pipes#FirehoseLogDestination", "traits": { - "smithy.api#documentation": "

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + "smithy.api#documentation": "

The Amazon Data Firehose logging configuration settings for the pipe.

" } }, "CloudwatchLogsLogDestination": { @@ -2097,7 +2328,7 @@ "IncludeExecutionData": { "target": "com.amazonaws.pipes#IncludeExecutionData", "traits": { - "smithy.api#documentation": "

Whether the execution data (specifically, the payload, awsRequest, and awsResponse fields) is included in the log messages for this pipe.

\n

This applies to all log destinations for the pipe.

\n

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

Whether the execution data (specifically, the payload,\n awsRequest, and awsResponse fields) is included in the log\n messages for this pipe.

\n

This applies to all log destinations for the pipe.

\n

For more information, see Including execution data in logs in the Amazon EventBridge User\n Guide.

" } } }, @@ -2117,7 +2348,7 @@ "FirehoseLogDestination": { "target": "com.amazonaws.pipes#FirehoseLogDestinationParameters", "traits": { - "smithy.api#documentation": "

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + "smithy.api#documentation": "

The Amazon Data Firehose logging configuration settings for the pipe.

" } }, "CloudwatchLogsLogDestination": { @@ -2129,19 +2360,19 @@ "Level": { "target": "com.amazonaws.pipes#LogLevel", "traits": { - "smithy.api#documentation": "

The level of logging detail to include. This applies to all log destinations for the pipe.

\n

For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

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

The level of logging detail to include. This applies to all log destinations for the pipe.

\n

For more information, see Specifying\n EventBridge Pipes log level in the Amazon EventBridge User\n Guide.

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

Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.

\n

This applies to all log destinations for the pipe.

\n

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

\n

The default is OFF.

" + "smithy.api#documentation": "

Specify ALL to include the execution data (specifically, the\n payload, awsRequest, and awsResponse fields) in\n the log messages for this pipe.

\n

This applies to all log destinations for the pipe.

\n

For more information, see Including execution data in logs in the Amazon EventBridge User\n Guide.

\n

By default, execution data is not included.

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

Specifies the logging configuration settings for the pipe.

\n

When you call UpdatePipe, EventBridge updates the fields in the\n PipeLogConfigurationParameters object atomically as one and overrides\n existing values. This is by design. If you don't specify an optional field in any of the\n Amazon Web Services service parameters objects\n (CloudwatchLogsLogDestinationParameters,\n FirehoseLogDestinationParameters, or\n S3LogDestinationParameters), EventBridge sets that field to its\n system-default value during the update.

\n

For example, suppose when you created the pipe you\n specified a Kinesis Data Firehose stream log destination. You then update the pipe to add an\n Amazon S3 log destination. In addition to specifying the\n S3LogDestinationParameters for the new log destination, you must also\n specify the fields in the FirehoseLogDestinationParameters object in order to\n retain the Kinesis Data Firehose stream log destination.

\n

For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

Specifies the logging configuration settings for the pipe.

\n

When you call UpdatePipe, EventBridge updates the fields in the\n PipeLogConfigurationParameters object atomically as one and overrides\n existing values. This is by design. If you don't specify an optional field in any of the\n Amazon Web Services service parameters objects\n (CloudwatchLogsLogDestinationParameters,\n FirehoseLogDestinationParameters, or\n S3LogDestinationParameters), EventBridge sets that field to its\n system-default value during the update.

\n

For example, suppose when you created the pipe you specified a Firehose stream\n log destination. You then update the pipe to add an Amazon S3 log destination. In\n addition to specifying the S3LogDestinationParameters for the new log\n destination, you must also specify the fields in the\n FirehoseLogDestinationParameters object in order to retain the Firehose stream log destination.

\n

For more information on generating pipe log records, see Log EventBridge\n Pipes in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.pipes#PipeName": { @@ -2347,7 +2578,7 @@ "StartingPositionTimestamp": { "target": "com.amazonaws.pipes#Timestamp", "traits": { - "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

" + "smithy.api#documentation": "

With StartingPosition set to AT_TIMESTAMP, the time from which\n to start reading, in Unix time seconds.

" } } }, @@ -2448,7 +2679,7 @@ "SelfManagedKafkaParameters": { "target": "com.amazonaws.pipes#PipeSourceSelfManagedKafkaParameters", "traits": { - "smithy.api#documentation": "

The parameters for using a self-managed Apache Kafka stream as a source.

" + "smithy.api#documentation": "

The parameters for using a self-managed Apache Kafka stream as a source.

\n

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services.\n This includes both clusters you manage yourself, as well as those hosted by a third-party\n provider, such as Confluent\n Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

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

The parameters for using a self-managed Apache Kafka stream as a source.

" + "smithy.api#documentation": "

The parameters for using a self-managed Apache Kafka stream as a source.

\n

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services.\n This includes both clusters you manage yourself, as well as those hosted by a third-party\n provider, such as Confluent\n Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.pipes#PipeSourceSqsQueueParameters": { @@ -2662,14 +2893,14 @@ "JobDefinition": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. \n If name is specified without a revision then the latest active revision is used.

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

The job definition used by this job. This value can be one of name,\n name:revision, or the Amazon Resource Name (ARN) for the job definition. If\n name is specified without a revision then the latest active revision is used.

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

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), \n and underscores (_).

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

The name of the job. It can be up to 128 letters long. The first character must be\n alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and\n underscores (_).

", "smithy.api#required": {} } }, @@ -2682,7 +2913,7 @@ "RetryStrategy": { "target": "com.amazonaws.pipes#BatchRetryStrategy", "traits": { - "smithy.api#documentation": "

The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

" + "smithy.api#documentation": "

The retry strategy to use for failed jobs. When a retry strategy is specified here, it\n overrides the retry strategy defined in the job definition.

" } }, "ContainerOverrides": { @@ -2694,13 +2925,13 @@ "DependsOn": { "target": "com.amazonaws.pipes#BatchDependsOn", "traits": { - "smithy.api#documentation": "

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without \n specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N \n type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each \n dependency to complete before it can begin.

" + "smithy.api#documentation": "

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can\n specify a SEQUENTIAL type dependency without specifying a job ID for array\n jobs so that each child array job completes sequentially, starting at index 0. You can also\n specify an N_TO_N type dependency with a job ID for array jobs. In that case,\n each index child of this job must wait for the corresponding index child of each dependency\n to complete before it can begin.

" } }, "Parameters": { "target": "com.amazonaws.pipes#BatchParametersMap", "traits": { - "smithy.api#documentation": "

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and \n value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

" + "smithy.api#documentation": "

Additional parameters passed to the job that replace parameter substitution placeholders\n that are set in the job definition. Parameters are specified as a key and value pair\n mapping. Parameters included here override any corresponding parameter defaults from the\n job definition.

" } } }, @@ -2720,7 +2951,7 @@ "Timestamp": { "target": "com.amazonaws.pipes#JsonPath", "traits": { - "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + "smithy.api#documentation": "

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970\n 00:00:00 UTC.

" } } }, @@ -2734,51 +2965,51 @@ "TaskDefinitionArn": { "target": "com.amazonaws.pipes#ArnOrJsonPath", "traits": { - "smithy.api#documentation": "

The ARN of the task definition to use if the event target is an Amazon ECS task.

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

The ARN of the task definition to use if the event target is an Amazon ECS task.\n

", "smithy.api#required": {} } }, "TaskCount": { "target": "com.amazonaws.pipes#LimitMin1", "traits": { - "smithy.api#documentation": "

The number of tasks to create based on TaskDefinition. The default is 1.

" + "smithy.api#documentation": "

The number of tasks to create based on TaskDefinition. The default is\n 1.

" } }, "LaunchType": { "target": "com.amazonaws.pipes#LaunchType", "traits": { - "smithy.api#documentation": "

Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where Fargate with Amazon ECS\n is supported. For more information, see Fargate on Amazon ECS in\n the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the launch type on which your task is running. The launch type that you\n specify here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see\n Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" } }, "NetworkConfiguration": { "target": "com.amazonaws.pipes#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

Use this structure if the Amazon ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and whether\n a public IP address is to be used. This structure is required if LaunchType is\n FARGATE because the awsvpc mode is required for Fargate\n tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.

" + "smithy.api#documentation": "

Use this structure if the Amazon ECS task uses the awsvpc network\n mode. This structure specifies the VPC subnets and security groups associated with the\n task, and whether a public IP address is to be used. This structure is required if\n LaunchType is FARGATE because the awsvpc mode is\n required for Fargate tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use\n the awsvpc network mode, the task fails.

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

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.

" + "smithy.api#documentation": "

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see Fargate\n Platform Versions in the Amazon Elastic Container Service Developer\n Guide.

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

Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.

" + "smithy.api#documentation": "

Specifies an Amazon ECS task group for the task. The maximum length is 255\n characters.

" } }, "CapacityProviderStrategy": { "target": "com.amazonaws.pipes#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or launchType is\n specified, the defaultCapacityProviderStrategy for the cluster is used.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n

If a capacityProviderStrategy is specified, the launchType\n parameter must be omitted. If no capacityProviderStrategy or launchType is\n specified, the defaultCapacityProviderStrategy for the cluster is used.\n

" } }, "EnableECSManagedTags": { "target": "com.amazonaws.pipes#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more information,\n see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer\n Guide.

" + "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the task. For more\n information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

" } }, "EnableExecuteCommand": { @@ -2803,7 +3034,7 @@ "PropagateTags": { "target": "com.amazonaws.pipes#PropagateTags", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no value\n is specified, the tags are not propagated. Tags can only be propagated to the task during task\n creation. To add tags to a task after task creation, use the TagResource API action.

" + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no\n value is specified, the tags are not propagated. Tags can only be propagated to the task\n during task creation. To add tags to a task after task creation, use the\n TagResource API action.

" } }, "ReferenceId": { @@ -2821,7 +3052,7 @@ "Tags": { "target": "com.amazonaws.pipes#TagList", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each tag\n consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

" + "smithy.api#documentation": "

The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define. To learn more, see\n RunTask in the Amazon ECS API Reference.

" } } }, @@ -2835,13 +3066,13 @@ "EndpointId": { "target": "com.amazonaws.pipes#EventBridgeEndpointId", "traits": { - "smithy.api#documentation": "

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

" + "smithy.api#documentation": "

The URL subdomain of the endpoint. For example, if the URL for Endpoint is\n https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is\n abcde.veo.

" } }, "DetailType": { "target": "com.amazonaws.pipes#EventBridgeDetailType", "traits": { - "smithy.api#documentation": "

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

" + "smithy.api#documentation": "

A free-form string, with a maximum of 128 characters, used to decide what fields to\n expect in the event detail.

" } }, "Source": { @@ -2853,7 +3084,7 @@ "Resources": { "target": "com.amazonaws.pipes#EventBridgeEventResourceList", "traits": { - "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event\n primarily concerns. Any number, including zero, may be present.

" } }, "Time": { @@ -2873,19 +3104,19 @@ "PathParameterValues": { "target": "com.amazonaws.pipes#PathParameterList", "traits": { - "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or EventBridge\n ApiDestination path wildcards (\"*\").

" + "smithy.api#documentation": "

The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards (\"*\").

" } }, "HeaderParameters": { "target": "com.amazonaws.pipes#HeaderParametersMap", "traits": { - "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST API or\n EventBridge ApiDestination.

" + "smithy.api#documentation": "

The headers that need to be sent as part of request invoking the API Gateway REST\n API or EventBridge ApiDestination.

" } }, "QueryStringParameters": { "target": "com.amazonaws.pipes#QueryStringParametersMap", "traits": { - "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API Gateway \n REST API or EventBridge ApiDestination.

" + "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the\n API Gateway REST API or EventBridge ApiDestination.

" } } }, @@ -2914,7 +3145,7 @@ "PartitionKey": { "target": "com.amazonaws.pipes#KinesisPartitionKey", "traits": { - "smithy.api#documentation": "

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters \n for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. \n Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this \n hashing mechanism, all data records with the same partition key map to the same shard within the stream.

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

Determines which shard in the stream the data record is assigned to. Partition keys are\n Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the\n partition key and associated data to a specific shard. Specifically, an MD5 hash function\n is used to map partition keys to 128-bit integer values and to map associated data records\n to shards. As a result of this hashing mechanism, all data records with the same partition\n key map to the same shard within the stream.

", "smithy.api#required": {} } } @@ -2929,7 +3160,7 @@ "InvocationType": { "target": "com.amazonaws.pipes#PipeTargetInvocationType", "traits": { - "smithy.api#documentation": "

Specify whether to invoke the function synchronously or asynchronously.

\n
    \n
  • \n

    \n REQUEST_RESPONSE (default) - Invoke synchronously. This corresponds to the RequestResponse option in the InvocationType parameter for the Lambda Invoke API.

    \n
  • \n
  • \n

    \n FIRE_AND_FORGET - Invoke asynchronously. This corresponds to the Event option in the InvocationType parameter for the Lambda Invoke API.

    \n
  • \n
\n

For more information, see Invocation types in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

Specify whether to invoke the function synchronously or asynchronously.

\n
    \n
  • \n

    \n REQUEST_RESPONSE (default) - Invoke synchronously. This corresponds\n to the RequestResponse option in the InvocationType\n parameter for the Lambda\n Invoke\n API.

    \n
  • \n
  • \n

    \n FIRE_AND_FORGET - Invoke asynchronously. This corresponds to the\n Event option in the InvocationType parameter for the\n Lambda\n Invoke\n API.

    \n
  • \n
\n

For more information, see Invocation\n types in the Amazon EventBridge User Guide.

" } } }, @@ -2943,7 +3174,7 @@ "InputTemplate": { "target": "com.amazonaws.pipes#InputTemplate", "traits": { - "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself is\n passed to the target. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

\n

To remove an input template, specify an empty string.

" + "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself is\n passed to the target. For more information, see The JavaScript Object Notation (JSON)\n Data Interchange Format.

\n

To remove an input template, specify an empty string.

" } }, "LambdaFunctionParameters": { @@ -3011,6 +3242,12 @@ "traits": { "smithy.api#documentation": "

The parameters for using an CloudWatch Logs log stream as a target.

" } + }, + "TimestreamParameters": { + "target": "com.amazonaws.pipes#PipeTargetTimestreamParameters", + "traits": { + "smithy.api#documentation": "

The parameters for using a Timestream for LiveAnalytics table as a\n target.

" + } } }, "traits": { @@ -3029,7 +3266,7 @@ "Database": { "target": "com.amazonaws.pipes#Database", "traits": { - "smithy.api#documentation": "

The name of the database. Required when authenticating using temporary credentials.

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

The name of the database. Required when authenticating using temporary\n credentials.

", "smithy.api#required": {} } }, @@ -3070,7 +3307,7 @@ "PipelineParameterList": { "target": "com.amazonaws.pipes#SageMakerPipelineParameterList", "traits": { - "smithy.api#documentation": "

List of Parameter names and values for SageMaker Model Building Pipeline execution.

" + "smithy.api#documentation": "

List of Parameter names and values for SageMaker Model Building Pipeline\n execution.

" } } }, @@ -3104,7 +3341,7 @@ "InvocationType": { "target": "com.amazonaws.pipes#PipeTargetInvocationType", "traits": { - "smithy.api#documentation": "

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

\n
    \n
  • \n

    \n REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.

    \n \n

    \n REQUEST_RESPONSE is not supported for STANDARD state machine workflows.

    \n
    \n
  • \n
  • \n

    \n FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.

    \n
  • \n
\n

For more information, see Invocation types in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

Specify whether to invoke the Step Functions state machine synchronously or\n asynchronously.

\n
    \n
  • \n

    \n REQUEST_RESPONSE (default) - Invoke synchronously. For more\n information, see StartSyncExecution in the Step Functions API\n Reference.

    \n \n

    \n REQUEST_RESPONSE is not supported for STANDARD state\n machine workflows.

    \n
    \n
  • \n
  • \n

    \n FIRE_AND_FORGET - Invoke asynchronously. For more information, see\n StartExecution in the Step Functions API\n Reference.

    \n
  • \n
\n

For more information, see Invocation\n types in the Amazon EventBridge User Guide.

" } } }, @@ -3112,6 +3349,65 @@ "smithy.api#documentation": "

The parameters for using a Step Functions state machine as a target.

" } }, + "com.amazonaws.pipes#PipeTargetTimestreamParameters": { + "type": "structure", + "members": { + "TimeValue": { + "target": "com.amazonaws.pipes#TimeValue", + "traits": { + "smithy.api#documentation": "

Dynamic path to the source data field that represents the time value for your data.

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

The granularity of the time units used. Default is MILLISECONDS.

\n

Required if TimeFieldType is specified as EPOCH.

" + } + }, + "TimeFieldType": { + "target": "com.amazonaws.pipes#TimeFieldType", + "traits": { + "smithy.api#documentation": "

The type of time value used.

\n

The default is EPOCH.

" + } + }, + "TimestampFormat": { + "target": "com.amazonaws.pipes#TimestampFormat", + "traits": { + "smithy.api#documentation": "

How to format the timestamps. For example,\n YYYY-MM-DDThh:mm:ss.sssTZD.

\n

Required if TimeFieldType is specified as\n TIMESTAMP_FORMAT.

" + } + }, + "VersionValue": { + "target": "com.amazonaws.pipes#VersionValue", + "traits": { + "smithy.api#documentation": "

64 bit version value or source data field that represents the version value for your data.

\n

Write requests with a higher version number will update the existing measure values of the record and version. \n In cases where the measure value is the same, the version will still be updated.

\n

Default value is 1.

\n

Timestream for LiveAnalytics does not support updating partial measure values in a record.

\n

Write requests for duplicate data with a\n higher version number will update the existing measure value and version. In cases where\n the measure value is the same, Version will still be updated. Default value is\n 1.

\n \n

\n Version must be 1 or greater, or you will receive a\n ValidationException error.

\n
", + "smithy.api#required": {} + } + }, + "DimensionMappings": { + "target": "com.amazonaws.pipes#DimensionMappings", + "traits": { + "smithy.api#documentation": "

Map source data to dimensions in the target Timestream for LiveAnalytics\n table.

\n

For more information, see Amazon Timestream for LiveAnalytics concepts\n

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

Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.

" + } + }, + "MultiMeasureMappings": { + "target": "com.amazonaws.pipes#MultiMeasureMappings", + "traits": { + "smithy.api#documentation": "

Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.

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

The parameters for using a Timestream for LiveAnalytics table as a\n target.

" + } + }, "com.amazonaws.pipes#Pipes": { "type": "service", "version": "2015-10-07", @@ -3191,7 +3487,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "

Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing \n event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. \n To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.

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

Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need\n for specialized knowledge and integration code when developing event driven architectures.\n This helps ensures consistency across your company’s applications. With Pipes, the target\n can be any available EventBridge target. To set up a pipe, you select the event\n source, add optional event filtering, define optional enrichment, and select the target for\n the event data.

", "smithy.api#title": "Amazon EventBridge Pipes", "smithy.api#xmlNamespace": { "uri": "http://events.amazonaws.com/doc/2015-10-07" @@ -3868,18 +4164,18 @@ "type": { "target": "com.amazonaws.pipes#PlacementConstraintType", "traits": { - "smithy.api#documentation": "

The type of constraint. Use distinctInstance to ensure that each task in a particular\n group is running on a different container instance. Use memberOf to restrict the selection to\n a group of valid candidates.

" + "smithy.api#documentation": "

The type of constraint. Use distinctInstance to ensure that each task in a particular\n group is running on a different container instance. Use memberOf to restrict the selection\n to a group of valid candidates.

" } }, "expression": { "target": "com.amazonaws.pipes#PlacementConstraintExpression", "traits": { - "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.\n

" + "smithy.api#documentation": "

A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance. To learn more, see\n Cluster Query\n Language in the Amazon Elastic Container Service Developer Guide.

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

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer\n Guide.

" + "smithy.api#documentation": "

An object representing a constraint on task placement. To learn more, see Task Placement\n Constraints in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.pipes#PlacementConstraintExpression": { @@ -3937,18 +4233,18 @@ "type": { "target": "com.amazonaws.pipes#PlacementStrategyType", "traits": { - "smithy.api#documentation": "

The type of placement strategy. The random placement strategy randomly places tasks on\n available candidates. The spread placement strategy spreads placement across available\n candidates evenly based on the field parameter. The binpack strategy places tasks on available\n candidates that have the least available amount of the resource that is specified with the\n field parameter. For example, if you binpack on memory, a task is placed on the instance with\n the least amount of remaining memory (but still enough to run the task).

" + "smithy.api#documentation": "

The type of placement strategy. The random placement strategy randomly places tasks on\n available candidates. The spread placement strategy spreads placement across available\n candidates evenly based on the field parameter. The binpack strategy places tasks on\n available candidates that have the least available amount of the resource that is specified\n with the field parameter. For example, if you binpack on memory, a task is placed on the\n instance with the least amount of remaining memory (but still enough to run the task).\n

" } }, "field": { "target": "com.amazonaws.pipes#PlacementStrategyField", "traits": { - "smithy.api#documentation": "

The field to apply the placement strategy against. For the spread placement strategy,\n valid values are instanceId (or host, which has the same effect), or any platform or custom\n attribute that is applied to a container instance, such as attribute:ecs.availability-zone.\n For the binpack placement strategy, valid values are cpu and memory. For the random placement\n strategy, this field is not used.

" + "smithy.api#documentation": "

The field to apply the placement strategy against. For the spread placement strategy,\n valid values are instanceId (or host, which has the same effect), or any platform or custom\n attribute that is applied to a container instance, such as attribute:ecs.availability-zone.\n For the binpack placement strategy, valid values are cpu and memory. For the random\n placement strategy, this field is not used.

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

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer\n Guide.

" + "smithy.api#documentation": "

The task placement strategy for a task or service. To learn more, see Task Placement\n Strategies in the Amazon Elastic Container Service Service Developer Guide.

" } }, "com.amazonaws.pipes#PlacementStrategyField": { @@ -4090,13 +4386,13 @@ "BucketName": { "target": "com.amazonaws.pipes#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

" + "smithy.api#documentation": "

The name of the Amazon S3 bucket to which EventBridge delivers the log\n records for the pipe.

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

The prefix text with which to begin Amazon S3 log object names.

\n

For more information, see Organizing objects using prefixes\n in the Amazon Simple Storage Service User Guide.

" + "smithy.api#documentation": "

The prefix text with which to begin Amazon S3 log object names.

\n

For more information, see Organizing objects using\n prefixes in the Amazon Simple Storage Service User Guide.

" } }, "BucketOwner": { @@ -4108,7 +4404,7 @@ "OutputFormat": { "target": "com.amazonaws.pipes#S3OutputFormat", "traits": { - "smithy.api#documentation": "

The format EventBridge uses for the log records.

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

The format EventBridge uses for the log records.

\n " } } }, @@ -4122,7 +4418,7 @@ "BucketName": { "target": "com.amazonaws.pipes#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

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

Specifies the name of the Amazon S3 bucket to which EventBridge delivers\n the log records for the pipe.

", "smithy.api#length": { "min": 3, "max": 63 @@ -4133,7 +4429,7 @@ "BucketOwner": { "target": "com.amazonaws.pipes#String", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

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

Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which\n EventBridge delivers the log records for the pipe.

", "smithy.api#pattern": "^\\d{12}$", "smithy.api#required": {} } @@ -4141,13 +4437,13 @@ "OutputFormat": { "target": "com.amazonaws.pipes#S3OutputFormat", "traits": { - "smithy.api#documentation": "

How EventBridge should format the log records.

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

How EventBridge should format the log records.

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

Specifies any prefix text with which to begin Amazon S3 log object names.

\n

You can use prefixes to organize the data that you store in Amazon S3 buckets. \n A prefix is a string of characters at the beginning of the object key name. \n A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). \n For more information, see Organizing objects using prefixes\n in the Amazon Simple Storage Service User Guide.

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

Specifies any prefix text with which to begin Amazon S3 log object names.

\n

You can use prefixes to organize the data that you store in Amazon S3 buckets. A\n prefix is a string of characters at the beginning of the object key name. A prefix can be\n any length, subject to the maximum length of the object key name (1,024 bytes). For more\n information, see Organizing objects using\n prefixes in the Amazon Simple Storage Service User Guide.

", "smithy.api#length": { "max": 256 } @@ -4183,14 +4479,14 @@ "Name": { "target": "com.amazonaws.pipes#SageMakerPipelineParameterName", "traits": { - "smithy.api#documentation": "

Name of parameter to start execution of a SageMaker Model Building Pipeline.

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

Name of parameter to start execution of a SageMaker Model Building\n Pipeline.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.pipes#SageMakerPipelineParameterValue", "traits": { - "smithy.api#documentation": "

Value of parameter to start execution of a SageMaker Model Building Pipeline.

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

Value of parameter to start execution of a SageMaker Model Building\n Pipeline.

", "smithy.api#required": {} } } @@ -4339,18 +4635,18 @@ "Subnets": { "target": "com.amazonaws.pipes#SubnetIds", "traits": { - "smithy.api#documentation": "

Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

" + "smithy.api#documentation": "

Specifies the subnets associated with the stream. These subnets must all be in the same\n VPC. You can specify as many as 16 subnets.

" } }, "SecurityGroup": { "target": "com.amazonaws.pipes#SecurityGroupIds", "traits": { - "smithy.api#documentation": "

Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many \n as five security groups. If you do not specify a security group, the default security group for the VPC is used.

" + "smithy.api#documentation": "

Specifies the security groups associated with the stream. These security groups must all\n be in the same VPC. You can specify as many as five security groups. If you do not specify\n a security group, the default security group for the VPC is used.

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

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

" + "smithy.api#documentation": "

This structure specifies the VPC subnets and security groups for the stream, and whether\n a public IP address is to be used.

" } }, "com.amazonaws.pipes#SelfManagedKafkaStartPosition": { @@ -4412,6 +4708,47 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.pipes#SingleMeasureMapping": { + "type": "structure", + "members": { + "MeasureValue": { + "target": "com.amazonaws.pipes#MeasureValue", + "traits": { + "smithy.api#documentation": "

Dynamic path of the source field to map to the measure in the record.

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

Data type of the source field.

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

Target measure name for the measurement attribute in the Timestream table.

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

Maps a single source data field to a single record in the specified Timestream\n for LiveAnalytics table.

\n

For more information, see Amazon Timestream for LiveAnalytics concepts\n

" + } + }, + "com.amazonaws.pipes#SingleMeasureMappings": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#SingleMeasureMapping" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + } + } + }, "com.amazonaws.pipes#Sql": { "type": "string", "traits": { @@ -4722,7 +5059,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses\n support tagging.

" + "smithy.api#documentation": "

A key-value pair associated with an Amazon Web Services resource. In EventBridge,\n rules and event buses support tagging.

" } }, "com.amazonaws.pipes#TagKey": { @@ -4793,7 +5130,7 @@ "aws:RequestTag/${TagKey}", "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified pipe. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of\n characters.

\n

You can use the TagResource action with a pipe that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n pipe. If you specify a tag key that is already associated with the pipe, the new tag\n value that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a pipe.

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

Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you\n organize and categorize your resources. You can also use them to scope user permissions by\n granting a user permission to access or change only resources with certain tag\n values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly\n as strings of characters.

\n

You can use the TagResource action with a pipe that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n pipe. If you specify a tag key that is already associated with the pipe, the new tag value\n that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a pipe.

", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "POST" @@ -4870,7 +5207,7 @@ "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of seconds to wait before retrying the action that caused the exception.

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

The number of seconds to wait before retrying the action that caused the\n exception.

", "smithy.api#httpHeader": "Retry-After" } } @@ -4881,9 +5218,42 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.pipes#TimeFieldType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EPOCH", + "name": "EPOCH" + }, + { + "value": "TIMESTAMP_FORMAT", + "name": "TIMESTAMP_FORMAT" + } + ] + } + }, + "com.amazonaws.pipes#TimeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.pipes#Timestamp": { "type": "timestamp" }, + "com.amazonaws.pipes#TimestampFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.pipes#URI": { "type": "string", "traits": { @@ -4995,7 +5365,7 @@ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], - "smithy.api#documentation": "

Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged.\n The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or \n TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. \n EventBridge updates the fields in these objects atomically as one and overrides existing values. \n This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update.

\n

For more information about pipes, see \n Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

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

Update an existing pipe. When you call UpdatePipe, EventBridge only the\n updates fields you have specified in the request; the rest remain unchanged. The exception\n to this is if you modify any Amazon Web Services-service specific fields in the\n SourceParameters, EnrichmentParameters, or\n TargetParameters objects. For example,\n DynamoDBStreamParameters or EventBridgeEventBusParameters.\n EventBridge updates the fields in these objects atomically as one and overrides existing\n values. This is by design, and means that if you don't specify an optional field in one of\n these Parameters objects, EventBridge sets that field to its system-default\n value during the update.

\n

For more information about pipes, see \n Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/pipes/{Name}", @@ -5322,7 +5692,7 @@ "SelfManagedKafkaParameters": { "target": "com.amazonaws.pipes#UpdatePipeSourceSelfManagedKafkaParameters", "traits": { - "smithy.api#documentation": "

The parameters for using a self-managed Apache Kafka stream as a source.

" + "smithy.api#documentation": "

The parameters for using a self-managed Apache Kafka stream as a source.

\n

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services.\n This includes both clusters you manage yourself, as well as those hosted by a third-party\n provider, such as Confluent\n Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

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

The parameters for using a self-managed Apache Kafka stream as a source.

" + "smithy.api#documentation": "

The parameters for using a self-managed Apache Kafka stream as a source.

\n

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services.\n This includes both clusters you manage yourself, as well as those hosted by a third-party\n provider, such as Confluent\n Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.pipes#UpdatePipeSourceSqsQueueParameters": { @@ -5424,7 +5794,7 @@ "fieldList": { "target": "com.amazonaws.pipes#ValidationExceptionFieldList", "traits": { - "smithy.api#documentation": "

The list of fields for which validation failed and the corresponding failure messages.

" + "smithy.api#documentation": "

The list of fields for which validation failed and the corresponding failure\n messages.

" } } }, @@ -5461,6 +5831,15 @@ "member": { "target": "com.amazonaws.pipes#ValidationExceptionField" } + }, + "com.amazonaws.pipes#VersionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index b95df6ef8d7..d82598e64b9 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -6443,6 +6443,18 @@ "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$" } }, + "com.amazonaws.sagemaker#ClusterAvailabilityZone": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z]+-\\d[a-z]$" + } + }, + "com.amazonaws.sagemaker#ClusterAvailabilityZoneId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{3}\\d-az\\d$" + } + }, "com.amazonaws.sagemaker#ClusterInstanceCount": { "type": "integer", "traits": { @@ -6583,6 +6595,26 @@ } } }, + "com.amazonaws.sagemaker#ClusterInstancePlacement": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.sagemaker#ClusterAvailabilityZone", + "traits": { + "smithy.api#documentation": "

The Availability Zone where the node in the SageMaker HyperPod cluster is launched.

" + } + }, + "AvailabilityZoneId": { + "target": "com.amazonaws.sagemaker#ClusterAvailabilityZoneId", + "traits": { + "smithy.api#documentation": "

The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster\n is launched.

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

Specifies the placement details for the node in the SageMaker HyperPod cluster, including the\n Availability Zone and the unique identifier (ID) of the Availability Zone.

" + } + }, "com.amazonaws.sagemaker#ClusterInstanceStatus": { "type": "enum", "members": { @@ -6971,6 +7003,24 @@ "traits": { "smithy.api#documentation": "

The number of threads per CPU core you specified under\n CreateCluster.

" } + }, + "PrivatePrimaryIp": { + "target": "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp", + "traits": { + "smithy.api#documentation": "

The private primary IP address of the SageMaker HyperPod cluster node.

" + } + }, + "PrivateDnsHostname": { + "target": "com.amazonaws.sagemaker#ClusterPrivateDnsHostname", + "traits": { + "smithy.api#documentation": "

The private DNS hostname of the SageMaker HyperPod cluster node.

" + } + }, + "Placement": { + "target": "com.amazonaws.sagemaker#ClusterInstancePlacement", + "traits": { + "smithy.api#documentation": "

The placement details of the SageMaker HyperPod cluster node.

" + } } }, "traits": { @@ -7049,6 +7099,18 @@ } } }, + "com.amazonaws.sagemaker#ClusterPrivateDnsHostname": { + "type": "string", + "traits": { + "smithy.api#pattern": "^ip-((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)-?\\b){4}\\..*$" + } + }, + "com.amazonaws.sagemaker#ClusterPrivatePrimaryIp": { + "type": "string", + "traits": { + "smithy.api#pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$" + } + }, "com.amazonaws.sagemaker#ClusterSortBy": { "type": "enum", "members": { @@ -17404,7 +17466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information of an instance (also called a node\n interchangeably) of a SageMaker HyperPod cluster.

" + "smithy.api#documentation": "

Retrieves information of a node (also called a instance\n interchangeably) of a SageMaker HyperPod cluster.

" } }, "com.amazonaws.sagemaker#DescribeClusterNodeRequest": { @@ -17414,7 +17476,7 @@ "target": "com.amazonaws.sagemaker#ClusterNameOrArn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.

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

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.

", "smithy.api#required": {} } }, @@ -17422,7 +17484,7 @@ "target": "com.amazonaws.sagemaker#ClusterNodeId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

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

The ID of the SageMaker HyperPod cluster node.

", "smithy.api#required": {} } } @@ -17438,7 +17500,7 @@ "target": "com.amazonaws.sagemaker#ClusterNodeDetails", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The details of the instance.

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

The details of the SageMaker HyperPod cluster node.

", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/taxsettings.json b/codegen/sdk/aws-models/taxsettings.json new file mode 100644 index 00000000000..35348647de1 --- /dev/null +++ b/codegen/sdk/aws-models/taxsettings.json @@ -0,0 +1,3122 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.taxsettings#AccountDetails": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.taxsettings#AccountId", + "traits": { + "smithy.api#documentation": "

List of unique account identifiers.

" + } + }, + "taxRegistration": { + "target": "com.amazonaws.taxsettings#TaxRegistrationWithJurisdiction", + "traits": { + "smithy.api#documentation": "

Your TRN information. Instead of having full legal address, here TRN information will have\n jurisdiction details (for example, country code and state/region/province if applicable).

" + } + }, + "taxInheritanceDetails": { + "target": "com.amazonaws.taxsettings#TaxInheritanceDetails", + "traits": { + "smithy.api#documentation": "

\n Tax inheritance information associated with the account.\n

" + } + }, + "accountMetaData": { + "target": "com.amazonaws.taxsettings#AccountMetaData", + "traits": { + "smithy.api#documentation": "

\n The meta data information associated with the account.\n

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

An object with your accountId and TRN information.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.taxsettings#AccountDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#AccountDetails" + } + }, + "com.amazonaws.taxsettings#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.taxsettings#AccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.taxsettings#AccountMetaData": { + "type": "structure", + "members": { + "accountName": { + "target": "com.amazonaws.taxsettings#AccountName", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services accounts name.\n

" + } + }, + "seller": { + "target": "com.amazonaws.taxsettings#Seller", + "traits": { + "smithy.api#documentation": "

\n Seller information associated with the account.\n

" + } + }, + "address": { + "target": "com.amazonaws.taxsettings#Address" + }, + "addressType": { + "target": "com.amazonaws.taxsettings#AddressRoleType", + "traits": { + "smithy.api#documentation": "

\n The type of address associated with the legal profile.\n

" + } + }, + "addressRoleMap": { + "target": "com.amazonaws.taxsettings#AddressRoleMap", + "traits": { + "smithy.api#documentation": "

\n Address roles associated with the account containing country code information.\n

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

\n The meta data information associated with the account.\n

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.taxsettings#AccountName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#AdditionalInfoRequest": { + "type": "structure", + "members": { + "malaysiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#MalaysiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in Malaysia.

" + } + }, + "israelAdditionalInfo": { + "target": "com.amazonaws.taxsettings#IsraelAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in Israel.

" + } + }, + "estoniaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#EstoniaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in Estonia.

" + } + }, + "canadaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#CanadaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Canada.

" + } + }, + "spainAdditionalInfo": { + "target": "com.amazonaws.taxsettings#SpainAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in Spain.

" + } + }, + "kenyaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#KenyaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in Kenya.

" + } + }, + "southKoreaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#SouthKoreaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in South Korea.

" + } + }, + "turkeyAdditionalInfo": { + "target": "com.amazonaws.taxsettings#TurkeyAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in Turkey.

" + } + }, + "georgiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#GeorgiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information to specify for a TRN in Georgia.\n

" + } + }, + "italyAdditionalInfo": { + "target": "com.amazonaws.taxsettings#ItalyAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information to specify for a TRN in Italy.\n

" + } + }, + "romaniaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#RomaniaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in Romania.

" + } + }, + "ukraineAdditionalInfo": { + "target": "com.amazonaws.taxsettings#UkraineAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Ukraine.\n

" + } + }, + "polandAdditionalInfo": { + "target": "com.amazonaws.taxsettings#PolandAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Poland.\n

" + } + }, + "saudiArabiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#SaudiArabiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Saudi Arabia.\n

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

Additional tax information associated with your tax registration number (TRN). Depending\n on the TRN for a specific country, you might need to specify this information when you set\n your TRN.

\n

You can only specify one of the following parameters and the value can't be empty.

\n \n

The parameter that you specify must match the country for the TRN, if available. For\n example, if you set a TRN in Canada for specific provinces, you must also specify the\n canadaAdditionalInfo parameter.

\n
" + } + }, + "com.amazonaws.taxsettings#AdditionalInfoResponse": { + "type": "structure", + "members": { + "malaysiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#MalaysiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Malaysia.

" + } + }, + "israelAdditionalInfo": { + "target": "com.amazonaws.taxsettings#IsraelAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Israel.

" + } + }, + "estoniaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#EstoniaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Estonia.

" + } + }, + "canadaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#CanadaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Canada.

" + } + }, + "brazilAdditionalInfo": { + "target": "com.amazonaws.taxsettings#BrazilAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Brazil. The Tax Settings API\n returns this information in your response when any additional information is present with your\n TRN in Brazil.

" + } + }, + "spainAdditionalInfo": { + "target": "com.amazonaws.taxsettings#SpainAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Spain.

" + } + }, + "kenyaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#KenyaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Kenya.

" + } + }, + "southKoreaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#SouthKoreaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in South Korea.

" + } + }, + "turkeyAdditionalInfo": { + "target": "com.amazonaws.taxsettings#TurkeyAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN in Turkey.

" + } + }, + "georgiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#GeorgiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Georgia.\n

" + } + }, + "italyAdditionalInfo": { + "target": "com.amazonaws.taxsettings#ItalyAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Italy.\n

" + } + }, + "romaniaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#RomaniaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Additional tax information to specify for a TRN in Romania.

" + } + }, + "ukraineAdditionalInfo": { + "target": "com.amazonaws.taxsettings#UkraineAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Ukraine.\n

" + } + }, + "polandAdditionalInfo": { + "target": "com.amazonaws.taxsettings#PolandAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Poland. \n

" + } + }, + "saudiArabiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#SaudiArabiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information associated with your TRN in Saudi Arabia.\n

" + } + }, + "indiaAdditionalInfo": { + "target": "com.amazonaws.taxsettings#IndiaAdditionalInfo", + "traits": { + "smithy.api#documentation": "

\n Additional tax information in India. \n

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

Additional tax information associated with your TRN. The Tax Settings API returns\n country-specific information in the response when any additional information is present with\n your TRN for the following countries.

" + } + }, + "com.amazonaws.taxsettings#Address": { + "type": "structure", + "members": { + "addressLine1": { + "target": "com.amazonaws.taxsettings#AddressLine1", + "traits": { + "smithy.api#documentation": "

The first line of the address.

", + "smithy.api#required": {} + } + }, + "addressLine2": { + "target": "com.amazonaws.taxsettings#AddressLine2", + "traits": { + "smithy.api#documentation": "

The second line of the address, if applicable.

" + } + }, + "addressLine3": { + "target": "com.amazonaws.taxsettings#AddressLine3", + "traits": { + "smithy.api#documentation": "

The third line of the address, if applicable. Currently, the Tax Settings API accepts the\n addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi\n Arabia, you must enter the addressLine3 and specify the building number for the\n address. For example, you might enter 1234.

" + } + }, + "districtOrCounty": { + "target": "com.amazonaws.taxsettings#District", + "traits": { + "smithy.api#documentation": "

The district or county the address is located.

\n \n

For addresses in Brazil, this parameter uses the name of the neighborhood. When you set\n a TRN in Brazil, use districtOrCounty for the neighborhood name.

\n
" + } + }, + "city": { + "target": "com.amazonaws.taxsettings#City", + "traits": { + "smithy.api#documentation": "

The city that the address is in.

", + "smithy.api#required": {} + } + }, + "stateOrRegion": { + "target": "com.amazonaws.taxsettings#State", + "traits": { + "smithy.api#documentation": "

The state, region, or province that the address is located.

\n

If this is required for tax settings, use the same name as shown on the Tax Settings page.

" + } + }, + "postalCode": { + "target": "com.amazonaws.taxsettings#PostalCode", + "traits": { + "smithy.api#documentation": "

The postal code associated with the address.

", + "smithy.api#required": {} + } + }, + "countryCode": { + "target": "com.amazonaws.taxsettings#CountryCode", + "traits": { + "smithy.api#documentation": "

The country code for the country that the address is in.

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

The details of the address associated with the TRN information.

" + } + }, + "com.amazonaws.taxsettings#AddressLine1": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 180 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#AddressLine2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#AddressLine3": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#AddressRoleMap": { + "type": "map", + "key": { + "target": "com.amazonaws.taxsettings#AddressRoleType" + }, + "value": { + "target": "com.amazonaws.taxsettings#Jurisdiction" + } + }, + "com.amazonaws.taxsettings#AddressRoleType": { + "type": "enum", + "members": { + "TAX_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaxAddress" + } + }, + "BILLING_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BillingAddress" + } + }, + "CONTACT_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContactAddress" + } + } + } + }, + "com.amazonaws.taxsettings#BatchDeleteTaxRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#BatchDeleteTaxRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#BatchDeleteTaxRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#ConflictException" + }, + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants delete permission" + }, + "smithy.api#documentation": "

Deletes tax registration for multiple accounts in batch. This can be used to delete tax\n registrations for up to five accounts in one batch.

\n \n

This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.

\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/BatchDeleteTaxRegistration" + } + } + }, + "com.amazonaws.taxsettings#BatchDeleteTaxRegistrationError": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.taxsettings#AccountId", + "traits": { + "smithy.api#documentation": "

The unique account identifier for the account whose tax registration couldn't be deleted\n during the BatchDeleteTaxRegistration operation.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.taxsettings#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message for an individual failure in the\n BatchDeleteTaxRegistration operation.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "com.amazonaws.taxsettings#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code for an individual failure in BatchDeleteTaxRegistration operation.

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

The error object for representing failures in the BatchDeleteTaxRegistration\n operation.

" + } + }, + "com.amazonaws.taxsettings#BatchDeleteTaxRegistrationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#BatchDeleteTaxRegistrationError" + } + }, + "com.amazonaws.taxsettings#BatchDeleteTaxRegistrationRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.taxsettings#AccountIds", + "traits": { + "smithy.api#documentation": "

List of unique account identifiers.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#BatchDeleteTaxRegistrationResponse": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.taxsettings#BatchDeleteTaxRegistrationErrors", + "traits": { + "smithy.api#documentation": "

The list of errors for the accounts the TRN information could not be deleted for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#BatchPutTaxRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#BatchPutTaxRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#BatchPutTaxRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#ConflictException" + }, + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants store permission" + }, + "smithy.api#documentation": "

Adds or updates tax registration for multiple accounts in batch. This can be used to add\n or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

\n

To call this API operation for specific countries, see the following country-specific\n requirements.

\n

\n Bangladesh\n

\n
    \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
  • \n
\n

\n Brazil\n

\n
    \n
  • \n

    You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

    \n
  • \n
  • \n

    For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

    \n
  • \n
\n

\n Georgia\n

\n
    \n
  • \n

    The valid personType values are Physical Person and Business.

    \n
  • \n
\n

\n Kenya\n

\n
    \n
  • \n

    You must specify the personType in the kenyaAdditionalInfo\n field of the additionalTaxInformation object.

    \n
  • \n
  • \n

    If the personType is Physical Person, you must specify the\n tax registration certificate document in the taxRegistrationDocuments field\n of the VerificationDetails object.

    \n
  • \n
\n

\n Malaysia\n

\n
    \n
  • \n

    If you use this operation to set a tax registration number (TRN) in Malaysia, only\n resellers with a valid sales and service tax (SST) number are required to provide tax\n registration information.

    \n
  • \n
  • \n

    By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as\n self-declaring that you're an authorized business reseller registered with the Royal\n Malaysia Customs Department (RMCD) and have a valid SST number.

    \n
  • \n
  • \n

    Amazon Web Services reserves the right to seek additional information and/or take other actions to\n support your self-declaration as appropriate.

    \n
  • \n
  • \n

    If you're not a reseller of Amazon Web Services, we don't recommend that you use\n this operation to set the TRN in Malaysia.

    \n
  • \n
  • \n

    Only use this API operation to upload the TRNs for accounts through which you're\n reselling Amazon Web Services.

    \n
  • \n
  • \n

    Amazon Web Services is currently registered under the following service tax codes. You must include\n at least one of the service tax codes in the service tax code strings to declare yourself\n as an authorized registered business reseller.

    \n

    Taxable service and service tax codes:

    \n

    Consultancy - 9907061674

    \n

    Training or coaching service - 9907071685

    \n

    IT service - 9907101676

    \n

    Digital services and electronic medium - 9907121690

    \n
  • \n
\n

\n Nepal\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
  • \n
\n

\n Saudi Arabia\n

\n
    \n
  • \n

    For address, you must specify addressLine3.

    \n
  • \n
\n

\n South Korea\n

\n
    \n
  • \n

    You must specify the certifiedEmailId and legalName in the\n TaxRegistrationEntry object. Use Korean characters for\n legalName.

    \n
  • \n
  • \n

    You must specify the businessRepresentativeName,\n itemOfBusiness, and lineOfBusiness in the\n southKoreaAdditionalInfo field of the additionalTaxInformation\n object. Use Korean characters for these fields.

    \n
  • \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
  • \n
  • \n

    For the address object, use Korean characters for addressLine1, addressLine2\n city, postalCode, and stateOrRegion.

    \n
  • \n
\n

\n Spain\n

\n
    \n
  • \n

    You must specify the registrationType in the\n spainAdditionalInfo field of the additionalTaxInformation\n object.

    \n
  • \n
  • \n

    If the registrationType is Local, you must specify the tax\n registration certificate document in the taxRegistrationDocuments field of\n the VerificationDetails object.

    \n
  • \n
\n

\n Turkey\n

\n
    \n
  • \n

    You must specify the sector in the taxRegistrationEntry object.

    \n
  • \n
  • \n

    If your sector is Business, Individual, or\n Government:

    \n
      \n
    • \n

      Specify the taxOffice. If your\n sector is Individual, don't enter this value.

      \n
    • \n
    • \n

      (Optional) Specify the kepEmailId. If your\n sector is Individual, don't enter this value.

      \n
    • \n
    • \n

      \n Note: In the Tax Settings page of the Billing console, Government appears as Public institutions\n

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

    If your sector is Business and you're subject to KDV tax,\n you must specify your industry in the industries field.

    \n
  • \n
  • \n

    For address, you must specify districtOrCounty.

    \n
  • \n
\n

\n Ukraine\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
  • \n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/BatchPutTaxRegistration" + } + } + }, + "com.amazonaws.taxsettings#BatchPutTaxRegistrationError": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.taxsettings#AccountId", + "traits": { + "smithy.api#documentation": "

The unique account identifier for the account that the tax registration couldn't be\n added, or updated during the BatchPutTaxRegistration operation.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.taxsettings#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The error message for an individual failure in the BatchPutTaxRegistration\n operation.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "com.amazonaws.taxsettings#ErrorCode", + "traits": { + "smithy.api#documentation": "

The error code for an individual failure in the BatchPutTaxRegistration\n operation.

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

The error object for representing failures in the BatchPutTaxRegistration\n operation.

" + } + }, + "com.amazonaws.taxsettings#BatchPutTaxRegistrationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#BatchPutTaxRegistrationError" + } + }, + "com.amazonaws.taxsettings#BatchPutTaxRegistrationRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.taxsettings#AccountIds", + "traits": { + "smithy.api#documentation": "

List of unique account identifiers.

", + "smithy.api#required": {} + } + }, + "taxRegistrationEntry": { + "target": "com.amazonaws.taxsettings#TaxRegistrationEntry", + "traits": { + "smithy.api#documentation": "

Your TRN information that will be stored to the accounts mentioned in\n putEntries.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#BatchPutTaxRegistrationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.taxsettings#TaxRegistrationStatus", + "traits": { + "smithy.api#documentation": "

The status of your TRN stored in the system after processing. Based on the validation\n occurring on the TRN, the status can be Verified, Pending or\n Rejected.

" + } + }, + "errors": { + "target": "com.amazonaws.taxsettings#BatchPutTaxRegistrationErrors", + "traits": { + "smithy.api#documentation": "

List of errors for the accounts the TRN information could not be added or updated to.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#Boolean": { + "type": "boolean" + }, + "com.amazonaws.taxsettings#BrazilAdditionalInfo": { + "type": "structure", + "members": { + "ccmCode": { + "target": "com.amazonaws.taxsettings#CcmCode", + "traits": { + "smithy.api#documentation": "

The Cadastro de Contribuintes Mobiliários (CCM) code for your TRN in Brazil. This only applies for a CNPJ tax type for the São Paulo municipality.

" + } + }, + "legalNatureCode": { + "target": "com.amazonaws.taxsettings#LegalNatureCode", + "traits": { + "smithy.api#documentation": "

Legal nature of business, based on your TRN in Brazil. This only applies for a CNPJ tax\n type.

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

Additional tax information associated with your TRN in Brazil.

" + } + }, + "com.amazonaws.taxsettings#BusinessRepresentativeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9\\u3130-\\u318F\\uAC00-\\uD7AF,.( )-\\\\s]*$" + } + }, + "com.amazonaws.taxsettings#CanadaAdditionalInfo": { + "type": "structure", + "members": { + "provincialSalesTaxId": { + "target": "com.amazonaws.taxsettings#CanadaProvincialSalesTaxIdString", + "traits": { + "smithy.api#documentation": "

The provincial sales tax ID for your TRN in Canada. This parameter can represent the\n following:

\n
    \n
  • \n

    Provincial sales tax ID number for British Columbia and Saskatchewan provinces

    \n
  • \n
  • \n

    Manitoba retail sales tax ID number for Manitoba province

    \n
  • \n
  • \n

    Quebec sales tax ID number for Quebec province

    \n
  • \n
\n

The Tax Setting API only accepts this parameter if the TRN is specified for the previous\n provinces. For other provinces, the Tax Settings API doesn't accept this parameter.

" + } + }, + "canadaQuebecSalesTaxNumber": { + "target": "com.amazonaws.taxsettings#CanadaQuebecSalesTaxNumberString", + "traits": { + "smithy.api#documentation": "

\n The Quebec Sales Tax ID number. Leave blank if you do not have a Quebec Sales Tax ID number.\n

" + } + }, + "canadaRetailSalesTaxNumber": { + "target": "com.amazonaws.taxsettings#CanadaRetailSalesTaxNumberString", + "traits": { + "smithy.api#documentation": "

\n Manitoba Retail Sales Tax ID number. Customers purchasing Amazon Web Services for resale in Manitoba must provide a valid Retail Sales Tax ID number for Manitoba. Leave this blank if you do not have a Retail Sales Tax ID number in Manitoba or are not purchasing Amazon Web Services for resale.\n

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

The value for this parameter must be true if the\n provincialSalesTaxId value is provided for a TRN in British Columbia,\n Saskatchewan, or Manitoba provinces.

\n

To claim a provincial sales tax (PST) and retail sales tax (RST) reseller exemption, you\n must confirm that purchases from this account were made for resale. Otherwise, remove the PST\n or RST number from the provincialSalesTaxId parameter from your request.

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

Additional tax information associated with your TRN in Canada .

" + } + }, + "com.amazonaws.taxsettings#CanadaProvincialSalesTaxIdString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 16 + }, + "smithy.api#pattern": "^([0-9A-Z/-]+)$" + } + }, + "com.amazonaws.taxsettings#CanadaQuebecSalesTaxNumberString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9]{10})(TQ[0-9]{4})?$" + } + }, + "com.amazonaws.taxsettings#CanadaRetailSalesTaxNumberString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9]{6}-[0-9]{1})$" + } + }, + "com.amazonaws.taxsettings#CcmCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.taxsettings#CertifiedEmailId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,20}$" + } + }, + "com.amazonaws.taxsettings#CigNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9A-Z]{1,15})$" + } + }, + "com.amazonaws.taxsettings#City": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.taxsettings#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.taxsettings#ErrorCode", + "traits": { + "smithy.api#documentation": "

409

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

The exception when the input is creating conflict with the given state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.taxsettings#CountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[a-zA-Z]+$" + } + }, + "com.amazonaws.taxsettings#CupNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9A-Z]{1,15})$" + } + }, + "com.amazonaws.taxsettings#DateOfBirth": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^(\\d{4}-(0[0-9]|1[0-2])-([0-2][0-9]|3[0-1]))$" + } + }, + "com.amazonaws.taxsettings#DeleteTaxRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#DeleteTaxRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#DeleteTaxRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#ConflictException" + }, + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants delete permission" + }, + "smithy.api#documentation": "

Deletes tax registration for a single account.

\n \n

This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.

\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/DeleteTaxRegistration" + } + } + }, + "com.amazonaws.taxsettings#DeleteTaxRegistrationRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.taxsettings#AccountId", + "traits": { + "smithy.api#documentation": "

Unique account identifier for the TRN information that needs to be deleted. If this isn't\n passed, the account ID corresponding to the credentials of the API caller will be used for\n this parameter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#DeleteTaxRegistrationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#DestinationFilePath": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#DestinationS3Location": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.taxsettings#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of your Amazon S3 bucket that you specify to download your tax documents to.

", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "com.amazonaws.taxsettings#S3Prefix", + "traits": { + "smithy.api#documentation": "

The Amazon S3 object prefix that you specify for your tax document file.

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

The location of the Amazon S3 bucket that you specify to download your tax documents to.

" + } + }, + "com.amazonaws.taxsettings#District": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.taxsettings#EstoniaAdditionalInfo": { + "type": "structure", + "members": { + "registryCommercialCode": { + "target": "com.amazonaws.taxsettings#RegistryCommercialCode", + "traits": { + "smithy.api#documentation": "

Registry commercial code (RCC) for your TRN in Estonia. This value is an eight-numeric\n string, such as 12345678.

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

Additional tax information associated with your TRN in Estonia.

" + } + }, + "com.amazonaws.taxsettings#FieldName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#GeorgiaAdditionalInfo": { + "type": "structure", + "members": { + "personType": { + "target": "com.amazonaws.taxsettings#PersonType", + "traits": { + "smithy.api#documentation": "

\n The legal person or physical person assigned to this TRN in Georgia.\n

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

\n Additional tax information associated with your TRN in Georgia.\n

" + } + }, + "com.amazonaws.taxsettings#GetTaxRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#GetTaxRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#GetTaxRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants retrieve permission" + }, + "smithy.api#documentation": "

Retrieves tax registration for a single account.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/GetTaxRegistration" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.taxsettings#GetTaxRegistrationDocument": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#GetTaxRegistrationDocumentRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#GetTaxRegistrationDocumentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants retrieve permission" + }, + "smithy.api#documentation": "

Downloads your tax documents to the Amazon S3 bucket that you specify in your\n request.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/GetTaxRegistrationDocument" + } + } + }, + "com.amazonaws.taxsettings#GetTaxRegistrationDocumentRequest": { + "type": "structure", + "members": { + "destinationS3Location": { + "target": "com.amazonaws.taxsettings#DestinationS3Location", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket that you specify to download your tax documents to.

", + "smithy.api#required": {} + } + }, + "taxDocumentMetadata": { + "target": "com.amazonaws.taxsettings#TaxDocumentMetadata", + "traits": { + "smithy.api#documentation": "

The metadata for your tax document.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#GetTaxRegistrationDocumentResponse": { + "type": "structure", + "members": { + "destinationFilePath": { + "target": "com.amazonaws.taxsettings#DestinationFilePath", + "traits": { + "smithy.api#documentation": "

The file path of the Amazon S3 bucket where you want to download your tax document to.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#GetTaxRegistrationRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.taxsettings#AccountId", + "traits": { + "smithy.api#documentation": "

Your unique account identifier.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#GetTaxRegistrationResponse": { + "type": "structure", + "members": { + "taxRegistration": { + "target": "com.amazonaws.taxsettings#TaxRegistration", + "traits": { + "smithy.api#documentation": "

TRN information of the account mentioned in the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#IndiaAdditionalInfo": { + "type": "structure", + "members": { + "pan": { + "target": "com.amazonaws.taxsettings#Pan", + "traits": { + "smithy.api#documentation": "

\n India pan information associated with the account.\n

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

\n Additional tax information in India.\n

" + } + }, + "com.amazonaws.taxsettings#IndividualRegistrationNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9]{10})$" + } + }, + "com.amazonaws.taxsettings#Industries": { + "type": "enum", + "members": { + "CIRCULATING_ORG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CirculatingOrg" + } + }, + "PROFESSIONAL_ORG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProfessionalOrg" + } + }, + "BANKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Banks" + } + }, + "INSURANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Insurance" + } + }, + "PENSION_AND_BENEFIT_FUNDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PensionAndBenefitFunds" + } + }, + "DEVELOPMENT_AGENCIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DevelopmentAgencies" + } + } + } + }, + "com.amazonaws.taxsettings#InheritanceObtainedReason": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.taxsettings#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.taxsettings#ErrorCode", + "traits": { + "smithy.api#documentation": "

500

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

The exception thrown when an unexpected error occurs when processing a request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.taxsettings#IsraelAdditionalInfo": { + "type": "structure", + "members": { + "dealerType": { + "target": "com.amazonaws.taxsettings#IsraelDealerType", + "traits": { + "smithy.api#documentation": "

Dealer type for your TRN in Israel. If you're not a local authorized dealer with an\n Israeli VAT ID, specify your tax identification number so that Amazon Web Services can send you\n a compliant tax invoice.

", + "smithy.api#required": {} + } + }, + "customerType": { + "target": "com.amazonaws.taxsettings#IsraelCustomerType", + "traits": { + "smithy.api#documentation": "

Customer type for your TRN in Israel. The value can be Business or\n Individual. Use Businessfor entities such as not-for-profit and\n financial institutions.

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

Additional tax information associated with your TRN in Israel.

" + } + }, + "com.amazonaws.taxsettings#IsraelCustomerType": { + "type": "enum", + "members": { + "BUSINESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Business" + } + }, + "INDIVIDUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Individual" + } + } + } + }, + "com.amazonaws.taxsettings#IsraelDealerType": { + "type": "enum", + "members": { + "AUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Authorized" + } + }, + "NON_AUTHORIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Non-authorized" + } + } + } + }, + "com.amazonaws.taxsettings#ItalyAdditionalInfo": { + "type": "structure", + "members": { + "sdiAccountId": { + "target": "com.amazonaws.taxsettings#SdiAccountId", + "traits": { + "smithy.api#documentation": "

\n Additional tax information to specify for a TRN in Italy. Use CodiceDestinatario to receive your invoices via web service (API) or FTP.\n

" + } + }, + "cigNumber": { + "target": "com.amazonaws.taxsettings#CigNumber", + "traits": { + "smithy.api#documentation": "

\n The tender procedure identification code.\n

" + } + }, + "cupNumber": { + "target": "com.amazonaws.taxsettings#CupNumber", + "traits": { + "smithy.api#documentation": "

\n Additional tax information to specify for a TRN in Italy. This is managed by the Interministerial Committee for Economic Planning (CIPE) which characterizes every public investment project (Individual Project Code).\n

" + } + }, + "taxCode": { + "target": "com.amazonaws.taxsettings#TaxCode", + "traits": { + "smithy.api#documentation": "

List of service tax codes for your TRN in Italy. You can use your customer tax code as part of a VAT Group.\n

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

\n Additional tax information associated with your TRN in Italy.\n

" + } + }, + "com.amazonaws.taxsettings#ItemOfBusiness": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9\\u3130-\\u318F\\uAC00-\\uD7AF,.( )-\\\\s]*$" + } + }, + "com.amazonaws.taxsettings#Jurisdiction": { + "type": "structure", + "members": { + "stateOrRegion": { + "target": "com.amazonaws.taxsettings#State", + "traits": { + "smithy.api#documentation": "

The state, region, or province associated with the country of the jurisdiction, if\n applicable.

" + } + }, + "countryCode": { + "target": "com.amazonaws.taxsettings#CountryCode", + "traits": { + "smithy.api#documentation": "

The country code of the jurisdiction.

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

The jurisdiction details of the TRN information of the customers. This doesn't contain\n full legal address, and contains only country code and state/region/province.

" + } + }, + "com.amazonaws.taxsettings#KenyaAdditionalInfo": { + "type": "structure", + "members": { + "personType": { + "target": "com.amazonaws.taxsettings#PersonType", + "traits": { + "smithy.api#documentation": "

The legal person or physical person assigned to this TRN in Kenya.

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

Additional tax information associated with your TRN in Kenya.

" + } + }, + "com.amazonaws.taxsettings#KepEmailId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#LegalName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#LegalNatureCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.taxsettings#LineOfBusiness": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9\\u3130-\\u318F\\uAC00-\\uD7AF,.( )-\\\\s]*$" + } + }, + "com.amazonaws.taxsettings#ListTaxRegistrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#ListTaxRegistrationsRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#ListTaxRegistrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants retrieve permission" + }, + "smithy.api#documentation": "

Retrieves the tax registration of accounts listed in a consolidated billing family. This\n can be used to retrieve up to 100 accounts' tax registrations in one call (default 50).\n

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/ListTaxRegistrations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "accountDetails", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.taxsettings#ListTaxRegistrationsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.taxsettings#MaxResults", + "traits": { + "smithy.api#documentation": "

Number of accountDetails results you want in one response.

" + } + }, + "nextToken": { + "target": "com.amazonaws.taxsettings#PaginationTokenString", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#ListTaxRegistrationsResponse": { + "type": "structure", + "members": { + "accountDetails": { + "target": "com.amazonaws.taxsettings#AccountDetailsList", + "traits": { + "smithy.api#documentation": "

The list of account details. This contains account Ids and TRN Information for each of the\n linked accounts.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.taxsettings#PaginationTokenString", + "traits": { + "smithy.api#documentation": "

The token to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#MalaysiaAdditionalInfo": { + "type": "structure", + "members": { + "serviceTaxCodes": { + "target": "com.amazonaws.taxsettings#MalaysiaServiceTaxCodesList", + "traits": { + "smithy.api#documentation": "

List of service tax codes for your TRN in Malaysia.

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

Additional tax information associated with your TRN in Malaysia.

" + } + }, + "com.amazonaws.taxsettings#MalaysiaServiceTaxCode": { + "type": "enum", + "members": { + "CONSULTANCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Consultancy" + } + }, + "DIGITAL_SVC_ELECTRONIC_MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Digital Service And Electronic Medium" + } + }, + "IT_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IT Services" + } + }, + "TRAINING_OR_COACHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Training Or Coaching" + } + } + } + }, + "com.amazonaws.taxsettings#MalaysiaServiceTaxCodesList": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#MalaysiaServiceTaxCode" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.taxsettings#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.taxsettings#PaginationTokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^[-A-Za-z0-9_+\\=\\/]+$" + } + }, + "com.amazonaws.taxsettings#Pan": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Z]{5}[0-9]{4}[A-Z]{1}$" + } + }, + "com.amazonaws.taxsettings#PersonType": { + "type": "enum", + "members": { + "LEGAL_PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Legal Person" + } + }, + "PHYSICAL_PERSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Physical Person" + } + }, + "BUSINESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Business" + } + } + } + }, + "com.amazonaws.taxsettings#PolandAdditionalInfo": { + "type": "structure", + "members": { + "individualRegistrationNumber": { + "target": "com.amazonaws.taxsettings#IndividualRegistrationNumber", + "traits": { + "smithy.api#documentation": "

\n The individual tax registration number (NIP). Individual NIP is valid for other taxes excluding VAT purposes.\n

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

\n True if your business is a member of a VAT group with a NIP active for VAT purposes. Otherwise, this is false.\n

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

\n Additional tax information associated with your TRN in Poland.\n

" + } + }, + "com.amazonaws.taxsettings#PostalCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#PutTaxRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#PutTaxRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#PutTaxRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#ConflictException" + }, + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants store permission" + }, + "smithy.api#documentation": "

Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

\n

To call this API operation for specific countries, see the following country-specific\n requirements.

\n

\n Bangladesh\n

\n
    \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
  • \n
\n

\n Brazil\n

\n
    \n
  • \n

    You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

    \n
  • \n
  • \n

    For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

    \n
  • \n
\n

\n Georgia\n

\n
    \n
  • \n

    The valid personType values are Physical Person and Business.

    \n
  • \n
\n

\n Kenya\n

\n
    \n
  • \n

    You must specify the personType in the kenyaAdditionalInfo\n field of the additionalTaxInformation object.

    \n
  • \n
  • \n

    If the personType is Physical Person, you must specify the\n tax registration certificate document in the taxRegistrationDocuments field\n of the VerificationDetails object.

    \n
  • \n
\n

\n Malaysia\n

\n
    \n
  • \n

    If you use this operation to set a tax registration number (TRN) in Malaysia, only\n resellers with a valid sales and service tax (SST) number are required to provide tax\n registration information.

    \n
  • \n
  • \n

    By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as\n self-declaring that you're an authorized business reseller registered with the Royal\n Malaysia Customs Department (RMCD) and have a valid SST number.

    \n
  • \n
  • \n

    Amazon Web Services reserves the right to seek additional information and/or take other actions to\n support your self-declaration as appropriate.

    \n
  • \n
  • \n

    If you're not a reseller of Amazon Web Services, we don't recommend that you use\n this operation to set the TRN in Malaysia.

    \n
  • \n
  • \n

    Only use this API operation to upload the TRNs for accounts through which you're\n reselling Amazon Web Services.

    \n
  • \n
  • \n

    Amazon Web Services is currently registered under the following service tax codes. You must include\n at least one of the service tax codes in the service tax code strings to declare yourself\n as an authorized registered business reseller.

    \n

    Taxable service and service tax codes:

    \n

    Consultancy - 9907061674

    \n

    Training or coaching service - 9907071685

    \n

    IT service - 9907101676

    \n

    Digital services and electronic medium - 9907121690

    \n
  • \n
\n

\n Nepal\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
  • \n
\n

\n Saudi Arabia\n

\n
    \n
  • \n

    For address, you must specify addressLine3.

    \n
  • \n
\n

\n South Korea\n

\n
    \n
  • \n

    You must specify the certifiedEmailId and legalName in the\n TaxRegistrationEntry object. Use Korean characters for\n legalName.

    \n
  • \n
  • \n

    You must specify the businessRepresentativeName,\n itemOfBusiness, and lineOfBusiness in the\n southKoreaAdditionalInfo field of the additionalTaxInformation\n object. Use Korean characters for these fields.

    \n
  • \n
  • \n

    You must specify the tax registration certificate document in the\n taxRegistrationDocuments field of the VerificationDetails\n object.

    \n
  • \n
  • \n

    For the address object, use Korean characters for addressLine1, addressLine2\n city, postalCode, and stateOrRegion.

    \n
  • \n
\n

\n Spain\n

\n
    \n
  • \n

    You must specify the registrationType in the\n spainAdditionalInfo field of the additionalTaxInformation\n object.

    \n
  • \n
  • \n

    If the registrationType is Local, you must specify the tax\n registration certificate document in the taxRegistrationDocuments field of\n the VerificationDetails object.

    \n
  • \n
\n

\n Turkey\n

\n
    \n
  • \n

    You must specify the sector in the taxRegistrationEntry object.

    \n
  • \n
  • \n

    If your sector is Business, Individual, or\n Government:

    \n
      \n
    • \n

      Specify the taxOffice. If your\n sector is Individual, don't enter this value.

      \n
    • \n
    • \n

      (Optional) Specify the kepEmailId. If your\n sector is Individual, don't enter this value.

      \n
    • \n
    • \n

      \n Note: In the Tax Settings page of the Billing console, Government appears as Public institutions\n

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

    If your sector is Business and you're subject to KDV tax,\n you must specify your industry in the industries field.

    \n
  • \n
  • \n

    For address, you must specify districtOrCounty.

    \n
  • \n
\n

\n Ukraine\n

\n
    \n
  • \n

    The sector valid values are Business and Individual.

    \n
  • \n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/PutTaxRegistration" + } + } + }, + "com.amazonaws.taxsettings#PutTaxRegistrationRequest": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.taxsettings#AccountId", + "traits": { + "smithy.api#documentation": "

Your unique account identifier.

" + } + }, + "taxRegistrationEntry": { + "target": "com.amazonaws.taxsettings#TaxRegistrationEntry", + "traits": { + "smithy.api#documentation": "

Your TRN information that will be stored to the account mentioned in\n accountId.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#PutTaxRegistrationResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.taxsettings#TaxRegistrationStatus", + "traits": { + "smithy.api#documentation": "

The status of your TRN stored in the system after processing. Based on the validation\n occurring on the TRN, the status can be Verified, Pending or\n Rejected.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#RegistrationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#RegistrationType": { + "type": "enum", + "members": { + "INTRA_EU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Intra-EU" + } + }, + "LOCAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Local" + } + } + } + }, + "com.amazonaws.taxsettings#RegistryCommercialCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 8 + }, + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.taxsettings#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.taxsettings#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.taxsettings#ErrorCode", + "traits": { + "smithy.api#documentation": "

404

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

The exception thrown when the input doesn't have a resource associated to it.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.taxsettings#RomaniaAdditionalInfo": { + "type": "structure", + "members": { + "taxRegistrationNumberType": { + "target": "com.amazonaws.taxsettings#TaxRegistrationNumberType", + "traits": { + "smithy.api#documentation": "

\n The tax registration number type. The value can be TaxRegistrationNumber or LocalRegistrationNumber.\n

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

Additional tax information to specify for a TRN in Romania.\n

" + } + }, + "com.amazonaws.taxsettings#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)$" + } + }, + "com.amazonaws.taxsettings#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.taxsettings#S3Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.taxsettings#SaudiArabiaAdditionalInfo": { + "type": "structure", + "members": { + "taxRegistrationNumberType": { + "target": "com.amazonaws.taxsettings#SaudiArabiaTaxRegistrationNumberType", + "traits": { + "smithy.api#documentation": "

\n The tax registration number type.\n

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

\n Additional tax information associated with your TRN in Saudi Arabia.\n

" + } + }, + "com.amazonaws.taxsettings#SaudiArabiaTaxRegistrationNumberType": { + "type": "enum", + "members": { + "TAX_REGISTRATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaxRegistrationNumber" + } + }, + "TAX_IDENTIFICATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaxIdentificationNumber" + } + }, + "COMMERCIAL_REGISTRATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CommercialRegistrationNumber" + } + } + } + }, + "com.amazonaws.taxsettings#SdiAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9A-Z]{6,7}$" + } + }, + "com.amazonaws.taxsettings#SecondaryTaxId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9]{10})$" + } + }, + "com.amazonaws.taxsettings#Sector": { + "type": "enum", + "members": { + "BUSINESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Business" + } + }, + "INDIVIDUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Individual" + } + }, + "PUBLIC_INSTITUTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Government" + } + } + } + }, + "com.amazonaws.taxsettings#Seller": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#SourceS3Location": { + "type": "structure", + "members": { + "bucket": { + "target": "com.amazonaws.taxsettings#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of your Amazon S3 bucket that your tax document is located.

", + "smithy.api#required": {} + } + }, + "key": { + "target": "com.amazonaws.taxsettings#S3Key", + "traits": { + "smithy.api#documentation": "

The object key of your tax document object in Amazon S3.

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

The Amazon S3 bucket in your account where your tax document is located.

" + } + }, + "com.amazonaws.taxsettings#SouthKoreaAdditionalInfo": { + "type": "structure", + "members": { + "businessRepresentativeName": { + "target": "com.amazonaws.taxsettings#BusinessRepresentativeName", + "traits": { + "smithy.api#documentation": "

The business legal name based on the most recently uploaded tax registration certificate.

", + "smithy.api#required": {} + } + }, + "lineOfBusiness": { + "target": "com.amazonaws.taxsettings#LineOfBusiness", + "traits": { + "smithy.api#documentation": "

Line of business based on the most recently uploaded tax registration certificate.

", + "smithy.api#required": {} + } + }, + "itemOfBusiness": { + "target": "com.amazonaws.taxsettings#ItemOfBusiness", + "traits": { + "smithy.api#documentation": "

Item of business based on the most recently uploaded tax registration certificate.

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

Additional tax information associated with your TRN in South Korea.

" + } + }, + "com.amazonaws.taxsettings#SpainAdditionalInfo": { + "type": "structure", + "members": { + "registrationType": { + "target": "com.amazonaws.taxsettings#RegistrationType", + "traits": { + "smithy.api#documentation": "

The registration type in Spain.

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

Additional tax information associated with your TRN in Spain.

" + } + }, + "com.amazonaws.taxsettings#State": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" + } + }, + "com.amazonaws.taxsettings#TaxCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9]{11}|[A-Z]{6}[0-9]{2}[A-Z][0-9]{2}[A-Z][0-9]{3}[A-Z])$" + } + }, + "com.amazonaws.taxsettings#TaxDocumentAccessToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#TaxDocumentMetadata": { + "type": "structure", + "members": { + "taxDocumentAccessToken": { + "target": "com.amazonaws.taxsettings#TaxDocumentAccessToken", + "traits": { + "smithy.api#documentation": "

The tax document access token, which contains information that the Tax Settings API uses to locate the tax document.

\n \n

If you update your tax registration, the existing taxDocumentAccessToken won't be valid. To get the latest token, call the GetTaxRegistration or ListTaxRegistrations API operation. This token is valid for 24 hours.

\n
", + "smithy.api#required": {} + } + }, + "taxDocumentName": { + "target": "com.amazonaws.taxsettings#TaxDocumentName", + "traits": { + "smithy.api#documentation": "

The name of your tax document.

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

The metadata for your tax document.

" + } + }, + "com.amazonaws.taxsettings#TaxDocumentMetadatas": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#TaxDocumentMetadata" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.taxsettings#TaxDocumentName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#TaxInheritanceDetails": { + "type": "structure", + "members": { + "parentEntityId": { + "target": "com.amazonaws.taxsettings#AccountId", + "traits": { + "smithy.api#documentation": "

\n Tax inheritance parent account information associated with the account.\n

" + } + }, + "inheritanceObtainedReason": { + "target": "com.amazonaws.taxsettings#InheritanceObtainedReason", + "traits": { + "smithy.api#documentation": "

\n Tax inheritance reason information associated with the account.\n

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

\n Tax inheritance information associated with the account.\n

" + } + }, + "com.amazonaws.taxsettings#TaxOffice": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.taxsettings#TaxRegistration": { + "type": "structure", + "members": { + "registrationId": { + "target": "com.amazonaws.taxsettings#RegistrationId", + "traits": { + "smithy.api#documentation": "

Your tax registration unique identifier.

", + "smithy.api#required": {} + } + }, + "registrationType": { + "target": "com.amazonaws.taxsettings#TaxRegistrationType", + "traits": { + "smithy.api#documentation": "

Type of your tax registration. This can be either VAT or GST.\n

", + "smithy.api#required": {} + } + }, + "legalName": { + "target": "com.amazonaws.taxsettings#LegalName", + "traits": { + "smithy.api#documentation": "

The legal name associated with your TRN registration.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.taxsettings#TaxRegistrationStatus", + "traits": { + "smithy.api#documentation": "

The status of your TRN. This can be either Verified, Pending,\n Deleted, or Rejected.

", + "smithy.api#required": {} + } + }, + "sector": { + "target": "com.amazonaws.taxsettings#Sector", + "traits": { + "smithy.api#documentation": "

The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government. Note that certain values may not applicable for the request country. Please refer to country specific information in API document.\n

" + } + }, + "taxDocumentMetadatas": { + "target": "com.amazonaws.taxsettings#TaxDocumentMetadatas", + "traits": { + "smithy.api#documentation": "

The metadata for your tax document.

" + } + }, + "certifiedEmailId": { + "target": "com.amazonaws.taxsettings#CertifiedEmailId", + "traits": { + "smithy.api#documentation": "

The email address to receive VAT invoices.

" + } + }, + "additionalTaxInformation": { + "target": "com.amazonaws.taxsettings#AdditionalInfoResponse", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN.

" + } + }, + "legalAddress": { + "target": "com.amazonaws.taxsettings#Address", + "traits": { + "smithy.api#documentation": "

The legal address associated with your TRN registration.

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

Your TRN information.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.taxsettings#TaxRegistrationDocument": { + "type": "structure", + "members": { + "s3Location": { + "target": "com.amazonaws.taxsettings#SourceS3Location", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location where your tax registration document is stored.

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

Tax registration document information.

" + } + }, + "com.amazonaws.taxsettings#TaxRegistrationDocuments": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#TaxRegistrationDocument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.taxsettings#TaxRegistrationEntry": { + "type": "structure", + "members": { + "registrationId": { + "target": "com.amazonaws.taxsettings#RegistrationId", + "traits": { + "smithy.api#documentation": "

Your tax registration unique identifier.

", + "smithy.api#required": {} + } + }, + "registrationType": { + "target": "com.amazonaws.taxsettings#TaxRegistrationType", + "traits": { + "smithy.api#documentation": "

Your tax registration type. This can be either VAT or GST.\n

", + "smithy.api#required": {} + } + }, + "legalName": { + "target": "com.amazonaws.taxsettings#LegalName", + "traits": { + "smithy.api#documentation": "

The legal name associated with your TRN.

\n \n

If you're setting a TRN in Brazil, you don't need to specify the legal name. For TRNs in\n other countries, you must specify the legal name.

\n
" + } + }, + "legalAddress": { + "target": "com.amazonaws.taxsettings#Address", + "traits": { + "smithy.api#documentation": "

The legal address associated with your TRN.

\n \n

If you're setting a TRN in Brazil for the CNPJ tax type, you don't need to specify the\n legal address.

\n

For TRNs in other countries and for CPF tax types Brazil, you must specify the legal\n address.

\n
" + } + }, + "sector": { + "target": "com.amazonaws.taxsettings#Sector", + "traits": { + "smithy.api#documentation": "

The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government.Note that certain values may not applicable for the request country. Please refer to country specific information in API document.\n

" + } + }, + "additionalTaxInformation": { + "target": "com.amazonaws.taxsettings#AdditionalInfoRequest", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN. You only need to specify this\n parameter if Amazon Web Services collects any additional information for your country within\n AdditionalInfoRequest.

" + } + }, + "verificationDetails": { + "target": "com.amazonaws.taxsettings#VerificationDetails", + "traits": { + "smithy.api#documentation": "

Additional details needed to verify your TRN information in Brazil. You only need to specify this\n parameter when you set a TRN in Brazil that is the CPF tax type.

\n \n

Don't specify this parameter to set a TRN in Brazil of the CNPJ tax type or to set a TRN\n for another country.

\n
" + } + }, + "certifiedEmailId": { + "target": "com.amazonaws.taxsettings#CertifiedEmailId", + "traits": { + "smithy.api#documentation": "

The email address to receive VAT invoices.

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

The TRN information you provide when you add a new TRN, or update.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.taxsettings#TaxRegistrationNumberType": { + "type": "enum", + "members": { + "TAX_REGISTRATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaxRegistrationNumber" + } + }, + "LOCAL_REGISTRATION_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LocalRegistrationNumber" + } + } + } + }, + "com.amazonaws.taxsettings#TaxRegistrationStatus": { + "type": "enum", + "members": { + "VERIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Verified" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + } + } + }, + "com.amazonaws.taxsettings#TaxRegistrationType": { + "type": "enum", + "members": { + "VAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAT" + } + }, + "GST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GST" + } + }, + "CPF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CPF" + } + }, + "CNPJ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CNPJ" + } + }, + "SST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SST" + } + } + } + }, + "com.amazonaws.taxsettings#TaxRegistrationWithJurisdiction": { + "type": "structure", + "members": { + "registrationId": { + "target": "com.amazonaws.taxsettings#RegistrationId", + "traits": { + "smithy.api#documentation": "

Your tax registration unique identifier.

", + "smithy.api#required": {} + } + }, + "registrationType": { + "target": "com.amazonaws.taxsettings#TaxRegistrationType", + "traits": { + "smithy.api#documentation": "

The type of your tax registration. This can be either VAT or\n GST.

", + "smithy.api#required": {} + } + }, + "legalName": { + "target": "com.amazonaws.taxsettings#LegalName", + "traits": { + "smithy.api#documentation": "

The legal name associated with your TRN information.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.taxsettings#TaxRegistrationStatus", + "traits": { + "smithy.api#documentation": "

The status of your TRN. This can be either Verified, Pending,\n Deleted, or Rejected.

", + "smithy.api#required": {} + } + }, + "sector": { + "target": "com.amazonaws.taxsettings#Sector", + "traits": { + "smithy.api#documentation": "

The industry that describes your business. For business-to-business (B2B) customers, specify Business. For business-to-consumer (B2C) customers, specify Individual. For business-to-government (B2G), specify Government.Note that certain values may not applicable for the request country. Please refer to country specific information in API document.\n

" + } + }, + "taxDocumentMetadatas": { + "target": "com.amazonaws.taxsettings#TaxDocumentMetadatas", + "traits": { + "smithy.api#documentation": "

The metadata for your tax document.

" + } + }, + "certifiedEmailId": { + "target": "com.amazonaws.taxsettings#CertifiedEmailId", + "traits": { + "smithy.api#documentation": "

The email address to receive VAT invoices.

" + } + }, + "additionalTaxInformation": { + "target": "com.amazonaws.taxsettings#AdditionalInfoResponse", + "traits": { + "smithy.api#documentation": "

Additional tax information associated with your TRN.

" + } + }, + "jurisdiction": { + "target": "com.amazonaws.taxsettings#Jurisdiction", + "traits": { + "smithy.api#documentation": "

The jurisdiction associated with your TRN information.

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

Your TRN information with jurisdiction details. This doesn't contain the full legal\n address associated with the TRN information.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.taxsettings#TaxSettings": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.taxsettings#BatchDeleteTaxRegistration" + }, + { + "target": "com.amazonaws.taxsettings#BatchPutTaxRegistration" + }, + { + "target": "com.amazonaws.taxsettings#DeleteTaxRegistration" + }, + { + "target": "com.amazonaws.taxsettings#GetTaxRegistration" + }, + { + "target": "com.amazonaws.taxsettings#GetTaxRegistrationDocument" + }, + { + "target": "com.amazonaws.taxsettings#ListTaxRegistrations" + }, + { + "target": "com.amazonaws.taxsettings#PutTaxRegistration" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "TaxSettings", + "arnNamespace": "tax", + "cloudTrailEventSource": "tax.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "tax" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

You can use the tax setting API to programmatically set, modify, and delete the tax\n registration number (TRN), associated business legal name, and address (Collectively referred\n to as \"TRN information\"). You can also programmatically view TRN information and tax addresses\n (\"Tax profiles\").

\n

You can use this API to automate your TRN information settings instead of manually using\n the console.

\n

Service Endpoint

\n
    \n
  • \n

    https://tax.us-east-1.amazonaws.com

    \n
  • \n
", + "smithy.api#title": "Tax Settings", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "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, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://tax-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://tax-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://tax.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://tax.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tax-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tax-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tax.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tax.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tax-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tax-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tax.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tax.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tax-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tax-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://tax.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://tax.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://tax-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://tax.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://tax-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://tax.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "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" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.taxsettings#TurkeyAdditionalInfo": { + "type": "structure", + "members": { + "taxOffice": { + "target": "com.amazonaws.taxsettings#TaxOffice", + "traits": { + "smithy.api#documentation": "

The tax office where you're registered. You can enter this information as a string. The Tax Settings API will add this information to your invoice. This parameter is required for business-to-business (B2B) and business-to-government customers. It's not required for business-to-consumer (B2C) customers.

" + } + }, + "kepEmailId": { + "target": "com.amazonaws.taxsettings#KepEmailId", + "traits": { + "smithy.api#documentation": "

The Registered Electronic Mail (REM) that is used to send notarized communication. This parameter is optional for business-to-business (B2B) and business-to-government (B2G) customers. It's not required for business-to-consumer (B2C) customers.

" + } + }, + "secondaryTaxId": { + "target": "com.amazonaws.taxsettings#SecondaryTaxId", + "traits": { + "smithy.api#documentation": "

\n Secondary tax ID (“harcama birimi VKN”si”). If one isn't provided, we will use your VKN as the secondary ID.\n

" + } + }, + "industries": { + "target": "com.amazonaws.taxsettings#Industries", + "traits": { + "smithy.api#documentation": "

The industry information that tells the Tax Settings API if you're subject to additional\n withholding taxes. This information required for business-to-business (B2B) customers. This\n information is conditionally mandatory for B2B customers who are subject to KDV tax.

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

Additional tax information associated with your TRN in Turkey.

" + } + }, + "com.amazonaws.taxsettings#UkraineAdditionalInfo": { + "type": "structure", + "members": { + "ukraineTrnType": { + "target": "com.amazonaws.taxsettings#UkraineTrnType", + "traits": { + "smithy.api#documentation": "

\n The tax registration type.\n

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

\n Additional tax information associated with your TRN in Ukraine.\n

" + } + }, + "com.amazonaws.taxsettings#UkraineTrnType": { + "type": "enum", + "members": { + "BUSINESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Business" + } + }, + "INDIVIDUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Individual" + } + } + } + }, + "com.amazonaws.taxsettings#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.taxsettings#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.taxsettings#ValidationExceptionErrorCode", + "traits": { + "smithy.api#documentation": "

400

", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.taxsettings#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

400

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

The exception when the input doesn't pass validation for at least one of the input\n parameters.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.taxsettings#ValidationExceptionErrorCode": { + "type": "enum", + "members": { + "MALFORMED_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MalformedToken" + } + }, + "EXPIRED_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExpiredToken" + } + }, + "INVALID_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidToken" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FieldValidationFailed" + } + }, + "MISSING_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingInput" + } + } + } + }, + "com.amazonaws.taxsettings#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.taxsettings#FieldName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that caused a ValidationException error.

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

The information about the specified parameter in the request that caused an error.

" + } + }, + "com.amazonaws.taxsettings#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#ValidationExceptionField" + } + }, + "com.amazonaws.taxsettings#VerificationDetails": { + "type": "structure", + "members": { + "dateOfBirth": { + "target": "com.amazonaws.taxsettings#DateOfBirth", + "traits": { + "smithy.api#documentation": "

Date of birth to verify your submitted TRN. Use the YYYY-MM-DD format.

" + } + }, + "taxRegistrationDocuments": { + "target": "com.amazonaws.taxsettings#TaxRegistrationDocuments", + "traits": { + "smithy.api#documentation": "

The tax registration document, which is required for specific countries such as Bangladesh, Kenya, South Korea and Spain.

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

Required information to verify your TRN.

" + } + } + } +} \ No newline at end of file From 075376d2e705fc4864a57de095c1a9df8974b956 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 4 Jun 2024 18:03:49 +0000 Subject: [PATCH 23/41] feat: update AWS service endpoints metadata --- .../aws/sdk/kotlin/codegen/endpoints.json | 51 +++++-------------- 1 file changed, 12 insertions(+), 39 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 3d3288dc20b..30c2ac8bca2 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 @@ -9020,6 +9020,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ca-central-1" : { }, + "ca-west-1" : { }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -19581,9 +19582,11 @@ "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "eu-west-3" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, + "us-west-1" : { }, "us-west-2" : { } } }, @@ -27888,43 +27891,23 @@ }, "rds" : { "endpoints" : { - "rds-fips.us-iso-east-1" : { - "credentialScope" : { - "region" : "us-iso-east-1" - }, - "deprecated" : true, - "hostname" : "rds-fips.us-iso-east-1.c2s.ic.gov" - }, - "rds-fips.us-iso-west-1" : { - "credentialScope" : { - "region" : "us-iso-west-1" - }, - "deprecated" : true, - "hostname" : "rds-fips.us-iso-west-1.c2s.ic.gov" - }, "rds.us-iso-east-1" : { "credentialScope" : { "region" : "us-iso-east-1" }, "deprecated" : true, - "variants" : [ { - "hostname" : "rds-fips.us-iso-east-1.c2s.ic.gov", - "tags" : [ "fips" ] - } ] + "hostname" : "rds.us-iso-east-1.c2s.ic.gov" }, "rds.us-iso-west-1" : { "credentialScope" : { "region" : "us-iso-west-1" }, "deprecated" : true, - "variants" : [ { - "hostname" : "rds-fips.us-iso-west-1.c2s.ic.gov", - "tags" : [ "fips" ] - } ] + "hostname" : "rds.us-iso-west-1.c2s.ic.gov" }, "us-iso-east-1" : { "variants" : [ { - "hostname" : "rds-fips.us-iso-east-1.c2s.ic.gov", + "hostname" : "rds.us-iso-east-1.c2s.ic.gov", "tags" : [ "fips" ] } ] }, @@ -27933,11 +27916,11 @@ "region" : "us-iso-east-1" }, "deprecated" : true, - "hostname" : "rds-fips.us-iso-east-1.c2s.ic.gov" + "hostname" : "rds.us-iso-east-1.c2s.ic.gov" }, "us-iso-west-1" : { "variants" : [ { - "hostname" : "rds-fips.us-iso-west-1.c2s.ic.gov", + "hostname" : "rds.us-iso-west-1.c2s.ic.gov", "tags" : [ "fips" ] } ] }, @@ -27946,7 +27929,7 @@ "region" : "us-iso-west-1" }, "deprecated" : true, - "hostname" : "rds-fips.us-iso-west-1.c2s.ic.gov" + "hostname" : "rds.us-iso-west-1.c2s.ic.gov" } } }, @@ -28616,26 +28599,16 @@ }, "rds" : { "endpoints" : { - "rds-fips.us-isob-east-1" : { - "credentialScope" : { - "region" : "us-isob-east-1" - }, - "deprecated" : true, - "hostname" : "rds-fips.us-isob-east-1.sc2s.sgov.gov" - }, "rds.us-isob-east-1" : { "credentialScope" : { "region" : "us-isob-east-1" }, "deprecated" : true, - "variants" : [ { - "hostname" : "rds-fips.us-isob-east-1.sc2s.sgov.gov", - "tags" : [ "fips" ] - } ] + "hostname" : "rds.us-isob-east-1.sc2s.sgov.gov" }, "us-isob-east-1" : { "variants" : [ { - "hostname" : "rds-fips.us-isob-east-1.sc2s.sgov.gov", + "hostname" : "rds.us-isob-east-1.sc2s.sgov.gov", "tags" : [ "fips" ] } ] }, @@ -28644,7 +28617,7 @@ "region" : "us-isob-east-1" }, "deprecated" : true, - "hostname" : "rds-fips.us-isob-east-1.sc2s.sgov.gov" + "hostname" : "rds.us-isob-east-1.sc2s.sgov.gov" } } }, From e467d70a1355832b521983125902b19c9d9df45b Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 4 Jun 2024 18:06:40 +0000 Subject: [PATCH 24/41] chore: release 1.2.26 --- CHANGELOG.md | 8 ++++++++ codegen/sdk/packages.json | 6 ++++++ gradle.properties | 2 +- 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3044892c321..aa462b926ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [1.2.26] - 06/04/2024 + +### Features +* (**ec2**) U7i instances with up to 32 TiB of DDR5 memory and 896 vCPUs are now available. C7i-flex instances are launched and are lower-priced variants of the Amazon EC2 C7i instances that offer a baseline level of CPU performance with the ability to scale up to the full compute performance 95% of the time. +* (**pipes**) This release adds Timestream for LiveAnalytics as a supported target in EventBridge Pipes +* (**sagemaker**) Extend DescribeClusterNode response with private DNS hostname and IP address, and placement information about availability zone and availability zone ID. +* (**taxsettings**) Initial release of AWS Tax Settings API + ## [1.2.25] - 06/03/2024 ### Features diff --git a/codegen/sdk/packages.json b/codegen/sdk/packages.json index 63f0ced5368..d40f6448602 100644 --- a/codegen/sdk/packages.json +++ b/codegen/sdk/packages.json @@ -1944,6 +1944,12 @@ "artifactName": "supportapp", "brazilName": "AwsSdkKotlinSupportApp" }, + { + "sdkId": "TaxSettings", + "namespace": "aws.sdk.kotlin.services.taxsettings", + "artifactName": "taxsettings", + "brazilName": "AwsSdkKotlinTaxsettings" + }, { "sdkId": "Textract", "namespace": "aws.sdk.kotlin.services.textract", diff --git a/gradle.properties b/gradle.properties index 90d014fe79a..d1490250571 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.2.26-SNAPSHOT +sdkVersion=1.2.26 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 06da5292ed466d9b162ea022496df299e4fcad86 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Tue, 4 Jun 2024 18:06:41 +0000 Subject: [PATCH 25/41] chore: bump snapshot version to 1.2.27-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index d1490250571..47f8c832d37 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.2.26 +sdkVersion=1.2.27-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 92abc2628e5a2c25c13dc71a8462e77e15c23fc5 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 5 Jun 2024 18:05:56 +0000 Subject: [PATCH 26/41] feat: update AWS API models --- .../sdk/aws-models/global-accelerator.json | 12 + codegen/sdk/aws-models/glue.json | 439 +++++++++++++++++- codegen/sdk/aws-models/s3.json | 108 +++-- 3 files changed, 509 insertions(+), 50 deletions(-) diff --git a/codegen/sdk/aws-models/global-accelerator.json b/codegen/sdk/aws-models/global-accelerator.json index 3f8300a1bc4..7374c575f08 100644 --- a/codegen/sdk/aws-models/global-accelerator.json +++ b/codegen/sdk/aws-models/global-accelerator.json @@ -5860,6 +5860,12 @@ "smithy.api#documentation": "

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

" } }, + "IpAddresses": { + "target": "com.amazonaws.globalaccelerator#IpAddresses", + "traits": { + "smithy.api#documentation": "

The IP addresses for an accelerator.

" + } + }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { @@ -6094,6 +6100,12 @@ "smithy.api#documentation": "

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

" } }, + "IpAddresses": { + "target": "com.amazonaws.globalaccelerator#IpAddresses", + "traits": { + "smithy.api#documentation": "

The IP addresses for an accelerator.

" + } + }, "Enabled": { "target": "com.amazonaws.globalaccelerator#GenericBoolean", "traits": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index c9158662031..ce8f37793de 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -1655,6 +1655,16 @@ } } }, + "com.amazonaws.glue#AWSManagedClientApplicationReference": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.glue#AccessDeniedException": { "type": "structure", "members": { @@ -2340,6 +2350,111 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.glue#AuthenticationConfiguration": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.glue#AuthenticationType", + "traits": { + "smithy.api#documentation": "

A structure containing the authentication configuration.

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

The secret manager ARN to store credentials.

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

The properties for OAuth2 authentication.

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

A structure containing the authentication configuration.

" + } + }, + "com.amazonaws.glue#AuthenticationConfigurationInput": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.glue#AuthenticationType", + "traits": { + "smithy.api#documentation": "

A structure containing the authentication configuration in the CreateConnection request.

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

The secret manager ARN to store credentials in the CreateConnection request.

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

The properties for OAuth2 authentication in the CreateConnection request.

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

A structure containing the authentication configuration in the CreateConnection request.

" + } + }, + "com.amazonaws.glue#AuthenticationType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "OAUTH2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH2" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.glue#AuthorizationCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.glue#AuthorizationCodeProperties": { + "type": "structure", + "members": { + "AuthorizationCode": { + "target": "com.amazonaws.glue#AuthorizationCode", + "traits": { + "smithy.api#documentation": "

An authorization code to be used in the third leg of the AUTHORIZATION_CODE grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.

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

The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.

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

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.

" + } + }, "com.amazonaws.glue#BackfillError": { "type": "structure", "members": { @@ -6490,19 +6605,19 @@ "PhysicalConnectionRequirements": { "target": "com.amazonaws.glue#PhysicalConnectionRequirements", "traits": { - "smithy.api#documentation": "

A map of physical connection requirements, such as virtual private cloud (VPC) and\n SecurityGroup, that are needed to make this connection successfully.

" + "smithy.api#documentation": "

The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.

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

The time that this connection definition was created.

" + "smithy.api#documentation": "

The timestamp of the time that this connection definition was created.

" } }, "LastUpdatedTime": { "target": "com.amazonaws.glue#Timestamp", "traits": { - "smithy.api#documentation": "

The last time that this connection definition was updated.

" + "smithy.api#documentation": "

The timestamp of the last time the connection definition was updated.

" } }, "LastUpdatedBy": { @@ -6510,6 +6625,30 @@ "traits": { "smithy.api#documentation": "

The user, group, or role that last updated this connection definition.

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

The status of the connection. Can be one of: READY, IN_PROGRESS, or FAILED.

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

The reason for the connection status.

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

A timestamp of the time this connection was last validated.

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

The authentication properties of the connection.

" + } } }, "traits": { @@ -6522,7 +6661,7 @@ "Name": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the connection. Connection will not function as expected without a name.

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

The name of the connection.

", "smithy.api#required": {} } }, @@ -6535,7 +6674,7 @@ "ConnectionType": { "target": "com.amazonaws.glue#ConnectionType", "traits": { - "smithy.api#documentation": "

The type of the connection. Currently, these types are supported:

\n
    \n
  • \n

    \n JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).

    \n

    \n JDBC Connections use the following ConnectionParameters.

    \n
      \n
    • \n

      Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

      \n
    • \n
    • \n

      Required: All of (USERNAME, PASSWORD) or SECRET_ID.

      \n
    • \n
    • \n

      Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

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

    \n KAFKA - Designates a connection to an Apache Kafka streaming platform.

    \n

    \n KAFKA Connections use the following ConnectionParameters.

    \n
      \n
    • \n

      Required: KAFKA_BOOTSTRAP_SERVERS.

      \n
    • \n
    • \n

      Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.

      \n
    • \n
    • \n

      Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.

      \n
    • \n
    • \n

      Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.

      \n
    • \n
    • \n

      Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.

      \n
    • \n
    • \n

      Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.

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

    \n MONGODB - Designates a connection to a MongoDB document database.

    \n

    \n MONGODB Connections use the following ConnectionParameters.

    \n
      \n
    • \n

      Required: CONNECTION_URL.

      \n
    • \n
    • \n

      Required: All of (USERNAME, PASSWORD) or SECRET_ID.

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

    \n NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

    \n

    \n NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

    \n
  • \n
  • \n

    \n MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.

    \n

    \n MARKETPLACE Connections use the following ConnectionParameters.

    \n
      \n
    • \n

      Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

      \n
    • \n
    • \n

      Required for JDBC\n CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.

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

    \n CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.

    \n
  • \n
\n

\n SFTP is not supported.

\n

For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.

\n

For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

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

The type of the connection. Currently, these types are supported:

\n
    \n
  • \n

    \n JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).

    \n

    \n JDBC Connections use the following ConnectionParameters.

    \n
      \n
    • \n

      Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

      \n
    • \n
    • \n

      Required: All of (USERNAME, PASSWORD) or SECRET_ID.

      \n
    • \n
    • \n

      Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

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

    \n KAFKA - Designates a connection to an Apache Kafka streaming platform.

    \n

    \n KAFKA Connections use the following ConnectionParameters.

    \n
      \n
    • \n

      Required: KAFKA_BOOTSTRAP_SERVERS.

      \n
    • \n
    • \n

      Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.

      \n
    • \n
    • \n

      Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.

      \n
    • \n
    • \n

      Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.

      \n
    • \n
    • \n

      Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.

      \n
    • \n
    • \n

      Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.

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

    \n MONGODB - Designates a connection to a MongoDB document database.

    \n

    \n MONGODB Connections use the following ConnectionParameters.

    \n
      \n
    • \n

      Required: CONNECTION_URL.

      \n
    • \n
    • \n

      Required: All of (USERNAME, PASSWORD) or SECRET_ID.

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

    \n SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

    \n
      \n
    • \n

      Requires the AuthenticationConfiguration member to be configured.

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

    \n NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

    \n

    \n NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

    \n
  • \n
  • \n

    \n MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.

    \n

    \n MARKETPLACE Connections use the following ConnectionParameters.

    \n
      \n
    • \n

      Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

      \n
    • \n
    • \n

      Required for JDBC\n CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.

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

    \n CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.

    \n
  • \n
\n

\n SFTP is not supported.

\n

For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.

\n

For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

", "smithy.api#required": {} } }, @@ -6555,7 +6694,20 @@ "PhysicalConnectionRequirements": { "target": "com.amazonaws.glue#PhysicalConnectionRequirements", "traits": { - "smithy.api#documentation": "

A map of physical connection requirements, such as virtual private cloud (VPC) and\n SecurityGroup, that are needed to successfully make this connection.

" + "smithy.api#documentation": "

The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

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

The authentication properties of the connection. Used for a Salesforce connection.

" + } + }, + "ValidateCredentials": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.

" } } }, @@ -6863,6 +7015,35 @@ "traits": { "smithy.api#enumValue": "KAFKA_SASL_GSSAPI_PRINCIPAL" } + }, + "ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLE_ARN" + } + } + } + }, + "com.amazonaws.glue#ConnectionStatus": { + "type": "enum", + "members": { + "READY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READY" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } } } }, @@ -6910,6 +7091,12 @@ "traits": { "smithy.api#enumValue": "CUSTOM" } + }, + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } } } }, @@ -7847,7 +8034,14 @@ }, "com.amazonaws.glue#CreateConnectionResponse": { "type": "structure", - "members": {}, + "members": { + "CreateConnectionStatus": { + "target": "com.amazonaws.glue#ConnectionStatus", + "traits": { + "smithy.api#documentation": "

The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.

" + } + } + }, "traits": { "smithy.api#output": {} } @@ -8719,7 +8913,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours) for batch jobs.

\n

Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.

" } }, "MaxCapacity": { @@ -14413,6 +14607,30 @@ "com.amazonaws.glue#FederationSourceErrorCode": { "type": "enum", "members": { + "AccessDeniedException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDeniedException" + } + }, + "EntityNotFoundException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EntityNotFoundException" + } + }, + "InvalidCredentialsException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidCredentialsException" + } + }, + "InvalidInputException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidInputException" + } + }, "InvalidResponseException": { "target": "smithy.api#Unit", "traits": { @@ -14437,6 +14655,12 @@ "smithy.api#enumValue": "InternalServiceException" } }, + "PartialFailureException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PartialFailureException" + } + }, "ThrottlingException": { "target": "smithy.api#Unit", "traits": { @@ -21999,7 +22223,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours) for batch jobs.

\n

Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.

" } }, "MaxCapacity": { @@ -22343,7 +22567,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

\n

The maximum value for timeout for batch jobs is 7 days or 10080 minutes. The default is 2880 minutes (48 hours) for batch jobs.

\n

Any existing Glue jobs that have a greater timeout value are defaulted to 7 days. For instance you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.

\n

Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.

" + "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

\n

Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.

" } }, "MaxCapacity": { @@ -22559,7 +22783,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The job timeout in minutes. This is the maximum time that a job run\n can consume resources before it is terminated and enters TIMEOUT\n status. The default is 2,880 minutes (48 hours) for batch jobs.

\n

Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.

" } }, "MaxCapacity": { @@ -25014,6 +25238,15 @@ "smithy.api#default": 0 } }, + "com.amazonaws.glue#LongValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + } + } + }, "com.amazonaws.glue#MLTransform": { "type": "structure", "members": { @@ -25964,6 +26197,119 @@ "com.amazonaws.glue#NullableString": { "type": "string" }, + "com.amazonaws.glue#OAuth2ClientApplication": { + "type": "structure", + "members": { + "UserManagedClientApplicationClientId": { + "target": "com.amazonaws.glue#UserManagedClientApplicationClientId", + "traits": { + "smithy.api#documentation": "

The client application clientID if the ClientAppType is USER_MANAGED.

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

The reference to the SaaS-side client app that is Amazon Web Services managed.

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

The OAuth2 client app used for the connection.

" + } + }, + "com.amazonaws.glue#OAuth2GrantType": { + "type": "enum", + "members": { + "AUTHORIZATION_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHORIZATION_CODE" + } + }, + "CLIENT_CREDENTIALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_CREDENTIALS" + } + }, + "JWT_BEARER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JWT_BEARER" + } + } + } + }, + "com.amazonaws.glue#OAuth2Properties": { + "type": "structure", + "members": { + "OAuth2GrantType": { + "target": "com.amazonaws.glue#OAuth2GrantType", + "traits": { + "smithy.api#documentation": "

The OAuth2 grant type. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.

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

The client application type. For example, AWS_MANAGED or USER_MANAGED.

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

The URL of the provider's authentication server, to exchange an authorization code for an access token.

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

A map of parameters that are added to the token GET request.

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

A structure containing properties for OAuth2 authentication.

" + } + }, + "com.amazonaws.glue#OAuth2PropertiesInput": { + "type": "structure", + "members": { + "OAuth2GrantType": { + "target": "com.amazonaws.glue#OAuth2GrantType", + "traits": { + "smithy.api#documentation": "

The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE, JWT_BEARER, or CLIENT_CREDENTIALS.

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

The client application type in the CreateConnection request. For example, AWS_MANAGED or USER_MANAGED.

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

The URL of the provider's authentication server, to exchange an authorization code for an access token.

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

A map of parameters that are added to the token GET request.

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

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

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

A structure containing properties for OAuth2 in the CreateConnection request.

" + } + }, "com.amazonaws.glue#OneInput": { "type": "list", "member": { @@ -26847,12 +27193,12 @@ "AvailabilityZone": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The connection's Availability Zone. This field is redundant because the specified subnet\n implies the Availability Zone to be used. Currently the field must be populated, but it will\n be deprecated in the future.

" + "smithy.api#documentation": "

The connection's Availability Zone.

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

Specifies the physical requirements for a connection.

" + "smithy.api#documentation": "

The OAuth client app in GetConnection response.

" } }, "com.amazonaws.glue#PiiType": { @@ -27735,6 +28081,16 @@ "smithy.api#documentation": "

When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. For more information, see Incremental Crawls in Glue in the developer guide.

" } }, + "com.amazonaws.glue#RedirectUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^(https?):\\/\\/[^\\s/$.?#].[^\\s]*$" + } + }, "com.amazonaws.glue#RedshiftSource": { "type": "structure", "members": { @@ -30190,6 +30546,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.glue#SecretArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(-(cn|us-gov|iso(-[bef])?))?:secretsmanager:.*$" + } + }, "com.amazonaws.glue#SecurityConfiguration": { "type": "structure", "members": { @@ -31869,7 +32231,7 @@ "Timeout": { "target": "com.amazonaws.glue#Timeout", "traits": { - "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

\n

Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).

" + "smithy.api#documentation": "

The JobRun timeout in minutes. This is the maximum time that a job run can\n consume resources before it is terminated and enters TIMEOUT status. This value overrides the timeout value set in the parent job.

\n

Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.

" } }, "MaxCapacity": { @@ -33848,6 +34210,43 @@ "com.amazonaws.glue#Token": { "type": "string" }, + "com.amazonaws.glue#TokenUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" + } + }, + "com.amazonaws.glue#TokenUrlParameterKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.glue#TokenUrlParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.glue#TokenUrlParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#TokenUrlParameterKey" + }, + "value": { + "target": "com.amazonaws.glue#TokenUrlParameterValue" + } + }, "com.amazonaws.glue#Topk": { "type": "integer", "traits": { @@ -36685,6 +37084,16 @@ "target": "com.amazonaws.glue#UserDefinedFunction" } }, + "com.amazonaws.glue#UserManagedClientApplicationClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.glue#ValidationException": { "type": "structure", "members": { @@ -36853,7 +37262,7 @@ "ViewExpandedText": { "target": "com.amazonaws.glue#ViewTextString", "traits": { - "smithy.api#documentation": "

The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:

\n
    \n
  • \n

    Fully qualify identifiers: SELECT * from table1 → SELECT * from db1.table1\n

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

The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:

\n
    \n
  • \n

    Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1\n

    \n
  • \n
" } }, "IsStale": { diff --git a/codegen/sdk/aws-models/s3.json b/codegen/sdk/aws-models/s3.json index 7279b69e8f5..3b48bc38581 100644 --- a/codegen/sdk/aws-models/s3.json +++ b/codegen/sdk/aws-models/s3.json @@ -647,6 +647,11 @@ "documentation": "The S3 Prefix used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Prefix.", "type": "String" }, + "CopySource": { + "required": false, + "documentation": "The Copy Source used for Copy Object request. This is an optional parameter that will be set automatically for operations that are scoped to Copy Source.", + "type": "String" + }, "DisableAccessPoints": { "required": false, "documentation": "Internal parameter to disable Access Point Buckets", @@ -10663,6 +10668,33 @@ "Key": "key" } }, + { + "documentation": "virtual addressing, aws-global region with Copy Source, and Key uses the global endpoint. Copy Source and Key parameters should not be used in endpoint evaluation.", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "s3", + "signingRegion": "us-east-1", + "disableDoubleEncoding": true + } + ] + }, + "url": "https://bucket-name.s3.amazonaws.com" + } + }, + "params": { + "Region": "aws-global", + "Bucket": "bucket-name", + "UseFIPS": false, + "UseDualStack": false, + "Accelerate": false, + "CopySource": "/copy/source", + "Key": "key" + } + }, { "documentation": "virtual addressing, aws-global region with fips uses the regional fips endpoint", "expect": { @@ -18844,7 +18876,10 @@ "traits": { "smithy.api#documentation": "

Specifies the source object for the copy operation. The source object \n can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.

\n

You specify the value of the copy source in one of two\n formats, depending on whether you want to access the source object through an access point:

\n
    \n
  • \n

    For objects not accessed through an access point, specify the name of the source bucket\n and the key of the source object, separated by a slash (/). For example, to copy the\n object reports/january.pdf from the general purpose bucket \n awsexamplebucket, use awsexamplebucket/reports/january.pdf.\n The value must be URL-encoded. To copy the\n object reports/january.pdf from the directory bucket \n awsexamplebucket--use1-az5--x-s3, use awsexamplebucket--use1-az5--x-s3/reports/january.pdf.\n The value must be URL-encoded.

    \n
  • \n
  • \n

    For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:::accesspoint//object/. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    \n \n
      \n
    • \n

      Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.

      \n
    • \n
    • \n

      Access points are not supported by directory buckets.

      \n
    • \n
    \n
    \n

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:::outpost//object/. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

    \n
  • \n
\n

If your source bucket versioning is enabled, the x-amz-copy-source header by default identifies the current\n version of an object to copy. If the current version is a delete marker, Amazon S3\n behaves as if the object was deleted. To copy a different version, use the\n versionId query parameter. Specifically, append ?versionId=\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.

\n

If you enable versioning on the destination bucket, Amazon S3 generates a unique version\n ID for the copied object. This version ID is different from the version ID\n of the source object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.

\n

If you do not enable versioning or suspend it on the destination bucket, the version\n ID that Amazon S3 generates in the\n x-amz-version-id response header is always null.

\n \n

\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.

\n
", "smithy.api#httpHeader": "x-amz-copy-source", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "CopySource" + } } }, "CopySourceIfMatch": { @@ -18915,7 +18950,10 @@ "traits": { "smithy.api#documentation": "

The key of the destination object.

", "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "Key" + } } }, "Metadata": { @@ -30612,19 +30650,31 @@ "smithy.api#documentation": "

Adds an object to a bucket.

\n \n
    \n
  • \n

    Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.

    \n
  • \n
  • \n

    If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All\n objects written to the bucket by any account will be owned by the bucket owner.

    \n
  • \n
  • \n

    \n Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

    \n
  • \n
\n
\n

Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:

\n
    \n
  • \n

    \n S3 Object Lock - To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock in the Amazon S3 User Guide.

    \n \n

    This functionality is not supported for directory buckets.

    \n
    \n
  • \n
  • \n

    \n S3 Versioning - When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID\n of that object being stored in Amazon S3. \n You can retrieve, replace, or delete any version of the object. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets in the Amazon S3\n User Guide. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.

    \n \n

    This functionality is not supported for directory buckets.

    \n
    \n
  • \n
\n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The following permissions are required in your policies when your \n PutObject request includes specific headers.

    \n
      \n
    • \n

      \n \n s3:PutObject\n - To successfully complete the PutObject request, you must always have the s3:PutObject permission on a bucket to add an object\n to it.

      \n
    • \n
    • \n

      \n \n s3:PutObjectAcl\n - To successfully change the objects ACL of your PutObject request, you must have the s3:PutObjectAcl.

      \n
    • \n
    • \n

      \n \n s3:PutObjectTagging\n - To successfully set the tag-set with your PutObject request, you\n must have the s3:PutObjectTagging.

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

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
  • \n
\n
\n
Data integrity with Content-MD5
\n
\n
    \n
  • \n

    \n General purpose bucket - To ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, \n you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.

    \n
  • \n
  • \n

    \n Directory bucket - This functionality is not supported for directory buckets.

    \n
  • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n
\n
\n

For more information about related Amazon S3 APIs, see the following:

\n ", "smithy.api#examples": [ { - "title": "To upload object and specify user-defined metadata", - "documentation": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", + "title": "To upload an object and specify server-side encryption and object tags", + "documentation": "The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", "input": { "Body": "filetoupload", "Bucket": "examplebucket", "Key": "exampleobject", - "Metadata": { - "metadata1": "value1", - "metadata2": "value2" - } + "ServerSideEncryption": "AES256", + "Tagging": "key1=value1&key2=value2" }, "output": { - "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0", + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "ServerSideEncryption": "AES256" + } + }, + { + "title": "To create an object.", + "documentation": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "input": { + "Body": "filetoupload", + "Bucket": "examplebucket", + "Key": "objectkey" + }, + "output": { + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ", "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" } }, @@ -30659,28 +30709,19 @@ } }, { - "title": "To create an object.", - "documentation": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "title": "To upload object and specify user-defined metadata", + "documentation": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", "input": { "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "objectkey" - }, - "output": { - "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" - } - }, - { - "title": "To upload an object", - "documentation": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", - "input": { - "Body": "HappyFace.jpg", - "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "exampleobject", + "Metadata": { + "metadata1": "value1", + "metadata2": "value2" + } }, "output": { - "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk", + "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0", "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" } }, @@ -30699,19 +30740,16 @@ } }, { - "title": "To upload an object and specify server-side encryption and object tags", - "documentation": "The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "title": "To upload an object", + "documentation": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", "input": { - "Body": "filetoupload", + "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "exampleobject", - "ServerSideEncryption": "AES256", - "Tagging": "key1=value1&key2=value2" + "Key": "HappyFace.jpg" }, "output": { - "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256" + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"" } } ], From d24f764502250526304ea9c505b8e021577b2cb4 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 5 Jun 2024 18:05:56 +0000 Subject: [PATCH 27/41] feat: update AWS service endpoints metadata --- .../aws/sdk/kotlin/codegen/endpoints.json | 160 +++++++++++++++--- 1 file changed, 136 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 30c2ac8bca2..ddc93c85e14 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 @@ -2951,28 +2951,116 @@ }, "cloud9" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-northeast-3" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, - "il-central-1" : { }, - "me-south-1" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "af-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ca-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "il-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "me-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + } } }, "cloudcontrolapi" : { @@ -5249,8 +5337,18 @@ "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ap-southeast-4" : { }, - "ca-central-1" : { }, - "ca-west-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "directconnect-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-west-1" : { + "variants" : [ { + "hostname" : "directconnect-fips.ca-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -5259,6 +5357,20 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "directconnect-fips.ca-central-1.amazonaws.com" + }, + "fips-ca-west-1" : { + "credentialScope" : { + "region" : "ca-west-1" + }, + "deprecated" : true, + "hostname" : "directconnect-fips.ca-west-1.amazonaws.com" + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" From 363074f151679a8876f2fcff900e13ab135e6288 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 5 Jun 2024 18:08:46 +0000 Subject: [PATCH 28/41] chore: release 1.2.27 --- CHANGELOG.md | 7 +++++++ gradle.properties | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index aa462b926ec..2cbba8d5b2b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [1.2.27] - 06/05/2024 + +### Features +* (**globalaccelerator**) This release contains a new optional ip-addresses input field for the update accelerator and update custom routing accelerator apis. This input enables consumers to replace IPv4 addresses on existing accelerators with addresses provided in the input. +* (**glue**) AWS Glue now supports native SaaS connectivity: Salesforce connector available now +* (**s3**) Added new params copySource and key to copyObject API for supporting S3 Access Grants plugin. These changes will not change any of the existing S3 API functionality. + ## [1.2.26] - 06/04/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 47f8c832d37..88b7c5fd97e 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.2.27-SNAPSHOT +sdkVersion=1.2.27 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 5248fb0f57dd2575cf9098b5047a63dd591413ad Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Wed, 5 Jun 2024 18:08:48 +0000 Subject: [PATCH 29/41] chore: bump snapshot version to 1.2.28-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 88b7c5fd97e..0c0101a6852 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.2.27 +sdkVersion=1.2.28-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 884d191196a1c090962cde259b070e0b090f4313 Mon Sep 17 00:00:00 2001 From: Ian Botsford <83236726+ianbotsf@users.noreply.github.com> Date: Thu, 6 Jun 2024 08:25:00 -0700 Subject: [PATCH 30/41] fix: upgrade to latest smithy-kotlin version (#1323) --- gradle/libs.versions.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index f4b6760efa3..2c400dfe58a 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.2.5" -smithy-kotlin-codegen-version = "0.32.5" +smithy-kotlin-runtime-version = "1.2.6" +smithy-kotlin-codegen-version = "0.32.6" # codegen smithy-version = "1.47.0" From e9baa4631f779b0bd6c0da3c4f96980eecf4ee9e Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 6 Jun 2024 18:03:57 +0000 Subject: [PATCH 31/41] feat: update AWS API models --- codegen/sdk/aws-models/account.json | 310 ++++- codegen/sdk/aws-models/firehose.json | 137 ++- codegen/sdk/aws-models/fsx.json | 150 ++- codegen/sdk/aws-models/glue.json | 136 +++ codegen/sdk/aws-models/iot-wireless.json | 6 + codegen/sdk/aws-models/location.json | 1176 +++++++++++++++---- codegen/sdk/aws-models/sns.json | 12 +- codegen/sdk/aws-models/sqs.json | 14 +- codegen/sdk/aws-models/storage-gateway.json | 73 +- 9 files changed, 1727 insertions(+), 287 deletions(-) diff --git a/codegen/sdk/aws-models/account.json b/codegen/sdk/aws-models/account.json index c0b7f7b3eca..95a0177d57b 100644 --- a/codegen/sdk/aws-models/account.json +++ b/codegen/sdk/aws-models/account.json @@ -1,6 +1,86 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.account#AcceptPrimaryEmailUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#AcceptPrimaryEmailUpdateRequest" + }, + "output": { + "target": "com.amazonaws.account#AcceptPrimaryEmailUpdateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#ConflictException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known\n as the root user email address) for the specified account.

", + "smithy.api#http": { + "uri": "/acceptPrimaryEmailUpdate", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.account#AcceptPrimaryEmailUpdateRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n

This operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.

\n \n

The management account can't specify its own AccountId.

\n
", + "smithy.api#required": {} + } + }, + "PrimaryEmail": { + "target": "com.amazonaws.account#PrimaryEmailAddress", + "traits": { + "smithy.api#documentation": "

The new primary email address for use with the specified account. This must\n match the PrimaryEmail from the StartPrimaryEmailUpdate API\n call.

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

The OTP code sent to the PrimaryEmail specified on the\n StartPrimaryEmailUpdate API call.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#AcceptPrimaryEmailUpdateResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.account#PrimaryEmailUpdateStatus", + "traits": { + "smithy.api#documentation": "

Retrieves the status of the accepted primary email update request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.account#AccessDeniedException": { "type": "structure", "members": { @@ -27,6 +107,9 @@ { "target": "com.amazonaws.account#ContactInformationResource" }, + { + "target": "com.amazonaws.account#PrimaryEmailResource" + }, { "target": "com.amazonaws.account#RegionOptResource" } @@ -1016,7 +1099,7 @@ "StateOrRegion": { "target": "com.amazonaws.account#StateOrRegion", "traits": { - "smithy.api#documentation": "

The state or region of the primary contact address. This field is required in selected countries.

" + "smithy.api#documentation": "

The state or region of the primary contact address. If the mailing address is within the United States (US), the\n value in this field can be either a two character state code (for example, NJ) or the full state name\n (for example, New Jersey). This field is required in the following countries: US,\n CA, GB, DE, JP, IN,\n and BR.

" } }, "DistrictOrCounty": { @@ -1042,14 +1125,14 @@ "PhoneNumber": { "target": "com.amazonaws.account#ContactInformationPhoneNumber", "traits": { - "smithy.api#documentation": "

The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.

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

The phone number of the primary contact information. The number will be validated and,\n in some countries, checked for activation.

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

The name of the company associated with the primary contact information, if any.

" + "smithy.api#documentation": "

The name of the company associated with the primary contact information, if\n any.

" } }, "WebsiteUrl": { @@ -1060,7 +1143,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the details of the primary contact information associated with an Amazon Web Services account.

" + "smithy.api#documentation": "

Contains the details of the primary contact information associated with an\n Amazon Web Services account.

" } }, "com.amazonaws.account#ContactInformationPhoneNumber": { @@ -1180,7 +1263,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables (opts-out) a particular Region for an account.

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

Disables (opts-out) a particular Region for an account.

\n \n

The act of disabling a Region will remove all IAM access to any resources that\n reside in that Region.

\n
", "smithy.api#http": { "uri": "/disableRegion", "method": "POST", @@ -1194,13 +1277,13 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "

Specifies the Region-code for a given Region name (for example, af-south-1). When\n you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such\n as destroying IAM resources in the Region. This process takes a few minutes for most\n accounts, but this can take several hours. You cannot enable the Region until the\n disabling process is fully completed.

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

Specifies the Region-code for a given Region name (for example,\n af-south-1). When you disable a Region, Amazon Web Services performs actions to\n deactivate that Region in your account, such as destroying IAM resources in the Region.\n This process takes a few minutes for most accounts, but this can take several hours. You\n cannot enable the Region until the disabling process is fully completed.

", "smithy.api#required": {} } } @@ -1270,13 +1353,13 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "

Specifies the Region-code for a given Region name (for example, af-south-1). When\n you enable a Region, Amazon Web Services performs actions to prepare your account in that Region, such\n as distributing your IAM resources to the Region. This process takes a few minutes for\n most accounts, but it can take several hours. You cannot use the Region until this\n process is complete. Furthermore, you cannot disable the Region until the enabling\n process is fully completed.

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

Specifies the Region-code for a given Region name (for example,\n af-south-1). When you enable a Region, Amazon Web Services performs actions to\n prepare your account in that Region, such as distributing your IAM resources to the\n Region. This process takes a few minutes for most accounts, but it can take several\n hours. You cannot use the Region until this process is complete. Furthermore, you cannot\n disable the Region until the enabling process is fully completed.

", "smithy.api#required": {} } } @@ -1412,7 +1495,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" } } }, @@ -1426,7 +1509,74 @@ "ContactInformation": { "target": "com.amazonaws.account#ContactInformation", "traits": { - "smithy.api#documentation": "

Contains the details of the primary contact information associated with an Amazon Web Services account.

" + "smithy.api#documentation": "

Contains the details of the primary contact information associated with an\n Amazon Web Services account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.account#GetPrimaryEmail": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#GetPrimaryEmailRequest" + }, + "output": { + "target": "com.amazonaws.account#GetPrimaryEmailResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the primary email address for the specified account.

", + "smithy.api#http": { + "uri": "/getPrimaryEmail", + "method": "POST", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] + } + }, + "com.amazonaws.account#GetPrimaryEmailRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n

This operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.

\n \n

The management account can't specify its own AccountId.

\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#GetPrimaryEmailResponse": { + "type": "structure", + "members": { + "PrimaryEmail": { + "target": "com.amazonaws.account#PrimaryEmailAddress", + "traits": { + "smithy.api#documentation": "

Retrieves the primary email address associated with the specified\n account.

" } } }, @@ -1475,13 +1625,13 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" } }, "RegionName": { "target": "com.amazonaws.account#RegionName", "traits": { - "smithy.api#documentation": "

Specifies the Region-code for a given Region name (for example, af-south-1). This\n function will return the status of whatever Region you pass into this parameter.

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

Specifies the Region-code for a given Region name (for example,\n af-south-1). This function will return the status of whatever Region\n you pass into this parameter.

", "smithy.api#required": {} } } @@ -1574,7 +1724,7 @@ "AccountId": { "target": "com.amazonaws.account#AccountId", "traits": { - "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must\n have all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" } }, "MaxResults": { @@ -1637,6 +1787,13 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.account#Otp": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9]{6}$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.account#PhoneNumber": { "type": "string", "traits": { @@ -1658,6 +1815,50 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.account#PrimaryEmailAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.account#PrimaryEmailResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.account#AcceptPrimaryEmailUpdate" + }, + { + "target": "com.amazonaws.account#GetPrimaryEmail" + }, + { + "target": "com.amazonaws.account#StartPrimaryEmailUpdate" + } + ], + "traits": { + "aws.api#arn": { + "template": "PrimaryEmail" + } + } + }, + "com.amazonaws.account#PrimaryEmailUpdateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "ACCEPTED", + "name": "ACCEPTED" + } + ] + } + }, "com.amazonaws.account#PutAlternateContact": { "type": "operation", "input": { @@ -1762,7 +1963,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the primary contact information of an Amazon Web Services account.

\n

For complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.

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

Updates the primary contact information of an Amazon Web Services account.

\n

For complete details about how to use the primary contact operations, see Update\n the primary and alternate contact information.

", "smithy.api#http": { "uri": "/putContactInformation", "method": "POST", @@ -1777,14 +1978,14 @@ "ContactInformation": { "target": "com.amazonaws.account#ContactInformation", "traits": { - "smithy.api#documentation": "

Contains the details of the primary contact information associated with an Amazon Web Services account.

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

Contains the details of the primary contact information associated with an\n Amazon Web Services account.

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

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this parameter, the\n caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must also be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to\n the account whose contacts you wish to retrieve or modify.

" + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. If you don't specify this parameter, it defaults to the\n Amazon Web Services account of the identity used to call the operation. To use this\n parameter, the caller must be an identity in the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n \n

The management account can't specify its own AccountId. It must call\n the operation in standalone context by not including the AccountId\n parameter.

\n
\n

To call this operation on an account that is not a member of an organization, don't\n specify this parameter. Instead, call the operation using an identity belonging to the\n account whose contacts you wish to retrieve or modify.

" } } }, @@ -1804,7 +2005,7 @@ "RegionOptStatus": { "target": "com.amazonaws.account#RegionOptStatus", "traits": { - "smithy.api#documentation": "

One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling,\n Enabled_By_Default).

" + "smithy.api#documentation": "

One of potential statuses a Region can undergo (Enabled, Enabling, Disabled,\n Disabling, Enabled_By_Default).

" } } }, @@ -1904,6 +2105,79 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.account#StartPrimaryEmailUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.account#StartPrimaryEmailUpdateRequest" + }, + "output": { + "target": "com.amazonaws.account#StartPrimaryEmailUpdateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.account#AccessDeniedException" + }, + { + "target": "com.amazonaws.account#ConflictException" + }, + { + "target": "com.amazonaws.account#InternalServerException" + }, + { + "target": "com.amazonaws.account#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.account#TooManyRequestsException" + }, + { + "target": "com.amazonaws.account#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the process to update the primary email address for the specified\n account.

", + "smithy.api#http": { + "uri": "/startPrimaryEmailUpdate", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.account#StartPrimaryEmailUpdateRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.account#AccountId", + "traits": { + "smithy.api#documentation": "

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access\n or modify with this operation. To use this parameter, the caller must be an identity in\n the organization's\n management account or a delegated administrator account. The specified\n account ID must be a member account in the same organization. The organization must have\n all features\n enabled, and the organization must have trusted access enabled\n for the Account Management service, and optionally a delegated admin account\n assigned.

\n

This operation can only be called from the management account or the delegated\n administrator account of an organization for a member account.

\n \n

The management account can't specify its own AccountId.

\n
", + "smithy.api#required": {} + } + }, + "PrimaryEmail": { + "target": "com.amazonaws.account#PrimaryEmailAddress", + "traits": { + "smithy.api#documentation": "

The new primary email address (also known as the root user email address) to\n use in the specified account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.account#StartPrimaryEmailUpdateResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.account#PrimaryEmailUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the primary email update request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.account#StateOrRegion": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/firehose.json b/codegen/sdk/aws-models/firehose.json index 09628529c9f..b31afc12c01 100644 --- a/codegen/sdk/aws-models/firehose.json +++ b/codegen/sdk/aws-models/firehose.json @@ -2614,7 +2614,7 @@ "name": "firehose" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Data Firehose\n \n

Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.

\n
\n

Amazon Data Firehose is a fully managed service that delivers real-time\n streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon\n OpenSearch Service, Amazon Redshift, Splunk, and various other supportd\n destinations.

", + "smithy.api#documentation": "Amazon Data Firehose\n \n

Amazon Data Firehose was previously known as Amazon Kinesis Data Firehose.

\n
\n

Amazon Data Firehose is a fully managed service that delivers real-time streaming\n data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch\n Service, Amazon Redshift, Splunk, and various other supported destinations.

", "smithy.api#title": "Amazon Kinesis Firehose", "smithy.api#xmlNamespace": { "uri": "http://firehose.amazonaws.com/doc/2015-08-04" @@ -3834,7 +3834,7 @@ "RequestConfiguration": { "target": "com.amazonaws.firehose#HttpEndpointRequestConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of the requeste sent to the HTTP endpoint specified as the\n destination.

" + "smithy.api#documentation": "

The configuration of the request sent to the HTTP endpoint that is specified as the\n destination.

" } }, "ProcessingConfiguration": { @@ -3863,6 +3863,12 @@ "traits": { "smithy.api#required": {} } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for HTTP Endpoint destination.\n

" + } } }, "traits": { @@ -3916,6 +3922,12 @@ }, "S3DestinationDescription": { "target": "com.amazonaws.firehose#S3DestinationDescription" + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for HTTP Endpoint destination.\n

" + } } }, "traits": { @@ -3969,6 +3981,12 @@ }, "S3Update": { "target": "com.amazonaws.firehose#S3DestinationUpdate" + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for HTTP Endpoint destination.\n

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

A serializer to use for converting data to the Parquet format before storing it in\n Amazon S3. For more information, see Apache Parquet.

" + "smithy.api#documentation": "

A serializer to use for converting data to the Parquet format before storing it in\n Amazon S3. For more information, see Apache Parquet.

" } }, "com.amazonaws.firehose#ParquetWriterVersion": { @@ -5267,15 +5285,13 @@ "Username": { "target": "com.amazonaws.firehose#Username", "traits": { - "smithy.api#documentation": "

The name of the user.

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

The name of the user.

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

The user password.

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

The user password.

" } }, "RetryOptions": { @@ -5314,6 +5330,12 @@ "traits": { "smithy.api#documentation": "

The CloudWatch logging options for your delivery stream.

" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for Amazon Redshift.\n

" + } } }, "traits": { @@ -5347,8 +5369,7 @@ "Username": { "target": "com.amazonaws.firehose#Username", "traits": { - "smithy.api#documentation": "

The name of the user.

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

The name of the user.

" } }, "RetryOptions": { @@ -5387,6 +5408,12 @@ "traits": { "smithy.api#documentation": "

The Amazon CloudWatch logging options for your delivery stream.

" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for Amazon Redshift.\n

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

The Amazon CloudWatch logging options for your delivery stream.

" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for Amazon Redshift.\n

" + } } }, "traits": { @@ -5806,6 +5839,43 @@ "smithy.api#documentation": "

Specifies the schema to which you want Firehose to configure your data\n before it writes it to Amazon S3. This parameter is required if Enabled is set\n to true.

" } }, + "com.amazonaws.firehose#SecretARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:" + } + }, + "com.amazonaws.firehose#SecretsManagerConfiguration": { + "type": "structure", + "members": { + "SecretARN": { + "target": "com.amazonaws.firehose#SecretARN", + "traits": { + "smithy.api#documentation": "

The ARN of the secret that stores your credentials. It must be in the same region as the\n Firehose stream and the role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True.

" + } + }, + "RoleARN": { + "target": "com.amazonaws.firehose#RoleARN", + "traits": { + "smithy.api#documentation": "

\n Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.\n

" + } + }, + "Enabled": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Specifies whether you want to use the the secrets manager feature. When set as\n True the secrets manager configuration overwrites the existing secrets in\n the destination configuration. When it's set to False Firehose falls back to\n the credentials in the destination configuration.

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

The structure that defines how Firehose accesses the secret.

" + } + }, "com.amazonaws.firehose#SecurityGroupIdList": { "type": "list", "member": { @@ -5930,8 +6000,7 @@ "PrivateKey": { "target": "com.amazonaws.firehose#SnowflakePrivateKey", "traits": { - "smithy.api#documentation": "

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

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

The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.

" } }, "KeyPassphrase": { @@ -5943,8 +6012,7 @@ "User": { "target": "com.amazonaws.firehose#SnowflakeUser", "traits": { - "smithy.api#documentation": "

User login name for the Snowflake account.

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

User login name for the Snowflake account.

" } }, "Database": { @@ -6028,6 +6096,12 @@ "traits": { "smithy.api#required": {} } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for Snowflake.\n

" + } } }, "traits": { @@ -6123,6 +6197,12 @@ }, "S3DestinationDescription": { "target": "com.amazonaws.firehose#S3DestinationDescription" + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for Snowflake.\n

" + } } }, "traits": { @@ -6224,6 +6304,12 @@ }, "S3Update": { "target": "com.amazonaws.firehose#S3DestinationUpdate" + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n Describes the Secrets Manager configuration in Snowflake.\n

" + } } }, "traits": { @@ -6465,8 +6551,7 @@ "HECToken": { "target": "com.amazonaws.firehose#HECToken", "traits": { - "smithy.api#documentation": "

This is a GUID that you obtain from your Splunk cluster when you create a new HEC\n endpoint.

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

This is a GUID that you obtain from your Splunk cluster when you create a new HEC\n endpoint.

" } }, "HECAcknowledgmentTimeoutInSeconds": { @@ -6511,6 +6596,12 @@ "traits": { "smithy.api#documentation": "

The buffering options. If no value is specified, the default values for Splunk are used.

" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for Splunk.\n

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

The buffering options. If no value is specified, the default values for Splunk are used.

" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for Splunk.\n

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

The buffering options. If no value is specified, the default values for Splunk are used.

" } + }, + "SecretsManagerConfiguration": { + "target": "com.amazonaws.firehose#SecretsManagerConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration that defines how you access secrets for Splunk.\n

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

Enables server-side encryption (SSE) for the delivery stream.

\n

This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then\n to ENABLED. The encryption status of a delivery stream is the\n Status property in DeliveryStreamEncryptionConfiguration.\n If the operation fails, the encryption status changes to ENABLING_FAILED. You\n can continue to read and write data to your delivery stream while the encryption status is\n ENABLING, but the data is not encrypted. It can take up to 5 seconds after\n the encryption status changes to ENABLED before all records written to the\n delivery stream are encrypted. To find out whether a record or a batch of records was\n encrypted, check the response elements PutRecordOutput$Encrypted and\n PutRecordBatchOutput$Encrypted, respectively.

\n

To check the encryption status of a delivery stream, use DescribeDeliveryStream.

\n

Even if encryption is currently enabled for a delivery stream, you can still invoke this\n operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this\n method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK,\n Firehose schedules the grant it had on the old CMK for retirement. If the new\n CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant\n that enables it to use the new CMK to encrypt and decrypt data and to manage the\n grant.

\n

For the KMS grant creation to be successful, Firehose APIs StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old.

\n

If a delivery stream already has encryption enabled and then you invoke this operation\n to change the ARN of the CMK or both its type and ARN and you get\n ENABLING_FAILED, this only means that the attempt to change the CMK failed.\n In this case, encryption remains enabled with the old CMK.

\n

If the encryption status of your delivery stream is ENABLING_FAILED, you\n can invoke this operation again with a valid CMK. The CMK must be enabled and the key\n policy mustn't explicitly deny the permission for Firehose to invoke KMS\n encrypt and decrypt operations.

\n

You can enable SSE for a delivery stream only if it's a delivery stream that uses\n DirectPut as its source.

\n

The StartDeliveryStreamEncryption and\n StopDeliveryStreamEncryption operations have a combined limit of 25 calls\n per delivery stream per 24 hours. For example, you reach the limit if you call\n StartDeliveryStreamEncryption 13 times and\n StopDeliveryStreamEncryption 12 times for the same delivery stream in a\n 24-hour period.

" + "smithy.api#documentation": "

Enables server-side encryption (SSE) for the delivery stream.

\n

This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then\n to ENABLED. The encryption status of a delivery stream is the\n Status property in DeliveryStreamEncryptionConfiguration.\n If the operation fails, the encryption status changes to ENABLING_FAILED. You\n can continue to read and write data to your delivery stream while the encryption status is\n ENABLING, but the data is not encrypted. It can take up to 5 seconds after\n the encryption status changes to ENABLED before all records written to the\n delivery stream are encrypted. To find out whether a record or a batch of records was\n encrypted, check the response elements PutRecordOutput$Encrypted and\n PutRecordBatchOutput$Encrypted, respectively.

\n

To check the encryption status of a delivery stream, use DescribeDeliveryStream.

\n

Even if encryption is currently enabled for a delivery stream, you can still invoke this\n operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this\n method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK,\n Firehose schedules the grant it had on the old CMK for retirement. If the new\n CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant\n that enables it to use the new CMK to encrypt and decrypt data and to manage the\n grant.

\n

For the KMS grant creation to be successful, the Firehose API operations\n StartDeliveryStreamEncryption and CreateDeliveryStream should\n not be called with session credentials that are more than 6 hours old.

\n

If a delivery stream already has encryption enabled and then you invoke this operation\n to change the ARN of the CMK or both its type and ARN and you get\n ENABLING_FAILED, this only means that the attempt to change the CMK failed.\n In this case, encryption remains enabled with the old CMK.

\n

If the encryption status of your delivery stream is ENABLING_FAILED, you\n can invoke this operation again with a valid CMK. The CMK must be enabled and the key\n policy mustn't explicitly deny the permission for Firehose to invoke KMS\n encrypt and decrypt operations.

\n

You can enable SSE for a delivery stream only if it's a delivery stream that uses\n DirectPut as its source.

\n

The StartDeliveryStreamEncryption and\n StopDeliveryStreamEncryption operations have a combined limit of 25 calls\n per delivery stream per 24 hours. For example, you reach the limit if you call\n StartDeliveryStreamEncryption 13 times and\n StopDeliveryStreamEncryption 12 times for the same delivery stream in a\n 24-hour period.

" } }, "com.amazonaws.firehose#StartDeliveryStreamEncryptionInput": { @@ -7100,7 +7203,7 @@ "SnowflakeDestinationUpdate": { "target": "com.amazonaws.firehose#SnowflakeDestinationUpdate", "traits": { - "smithy.api#documentation": "

Update to the Snowflake destination condiguration settings

" + "smithy.api#documentation": "

Update to the Snowflake destination configuration settings.

" } } }, diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index 42c5e7570be..29023e09dd0 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -3013,7 +3013,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new, empty Amazon FSx file system. You can create the following supported \n Amazon FSx file systems using the CreateFileSystem API operation:

\n
    \n
  • \n

    Amazon FSx for Lustre

    \n
  • \n
  • \n

    Amazon FSx for NetApp ONTAP

    \n
  • \n
  • \n

    Amazon FSx for OpenZFS

    \n
  • \n
  • \n

    Amazon FSx for Windows File Server

    \n
  • \n
\n

This operation requires a client request token in the request that Amazon FSx uses\n to ensure idempotent creation. This means that calling the operation multiple times with\n the same client request token has no effect. By using the idempotent operation, you can\n retry a CreateFileSystem operation without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.

\n

If a file system with the specified client request token exists and the parameters\n match, CreateFileSystem returns the description of the existing file\n system. If a file system with the specified client request token exists and the\n parameters don't match, this call returns IncompatibleParameterError. If a\n file system with the specified client request token doesn't exist,\n CreateFileSystem does the following:

\n
    \n
  • \n

    Creates a new, empty Amazon FSx file system with an assigned ID, and\n an initial lifecycle state of CREATING.

    \n
  • \n
  • \n

    Returns the description of the file system in JSON format.

    \n
  • \n
\n \n

The CreateFileSystem call returns while the file system's lifecycle\n state is still CREATING. You can check the file-system creation status\n by calling the DescribeFileSystems operation, which returns the file system state\n along with other information.

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

Creates a new, empty Amazon FSx file system. You can create the following supported \n Amazon FSx file systems using the CreateFileSystem API operation:

\n
    \n
  • \n

    Amazon FSx for Lustre

    \n
  • \n
  • \n

    Amazon FSx for NetApp ONTAP

    \n
  • \n
  • \n

    Amazon FSx for OpenZFS

    \n
  • \n
  • \n

    Amazon FSx for Windows File Server

    \n
  • \n
\n

This operation requires a client request token in the request that Amazon FSx uses\n to ensure idempotent creation. This means that calling the operation multiple times with\n the same client request token has no effect. By using the idempotent operation, you can\n retry a CreateFileSystem operation without the risk of creating an extra\n file system. This approach can be useful when an initial call fails in a way that makes\n it unclear whether a file system was created. Examples are if a transport level timeout\n occurred, or your connection was reset. If you use the same client request token and the\n initial call created a file system, the client receives success as long as the\n parameters are the same.

\n

If a file system with the specified client request token exists and the parameters\n match, CreateFileSystem returns the description of the existing file\n system. If a file system with the specified client request token exists and the\n parameters don't match, this call returns IncompatibleParameterError. If a\n file system with the specified client request token doesn't exist,\n CreateFileSystem does the following:

\n
    \n
  • \n

    Creates a new, empty Amazon FSx file system with an assigned ID, and\n an initial lifecycle state of CREATING.

    \n
  • \n
  • \n

    Returns the description of the file system in JSON format.

    \n
  • \n
\n \n

The CreateFileSystem call returns while the file system's lifecycle\n state is still CREATING. You can check the file-system creation status\n by calling the DescribeFileSystems operation, which returns the file system state\n along with other information.

\n
" } }, "com.amazonaws.fsx#CreateFileSystemFromBackup": { @@ -3181,7 +3181,7 @@ "DeploymentType": { "target": "com.amazonaws.fsx#LustreDeploymentType", "traits": { - "smithy.api#documentation": "

(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.

\n

Choose PERSISTENT_1 for longer-term storage and for throughput-focused \n workloads that aren’t latency-sensitive.\n PERSISTENT_1 supports encryption of data in transit, and is available in all \n Amazon Web Services Regions in which FSx for Lustre is available.

\n

Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads \n that require the highest levels of IOPS/throughput. PERSISTENT_2 supports \n SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 \n is available in a limited number of Amazon Web Services Regions. \n For more information, and an up-to-date list of Amazon Web Services Regions in which \n PERSISTENT_2 is available, see \n File \n system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.

\n \n

If you choose PERSISTENT_2, and you set FileSystemTypeVersion to\n 2.10, the CreateFileSystem operation fails.

\n
\n

Encryption of data in transit is automatically turned on when you access\n SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 file\n systems from Amazon EC2 instances that support automatic encryption in\n the Amazon Web Services Regions where they are available. For more information about\n encryption in transit for FSx for Lustre file systems, see Encrypting data in\n transit in the Amazon FSx for Lustre User Guide.

\n

(Default = SCRATCH_1)

" + "smithy.api#documentation": "

(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.

\n

Choose PERSISTENT_1 for longer-term storage and for throughput-focused \n workloads that aren’t latency-sensitive.\n PERSISTENT_1 supports encryption of data in transit, and is available in all \n Amazon Web Services Regions in which FSx for Lustre is available.

\n

Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads \n that require the highest levels of IOPS/throughput. PERSISTENT_2 supports \n SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB).\n You can optionally specify a metadata configuration mode for PERSISTENT_2\n which supports increasing metadata performance. PERSISTENT_2 is available\n in a limited number of Amazon Web Services Regions. For more information, and an up-to-date\n list of Amazon Web Services Regions in which PERSISTENT_2 is available, see \n File \n system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.

\n \n

If you choose PERSISTENT_2, and you set FileSystemTypeVersion to\n 2.10, the CreateFileSystem operation fails.

\n
\n

Encryption of data in transit is automatically turned on when you access\n SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 file\n systems from Amazon EC2 instances that support automatic encryption in\n the Amazon Web Services Regions where they are available. For more information about\n encryption in transit for FSx for Lustre file systems, see Encrypting data in\n transit in the Amazon FSx for Lustre User Guide.

\n

(Default = SCRATCH_1)

" } }, "AutoImportPolicy": { @@ -3234,12 +3234,40 @@ "traits": { "smithy.api#documentation": "

The Lustre root squash configuration used when creating an Amazon FSx for Lustre\n file system. When enabled, root squash restricts root-level access from clients that\n try to access your file system as a root user.

" } + }, + "MetadataConfiguration": { + "target": "com.amazonaws.fsx#CreateFileSystemLustreMetadataConfiguration", + "traits": { + "smithy.api#documentation": "

The Lustre metadata performance configuration for the creation of an\n FSx for Lustre file system using a PERSISTENT_2\n deployment type.

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

The Lustre configuration for the file system being created.

\n \n

The following parameters are not supported for file systems\n with a data repository association created with\n .

\n
    \n
  • \n

    \n AutoImportPolicy\n

    \n
  • \n
  • \n

    \n ExportPath\n

    \n
  • \n
  • \n

    \n ImportedFileChunkSize\n

    \n
  • \n
  • \n

    \n ImportPath\n

    \n
  • \n
\n
" } }, + "com.amazonaws.fsx#CreateFileSystemLustreMetadataConfiguration": { + "type": "structure", + "members": { + "Iops": { + "target": "com.amazonaws.fsx#MetadataIops", + "traits": { + "smithy.api#documentation": "

(USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision\n for the file system. This parameter sets the maximum rate of metadata disk IOPS\n supported by the file system. Valid values are 1500, 3000,\n 6000, 12000, and multiples of 12000\n up to a maximum of 192000.

\n \n

Iops doesn’t have a default value. If you're using USER_PROVISIONED mode,\n you can choose to specify a valid value. If you're using AUTOMATIC mode,\n you cannot specify a value because FSx for Lustre automatically sets\n the value based on your file system storage capacity.\n

\n
" + } + }, + "Mode": { + "target": "com.amazonaws.fsx#MetadataConfigurationMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metadata configuration mode for provisioning Metadata IOPS for\n an FSx for Lustre file system using a PERSISTENT_2\n deployment type.

\n
    \n
  • \n

    In AUTOMATIC mode, FSx for Lustre automatically\n provisions and scales the number of Metadata IOPS for your file system\n based on your file system storage capacity.

    \n
  • \n
  • \n

    In USER_PROVISIONED mode, you specify the number of Metadata\n IOPS to provision for your file system.

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

The Lustre metadata performance configuration for the creation of an\n Amazon FSx for Lustre file system using a PERSISTENT_2\n deployment type. The configuration uses a Metadata IOPS value to set the\n maximum rate of metadata disk IOPS supported by the file system.

\n

After creation, the file system supports increasing metadata performance.\n For more information on Metadata IOPS, see Lustre\n metadata performance configuration in the Amazon FSx for Lustre User Guide.

" + } + }, "com.amazonaws.fsx#CreateFileSystemOntapConfiguration": { "type": "structure", "members": { @@ -3299,7 +3327,7 @@ "HAPairs": { "target": "com.amazonaws.fsx#HAPairs", "traits": { - "smithy.api#documentation": "

Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. \n FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide.

\n

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

\n
    \n
  • \n

    The value of HAPairs is less than 1 or greater than 12.

    \n
  • \n
  • \n

    The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.

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

Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. \n FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide.

\n

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

\n
    \n
  • \n

    The value of HAPairs is less than 1 or greater than 12.

    \n
  • \n
  • \n

    The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.

    \n
  • \n
" } }, "ThroughputCapacityPerHAPair": { @@ -3407,14 +3435,14 @@ "target": "com.amazonaws.fsx#StorageCapacity", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).

\n

\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType and the Lustre DeploymentType, as\n follows:

\n
    \n
  • \n

    For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

    \n
  • \n
  • \n

    For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.

    \n
  • \n
  • \n

    For SCRATCH_1 deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.

    \n
  • \n
\n

\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.

\n

\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).

\n

\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType as follows:

\n
    \n
  • \n

    For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).

    \n
  • \n
  • \n

    For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).

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

Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).

\n

\n FSx for Lustre file systems - The amount of\n storage capacity that you can configure depends on the value that you set for\n StorageType and the Lustre DeploymentType, as\n follows:

\n
    \n
  • \n

    For SCRATCH_2, PERSISTENT_2, and PERSISTENT_1 deployment types \n using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

    \n
  • \n
  • \n

    For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for \n 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.

    \n
  • \n
  • \n

    For SCRATCH_1 deployment type, valid values are \n 1200 GiB, 2400 GiB, and increments of 3600 GiB.

    \n
  • \n
\n

\n FSx for ONTAP file systems - The amount of storage capacity \n that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.

\n

\n FSx for OpenZFS file systems - The amount of storage capacity that \n you can configure is from 64 GiB up to 524,288 GiB (512 TiB).

\n

\n FSx for Windows File Server file systems - The amount\n of storage capacity that you can configure depends on the value that you set for\n StorageType as follows:

\n
    \n
  • \n

    For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).

    \n
  • \n
  • \n

    For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).

    \n
  • \n
", "smithy.api#required": {} } }, "StorageType": { "target": "com.amazonaws.fsx#StorageType", "traits": { - "smithy.api#documentation": "

Sets the storage type for the file system that you're creating. Valid values are\n SSD and HDD.

\n
    \n
  • \n

    Set to SSD to use solid state drive storage. SSD is supported on all Windows,\n Lustre, ONTAP, and OpenZFS deployment types.

    \n
  • \n
  • \n

    Set to HDD to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types,\n and on PERSISTENT_1 Lustre file system deployment types. \n

    \n
  • \n
\n

Default value is SSD. For more information, see Storage\n type options in the FSx for Windows File Server User\n Guide and Multiple storage\n options in the FSx for Lustre User\n Guide.

" + "smithy.api#documentation": "

Sets the storage type for the file system that you're creating. Valid values are\n SSD and HDD.

\n
    \n
  • \n

    Set to SSD to use solid state drive storage. SSD is supported on all Windows,\n Lustre, ONTAP, and OpenZFS deployment types.

    \n
  • \n
  • \n

    Set to HDD to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types,\n and on PERSISTENT_1 Lustre file system deployment types.

    \n
  • \n
\n

Default value is SSD. For more information, see Storage\n type options in the FSx for Windows File Server User\n Guide and Multiple storage\n options in the FSx for Lustre User\n Guide.

" } }, "SubnetIds": { @@ -3455,7 +3483,7 @@ "FileSystemTypeVersion": { "target": "com.amazonaws.fsx#FileSystemTypeVersion", "traits": { - "smithy.api#documentation": "

(Optional) For FSx for Lustre file systems, sets the Lustre version\n for the file system that you're creating. Valid values are 2.10, \n 2.12, and 2.15:

\n
    \n
  • \n

    2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.

    \n
  • \n
  • \n

    2.12 and 2.15 are supported by all Lustre deployment types. 2.12\n or 2.15 is required when setting FSx for Lustre DeploymentType\n to PERSISTENT_2.

    \n
  • \n
\n

Default value = 2.10, except when DeploymentType is set to \n PERSISTENT_2, then the default is 2.12.

\n \n

If you set FileSystemTypeVersion to 2.10 for a \n PERSISTENT_2 Lustre deployment type, the CreateFileSystem \n operation fails.

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

For FSx for Lustre file systems, sets the Lustre version for the file system\n that you're creating. Valid values are 2.10, 2.12, and\n 2.15:

\n
    \n
  • \n

    \n 2.10 is supported by the Scratch and Persistent_1 Lustre \n deployment types.

    \n
  • \n
  • \n

    \n 2.12 is supported by all Lustre deployment types, except\n for PERSISTENT_2 with a metadata configuration mode.

    \n
  • \n
  • \n

    \n 2.15 is supported by all Lustre deployment types and is\n recommended for all new file systems.

    \n
  • \n
\n

Default value is 2.10, except for the following deployments:

\n
    \n
  • \n

    Default value is 2.12 when DeploymentType is set to \n PERSISTENT_2 without a metadata configuration mode.

    \n
  • \n
  • \n

    Default value is 2.15 when DeploymentType is set to \n PERSISTENT_2 with a metadata configuration mode.

    \n
  • \n
" } }, "OpenZFSConfiguration": { @@ -3576,7 +3604,7 @@ "SecurityStyle": { "target": "com.amazonaws.fsx#SecurityStyle", "traits": { - "smithy.api#documentation": "

Specifies the security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. The security style determines the type of permissions \n that FSx for ONTAP uses to control data access. For more information, see \n Volume security style \n in the Amazon FSx for NetApp ONTAP User Guide.\n Specify one of the following values:

\n
    \n
  • \n

    \n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n

    \n
  • \n
  • \n

    \n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.

    \n
  • \n
  • \n

    \n MIXED This is an advanced setting. For more information, see the topic \n What the security styles and their effects are \n in the NetApp Documentation Center.

    \n
  • \n
\n

For more information, see Volume security style in the \n FSx for ONTAP User Guide.

" + "smithy.api#documentation": "

Specifies the security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. The security style determines the type of permissions \n that FSx for ONTAP uses to control data access. Specify one of the following values:

\n
    \n
  • \n

    \n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.\n

    \n
  • \n
  • \n

    \n NTFS if the file system is managed by a Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Windows user as the service account.

    \n
  • \n
  • \n

    \n MIXED This is an advanced setting. For more information, see the topic \n What the security styles and their effects are \n in the NetApp Documentation Center.

    \n
  • \n
\n

For more information, see Volume security style in the \n FSx for ONTAP User Guide.

" } }, "SizeInMegabytes": { @@ -3608,7 +3636,7 @@ "OntapVolumeType": { "target": "com.amazonaws.fsx#InputOntapVolumeType", "traits": { - "smithy.api#documentation": "

Specifies the type of volume you are creating. Valid values are the following:

\n
    \n
  • \n

    \n RW specifies a read/write volume. RW is the default.

    \n
  • \n
  • \n

    \n DP specifies a data-protection volume. A DP volume\n is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    \n
  • \n
\n

For more information, see Volume types \n in the Amazon FSx for NetApp ONTAP User Guide.

" + "smithy.api#documentation": "

Specifies the type of volume you are creating. Valid values are the following:

\n
    \n
  • \n

    \n RW specifies a read/write volume. RW is the default.

    \n
  • \n
  • \n

    \n DP specifies a data-protection volume. A DP volume\n is read-only and can be used as the destination of a NetApp SnapMirror relationship.

    \n
  • \n
\n

For more information, see Volume types \n in the Amazon FSx for NetApp ONTAP User Guide.

" } }, "SnapshotPolicy": { @@ -3632,7 +3660,7 @@ "VolumeStyle": { "target": "com.amazonaws.fsx#VolumeStyle", "traits": { - "smithy.api#documentation": "

Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, \n FlexVol and FlexGroup volumes. For more information, see \n Volume styles in the Amazon FSx for NetApp ONTAP User Guide.

" + "smithy.api#documentation": "

Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, \n FlexVol and FlexGroup volumes. For more information, see \n Volume styles in the Amazon FSx for NetApp ONTAP User Guide.

" } }, "AggregateConfiguration": { @@ -3942,7 +3970,7 @@ "RootVolumeSecurityStyle": { "target": "com.amazonaws.fsx#StorageVirtualMachineRootVolumeSecurityStyle", "traits": { - "smithy.api#documentation": "

The security style of the root volume of the SVM. Specify one of the following values:

\n
    \n
  • \n

    \n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.

    \n
  • \n
  • \n

    \n NTFS if the file system is managed by a Microsoft Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Microsoft Windows user as the service account.

    \n
  • \n
  • \n

    \n MIXED This is an advanced setting. For more information, see \n Volume security style in the Amazon FSx for NetApp ONTAP User Guide.

    \n
  • \n
\n

" + "smithy.api#documentation": "

The security style of the root volume of the SVM. Specify one of the following values:

\n
    \n
  • \n

    \n UNIX if the file system is managed by a UNIX\n administrator, the majority of users are NFS clients, and an application\n accessing the data uses a UNIX user as the service account.

    \n
  • \n
  • \n

    \n NTFS if the file system is managed by a Microsoft Windows\n administrator, the majority of users are SMB clients, and an application\n accessing the data uses a Microsoft Windows user as the service account.

    \n
  • \n
  • \n

    \n MIXED This is an advanced setting. For more information, see \n Volume security style\n in the Amazon FSx for NetApp ONTAP User Guide.

    \n
  • \n
\n

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

Deletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.

\n

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleFileSystem operation.

\n

By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.

\n

To delete an Amazon FSx for Lustre file system, first \n unmount\n it from every connected Amazon EC2 instance, then provide a FileSystemId\n value to the DeleFileSystem operation. By default, Amazon FSx will not\n take a final backup when the DeleteFileSystem operation is invoked. On file systems\n not linked to an Amazon S3 bucket, set SkipFinalBackup to false\n to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked\n file systems. To ensure all of your data is written back to S3 before deleting your file system,\n you can either monitor for the\n AgeOfOldestQueuedMessage\n metric to be zero (if using automatic export) or you can run an\n export data repository task.\n If you have automatic export enabled and want to use an export data repository task, you have\n to disable automatic export before executing the export data repository task.

\n

The DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.

\n \n

If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).

\n
\n \n

The data in a deleted file system is also deleted and can't be recovered by\n any means.

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

Deletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.

\n

To delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleteFileSystem operation.

\n

By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.

\n

To delete an Amazon FSx for Lustre file system, first \n unmount\n it from every connected Amazon EC2 instance, then provide a FileSystemId\n value to the DeleteFileSystem operation. By default, Amazon FSx will not\n take a final backup when the DeleteFileSystem operation is invoked. On file systems\n not linked to an Amazon S3 bucket, set SkipFinalBackup to false\n to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked\n file systems. To ensure all of your data is written back to S3 before deleting your file system,\n you can either monitor for the\n AgeOfOldestQueuedMessage\n metric to be zero (if using automatic export) or you can run an\n export data repository task.\n If you have automatic export enabled and want to use an export data repository task, you have\n to disable automatic export before executing the export data repository task.

\n

The DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.

\n \n

If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).

\n
\n \n

The data in a deleted file system is also deleted and can't be recovered by\n any means.

\n
", "smithy.api#examples": [ { "title": "To delete a file system", @@ -6783,7 +6811,7 @@ "target": "com.amazonaws.fsx#ArchivePath", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:

\n
    \n
  • \n

    The path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:

    \n
      \n
    • \n

      If you are not using the DataRepositorySubdirectories\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nsf://nfs-domain-name/exportpath. You can therefore\n link a single NFS Export to a single data repository association.

      \n
    • \n
    • \n

      If you are using the DataRepositorySubdirectories\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories\n parameter.

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

    The path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/.

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

The path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:

\n
    \n
  • \n

    The path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:

    \n
      \n
    • \n

      If you are not using the DataRepositorySubdirectories\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nfs://nfs-domain-name/exportpath. You can therefore\n link a single NFS Export to a single data repository association.

      \n
    • \n
    • \n

      If you are using the DataRepositorySubdirectories\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories\n parameter.

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

    The path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -7263,6 +7291,28 @@ "smithy.api#documentation": "

The lifecycle status of the file system.

" } }, + "com.amazonaws.fsx#FileSystemLustreMetadataConfiguration": { + "type": "structure", + "members": { + "Iops": { + "target": "com.amazonaws.fsx#MetadataIops", + "traits": { + "smithy.api#documentation": "

The number of Metadata IOPS provisioned for the file system. Valid values\n are 1500, 3000, 6000, 12000,\n and multiples of 12000 up to a maximum of 192000.

" + } + }, + "Mode": { + "target": "com.amazonaws.fsx#MetadataConfigurationMode", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The metadata configuration mode for provisioning Metadata IOPS for the\n file system.

\n
    \n
  • \n

    In AUTOMATIC mode, FSx for Lustre automatically\n provisions and scales the number of Metadata IOPS on your file system based\n on your file system storage capacity.

    \n
  • \n
  • \n

    In USER_PROVISIONED mode, you can choose to specify the number\n of Metadata IOPS to provision for your file system.

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

The Lustre metadata performance configuration of an Amazon FSx for Lustre\n file system using a PERSISTENT_2 deployment type. The configuration\n enables the file system to support increasing metadata performance.

" + } + }, "com.amazonaws.fsx#FileSystemMaintenanceOperation": { "type": "enum", "members": { @@ -7982,7 +8032,7 @@ "MountName": { "target": "com.amazonaws.fsx#LustreFileSystemMountName", "traits": { - "smithy.api#documentation": "

You use the MountName value when mounting the file system.

\n

For the SCRATCH_1 deployment type, this value is always \"fsx\". \n For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment\n types, this value is a string that is unique within an Amazon Web Services Region. \n \n

" + "smithy.api#documentation": "

You use the MountName value when mounting the file system.

\n

For the SCRATCH_1 deployment type, this value is always \"fsx\". \n For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment\n types, this value is a string that is unique within an Amazon Web Services Region. \n

" } }, "DailyAutomaticBackupStartTime": { @@ -8020,6 +8070,12 @@ "traits": { "smithy.api#documentation": "

The Lustre root squash configuration for an Amazon FSx for Lustre\n file system. When enabled, root squash restricts root-level access from clients that\n try to access your file system as a root user.

" } + }, + "MetadataConfiguration": { + "target": "com.amazonaws.fsx#FileSystemLustreMetadataConfiguration", + "traits": { + "smithy.api#documentation": "

The Lustre metadata performance configuration for an Amazon FSx for Lustre file system\n using a PERSISTENT_2 deployment type.

" + } } }, "traits": { @@ -8161,6 +8217,32 @@ } } }, + "com.amazonaws.fsx#MetadataConfigurationMode": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "USER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_PROVISIONED" + } + } + } + }, + "com.amazonaws.fsx#MetadataIops": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1500, + "max": 192000 + } + } + }, "com.amazonaws.fsx#MetadataStorageCapacity": { "type": "integer", "traits": { @@ -9677,42 +9759,42 @@ "UserName": { "target": "com.amazonaws.fsx#DirectoryUserName", "traits": { - "smithy.api#documentation": "

Specifies the updated user name for the service account on your self-managed AD domain.\n Amazon FSx uses this account to join to your self-managed AD domain.

\n

This account must have the permissions required to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName.

" + "smithy.api#documentation": "

Specifies the updated user name for the service account on your self-managed Active Directory domain.\n Amazon FSx uses this account to join to your self-managed Active Directory domain.

\n

This account must have the permissions required to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName.

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

Specifies the updated password for the service account on your self-managed AD domain. \n Amazon FSx uses this account to join to your self-managed AD domain.

" + "smithy.api#documentation": "

Specifies the updated password for the service account on your self-managed Active Directory domain. \n Amazon FSx uses this account to join to your self-managed Active Directory domain.

" } }, "DnsIps": { "target": "com.amazonaws.fsx#DnsIps", "traits": { - "smithy.api#documentation": "

A list of up to three DNS server or domain controller IP addresses in your\n self-managed AD domain.

" + "smithy.api#documentation": "

A list of up to three DNS server or domain controller IP addresses in your\n self-managed Active Directory domain.

" } }, "DomainName": { "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", "traits": { - "smithy.api#documentation": "

Specifies an updated fully qualified domain name of your self-managed AD configuration.

" + "smithy.api#documentation": "

Specifies an updated fully qualified domain name of your self-managed Active Directory configuration.

" } }, "OrganizationalUnitDistinguishedName": { "target": "com.amazonaws.fsx#OrganizationalUnitDistinguishedName", "traits": { - "smithy.api#documentation": "

Specifies an updated fully qualified distinguished name of the organization unit within your self-managed AD.

" + "smithy.api#documentation": "

Specifies an updated fully qualified distinguished name of the organization unit within your self-managed Active Directory.

" } }, "FileSystemAdministratorsGroup": { "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", "traits": { - "smithy.api#documentation": "

Specifies the updated name of the self-managed AD domain group whose members are granted administrative privileges\n for the Amazon FSx resource.

" + "smithy.api#documentation": "

For FSx for ONTAP file systems only - Specifies the updated name of the self-managed Active Directory domain group whose members are granted administrative privileges\n for the Amazon FSx resource.

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

Specifies changes you are making to the self-managed Microsoft Active Directory (AD) configuration to which \n an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined.

" + "smithy.api#documentation": "

Specifies changes you are making to the self-managed Microsoft Active Directory configuration to which \n an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined.

" } }, "com.amazonaws.fsx#ServiceLimit": { @@ -11212,7 +11294,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.

\n

For FSx for Windows File Server file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AuditLogConfiguration\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n SelfManagedActiveDirectoryConfiguration\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n StorageType\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for Lustre file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AutoImportPolicy\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DataCompressionType\n

    \n
  • \n
  • \n

    \n LogConfiguration\n

    \n
  • \n
  • \n

    \n LustreRootSquashConfiguration\n

    \n
  • \n
  • \n

    \n PerUnitStorageThroughput\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for ONTAP file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n FsxAdminPassword\n

    \n
  • \n
  • \n

    \n HAPairs\n

    \n
  • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacityPerHAPair\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for OpenZFS file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n CopyTagsToBackups\n

    \n
  • \n
  • \n

    \n CopyTagsToVolumes\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

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

Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.

\n

For FSx for Windows File Server file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AuditLogConfiguration\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n SelfManagedActiveDirectoryConfiguration\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n StorageType\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for Lustre file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AutoImportPolicy\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DataCompressionType\n

    \n
  • \n
  • \n

    \n LogConfiguration\n

    \n
  • \n
  • \n

    \n LustreRootSquashConfiguration\n

    \n
  • \n
  • \n

    \n MetadataConfiguration\n

    \n
  • \n
  • \n

    \n PerUnitStorageThroughput\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for ONTAP file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n FsxAdminPassword\n

    \n
  • \n
  • \n

    \n HAPairs\n

    \n
  • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacityPerHAPair\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
\n

For FSx for OpenZFS file systems, you can update the following\n properties:

\n
    \n
  • \n

    \n AddRouteTableIds\n

    \n
  • \n
  • \n

    \n AutomaticBackupRetentionDays\n

    \n
  • \n
  • \n

    \n CopyTagsToBackups\n

    \n
  • \n
  • \n

    \n CopyTagsToVolumes\n

    \n
  • \n
  • \n

    \n DailyAutomaticBackupStartTime\n

    \n
  • \n
  • \n

    \n DiskIopsConfiguration\n

    \n
  • \n
  • \n

    \n RemoveRouteTableIds\n

    \n
  • \n
  • \n

    \n StorageCapacity\n

    \n
  • \n
  • \n

    \n ThroughputCapacity\n

    \n
  • \n
  • \n

    \n WeeklyMaintenanceStartTime\n

    \n
  • \n
" } }, "com.amazonaws.fsx#UpdateFileSystemLustreConfiguration": { @@ -11262,12 +11344,38 @@ "traits": { "smithy.api#documentation": "

The throughput of an Amazon FSx for Lustre Persistent SSD-based file system,\n measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or decrease\n your file system's throughput. Valid values depend on the deployment type of the file\n system, as follows:

\n
    \n
  • \n

    For PERSISTENT_1 SSD-based deployment types, valid values\n are 50, 100, and 200 MB/s/TiB.

    \n
  • \n
  • \n

    For PERSISTENT_2 SSD-based deployment types, valid values\n are 125, 250, 500, and 1000 MB/s/TiB.

    \n
  • \n
\n

For more information, see \n \n Managing throughput capacity.

" } + }, + "MetadataConfiguration": { + "target": "com.amazonaws.fsx#UpdateFileSystemLustreMetadataConfiguration", + "traits": { + "smithy.api#documentation": "

The Lustre metadata performance configuration for an Amazon FSx for Lustre\n file system using a PERSISTENT_2 deployment type. When this configuration\n is enabled, the file system supports increasing metadata performance.

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

The configuration object for Amazon FSx for Lustre file systems used in the\n UpdateFileSystem operation.

" } }, + "com.amazonaws.fsx#UpdateFileSystemLustreMetadataConfiguration": { + "type": "structure", + "members": { + "Iops": { + "target": "com.amazonaws.fsx#MetadataIops", + "traits": { + "smithy.api#documentation": "

(USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision\n for your file system. Valid values are 1500, 3000,\n 6000, 12000, and multiples of 12000\n up to a maximum of 192000.

\n

The value you provide must be greater than or equal to the current number of\n Metadata IOPS provisioned for the file system.

" + } + }, + "Mode": { + "target": "com.amazonaws.fsx#MetadataConfigurationMode", + "traits": { + "smithy.api#documentation": "

The metadata configuration mode for provisioning Metadata IOPS for\n an FSx for Lustre file system using a PERSISTENT_2\n deployment type.

\n
    \n
  • \n

    To increase the Metadata IOPS or to switch from AUTOMATIC mode,\n specify USER_PROVISIONED as the value for this parameter. Then use the\n Iops parameter to provide a Metadata IOPS value that is greater than or equal to\n the current number of Metadata IOPS provisioned for the file system.

    \n
  • \n
  • \n

    To switch from USER_PROVISIONED mode, specify\n AUTOMATIC as the value for this parameter, but do not input a value\n for Iops.

    \n \n

    If you request to switch from USER_PROVISIONED to AUTOMATIC mode and the\n current Metadata IOPS value is greater than the automated default, FSx for Lustre\n rejects the request because downscaling Metadata IOPS is not supported.

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

The Lustre metadata performance configuration update for an Amazon FSx for Lustre\n file system using a PERSISTENT_2 deployment type. You can request\n an increase in your file system's Metadata IOPS and/or switch your file system's\n metadata configuration mode. For more information, see Managing\n metadata performance in the\n Amazon FSx for Lustre User Guide.

" + } + }, "com.amazonaws.fsx#UpdateFileSystemOntapConfiguration": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index ce8f37793de..2ac70181bcb 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -33556,6 +33556,12 @@ "traits": { "smithy.api#documentation": "

A TableIdentifier structure that describes a target table for resource linking.

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

A structure that contains all the information that defines the view, including the dialect or dialects for the view, and the query.

" + } } }, "traits": { @@ -36700,6 +36706,19 @@ "traits": { "smithy.api#documentation": "

The version ID at which to update the table contents.

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

The operation to be performed when updating the view.

" + } + }, + "Force": { + "target": "com.amazonaws.glue#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that can be set to true to ignore matching storage descriptor and subobject matching requirements.

" + } } }, "traits": { @@ -37206,6 +37225,38 @@ "smithy.api#documentation": "

A structure containing details for representations.

" } }, + "com.amazonaws.glue#ViewDefinitionInput": { + "type": "structure", + "members": { + "IsProtected": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

You can set this flag as true to instruct the engine not to push user-provided operations into the logical plan of the view during query planning. However, setting this flag does not guarantee that the engine will comply. Refer to the engine's documentation to understand the guarantees provided, if any.

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

The definer of a view in SQL.

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

A list of structures that contains the dialect of the view, and the query that defines the view.

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

A list of base table ARNs that make up the view.

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

A structure containing details for creating or updating an Glue view.

" + } + }, "com.amazonaws.glue#ViewDialect": { "type": "enum", "members": { @@ -37265,6 +37316,12 @@ "smithy.api#documentation": "

The expanded SQL for the view. This SQL is used by engines while processing a query on a view. Engines may perform operations during view creation to transform ViewOriginalText to ViewExpandedText. For example:

\n
    \n
  • \n

    Fully qualified identifiers: SELECT * from table1 -> SELECT * from db1.table1\n

    \n
  • \n
" } }, + "ValidationConnection": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the connection to be used to validate the specific representation of the view.

" + } + }, "IsStale": { "target": "com.amazonaws.glue#NullableBoolean", "traits": { @@ -37276,6 +37333,56 @@ "smithy.api#documentation": "

A structure that contains the dialect of the view, and the query that defines the view.

" } }, + "com.amazonaws.glue#ViewRepresentationInput": { + "type": "structure", + "members": { + "Dialect": { + "target": "com.amazonaws.glue#ViewDialect", + "traits": { + "smithy.api#documentation": "

A parameter that specifies the engine type of a specific representation.

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

A parameter that specifies the version of the engine of a specific representation.

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

A string that represents the original SQL query that describes the view.

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

The name of the connection to be used to validate the specific representation of the view.

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

A string that represents the SQL query that describes the view with expanded resource ARNs

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

A structure containing details of a representation to update or create a Lake Formation view.

" + } + }, + "com.amazonaws.glue#ViewRepresentationInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#ViewRepresentationInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.glue#ViewRepresentationList": { "type": "list", "member": { @@ -37309,6 +37416,35 @@ } } }, + "com.amazonaws.glue#ViewUpdateAction": { + "type": "enum", + "members": { + "ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD" + } + }, + "REPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE" + } + }, + "ADD_OR_REPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_OR_REPLACE" + } + }, + "DROP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP" + } + } + } + }, "com.amazonaws.glue#WorkerType": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/iot-wireless.json b/codegen/sdk/aws-models/iot-wireless.json index e703a56407c..7edd03b1933 100644 --- a/codegen/sdk/aws-models/iot-wireless.json +++ b/codegen/sdk/aws-models/iot-wireless.json @@ -4479,6 +4479,12 @@ "traits": { "smithy.api#enumValue": "Successful" } + }, + "Device_exist_in_conflict_fuota_task": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Device_exist_in_conflict_fuota_task" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/location.json b/codegen/sdk/aws-models/location.json index 29c384c36f9..0e2b3d4021f 100644 --- a/codegen/sdk/aws-models/location.json +++ b/codegen/sdk/aws-models/location.json @@ -37,7 +37,7 @@ "min": 5, "max": 200 }, - "smithy.api#pattern": "^geo:\\w*\\*?$" + "smithy.api#pattern": "^(geo|geo-routes|geo-places|geo-maps):\\w*\\*?$" } }, "com.amazonaws.location#ApiKeyActionList": { @@ -214,6 +214,15 @@ "type": "structure", "members": {} }, + "com.amazonaws.location#Base64EncodedGeobuf": { + "type": "blob", + "traits": { + "smithy.api#length": { + "max": 600000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.location#BatchDeleteDevicePositionHistory": { "type": "operation", "input": { @@ -783,7 +792,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the details of the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.

\n \n

Each \n geofence polygon can have a maximum of 1,000 vertices.

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

Contains the details to specify the position of the geofence. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

\n \n

The \n geofence polygon format supports a maximum of 1,000 vertices. The Geofence geobuf format supports a maximum of 100,000 vertices.

\n
", "smithy.api#required": {} } }, @@ -1439,6 +1448,25 @@ "smithy.api#documentation": "

Contains details about additional route preferences for requests that specify\n TravelMode as Truck.

" } }, + "com.amazonaws.location#CellSignals": { + "type": "structure", + "members": { + "LteCellDetails": { + "target": "com.amazonaws.location#LteCellDetailsList", + "traits": { + "smithy.api#documentation": "

Information about the Long-Term Evolution (LTE) network the device is connected to.

", + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The cellular network communication infrastructure that the device uses.

" + } + }, "com.amazonaws.location#Circle": { "type": "structure", "members": { @@ -1479,12 +1507,6 @@ "smithy.api#httpError": 409 } }, - "com.amazonaws.location#CountryCode": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Z]{3}$" - } - }, "com.amazonaws.location#CountryCode3": { "type": "string", "traits": { @@ -1508,7 +1530,7 @@ "com.amazonaws.location#CountryCodeList": { "type": "list", "member": { - "target": "com.amazonaws.location#CountryCode" + "target": "com.amazonaws.location#CountryCode3" }, "traits": { "smithy.api#length": { @@ -1603,7 +1625,7 @@ "target": "com.amazonaws.location#KmsKeyId", "traits": { "aws.cloudformation#cfnMutability": "create-and-read", - "smithy.api#documentation": "

A key identifier for an \n Amazon Web Services \n KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.\n\t

" + "smithy.api#documentation": "

A key identifier for an\n Amazon Web Services\n KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.\n\t

" } } } @@ -2682,7 +2704,7 @@ "KmsKeyId": { "target": "com.amazonaws.location#KmsKeyId", "traits": { - "smithy.api#documentation": "

A key identifier for an \n Amazon Web Services \n KMS customer managed key assigned to the Amazon Location resource

" + "smithy.api#documentation": "

A key identifier for an\n Amazon Web Services\n KMS customer managed key assigned to the Amazon Location resource

" } }, "Tags": { @@ -3434,6 +3456,57 @@ "target": "com.amazonaws.location#DevicePositionUpdate" } }, + "com.amazonaws.location#DeviceState": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.location#Id", + "traits": { + "smithy.api#documentation": "

The device identifier.

", + "smithy.api#required": {} + } + }, + "SampleTime": { + "target": "com.amazonaws.location#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the device's position was determined. Uses ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ.

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

The last known device position.

", + "smithy.api#required": {} + } + }, + "Accuracy": { + "target": "com.amazonaws.location#PositionalAccuracy" + }, + "Ipv4Address": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The device's Ipv4 address.

", + "smithy.api#pattern": "^(?:(?:25[0-5]|(?:2[0-4]|1\\d|[0-9]|)\\d)\\.?\\b){4}$" + } + }, + "WiFiAccessPoints": { + "target": "com.amazonaws.location#WiFiAccessPointList", + "traits": { + "smithy.api#documentation": "

The Wi-Fi access points the device is using.

" + } + }, + "CellSignals": { + "target": "com.amazonaws.location#CellSignals", + "traits": { + "smithy.api#documentation": "

The cellular network infrastructure that the device is connected to.

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

The device's position, IP address, and Wi-Fi access points.

" + } + }, "com.amazonaws.location#DimensionUnit": { "type": "string", "traits": { @@ -3521,173 +3594,45 @@ ] } }, - "com.amazonaws.location#FilterPlaceCategoryList": { - "type": "list", - "member": { - "target": "com.amazonaws.location#PlaceCategory" - }, + "com.amazonaws.location#Earfcn": { + "type": "integer", "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.location#GenericResource": { - "type": "resource", - "identifiers": { - "ResourceArn": { - "target": "com.amazonaws.location#Arn" - } - }, - "operations": [ - { - "target": "com.amazonaws.location#ListTagsForResource" - }, - { - "target": "com.amazonaws.location#TagResource" - }, - { - "target": "com.amazonaws.location#UntagResource" + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 262143 } - ], - "traits": { - "aws.api#controlPlane": {}, - "aws.iam#disableConditionKeyInference": {} } }, - "com.amazonaws.location#GeoArn": { - "type": "string", + "com.amazonaws.location#EutranCellId": { + "type": "integer", "traits": { - "aws.api#arnReference": {}, - "smithy.api#length": { - "max": 1600 - }, - "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$" + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 268435455 + } } }, - "com.amazonaws.location#GeoArnList": { + "com.amazonaws.location#FilterPlaceCategoryList": { "type": "list", "member": { - "target": "com.amazonaws.location#GeoArn" - } - }, - "com.amazonaws.location#GeofenceCollectionResource": { - "type": "resource", - "identifiers": { - "CollectionName": { - "target": "com.amazonaws.location#ResourceName" - } - }, - "put": { - "target": "com.amazonaws.location#CreateGeofenceCollection" - }, - "read": { - "target": "com.amazonaws.location#DescribeGeofenceCollection" - }, - "update": { - "target": "com.amazonaws.location#UpdateGeofenceCollection" - }, - "delete": { - "target": "com.amazonaws.location#DeleteGeofenceCollection" - }, - "list": { - "target": "com.amazonaws.location#ListGeofenceCollections" - }, - "operations": [ - { - "target": "com.amazonaws.location#BatchDeleteGeofence" - }, - { - "target": "com.amazonaws.location#BatchEvaluateGeofences" - }, - { - "target": "com.amazonaws.location#BatchPutGeofence" - }, - { - "target": "com.amazonaws.location#GetGeofence" - }, - { - "target": "com.amazonaws.location#ListGeofences" - }, - { - "target": "com.amazonaws.location#PutGeofence" - } - ], - "traits": { - "aws.api#arn": { - "template": "geofence-collection/{CollectionName}" - }, - "aws.cloudformation#cfnResource": { - "name": "GeofenceCollection" - }, - "aws.iam#disableConditionKeyInference": {} - } - }, - "com.amazonaws.location#GeofenceGeometry": { - "type": "structure", - "members": { - "Polygon": { - "target": "com.amazonaws.location#LinearRings", - "traits": { - "smithy.api#documentation": "

A polygon is a list of linear rings which are each made up of a list of\n vertices.

\n

Each vertex is a 2-dimensional point of the form: [longitude, latitude].\n This is represented as an array of doubles of length 2 (so [double,\n double]).

\n

An array of 4 or more vertices, where the first and last vertex are the same (to form\n a closed boundary), is called a linear ring. The linear ring vertices must be listed in\n counter-clockwise order around the ring’s interior. The linear ring is represented as an\n array of vertices, or an array of arrays of doubles ([[double, double], ...]).

\n

A geofence consists of a single linear ring. To allow for future expansion, the\n Polygon parameter takes an array of linear rings, which is represented as an array of\n arrays of arrays of doubles ([[[double, double], ...], ...]).

\n

A linear ring for use in geofences can consist of between 4 and 1,000 vertices.

" - } - }, - "Circle": { - "target": "com.amazonaws.location#Circle", - "traits": { - "smithy.api#documentation": "

A circle on the earth, as defined by a center point and a radius.

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

Contains the geofence geometry details.

\n

A geofence geometry is made up of either a polygon or a circle. Can be either a \n polygon or a circle. Including both will return a validation error.

\n \n

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons\n that are wound clockwise, or that cross the antimeridian.

\n
" - } - }, - "com.amazonaws.location#GetDevicePosition": { - "type": "operation", - "input": { - "target": "com.amazonaws.location#GetDevicePositionRequest" - }, - "output": { - "target": "com.amazonaws.location#GetDevicePositionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.location#AccessDeniedException" - }, - { - "target": "com.amazonaws.location#InternalServerException" - }, - { - "target": "com.amazonaws.location#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.location#ThrottlingException" - }, - { - "target": "com.amazonaws.location#ValidationException" + "smithy.api#length": { + "min": 1, + "max": 5 } - ], - "traits": { - "smithy.api#documentation": "

Retrieves a device's most recent position according to its sample time.

\n \n

Device positions are deleted after 30 days.

\n
", - "smithy.api#endpoint": { - "hostPrefix": "tracking." - }, - "smithy.api#http": { - "uri": "/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/positions/latest", - "method": "GET" - }, - "smithy.api#readonly": {} } }, - "com.amazonaws.location#GetDevicePositionHistory": { + "com.amazonaws.location#ForecastGeofenceEvents": { "type": "operation", "input": { - "target": "com.amazonaws.location#GetDevicePositionHistoryRequest" + "target": "com.amazonaws.location#ForecastGeofenceEventsRequest" }, "output": { - "target": "com.amazonaws.location#GetDevicePositionHistoryResponse" + "target": "com.amazonaws.location#ForecastGeofenceEventsResponse" }, "errors": [ { @@ -3707,49 +3652,460 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the device position history from a tracker resource within a specified range\n of time.

\n \n

Device positions are deleted after 30 days.

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

Evaluates device positions against\n geofence geometries from a given geofence collection. The event forecasts three states for which\n a device can be in relative to a geofence:

\n

\n ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

\n

\n EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

\n

\n IDLE: If a device is inside of a geofence, and the device is not moving.

", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "geofencing." }, "smithy.api#http": { - "uri": "/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/list-positions", + "uri": "/geofencing/v0/collections/{CollectionName}/forecast-geofence-events", "method": "POST" }, "smithy.api#paginated": { "pageSize": "MaxResults", "inputToken": "NextToken", "outputToken": "NextToken", - "items": "DevicePositions" + "items": "ForecastedEvents" }, "smithy.api#readonly": {} } }, - "com.amazonaws.location#GetDevicePositionHistoryRequest": { + "com.amazonaws.location#ForecastGeofenceEventsDeviceState": { "type": "structure", "members": { - "TrackerName": { - "target": "com.amazonaws.location#ResourceName", + "Position": { + "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The tracker resource receiving the request for the device position history.

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

The device's position.

", "smithy.api#required": {} } }, - "DeviceId": { - "target": "com.amazonaws.location#Id", + "Speed": { + "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The device whose position history you want to retrieve.

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

The device's speed.

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

The device's position, IP address, and WiFi access points.

" + } + }, + "com.amazonaws.location#ForecastGeofenceEventsRequest": { + "type": "structure", + "members": { + "CollectionName": { + "target": "com.amazonaws.location#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the geofence collection.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "NextToken": { - "target": "com.amazonaws.location#Token", + "DeviceState": { + "target": "com.amazonaws.location#ForecastGeofenceEventsDeviceState", "traits": { - "smithy.api#documentation": "

The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.

\n

Default value: null\n

" + "smithy.api#documentation": "

The device's state, including current position and speed.

", + "smithy.api#required": {} } }, - "StartTimeInclusive": { + "TimeHorizonMinutes": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

Specifies the time horizon in minutes for the forecasted events.

", + "smithy.api#range": { + "min": 0 + } + } + }, + "DistanceUnit": { + "target": "com.amazonaws.location#DistanceUnit", + "traits": { + "smithy.api#documentation": "

The distance unit used for the NearestDistance property returned in a forecasted event.\n The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers\n is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.\n

\n

Default Value: Kilometers\n

" + } + }, + "SpeedUnit": { + "target": "com.amazonaws.location#SpeedUnit", + "traits": { + "smithy.api#documentation": "

The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers\n is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

\n

Default Value: KilometersPerHour.

" + } + }, + "NextToken": { + "target": "com.amazonaws.location#LargeToken", + "traits": { + "smithy.api#documentation": "

The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.

\n

Default value: null\n

" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

An optional limit for the number of resources returned in a single call.

\n

Default value: 20\n

", + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.location#ForecastGeofenceEventsResponse": { + "type": "structure", + "members": { + "ForecastedEvents": { + "target": "com.amazonaws.location#ForecastedEventsList", + "traits": { + "smithy.api#documentation": "

The list of forecasted events.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.location#LargeToken", + "traits": { + "smithy.api#documentation": "

The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.

" + } + }, + "DistanceUnit": { + "target": "com.amazonaws.location#DistanceUnit", + "traits": { + "smithy.api#documentation": "

The distance unit for the forecasted events.

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

The speed unit for the forecasted events.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.location#ForecastedEvent": { + "type": "structure", + "members": { + "EventId": { + "target": "com.amazonaws.location#Uuid", + "traits": { + "smithy.api#documentation": "

The forecasted event identifier.

", + "smithy.api#required": {} + } + }, + "GeofenceId": { + "target": "com.amazonaws.location#Id", + "traits": { + "smithy.api#documentation": "

The geofence identifier pertaining to the forecasted event.

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

Indicates if the device is located within the geofence.

", + "smithy.api#required": {} + } + }, + "NearestDistance": { + "target": "com.amazonaws.location#NearestDistance", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The closest distance from the device's position to the geofence.

", + "smithy.api#required": {} + } + }, + "EventType": { + "target": "com.amazonaws.location#ForecastedGeofenceEventType", + "traits": { + "smithy.api#documentation": "

The event type, forecasting three states for which\n a device can be in relative to a geofence:

\n

\n ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

\n

\n EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

\n

\n IDLE: If a device is inside of a geofence, and the device is not moving.

", + "smithy.api#required": {} + } + }, + "ForecastedBreachTime": { + "target": "com.amazonaws.location#Timestamp", + "traits": { + "smithy.api#documentation": "

The forecasted time the device will breach the geofence in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ\n

" + } + }, + "GeofenceProperties": { + "target": "com.amazonaws.location#PropertyMap", + "traits": { + "smithy.api#documentation": "

The geofence properties.

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

A forecasted event represents a geofence event in relation to the requested device state, that may occur\n given the provided device state and time horizon.

" + } + }, + "com.amazonaws.location#ForecastedEventsList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#ForecastedEvent" + } + }, + "com.amazonaws.location#ForecastedGeofenceEventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENTER", + "documentation": "This event type signifies that a device is forecasted to enter the geofence" + }, + { + "value": "EXIT", + "documentation": "This event type signifies that a device is forecasted to exit the geofence" + }, + { + "value": "IDLE", + "documentation": "This event type signifies that a device is stationary in the geofence and an exit/enter cannot be forecasted" + } + ] + } + }, + "com.amazonaws.location#GenericResource": { + "type": "resource", + "identifiers": { + "ResourceArn": { + "target": "com.amazonaws.location#Arn" + } + }, + "operations": [ + { + "target": "com.amazonaws.location#ListTagsForResource" + }, + { + "target": "com.amazonaws.location#TagResource" + }, + { + "target": "com.amazonaws.location#UntagResource" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.location#GeoArn": { + "type": "string", + "traits": { + "aws.api#arnReference": {}, + "smithy.api#length": { + "max": 1600 + }, + "smithy.api#pattern": "^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$" + } + }, + "com.amazonaws.location#GeoArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#GeoArnV2" + } + }, + "com.amazonaws.location#GeoArnV2": { + "type": "string", + "traits": { + "aws.api#arnReference": {}, + "smithy.api#length": { + "max": 1600 + }, + "smithy.api#pattern": "(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):geo(:([a-z0-9]+([.-][a-z0-9]+)*))(:[0-9]+):((\\*)|([-a-z]+[/][*-._\\w]+))$)|(^arn(:[a-z0-9]+([.-][a-z0-9]+)*):(geo-routes|geo-places|geo-maps)(:((\\*)|([a-z0-9]+([.-][a-z0-9]+)*)))::((provider[\\/][*-._\\w]+))$)" + } + }, + "com.amazonaws.location#GeofenceCollectionResource": { + "type": "resource", + "identifiers": { + "CollectionName": { + "target": "com.amazonaws.location#ResourceName" + } + }, + "put": { + "target": "com.amazonaws.location#CreateGeofenceCollection" + }, + "read": { + "target": "com.amazonaws.location#DescribeGeofenceCollection" + }, + "update": { + "target": "com.amazonaws.location#UpdateGeofenceCollection" + }, + "delete": { + "target": "com.amazonaws.location#DeleteGeofenceCollection" + }, + "list": { + "target": "com.amazonaws.location#ListGeofenceCollections" + }, + "operations": [ + { + "target": "com.amazonaws.location#BatchDeleteGeofence" + }, + { + "target": "com.amazonaws.location#BatchEvaluateGeofences" + }, + { + "target": "com.amazonaws.location#BatchPutGeofence" + }, + { + "target": "com.amazonaws.location#ForecastGeofenceEvents" + }, + { + "target": "com.amazonaws.location#GetGeofence" + }, + { + "target": "com.amazonaws.location#ListGeofences" + }, + { + "target": "com.amazonaws.location#PutGeofence" + } + ], + "traits": { + "aws.api#arn": { + "template": "geofence-collection/{CollectionName}" + }, + "aws.cloudformation#cfnResource": { + "name": "GeofenceCollection" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.location#GeofenceGeometry": { + "type": "structure", + "members": { + "Polygon": { + "target": "com.amazonaws.location#LinearRings", + "traits": { + "smithy.api#documentation": "

A polygon is a list of linear rings which are each made up of a list of\n vertices.

\n

Each vertex is a 2-dimensional point of the form: [longitude, latitude].\n This is represented as an array of doubles of length 2 (so [double,\n double]).

\n

An array of 4 or more vertices, where the first and last vertex are the same (to form\n a closed boundary), is called a linear ring. The linear ring vertices must be listed in\n counter-clockwise order around the ring’s interior. The linear ring is represented as an\n array of vertices, or an array of arrays of doubles ([[double, double], ...]).

\n

A geofence consists of a single linear ring. To allow for future expansion, the\n Polygon parameter takes an array of linear rings, which is represented as an array of\n arrays of arrays of doubles ([[[double, double], ...], ...]).

\n

A linear ring for use in geofences can consist of between 4 and 1,000 vertices.

" + } + }, + "Circle": { + "target": "com.amazonaws.location#Circle", + "traits": { + "smithy.api#documentation": "

A circle on the earth, as defined by a center point and a radius.

" + } + }, + "Geobuf": { + "target": "com.amazonaws.location#Base64EncodedGeobuf", + "traits": { + "smithy.api#documentation": "

Geobuf is a compact binary encoding for geographic data that provides lossless compression of GeoJSON polygons. The Geobuf must be Base64-encoded.

\n

A polygon in Geobuf format can have up to 100,000 vertices.

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

Contains the geofence geometry details.

\n

A geofence geometry is made up of either a polygon or a circle. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

\n \n

Amazon Location doesn't currently support polygons with holes, multipolygons, polygons\n that are wound clockwise, or that cross the antimeridian.

\n
" + } + }, + "com.amazonaws.location#GetDevicePosition": { + "type": "operation", + "input": { + "target": "com.amazonaws.location#GetDevicePositionRequest" + }, + "output": { + "target": "com.amazonaws.location#GetDevicePositionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.location#AccessDeniedException" + }, + { + "target": "com.amazonaws.location#InternalServerException" + }, + { + "target": "com.amazonaws.location#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.location#ThrottlingException" + }, + { + "target": "com.amazonaws.location#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a device's most recent position according to its sample time.

\n \n

Device positions are deleted after 30 days.

\n
", + "smithy.api#endpoint": { + "hostPrefix": "tracking." + }, + "smithy.api#http": { + "uri": "/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/positions/latest", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.location#GetDevicePositionHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.location#GetDevicePositionHistoryRequest" + }, + "output": { + "target": "com.amazonaws.location#GetDevicePositionHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.location#AccessDeniedException" + }, + { + "target": "com.amazonaws.location#InternalServerException" + }, + { + "target": "com.amazonaws.location#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.location#ThrottlingException" + }, + { + "target": "com.amazonaws.location#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the device position history from a tracker resource within a specified range\n of time.

\n \n

Device positions are deleted after 30 days.

\n
", + "smithy.api#endpoint": { + "hostPrefix": "tracking." + }, + "smithy.api#http": { + "uri": "/tracking/v0/trackers/{TrackerName}/devices/{DeviceId}/list-positions", + "method": "POST" + }, + "smithy.api#paginated": { + "pageSize": "MaxResults", + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DevicePositions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.location#GetDevicePositionHistoryRequest": { + "type": "structure", + "members": { + "TrackerName": { + "target": "com.amazonaws.location#ResourceName", + "traits": { + "smithy.api#documentation": "

The tracker resource receiving the request for the device position history.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeviceId": { + "target": "com.amazonaws.location#Id", + "traits": { + "smithy.api#documentation": "

The device whose position history you want to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.location#Token", + "traits": { + "smithy.api#documentation": "

The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.

\n

Default value: null\n

" + } + }, + "StartTimeInclusive": { "target": "com.amazonaws.location#Timestamp", "traits": { "smithy.api#documentation": "

Specify the start time for the position history in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours\n prior to the time that the request is made.

\n

Requirement:

\n
    \n
  • \n

    The time specified for StartTimeInclusive must be before\n EndTimeExclusive.

    \n
  • \n
" @@ -3832,7 +4188,7 @@ "ReceivedTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp for when the tracker resource received the device position in ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ.

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

The timestamp for when the tracker resource received the device position. Uses ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ.

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

Retrieves the geofence details from a geofence collection.

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

Retrieves the geofence details from a geofence collection.

\n \n

The returned geometry will always match the geometry format used when the geofence was created.

\n
", "smithy.api#endpoint": { "hostPrefix": "geofencing." }, @@ -4012,7 +4368,7 @@ "FontStack": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid font stacks for Esri styles:

\n
    \n
  • \n

    VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu\n Medium | Ubuntu Italic | Ubuntu Regular |\n Ubuntu Bold\n

    \n
  • \n
  • \n

    VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu\n Regular | Ubuntu Light | Ubuntu Bold\n

    \n
  • \n
  • \n

    VectorEsriTopographic – Noto Sans Italic | Noto Sans\n Regular | Noto Sans Bold | Noto Serif\n Regular | Roboto Condensed Light Italic\n

    \n
  • \n
  • \n

    VectorEsriStreets – Arial Regular | Arial Italic |\n Arial Bold\n

    \n
  • \n
  • \n

    VectorEsriNavigation – Arial Regular | Arial Italic\n | Arial Bold | Arial Unicode MS Bold | Arial Unicode MS Regular\n

    \n
  • \n
\n

Valid font stacks for HERE Technologies styles:

\n
    \n
  • \n

    VectorHereContrast – Fira \n GO Regular | Fira GO Bold\n

    \n
  • \n
  • \n

    VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – \n Fira GO Italic | Fira GO Map | \n Fira GO Map Bold | Noto Sans CJK JP Bold | \n Noto Sans CJK JP Light | \n Noto Sans CJK JP Regular\n

    \n
  • \n
\n

Valid font stacks for GrabMaps styles:

\n
    \n
  • \n

    VectorGrabStandardLight, VectorGrabStandardDark – \n Noto Sans Regular |\n Noto Sans Medium |\n Noto Sans Bold\n

    \n
  • \n
\n

Valid font stacks for Open Data styles:

\n
    \n
  • \n

    VectorOpenDataStandardLight, VectorOpenDataStandardDark,\n VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – \n Amazon Ember Regular,Noto Sans Regular |\n Amazon Ember Bold,Noto Sans Bold | \n Amazon Ember Medium,Noto Sans Medium |\n Amazon Ember Regular Italic,Noto Sans Italic | \n Amazon Ember Condensed RC Regular,Noto Sans Regular | \n Amazon Ember Condensed RC Bold,Noto Sans Bold |\n Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular |\n Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic \n Condensed Bold |\n Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold |\n Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic \n Regular |\n Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic \n Condensed Regular |\n Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium\n

    \n
  • \n
\n \n

The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.

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

A comma-separated list of fonts to load glyphs from in order of preference. For\n example, Noto Sans Regular, Arial Unicode.

\n

Valid font stacks for Esri styles:

\n
    \n
  • \n

    VectorEsriDarkGrayCanvas – Ubuntu Medium Italic | Ubuntu\n Medium | Ubuntu Italic | Ubuntu Regular |\n Ubuntu Bold\n

    \n
  • \n
  • \n

    VectorEsriLightGrayCanvas – Ubuntu Italic | Ubuntu\n Regular | Ubuntu Light | Ubuntu Bold\n

    \n
  • \n
  • \n

    VectorEsriTopographic – Noto Sans Italic | Noto Sans\n Regular | Noto Sans Bold | Noto Serif\n Regular | Roboto Condensed Light Italic\n

    \n
  • \n
  • \n

    VectorEsriStreets – Arial Regular | Arial Italic |\n Arial Bold\n

    \n
  • \n
  • \n

    VectorEsriNavigation – Arial Regular | Arial Italic\n | Arial Bold\n

    \n
  • \n
\n

Valid font stacks for HERE Technologies styles:

\n
    \n
  • \n

    VectorHereContrast – Fira \n GO Regular | Fira GO Bold\n

    \n
  • \n
  • \n

    VectorHereExplore, VectorHereExploreTruck, HybridHereExploreSatellite – \n Fira GO Italic | Fira GO Map | \n Fira GO Map Bold | Noto Sans CJK JP Bold | \n Noto Sans CJK JP Light | \n Noto Sans CJK JP Regular\n

    \n
  • \n
\n

Valid font stacks for GrabMaps styles:

\n
    \n
  • \n

    VectorGrabStandardLight, VectorGrabStandardDark – \n Noto Sans Regular |\n Noto Sans Medium |\n Noto Sans Bold\n

    \n
  • \n
\n

Valid font stacks for Open Data styles:

\n
    \n
  • \n

    VectorOpenDataStandardLight, VectorOpenDataStandardDark,\n VectorOpenDataVisualizationLight, VectorOpenDataVisualizationDark – \n Amazon Ember Regular,Noto Sans Regular |\n Amazon Ember Bold,Noto Sans Bold | \n Amazon Ember Medium,Noto Sans Medium |\n Amazon Ember Regular Italic,Noto Sans Italic | \n Amazon Ember Condensed RC Regular,Noto Sans Regular | \n Amazon Ember Condensed RC Bold,Noto Sans Bold |\n Amazon Ember Regular,Noto Sans Regular,Noto Sans Arabic Regular |\n Amazon Ember Condensed RC Bold,Noto Sans Bold,Noto Sans Arabic \n Condensed Bold |\n Amazon Ember Bold,Noto Sans Bold,Noto Sans Arabic Bold |\n Amazon Ember Regular Italic,Noto Sans Italic,Noto Sans Arabic \n Regular |\n Amazon Ember Condensed RC Regular,Noto Sans Regular,Noto Sans Arabic \n Condensed Regular |\n Amazon Ember Medium,Noto Sans Medium,Noto Sans Arabic Medium\n

    \n
  • \n
\n \n

The fonts used by the Open Data map styles are combined fonts\n that use Amazon Ember for most glyphs but Noto Sans \n for glyphs unsupported by Amazon Ember.

\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4405,7 +4761,7 @@ "PlaceId": { "target": "com.amazonaws.location#PlaceId", "traits": { - "smithy.api#documentation": "

The identifier of the place to find.

\n

While you can use PlaceID in subsequent requests, \n PlaceID is not intended to be a permanent \n identifier and the ID can change between consecutive API calls. \n Please see the following PlaceID behaviour for each data provider:

\n
    \n
  • \n

    Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.

    \n
  • \n
  • \n

    HERE: We recommend \n that you cache data for no longer than a week \n to keep your data data fresh. You can \n assume that less than 1% ID shifts will\n release over release which is approximately 1 - 2 times per week.

    \n
  • \n
  • \n

    Grab: Place IDs can expire or become invalid in the following situations.

    \n
      \n
    • \n

      Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth,\n such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.

      \n
    • \n
    • \n

      Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, \n and it will be marked as derived in the place.result_type field in the response. \n The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by \n Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.

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

The identifier of the place to find.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4454,6 +4810,39 @@ "target": "com.amazonaws.location#Id" } }, + "com.amazonaws.location#InferredState": { + "type": "structure", + "members": { + "Position": { + "target": "com.amazonaws.location#Position", + "traits": { + "smithy.api#documentation": "

The device position inferred by the provided position, IP address, cellular signals, and Wi-Fi- access points.

" + } + }, + "Accuracy": { + "target": "com.amazonaws.location#PositionalAccuracy", + "traits": { + "smithy.api#documentation": "

The level of certainty of the inferred position.

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

The distance between the inferred position and the device's self-reported position.

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

Indicates if a proxy was used.

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

The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.

" + } + }, "com.amazonaws.location#IntendedUse": { "type": "string", "traits": { @@ -4505,6 +4894,15 @@ } } }, + "com.amazonaws.location#LargeToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60000 + } + } + }, "com.amazonaws.location#Leg": { "type": "structure", "members": { @@ -4893,7 +5291,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the geofence collection details.

" + "smithy.api#documentation": "

Contains the geofence collection details.

\n \n

The returned geometry will always match the geometry format used when the geofence was created.

\n
" } }, "com.amazonaws.location#ListGeofenceCollectionsResponseEntryList": { @@ -4948,7 +5346,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains a list of geofences stored in a given geofence collection.

" + "smithy.api#documentation": "

Contains a list of geofences stored in a given geofence collection.

\n \n

The returned geometry will always match the geometry format used when the geofence was created.

\n
" } }, "com.amazonaws.location#ListGeofenceResponseEntryList": { @@ -5012,7 +5410,7 @@ } }, "NextToken": { - "target": "com.amazonaws.location#Token", + "target": "com.amazonaws.location#LargeToken", "traits": { "smithy.api#documentation": "

The pagination token specifying which page of results to return in the response. If no\n token is provided, the default page is the first page.

\n

Default value: null\n

" } @@ -5041,7 +5439,7 @@ } }, "NextToken": { - "target": "com.amazonaws.location#Token", + "target": "com.amazonaws.location#LargeToken", "traits": { "smithy.api#documentation": "

A pagination token indicating there are additional pages available. You can use the\n token in a following request to fetch the next set of results.

" } @@ -6555,15 +6953,187 @@ "Endpoint": "https://example.com" } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.location#LteCellDetails": { + "type": "structure", + "members": { + "CellId": { + "target": "com.amazonaws.location#EutranCellId", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The E-UTRAN Cell Identifier (ECI).

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

The Mobile Country Code (MCC).

", + "smithy.api#range": { + "min": 200, + "max": 999 + }, + "smithy.api#required": {} + } + }, + "Mnc": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The Mobile Network Code (MNC)

", + "smithy.api#range": { + "min": 0, + "max": 999 + }, + "smithy.api#required": {} + } + }, + "LocalId": { + "target": "com.amazonaws.location#LteLocalId", + "traits": { + "smithy.api#documentation": "

The LTE local identification information (local ID).

" + } + }, + "NetworkMeasurements": { + "target": "com.amazonaws.location#LteNetworkMeasurementsList", + "traits": { + "smithy.api#documentation": "

The network measurements.

", + "smithy.api#length": { + "min": 1, + "max": 32 } - ], - "version": "1.0" + } + }, + "TimingAdvance": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Timing Advance (TA).

", + "smithy.api#range": { + "min": 0, + "max": 1282 + } + } + }, + "NrCapable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the LTE object is capable of supporting NR (new radio).

" + } + }, + "Rsrp": { + "target": "com.amazonaws.location#Rsrp", + "traits": { + "smithy.api#documentation": "

Signal power of the reference signal received, measured in decibel-milliwatts (dBm).

" + } + }, + "Rsrq": { + "target": "com.amazonaws.location#Rsrq", + "traits": { + "smithy.api#documentation": "

Signal quality of the reference Signal received, measured in decibels (dB).

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

LTE Tracking Area Code (TAC).

", + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the Long-Term Evolution (LTE) network.

" + } + }, + "com.amazonaws.location#LteCellDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#LteCellDetails" + } + }, + "com.amazonaws.location#LteLocalId": { + "type": "structure", + "members": { + "Earfcn": { + "target": "com.amazonaws.location#Earfcn", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).

", + "smithy.api#required": {} + } + }, + "Pci": { + "target": "com.amazonaws.location#Pci", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Physical Cell ID (PCI).

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

LTE local identification information (local ID).

" + } + }, + "com.amazonaws.location#LteNetworkMeasurements": { + "type": "structure", + "members": { + "Earfcn": { + "target": "com.amazonaws.location#Earfcn", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

E-UTRA (Evolved Universal Terrestrial Radio Access) absolute radio frequency channel number (EARFCN).

", + "smithy.api#required": {} + } + }, + "CellId": { + "target": "com.amazonaws.location#EutranCellId", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

E-UTRAN Cell Identifier (ECI).

", + "smithy.api#required": {} + } + }, + "Pci": { + "target": "com.amazonaws.location#Pci", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Physical Cell ID (PCI).

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

Signal power of the reference signal received, measured in dBm (decibel-milliwatts).

" + } + }, + "Rsrq": { + "target": "com.amazonaws.location#Rsrq", + "traits": { + "smithy.api#documentation": "

Signal quality of the reference Signal received, measured in decibels (dB).

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

LTE network measurements.

" + } + }, + "com.amazonaws.location#LteNetworkMeasurementsList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#LteNetworkMeasurements" } }, "com.amazonaws.location#MapConfiguration": { @@ -6572,7 +7142,7 @@ "Style": { "target": "com.amazonaws.location#MapStyle", "traits": { - "smithy.api#documentation": "

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n
    \n
  • \n

    \n VectorEsriNavigation – The Esri Navigation map style, which provides a detailed basemap for the world symbolized with a \n custom navigation map style that's designed for use during the day in mobile devices. It also includes a richer set of places, \n such as shops, services, restaurants, attractions, and other points of interest. \n Enable the POI layer by setting it in CustomLayers to leverage the additional places data.

    \n

    \n

  • \n
  • \n

    \n RasterEsriImagery – The Esri Imagery map style. A raster basemap\n that provides one meter or better satellite and aerial imagery in many parts of\n the world and lower resolution satellite imagery worldwide.

    \n
  • \n
  • \n

    \n VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style,\n which provides a detailed vector basemap with a light gray, neutral background\n style with minimal colors, labels, and features that's designed to draw\n attention to your thematic content.

    \n
  • \n
  • \n

    \n VectorEsriTopographic – The Esri Light map style, which provides\n a detailed vector basemap with a classic Esri map style.

    \n
  • \n
  • \n

    \n VectorEsriStreets – The Esri Street Map style, which\n provides a detailed vector basemap for the world symbolized with a classic Esri\n street map style. The vector tile layer is similar in content and style to the\n World Street Map raster map.

    \n
  • \n
  • \n

    \n VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A\n vector basemap with a dark gray, neutral background with minimal colors, labels,\n and features that's designed to draw attention to your thematic content.

    \n
  • \n
\n

Valid HERE\n Technologies map styles:

\n
    \n
  • \n

    \n VectorHereExplore – A default HERE map style containing a \n neutral, global map and its features including roads, buildings, landmarks, \n and water features. It also now includes a fully designed map of Japan.

    \n
  • \n
  • \n

    \n RasterHereExploreSatellite – A global map containing high\n resolution satellite imagery.

    \n
  • \n
  • \n

    \n HybridHereExploreSatellite – A global map displaying the road \n network, street names, and city labels over satellite imagery. This style \n will automatically retrieve both raster and vector tiles, and your charges \n will be based on total tiles retrieved.

    \n \n

    Hybrid styles use both vector and raster tiles when rendering the \n map that you see. This means that more tiles are retrieved than when using \n either vector or raster tiles alone. Your charges will include all tiles \n retrieved.

    \n
    \n
  • \n
  • \n

    \n VectorHereContrast – The HERE Contrast (Berlin) map style is a \n high contrast\n detailed base map of the world that blends 3D and 2D rendering.

    \n \n

    The VectorHereContrast style has been renamed from \n VectorHereBerlin. \n VectorHereBerlin has been deprecated, but will continue to work in \n applications that use it.

    \n
    \n
  • \n
  • \n

    \n VectorHereExploreTruck – A global map containing truck \n restrictions and attributes (e.g. width / height / HAZMAT) symbolized with \n highlighted segments and icons on top of HERE Explore to support use cases \n within transport and logistics.

    \n
  • \n
\n

Valid GrabMaps map styles:

\n
    \n
  • \n

    \n VectorGrabStandardLight – The Grab Standard Light \n map style provides a basemap with detailed land use coloring, \n area names, roads, landmarks, and points of interest covering \n Southeast Asia.

    \n
  • \n
  • \n

    \n VectorGrabStandardDark – The Grab Standard Dark \n map style provides a dark variation of the standard basemap \n covering Southeast Asia.

    \n
  • \n
\n \n

Grab provides maps only for countries in Southeast Asia, and is only available \n in the Asia Pacific (Singapore) Region (ap-southeast-1).\n For more information, see GrabMaps countries and area covered.

\n
\n

Valid Open Data map styles:

\n
    \n
  • \n

    \n VectorOpenDataStandardLight – The Open Data Standard Light \n map style provides a detailed basemap for the world suitable for\n website and mobile application use. The map includes highways major roads, \n minor roads, railways, water features, cities, parks, landmarks, building\n footprints, and administrative boundaries.

    \n
  • \n
  • \n

    \n VectorOpenDataStandardDark – Open Data Standard Dark is a\n dark-themed map style that provides a detailed basemap for the world \n suitable for website and mobile application use. The map includes highways \n major roads, minor roads, railways, water features, cities, parks, \n landmarks, building footprints, and administrative boundaries.

    \n
  • \n
  • \n

    \n VectorOpenDataVisualizationLight – The Open Data \n Visualization Light map style is a light-themed style with muted colors and\n fewer features that aids in understanding overlaid data.

    \n
  • \n
  • \n

    \n VectorOpenDataVisualizationDark – The Open Data \n Visualization Dark map style is a dark-themed style with muted colors and\n fewer features that aids in understanding overlaid data.

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

Specifies the map style selected from an available data provider.

\n

Valid Esri map styles:

\n
    \n
  • \n

    \n VectorEsriDarkGrayCanvas – The Esri Dark Gray Canvas map style. A\n vector basemap with a dark gray, neutral background with minimal colors, labels,\n and features that's designed to draw attention to your thematic content.

    \n
  • \n
  • \n

    \n RasterEsriImagery – The Esri Imagery map style. A raster basemap\n that provides one meter or better satellite and aerial imagery in many parts of\n the world and lower resolution satellite imagery worldwide.

    \n
  • \n
  • \n

    \n VectorEsriLightGrayCanvas – The Esri Light Gray Canvas map style,\n which provides a detailed vector basemap with a light gray, neutral background\n style with minimal colors, labels, and features that's designed to draw\n attention to your thematic content.

    \n
  • \n
  • \n

    \n VectorEsriTopographic – The Esri Light map style, which provides\n a detailed vector basemap with a classic Esri map style.

    \n
  • \n
  • \n

    \n VectorEsriStreets – The Esri Street Map style, which\n provides a detailed vector basemap for the world symbolized with a classic Esri\n street map style. The vector tile layer is similar in content and style to the\n World Street Map raster map.

    \n
  • \n
  • \n

    \n VectorEsriNavigation – The Esri Navigation map style, which\n provides a detailed basemap for the world symbolized with a custom navigation\n map style that's designed for use during the day in mobile devices.

    \n
  • \n
\n

Valid HERE\n Technologies map styles:

\n
    \n
  • \n

    \n VectorHereContrast – The HERE Contrast (Berlin) map style is a \n high contrast\n detailed base map of the world that blends 3D and 2D rendering.

    \n \n

    The VectorHereContrast style has been renamed from \n VectorHereBerlin. \n VectorHereBerlin has been deprecated, but will continue to work in \n applications that use it.

    \n
    \n
  • \n
  • \n

    \n VectorHereExplore – A default HERE map style containing a \n neutral, global map and its features including roads, buildings, landmarks, \n and water features. It also now includes a fully designed map of Japan.

    \n
  • \n
  • \n

    \n VectorHereExploreTruck – A global map containing truck \n restrictions and attributes (e.g. width / height / HAZMAT) symbolized with \n highlighted segments and icons on top of HERE Explore to support use cases \n within transport and logistics.

    \n
  • \n
  • \n

    \n RasterHereExploreSatellite – A global map containing high\n resolution satellite imagery.

    \n
  • \n
  • \n

    \n HybridHereExploreSatellite – A global map displaying the road \n network, street names, and city labels over satellite imagery. This style \n will automatically retrieve both raster and vector tiles, and your charges \n will be based on total tiles retrieved.

    \n \n

    Hybrid styles use both vector and raster tiles when rendering the \n map that you see. This means that more tiles are retrieved than when using \n either vector or raster tiles alone. Your charges will include all tiles \n retrieved.

    \n
    \n
  • \n
\n

Valid GrabMaps map styles:

\n
    \n
  • \n

    \n VectorGrabStandardLight – The Grab Standard Light \n map style provides a basemap with detailed land use coloring, \n area names, roads, landmarks, and points of interest covering \n Southeast Asia.

    \n
  • \n
  • \n

    \n VectorGrabStandardDark – The Grab Standard Dark \n map style provides a dark variation of the standard basemap \n covering Southeast Asia.

    \n
  • \n
\n \n

Grab provides maps only for countries in Southeast Asia, and is only available \n in the Asia Pacific (Singapore) Region (ap-southeast-1).\n For more information, see GrabMaps countries and area covered.

\n
\n

Valid Open Data map styles:

\n
    \n
  • \n

    \n VectorOpenDataStandardLight – The Open Data Standard Light \n map style provides a detailed basemap for the world suitable for\n website and mobile application use. The map includes highways major roads, \n minor roads, railways, water features, cities, parks, landmarks, building\n footprints, and administrative boundaries.

    \n
  • \n
  • \n

    \n VectorOpenDataStandardDark – Open Data Standard Dark is a\n dark-themed map style that provides a detailed basemap for the world \n suitable for website and mobile application use. The map includes highways \n major roads, minor roads, railways, water features, cities, parks, \n landmarks, building footprints, and administrative boundaries.

    \n
  • \n
  • \n

    \n VectorOpenDataVisualizationLight – The Open Data \n Visualization Light map style is a light-themed style with muted colors and\n fewer features that aids in understanding overlaid data.

    \n
  • \n
  • \n

    \n VectorOpenDataVisualizationDark – The Open Data \n Visualization Dark map style is a dark-themed style with muted colors and\n fewer features that aids in understanding overlaid data.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -6585,8 +7155,7 @@ "CustomLayers": { "target": "com.amazonaws.location#CustomLayerList", "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style.\nDefault is unset.

\n \n

Currenlty only VectorEsriNavigation supports CustomLayers. \nFor more information, see Custom Layers.

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

Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style.\nDefault is unset.

\n \n

Not all map resources or styles support custom layers. See Custom Layers for more information.

\n
" } } }, @@ -6606,8 +7175,7 @@ "CustomLayers": { "target": "com.amazonaws.location#CustomLayerList", "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style.\nDefault is unset.

\n \n

Currenlty only VectorEsriNavigation supports CustomLayers. \nFor more information, see Custom Layers.

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

Specifies the custom layers for the style. Leave unset to not enable any custom layer, or, for styles that support custom layers, you can enable layer(s), such as POI layer for the VectorEsriNavigation style.\nDefault is unset.

\n \n

Not all map resources or styles support custom layers. See Custom Layers for more information.

\n
" } } }, @@ -6671,6 +7239,15 @@ "smithy.api#pattern": "^[-._\\w]+$" } }, + "com.amazonaws.location#NearestDistance": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.location#OptimizationMode": { "type": "string", "traits": { @@ -6684,6 +7261,16 @@ ] } }, + "com.amazonaws.location#Pci": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 503 + } + } + }, "com.amazonaws.location#Place": { "type": "structure", "members": { @@ -6762,13 +7349,13 @@ "UnitType": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

For addresses with a UnitNumber, the type of unit. For example,\n Apartment.

\n \n

This property is returned only for a place index that uses Esri as a data provider.

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

For addresses with a UnitNumber, the type of unit. For example,\n Apartment.

\n \n

Returned only for a place index that uses Esri as a data provider.

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

For addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B or Unit 123.

\n \n

This property is returned only for a place index that uses Esri or Grab as a data provider. It is \n not returned for SearchPlaceIndexForPosition.

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

For addresses with multiple units, the unit identifier. Can include numbers and\n letters, for example 3B or Unit 123.

\n \n

Returned only for a place index that uses Esri or Grab as a data provider. Is \n not returned for SearchPlaceIndexForPosition.

\n
" } }, "Categories": { @@ -6786,7 +7373,7 @@ "SubMunicipality": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

An area that's part of a larger municipality. For example, Blissville \n is a submunicipality in the Queen County in New York.

\n \n

This property is only returned for a place index that uses Esri as a data provider. The property is represented as a district.

\n
\n

For more information about data providers, see Amazon Location Service data providers.

" + "smithy.api#documentation": "

An area that's part of a larger municipality. For example, Blissville \n is a submunicipality in the Queen County in New York.

\n \n

This property supported by Esri and OpenData. The Esri property is district, and the OpenData property is borough.

\n
" } } }, @@ -6956,7 +7543,7 @@ "smithy.api#documentation": "

Estimated maximum distance, in meters, between the measured position and the true\n position of a device, along the Earth's surface.

", "smithy.api#range": { "min": 0, - "max": 10000 + "max": 10000000 }, "smithy.api#required": {} } @@ -7074,7 +7661,7 @@ "Geometry": { "target": "com.amazonaws.location#GeofenceGeometry", "traits": { - "smithy.api#documentation": "

Contains the details to specify the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.

\n \n

Each \n geofence polygon can have a maximum of 1,000 vertices.

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

Contains the details to specify the position of the geofence. Can be a\n polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

\n \n

The \n geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

\n
", "smithy.api#required": {} } }, @@ -7293,6 +7880,24 @@ "target": "com.amazonaws.location#RouteMatrixEntry" } }, + "com.amazonaws.location#Rsrp": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": -140, + "max": -44 + } + } + }, + "com.amazonaws.location#Rsrq": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": -19.5, + "max": -3 + } + } + }, "com.amazonaws.location#SearchForPositionResult": { "type": "structure", "members": { @@ -7343,7 +7948,7 @@ "PlaceId": { "target": "com.amazonaws.location#PlaceId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Place. You can use this with the GetPlace\n operation to find the place again later, or to get full information for the Place.

\n

The GetPlace request must use the same PlaceIndex \n resource as the SearchPlaceIndexForSuggestions that generated the Place \n ID.

\n \n

For SearchPlaceIndexForSuggestions operations, the\n PlaceId is returned by place indexes that use Esri, Grab, or HERE\n as data providers.

\n
\n

While you can use PlaceID in subsequent requests, \n PlaceID is not intended to be a permanent \n identifier and the ID can change between consecutive API calls. \n Please see the following PlaceID behaviour for each data provider:

\n
    \n
  • \n

    Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.

    \n
  • \n
  • \n

    HERE: We recommend \n that you cache data for no longer than a week \n to keep your data data fresh. You can \n assume that less than 1% ID shifts will\n release over release which is approximately 1 - 2 times per week.

    \n
  • \n
  • \n

    Grab: Place IDs can expire or become invalid in the following situations.

    \n
      \n
    • \n

      Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth,\n such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.

      \n
    • \n
    • \n

      Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, \n and it will be marked as derived in the place.result_type field in the response. \n The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by \n Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.

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

The unique identifier of the Place. You can use this with the GetPlace\n operation to find the place again later, or to get full information for the Place.

\n

The GetPlace request must use the same PlaceIndex \n resource as the SearchPlaceIndexForSuggestions that generated the Place \n ID.

\n \n

For SearchPlaceIndexForSuggestions operations, the\n PlaceId is returned by place indexes that use Esri, Grab, or HERE\n as data providers.

\n
" } }, "Categories": { @@ -7941,6 +8546,19 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.location#SpeedUnit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KilometersPerHour" + }, + { + "value": "MilesPerHour" + } + ] + } + }, "com.amazonaws.location#Status": { "type": "string", "traits": { @@ -8222,6 +8840,9 @@ }, { "target": "com.amazonaws.location#ListTrackerConsumers" + }, + { + "target": "com.amazonaws.location#VerifyDevicePosition" } ], "traits": { @@ -9014,6 +9635,12 @@ } } }, + "com.amazonaws.location#Uuid": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + } + }, "com.amazonaws.location#ValidationException": { "type": "structure", "members": { @@ -9117,11 +9744,156 @@ ] } }, + "com.amazonaws.location#VerifyDevicePosition": { + "type": "operation", + "input": { + "target": "com.amazonaws.location#VerifyDevicePositionRequest" + }, + "output": { + "target": "com.amazonaws.location#VerifyDevicePositionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.location#AccessDeniedException" + }, + { + "target": "com.amazonaws.location#InternalServerException" + }, + { + "target": "com.amazonaws.location#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.location#ThrottlingException" + }, + { + "target": "com.amazonaws.location#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Verifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state.

", + "smithy.api#endpoint": { + "hostPrefix": "tracking." + }, + "smithy.api#http": { + "uri": "/tracking/v0/trackers/{TrackerName}/positions/verify", + "method": "POST" + } + } + }, + "com.amazonaws.location#VerifyDevicePositionRequest": { + "type": "structure", + "members": { + "TrackerName": { + "target": "com.amazonaws.location#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the tracker resource to be associated with verification request.

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

The device's state, including position, IP address, cell signals and Wi-Fi access points.

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

The distance unit for the verification request.

\n

Default Value: Kilometers\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.location#VerifyDevicePositionResponse": { + "type": "structure", + "members": { + "InferredState": { + "target": "com.amazonaws.location#InferredState", + "traits": { + "smithy.api#documentation": "

The inferred state of the device, given the provided position, IP address, cellular signals, and Wi-Fi- access points.

", + "smithy.api#required": {} + } + }, + "DeviceId": { + "target": "com.amazonaws.location#Id", + "traits": { + "smithy.api#documentation": "

The device identifier.

", + "smithy.api#required": {} + } + }, + "SampleTime": { + "target": "com.amazonaws.location#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp at which the device's position was determined. Uses ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ.

", + "smithy.api#required": {} + } + }, + "ReceivedTime": { + "target": "com.amazonaws.location#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp for when the tracker resource received the device position in ISO 8601 \n format: YYYY-MM-DDThh:mm:ss.sssZ.

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

The distance unit for the verification response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.location#WaypointPositionList": { "type": "list", "member": { "target": "com.amazonaws.location#Position" } + }, + "com.amazonaws.location#WiFiAccessPoint": { + "type": "structure", + "members": { + "MacAddress": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Medium access control address (Mac).

", + "smithy.api#length": { + "min": 12, + "max": 17 + }, + "smithy.api#pattern": "^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$", + "smithy.api#required": {} + } + }, + "Rss": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Received signal strength (dBm) of the WLAN measurement data.

", + "smithy.api#range": { + "min": -128, + "max": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Wi-Fi access point.

" + } + }, + "com.amazonaws.location#WiFiAccessPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#WiFiAccessPoint" + } } } } \ No newline at end of file diff --git a/codegen/sdk/aws-models/sns.json b/codegen/sdk/aws-models/sns.json index c77285f4bf6..b523df57d06 100644 --- a/codegen/sdk/aws-models/sns.json +++ b/codegen/sdk/aws-models/sns.json @@ -1571,7 +1571,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n
    \n
  • \n

    For ADM, PlatformPrincipal is client id\n and PlatformCredential is client secret.

    \n
  • \n
  • \n

    For Baidu, PlatformPrincipal is API key\n and PlatformCredential is secret key.

    \n
  • \n
  • \n

    For APNS and APNS_SANDBOX using certificate\n credentials, PlatformPrincipal is SSL certificate and\n PlatformCredential is private key.

    \n
  • \n
  • \n

    For APNS and APNS_SANDBOX using token credentials,\n PlatformPrincipal is signing key ID and\n PlatformCredential is signing key.

    \n
  • \n
  • \n

    For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal. The PlatformCredential is\n API key.

    \n
  • \n
  • \n

    For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal. The PlatformCredential is a\n JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in\n string format and special characters must be ignored. To format the file\n correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq\n @json <<< cat service.json`.

    \n
  • \n
  • \n

    For MPNS, PlatformPrincipal is TLS\n certificate and PlatformCredential is private\n key.

    \n
  • \n
  • \n

    For WNS, PlatformPrincipal is Package Security\n Identifier and PlatformCredential is secret\n key.

    \n
  • \n
\n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" + "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n
    \n
  • \n

    For ADM, PlatformPrincipal is client id\n and PlatformCredential is client secret.

    \n
  • \n
  • \n

    For APNS and APNS_SANDBOX using certificate\n credentials, PlatformPrincipal is SSL certificate and\n PlatformCredential is private key.

    \n
  • \n
  • \n

    For APNS and APNS_SANDBOX using token credentials,\n PlatformPrincipal is signing key ID and\n PlatformCredential is signing key.

    \n
  • \n
  • \n

    For Baidu, PlatformPrincipal is API key\n and PlatformCredential is secret key.

    \n
  • \n
  • \n

    For GCM (Firebase Cloud Messaging) using key credentials, there is no\n PlatformPrincipal. The PlatformCredential is\n API key.

    \n
  • \n
  • \n

    For GCM (Firebase Cloud Messaging) using token credentials, there is no\n PlatformPrincipal. The PlatformCredential is a\n JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in\n string format and special characters must be ignored. To format the file\n correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq\n @json <<< cat service.json`.

    \n
  • \n
  • \n

    For MPNS, PlatformPrincipal is TLS\n certificate and PlatformCredential is private\n key.

    \n
  • \n
  • \n

    For WNS, PlatformPrincipal is Package Security\n Identifier and PlatformCredential is secret\n key.

    \n
  • \n
\n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" } }, "com.amazonaws.sns#CreatePlatformApplicationInput": { @@ -1794,7 +1794,7 @@ "Attributes": { "target": "com.amazonaws.sns#TopicAttributesMap", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the CreateTopic action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
  • \n
  • \n

    \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

    \n
  • \n
  • \n

    \n FifoTopic – Set to true to create a FIFO topic.

    \n
  • \n
  • \n

    \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

    \n
  • \n
  • \n

    \n SignatureVersion – The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion is set to 1.

    \n
  • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
  • \n
\n

The following attribute applies only to server-side\n encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
  • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – Adds or updates an inline policy document\n to archive messages stored in the specified Amazon SNS topic.

    \n
  • \n
  • \n

    \n BeginningArchiveTime – The earliest starting point at\n which a message in the topic’s archive can be replayed from. This point in time\n is based on the configured message retention period set by the topic’s message\n archiving policy.

    \n
  • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based deduplication for\n FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to false.\n If you create a FIFO topic and this attribute is false, you must\n specify a value for the MessageDeduplicationId parameter for the\n Publish action.

      \n
    • \n
    • \n

      When you set ContentBasedDeduplication to true, \n Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using \n the body of the message (but not the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the Publish\n action.

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

A map of attributes with their corresponding values.

\n

The following lists names, descriptions, and values of the special request\n parameters that the CreateTopic action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
  • \n
  • \n

    \n DisplayName – The display name to use for a topic with SMS\n subscriptions.

    \n
  • \n
  • \n

    \n FifoTopic – Set to true to create a FIFO topic.

    \n
  • \n
  • \n

    \n Policy – The policy that defines who can access your\n topic. By default, only the topic owner can publish or subscribe to the\n topic.

    \n
  • \n
  • \n

    \n SignatureVersion – The signature version corresponds to\n the hashing algorithm used while creating the signature of the notifications,\n subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.\n By default, SignatureVersion is set to 1.

    \n
  • \n
  • \n

    \n TracingConfig – Tracing mode of an Amazon SNS topic. By default\n TracingConfig is set to PassThrough, and the topic\n passes through the tracing header it receives from an Amazon SNS publisher to its\n subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data\n to topic owner account if the sampled flag in the tracing header is true. This\n is only supported on standard topics.

    \n
  • \n
\n

The following attribute applies only to server-side\n encryption:

\n
    \n
  • \n

    \n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SNS or a custom CMK. For more information, see Key\n Terms. For more examples, see KeyId in the Key Management Service API Reference.

    \n
  • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ArchivePolicy – Adds or updates an inline policy document\n to archive messages stored in the specified Amazon SNS topic.

    \n
  • \n
  • \n

    \n BeginningArchiveTime – The earliest starting point at\n which a message in the topic’s archive can be replayed from. This point in time\n is based on the configured message retention period set by the topic’s message\n archiving policy.

    \n
  • \n
  • \n

    \n ContentBasedDeduplication – Enables content-based deduplication for\n FIFO topics.

    \n
      \n
    • \n

      By default, ContentBasedDeduplication is set to false.\n If you create a FIFO topic and this attribute is false, you must\n specify a value for the MessageDeduplicationId parameter for the\n Publish action.

      \n
    • \n
    • \n

      When you set ContentBasedDeduplication to true, \n Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using \n the body of the message (but not the attributes of the message).

      \n

      (Optional) To override the generated value, you can specify a value\n for the MessageDeduplicationId parameter for the Publish\n action.

      \n
    • \n
    \n
  • \n
" } }, "Tags": { @@ -2420,7 +2420,7 @@ "Attributes": { "target": "com.amazonaws.sns#SubscriptionAttributesMap", "traits": { - "smithy.api#documentation": "

A map of the subscription's attributes. Attributes in this map include the\n following:

\n
    \n
  • \n

    \n ConfirmationWasAuthenticatedtrue if the\n subscription confirmation request was authenticated.

    \n
  • \n
  • \n

    \n DeliveryPolicy – The JSON serialization of the\n subscription's delivery policy.

    \n
  • \n
  • \n

    \n EffectiveDeliveryPolicy – The JSON serialization of the\n effective delivery policy that takes into account the topic delivery policy and\n account system defaults.

    \n
  • \n
  • \n

    \n FilterPolicy – The filter policy JSON that is assigned to\n the subscription. For more information, see Amazon SNS Message\n Filtering in the Amazon SNS Developer Guide.

    \n
  • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
    • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

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

    \n Owner – The Amazon Web Services account ID of the subscription's\n owner.

    \n
  • \n
  • \n

    \n PendingConfirmationtrue if the subscription\n hasn't been confirmed. To confirm a pending subscription, call the\n ConfirmSubscription action with a confirmation token.

    \n
  • \n
  • \n

    \n RawMessageDeliverytrue if raw message\n delivery is enabled for the subscription. Raw messages are free of JSON\n formatting and can be sent to HTTP/S and Amazon SQS endpoints.

    \n
  • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
  • \n
  • \n

    \n SubscriptionArn – The subscription's ARN.

    \n
  • \n
  • \n

    \n TopicArn – The topic ARN that the subscription is associated\n with.

    \n
  • \n
\n

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Kinesis Data Firehose delivery stream

      \n
    • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
    • \n
    \n

    Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

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

A map of the subscription's attributes. Attributes in this map include the\n following:

\n
    \n
  • \n

    \n ConfirmationWasAuthenticatedtrue if the\n subscription confirmation request was authenticated.

    \n
  • \n
  • \n

    \n DeliveryPolicy – The JSON serialization of the\n subscription's delivery policy.

    \n
  • \n
  • \n

    \n EffectiveDeliveryPolicy – The JSON serialization of the\n effective delivery policy that takes into account the topic delivery policy and\n account system defaults.

    \n
  • \n
  • \n

    \n FilterPolicy – The filter policy JSON that is assigned to\n the subscription. For more information, see Amazon SNS Message\n Filtering in the Amazon SNS Developer Guide.

    \n
  • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
    • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

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

    \n Owner – The Amazon Web Services account ID of the subscription's\n owner.

    \n
  • \n
  • \n

    \n PendingConfirmationtrue if the subscription\n hasn't been confirmed. To confirm a pending subscription, call the\n ConfirmSubscription action with a confirmation token.

    \n
  • \n
  • \n

    \n RawMessageDeliverytrue if raw message\n delivery is enabled for the subscription. Raw messages are free of JSON\n formatting and can be sent to HTTP/S and Amazon SQS endpoints.

    \n
  • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
  • \n
  • \n

    \n SubscriptionArn – The subscription's ARN.

    \n
  • \n
  • \n

    \n TopicArn – The topic ARN that the subscription is associated\n with.

    \n
  • \n
\n

The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Firehose delivery stream

      \n
    • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
    • \n
    \n

    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.

    \n
  • \n
" } } }, @@ -4037,7 +4037,7 @@ "Subject": { "target": "com.amazonaws.sns#subject", "traits": { - "smithy.api#documentation": "

Optional parameter to be used as the \"Subject\" line when the message is delivered to\n email endpoints. This field will also be included, if present, in the standard JSON\n messages delivered to other endpoints.

\n

Constraints: Subjects must be ASCII text that begins with a letter, number, or\n punctuation mark; must not include line breaks or control characters; and must be less\n than 100 characters long.

" + "smithy.api#documentation": "

Optional parameter to be used as the \"Subject\" line when the message is delivered to\n email endpoints. This field will also be included, if present, in the standard JSON\n messages delivered to other endpoints.

\n

Constraints: Subjects must be UTF-8 text with no line breaks or control characters,\n and less than 100 characters long.

" } }, "MessageStructure": { @@ -4490,7 +4490,7 @@ "AttributeName": { "target": "com.amazonaws.sns#attributeName", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that this action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
  • \n
  • \n

    \n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.

    \n
  • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
    • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

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

    \n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.

    \n
  • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
  • \n
\n

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Kinesis Data Firehose delivery stream

      \n
    • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
    • \n
    \n

    Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

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

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that this action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
  • \n
  • \n

    \n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.

    \n
  • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
    • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

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

    \n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.

    \n
  • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
  • \n
\n

The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Firehose delivery stream

      \n
    • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
    • \n
    \n

    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.

    \n
  • \n
", "smithy.api#required": {} } }, @@ -4648,7 +4648,7 @@ "Attributes": { "target": "com.amazonaws.sns#SubscriptionAttributesMap", "traits": { - "smithy.api#documentation": "

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the Subscribe action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
  • \n
  • \n

    \n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.

    \n
  • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
    • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

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

    \n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.

    \n
  • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
  • \n
\n

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Kinesis Data Firehose delivery stream

      \n
    • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
    • \n
    \n

    Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

    \n
  • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ReplayPolicy – Adds or updates an inline policy document\n for a subscription to replay messages stored in the specified Amazon SNS\n topic.

    \n
  • \n
  • \n

    \n ReplayStatus – Retrieves the status of the subscription\n message replay, which can be one of the following:

    \n
      \n
    • \n

      \n Completed – The replay has successfully\n redelivered all messages, and is now delivering newly published\n messages. If an ending point was specified in the\n ReplayPolicy then the subscription will no longer\n receive newly published messages.

      \n
    • \n
    • \n

      \n In progress – The replay is currently replaying\n the selected messages.

      \n
    • \n
    • \n

      \n Failed – The replay was unable to complete.

      \n
    • \n
    • \n

      \n Pending – The default state while the replay\n initiates.

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

A map of attributes with their corresponding values.

\n

The following lists the names, descriptions, and values of the special request\n parameters that the Subscribe action uses:

\n
    \n
  • \n

    \n DeliveryPolicy – The policy that defines how Amazon SNS retries\n failed deliveries to HTTP/S endpoints.

    \n
  • \n
  • \n

    \n FilterPolicy – The simple JSON object that lets your\n subscriber receive only a subset of messages, rather than receiving every\n message published to the topic.

    \n
  • \n
  • \n

    \n FilterPolicyScope – This attribute lets you choose the\n filtering scope by using one of the following string value types:

    \n
      \n
    • \n

      \n MessageAttributes (default) – The filter is\n applied on the message attributes.

      \n
    • \n
    • \n

      \n MessageBody – The filter is applied on the message\n body.

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

    \n RawMessageDelivery – When set to true,\n enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the\n need for the endpoints to process JSON formatting, which is otherwise created\n for Amazon SNS metadata.

    \n
  • \n
  • \n

    \n RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. \n Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable)\n or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held \n in the dead-letter queue for further analysis or reprocessing.

    \n
  • \n
\n

The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

\n
    \n
  • \n

    \n SubscriptionRoleArn – The ARN of the IAM role that has the following:

    \n
      \n
    • \n

      Permission to write to the Firehose delivery stream

      \n
    • \n
    • \n

      Amazon SNS listed as a trusted entity

      \n
    • \n
    \n

    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. \n For more information, see Fanout \n to Firehose delivery streams in the Amazon SNS Developer Guide.

    \n
  • \n
\n

The following attributes apply only to FIFO topics:

\n
    \n
  • \n

    \n ReplayPolicy – Adds or updates an inline policy document\n for a subscription to replay messages stored in the specified Amazon SNS\n topic.

    \n
  • \n
  • \n

    \n ReplayStatus – Retrieves the status of the subscription\n message replay, which can be one of the following:

    \n
      \n
    • \n

      \n Completed – The replay has successfully\n redelivered all messages, and is now delivering newly published\n messages. If an ending point was specified in the\n ReplayPolicy then the subscription will no longer\n receive newly published messages.

      \n
    • \n
    • \n

      \n In progress – The replay is currently replaying\n the selected messages.

      \n
    • \n
    • \n

      \n Failed – The replay was unable to complete.

      \n
    • \n
    • \n

      \n Pending – The default state while the replay\n initiates.

      \n
    • \n
    \n
  • \n
" } }, "ReturnSubscriptionArn": { diff --git a/codegen/sdk/aws-models/sqs.json b/codegen/sdk/aws-models/sqs.json index 578c7847656..9a96b4f9d07 100644 --- a/codegen/sdk/aws-models/sqs.json +++ b/codegen/sdk/aws-models/sqs.json @@ -3339,7 +3339,7 @@ "smithy.api#deprecated": { "message": "AttributeNames has been replaced by MessageSystemAttributeNames" }, - "smithy.api#documentation": "\n

\n This parameter has been deprecated but will be supported for backward compatibility.\n To provide attribute names, you are encouraged to use MessageSystemAttributeNames. \n

\n
\n

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
  • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
  • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
  • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
  • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
    • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

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

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
  • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
  • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
  • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

    \n
  • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

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

This parameter has been deprecated but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames.

\n
\n

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
  • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
  • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
  • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
  • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
    • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

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

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
  • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
  • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
  • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

    \n
  • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

    \n
  • \n
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -3347,7 +3347,7 @@ "MessageSystemAttributeNames": { "target": "com.amazonaws.sqs#MessageSystemAttributeList", "traits": { - "smithy.api#documentation": "

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
  • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
  • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
  • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
  • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
    • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

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

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
  • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
  • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
  • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

    \n
  • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

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

A list of attributes that need to be returned along with each message. These\n attributes include:

\n
    \n
  • \n

    \n All – Returns all values.

    \n
  • \n
  • \n

    \n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).

    \n
  • \n
  • \n

    \n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.

    \n
  • \n
  • \n

    \n AWSTraceHeader – Returns the X-Ray trace\n header string.

    \n
  • \n
  • \n

    \n SenderId\n

    \n
      \n
    • \n

      For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.

      \n
    • \n
    • \n

      For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

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

    \n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).

    \n
  • \n
  • \n

    \n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).

    \n
  • \n
  • \n

    \n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.

    \n
  • \n
  • \n

    \n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.

    \n
  • \n
  • \n

    \n SequenceNumber – Returns the value provided by\n Amazon SQS.

    \n
  • \n
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -3471,7 +3471,7 @@ "code": "RequestThrottled", "httpResponseCode": 403 }, - "smithy.api#documentation": "

The request was denied due to request throttling.

\n
    \n
  • \n

    The rate of requests per second exceeds the Amazon Web Services KMS request quota for an\n account and Region.

    \n
  • \n
  • \n

    A burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\"

    \n
  • \n
  • \n

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

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

The request was denied due to request throttling.

\n
    \n
  • \n

    The rate of requests per second exceeds the Amazon Web Services KMS request\n quota for an account and Region.

    \n
  • \n
  • \n

    A burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\"

    \n
  • \n
  • \n

    Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.

    \n
  • \n
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -3543,7 +3543,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delivers a message to the specified queue.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

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

Delivers a message to the specified queue.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n
" } }, "com.amazonaws.sqs#SendMessageBatch": { @@ -3608,7 +3608,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.

\n

The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

\n
\n

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.

" + "smithy.api#documentation": "

You can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.

\n

The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

\n
\n

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.

" } }, "com.amazonaws.sqs#SendMessageBatchRequest": { @@ -3791,7 +3791,7 @@ "MessageBody": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "

The message to send. The minimum size is one character. The maximum size is 256\n KiB.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

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

The message to send. The minimum size is one character. The maximum size is 256\n KiB.

\n \n

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.

\n

\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n

\n

Amazon SQS does not throw an exception or completely reject the message if it contains invalid characters. Instead, it replaces those invalid characters with U+FFFD before storing the message in the queue, as long as the message body contains at least one valid character.

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

Sets the value of one or more queue attributes, like a policy. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can\n take up to 15 minutes and will impact existing messages in the queue potentially causing\n them to be expired and deleted if the MessageRetentionPeriod is reduced\n below the age of existing messages.

\n \n
    \n
  • \n

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    \n
  • \n
  • \n

    Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

    \n
  • \n
  • \n

    To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

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

Sets the value of one or more queue attributes, like a policy. When you change a\n queue's attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and will\n impact existing messages in the queue potentially causing them to be expired and deleted\n if the MessageRetentionPeriod is reduced below the age of existing\n messages.

\n \n
    \n
  • \n

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    \n
  • \n
  • \n

    Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.

    \n
  • \n
  • \n

    To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    \n
  • \n
\n
" } }, "com.amazonaws.sqs#SetQueueAttributesRequest": { diff --git a/codegen/sdk/aws-models/storage-gateway.json b/codegen/sdk/aws-models/storage-gateway.json index be8461e5675..2e87c99d343 100644 --- a/codegen/sdk/aws-models/storage-gateway.json +++ b/codegen/sdk/aws-models/storage-gateway.json @@ -818,6 +818,23 @@ } } }, + "com.amazonaws.storagegateway#AutomaticUpdatePolicy": { + "type": "enum", + "members": { + "ALL_VERSIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VERSIONS" + } + }, + "EMERGENCY_VERSIONS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMERGENCY_VERSIONS_ONLY" + } + } + } + }, "com.amazonaws.storagegateway#AvailabilityMonitorTestStatus": { "type": "enum", "members": { @@ -3789,7 +3806,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns your gateway's weekly maintenance start time including the day and time of\n the week. Note that values are in terms of the gateway's time zone.

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

Returns your gateway's maintenance window schedule information, with values for\n monthly or weekly cadence, specific day and time to begin maintenance, and which types of\n updates to apply. Time values returned are for the gateway's time zone.

", "smithy.api#examples": [ { "title": "To describe gateway's maintenance start time", @@ -3850,7 +3867,7 @@ "DayOfMonth": { "target": "com.amazonaws.storagegateway#DayOfMonth", "traits": { - "smithy.api#documentation": "

The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.

" + "smithy.api#documentation": "

The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month. It is not possible to\n set the maintenance schedule to start on days 29 through 31.

" } }, "Timezone": { @@ -3858,10 +3875,16 @@ "traits": { "smithy.api#documentation": "

A value that indicates the time zone that is set for the gateway. The start time and day\n of week specified should be in the time zone of the gateway.

" } + }, + "SoftwareUpdatePreferences": { + "target": "com.amazonaws.storagegateway#SoftwareUpdatePreferences", + "traits": { + "smithy.api#documentation": "

A set of variables indicating the software update preferences for the gateway.

\n

Includes AutomaticUpdatePolicy field with the following inputs:

\n

\n ALL_VERSIONS - Enables regular gateway maintenance updates.

\n

\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance\n updates.

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

A JSON object containing the following fields:

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

A JSON object containing the following fields:

\n ", "smithy.api#output": {} } }, @@ -4028,7 +4051,7 @@ "SMBSecurityStrategy": { "target": "com.amazonaws.storagegateway#SMBSecurityStrategy", "traits": { - "smithy.api#documentation": "

The type of security strategy that was specified for file gateway.

\n
    \n
  • \n

    \n ClientSpecified: If you choose this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment. Supported\n only for S3 File Gateway.

    \n
  • \n
  • \n

    \n MandatorySigning: If you use this option, File Gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing turned on. This option\n works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.\n

    \n
  • \n
  • \n

    \n MandatoryEncryption: If you use this option, File Gateway only allows\n connections from SMBv3 clients that have encryption turned on. Both 256-bit and\n 128-bit algorithms are allowed. This option is recommended for environments that\n handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows\n Server 2012, or later.

    \n
  • \n
  • \n

    \n EnforceEncryption: If you use this option, File Gateway only allows\n connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit\n algorithms are not allowed. This option is recommended for environments that handle\n sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server\n 2012, or later.

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

The type of security strategy that was specified for file gateway.

\n
    \n
  • \n

    \n ClientSpecified: If you choose this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment. Supported\n only for S3 File Gateway.

    \n
  • \n
  • \n

    \n MandatorySigning: If you choose this option, File Gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing turned on. This option\n works with SMB clients on Microsoft Windows Vista, Windows Server 2008, or later.\n

    \n
  • \n
  • \n

    \n MandatoryEncryption: If you choose this option, File Gateway only\n allows connections from SMBv3 clients that have encryption turned on. Both 256-bit\n and 128-bit algorithms are allowed. This option is recommended for environments that\n handle sensitive data. It works with SMB clients on Microsoft Windows 8, Windows\n Server 2012, or later.

    \n
  • \n
  • \n

    \n MandatoryEncryptionNoAes128: If you choose this option, File Gateway\n only allows connections from SMBv3 clients that use 256-bit AES encryption\n algorithms. 128-bit algorithms are not allowed. This option is recommended for\n environments that handle sensitive data. It works with SMB clients on Microsoft\n Windows 8, Windows Server 2012, or later.

    \n
  • \n
" } }, "FileSharesVisible": { @@ -8546,6 +8569,20 @@ "smithy.api#pattern": "^\\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\\z$" } }, + "com.amazonaws.storagegateway#SoftwareUpdatePreferences": { + "type": "structure", + "members": { + "AutomaticUpdatePolicy": { + "target": "com.amazonaws.storagegateway#AutomaticUpdatePolicy", + "traits": { + "smithy.api#documentation": "

Indicates the automatic update policy for a gateway.

\n

\n ALL_VERSIONS - Enables regular gateway maintenance updates.

\n

\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance\n updates.

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

A set of variables indicating the software update preferences for the gateway.

" + } + }, "com.amazonaws.storagegateway#SoftwareUpdatesEndDate": { "type": "string", "traits": { @@ -10902,7 +10939,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a gateway's metadata, which includes the gateway's name and time zone.\n To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in\n your request.

\n \n

For gateways activated after September 2, 2015, the gateway's ARN contains the\n gateway ID rather than the gateway name. However, changing the name of the gateway has\n no effect on the gateway's ARN.

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

Updates a gateway's metadata, which includes the gateway's name, time zone,\n and metadata cache size. To specify which gateway to update, use the Amazon Resource Name\n (ARN) of the gateway in your request.

\n \n

For gateways activated after September 2, 2015, the gateway's ARN contains the\n gateway ID rather than the gateway name. However, changing the name of the gateway has\n no effect on the gateway's ARN.

\n
", "smithy.api#examples": [ { "title": "To update a gateway's metadata", @@ -10947,7 +10984,7 @@ "GatewayCapacity": { "target": "com.amazonaws.storagegateway#GatewayCapacity", "traits": { - "smithy.api#documentation": "

Specifies the size of the gateway's metadata cache.

" + "smithy.api#documentation": "

Specifies the size of the gateway's metadata cache. This setting impacts gateway\n performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares\n in the Amazon S3 File Gateway User Guide.

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

Updates a gateway's weekly maintenance start time information, including day and\n time of the week. The maintenance time is the time in your gateway's time zone.

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

Updates a gateway's maintenance window schedule, with settings for monthly or\n weekly cadence, specific day and time to begin maintenance, and which types of updates to\n apply. Time configuration uses the gateway's time zone. You can pass values for a complete\n maintenance schedule, or update policy, or both. Previous values will persist for whichever\n setting you choose not to modify. If an incomplete or invalid maintenance schedule is\n passed, the entire request will be rejected with an error and no changes will occur.

\n

A complete maintenance schedule must include values for both\n MinuteOfHour and HourOfDay, and either\n DayOfMonth\n or\n DayOfWeek.

\n \n

We recommend keeping maintenance updates turned on, except in specific use cases\n where the brief disruptions caused by updating the gateway could critically impact your\n deployment.

\n
", "smithy.api#examples": [ { "title": "To update a gateway's maintenance start time", @@ -11079,32 +11116,36 @@ "HourOfDay": { "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { - "smithy.api#documentation": "

The hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time\n zone of the gateway.

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

The hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time\n zone of the gateway.

" } }, "MinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { - "smithy.api#documentation": "

The minute component of the maintenance start time represented as\n mm, where mm is the minute (00 to 59). The\n minute of the hour is in the time zone of the gateway.

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

The minute component of the maintenance start time represented as\n mm, where mm is the minute (00 to 59). The\n minute of the hour is in the time zone of the gateway.

" } }, "DayOfWeek": { "target": "com.amazonaws.storagegateway#DayOfWeek", "traits": { - "smithy.api#documentation": "

The day of the week component of the maintenance start time week represented as an\n ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.

" + "smithy.api#documentation": "

The day of the week component of the maintenance start time week represented as an\n ordinal number from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

" } }, "DayOfMonth": { "target": "com.amazonaws.storagegateway#DayOfMonth", "traits": { - "smithy.api#documentation": "

The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.

" + "smithy.api#documentation": "

The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month. It is not possible to\n set the maintenance schedule to start on days 29 through 31.

" + } + }, + "SoftwareUpdatePreferences": { + "target": "com.amazonaws.storagegateway#SoftwareUpdatePreferences", + "traits": { + "smithy.api#documentation": "

A set of variables indicating the software update preferences for the gateway.

\n

Includes AutomaticUpdatePolicy field with the following inputs:

\n

\n ALL_VERSIONS - Enables regular gateway maintenance updates.

\n

\n EMERGENCY_VERSIONS_ONLY - Disables regular gateway maintenance\n updates.

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

A JSON object containing the following fields:

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

A JSON object containing the following fields:

\n ", "smithy.api#input": {} } }, @@ -11535,7 +11576,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the SMB security strategy on a file gateway. This action is only supported in\n file gateways.

\n \n

This API is called Security level in the User Guide.

\n

A higher security level can affect performance of the gateway.

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

Updates the SMB security strategy level for an Amazon S3 file gateway. This\n action is only supported for Amazon S3 file gateways.

\n \n

For information about configuring this setting using the Amazon Web Services console,\n see Setting a security level for your gateway in the Amazon S3\n File Gateway User Guide.

\n

A higher security strategy level can affect performance of the gateway.

\n
" } }, "com.amazonaws.storagegateway#UpdateSMBSecurityStrategyInput": { @@ -11550,7 +11591,7 @@ "SMBSecurityStrategy": { "target": "com.amazonaws.storagegateway#SMBSecurityStrategy", "traits": { - "smithy.api#documentation": "

Specifies the type of security strategy.

\n

ClientSpecified: if you use this option, requests are established based on what is\n negotiated by the client. This option is recommended when you want to maximize\n compatibility across different clients in your environment. Supported only in S3 File\n Gateway.

\n

MandatorySigning: if you use this option, file gateway only allows connections from\n SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on\n Microsoft Windows Vista, Windows Server 2008 or newer.

\n

MandatoryEncryption: if you use this option, file gateway only allows connections from\n SMBv3 clients that have encryption enabled. This option is highly recommended for\n environments that handle sensitive data. This option works with SMB clients on Microsoft\n Windows 8, Windows Server 2012 or newer.

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

Specifies the type of security strategy.

\n

\n ClientSpecified: If you choose this option, requests are established based\n on what is negotiated by the client. This option is recommended when you want to maximize\n compatibility across different clients in your environment. Supported only for S3 File\n Gateway.

\n

\n MandatorySigning: If you choose this option, File Gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with\n SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

\n

\n MandatoryEncryption: If you choose this option, File Gateway only allows\n connections from SMBv3 clients that have encryption enabled. This option is recommended for\n environments that handle sensitive data. This option works with SMB clients on Microsoft\n Windows 8, Windows Server 2012 or newer.

\n

\n MandatoryEncryptionNoAes128: If you choose this option, File Gateway only\n allows connections from SMBv3 clients that use 256-bit AES encryption algorithms. 128-bit\n algorithms are not allowed. This option is recommended for environments that handle\n sensitive data. It works with SMB clients on Microsoft Windows 8, Windows Server 2012, or\n later.

", "smithy.api#required": {} } } From 15f29e636694da40b0fd020c6ba469d9f97bd6a4 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 6 Jun 2024 18:06:51 +0000 Subject: [PATCH 32/41] chore: release 1.2.28 --- CHANGELOG.md | 15 +++++++++++++++ gradle.properties | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2cbba8d5b2b..2e988562c18 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,20 @@ # Changelog +## [1.2.28] - 06/06/2024 + +### Features +* (**account**) This release adds 3 new APIs (AcceptPrimaryEmailUpdate, GetPrimaryEmail, and StartPrimaryEmailUpdate) used to centrally manage the root user email address of member accounts within an AWS organization. +* (**firehose**) Adds integration with Secrets Manager for Redshift, Splunk, HttpEndpoint, and Snowflake destinations +* (**fsx**) This release adds support to increase metadata performance on FSx for Lustre file systems beyond the default level provisioned when a file system is created. This can be done by specifying MetadataConfiguration during the creation of Persistent_2 file systems or by updating it on demand. +* (**glue**) This release adds support for creating and updating Glue Data Catalog Views. +* (**iotwireless**) Adds support for wireless device to be in Conflict FUOTA Device Status due to a FUOTA Task, so it couldn't be attached to a new one. +* (**location**) Added two new APIs, VerifyDevicePosition and ForecastGeofenceEvents. Added support for putting larger geofences up to 100,000 vertices with Geobuf fields. +* (**storagegateway**) Adds SoftwareUpdatePreferences to DescribeMaintenanceStartTime and UpdateMaintenanceStartTime, a structure which contains AutomaticUpdatePolicy. + +### Documentation +* (**sns**) Doc-only update for SNS. These changes include customer-reported issues and TXC3 updates. +* (**sqs**) Doc only updates for SQS. These updates include customer-reported issues and TCX3 modifications. + ## [1.2.27] - 06/05/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 0c0101a6852..c385828f574 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.2.28-SNAPSHOT +sdkVersion=1.2.28 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From e93d6b83b15467e5b03b918f0f199b3d33c769f0 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Thu, 6 Jun 2024 18:06:52 +0000 Subject: [PATCH 33/41] chore: bump snapshot version to 1.2.29-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index c385828f574..6304f2a9afa 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.2.28 +sdkVersion=1.2.29-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From e502bccaa9e39bb619593a3b07060cf22c04f1c7 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 7 Jun 2024 18:03:49 +0000 Subject: [PATCH 34/41] feat: update AWS API models --- codegen/sdk/aws-models/auditmanager.json | 179 ++++-- codegen/sdk/aws-models/b2bi.json | 48 +- codegen/sdk/aws-models/codepipeline.json | 58 +- codegen/sdk/aws-models/sagemaker.json | 35 +- .../sdk/aws-models/verifiedpermissions.json | 561 +++++++++++++++++- 5 files changed, 814 insertions(+), 67 deletions(-) diff --git a/codegen/sdk/aws-models/auditmanager.json b/codegen/sdk/aws-models/auditmanager.json index ba6977be4ad..003dfcb8a56 100644 --- a/codegen/sdk/aws-models/auditmanager.json +++ b/codegen/sdk/aws-models/auditmanager.json @@ -2868,12 +2868,28 @@ "traits": { "smithy.api#documentation": "

The tags associated with the control.

" } + }, + "state": { + "target": "com.amazonaws.auditmanager#ControlState", + "traits": { + "smithy.api#documentation": "

The state of the control. The END_OF_SUPPORT state is applicable to\n standard controls only. This state indicates that the standard control can still be used to\n collect evidence, but Audit Manager is no longer updating or maintaining that\n control.

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

A control in Audit Manager.

" } }, + "com.amazonaws.auditmanager#ControlCatalogId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 13, + "max": 2048 + }, + "smithy.api#pattern": "^arn:.*:controlcatalog:.*|UNCATEGORIZED$" + } + }, "com.amazonaws.auditmanager#ControlComment": { "type": "structure", "members": { @@ -2924,22 +2940,33 @@ "min": 0, "max": 1000 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.auditmanager#ControlDomainId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 13, + "max": 2048 + }, + "smithy.api#pattern": "^arn:.*:controlcatalog:.*:.*:domain/.*|UNCATEGORIZED|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.auditmanager#ControlDomainInsights": { "type": "structure", "members": { "name": { - "target": "com.amazonaws.auditmanager#NonEmptyString", + "target": "com.amazonaws.auditmanager#String", "traits": { "smithy.api#documentation": "

The name of the control domain.

" } }, "id": { - "target": "com.amazonaws.auditmanager#UUID", + "target": "com.amazonaws.auditmanager#ControlDomainId", "traits": { - "smithy.api#documentation": "

The unique identifier for the control domain.

" + "smithy.api#documentation": "

The unique identifier for the control domain. Audit Manager supports the control\n domains that are provided by Amazon Web Services Control Catalog. For information about how\n to find a list of available control domains, see \n ListDomains\n in the Amazon Web Services Control Catalog API\n Reference.

" } }, "controlsCountByNoncompliantEvidence": { @@ -2993,13 +3020,13 @@ "type": "structure", "members": { "name": { - "target": "com.amazonaws.auditmanager#NonEmptyString", + "target": "com.amazonaws.auditmanager#String", "traits": { "smithy.api#documentation": "

The name of the assessment control.

" } }, "id": { - "target": "com.amazonaws.auditmanager#UUID", + "target": "com.amazonaws.auditmanager#ControlDomainId", "traits": { "smithy.api#documentation": "

The unique identifier for the assessment control.

" } @@ -3031,13 +3058,13 @@ "type": "structure", "members": { "name": { - "target": "com.amazonaws.auditmanager#NonEmptyString", + "target": "com.amazonaws.auditmanager#String", "traits": { "smithy.api#documentation": "

The name of the control.

" } }, "id": { - "target": "com.amazonaws.auditmanager#UUID", + "target": "com.amazonaws.auditmanager#ControlDomainId", "traits": { "smithy.api#documentation": "

The unique identifier for the control.

" } @@ -3083,13 +3110,13 @@ "sourceSetUpOption": { "target": "com.amazonaws.auditmanager#SourceSetUpOption", "traits": { - "smithy.api#documentation": "

The setup option for the data source. This option reflects if the evidence collection\n is automated or manual.

" + "smithy.api#documentation": "

The setup option for the data source. This option reflects if the evidence collection\n method is automated or manual. If you don’t provide a value for\n sourceSetUpOption, Audit Manager automatically infers and populates\n the correct value based on the sourceType that you specify.

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

Specifies one of the five data source types for evidence collection.

" + "smithy.api#documentation": "

Specifies which type of data source is used to collect evidence.

\n
    \n
  • \n

    The source can be an individual data source type, such as\n AWS_Cloudtrail, AWS_Config,\n AWS_Security_Hub, AWS_API_Call, or MANUAL.\n

    \n
  • \n
  • \n

    The source can also be a managed grouping of data sources, such as a\n Core_Control or a Common_Control.

    \n
  • \n
" } }, "sourceKeyword": { @@ -3309,6 +3336,23 @@ "smithy.api#pattern": "^[a-zA-Z_0-9-\\s.,]+$" } }, + "com.amazonaws.auditmanager#ControlState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "END_OF_SUPPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "END_OF_SUPPORT" + } + } + } + }, "com.amazonaws.auditmanager#ControlStatus": { "type": "enum", "members": { @@ -3346,6 +3390,12 @@ "traits": { "smithy.api#enumValue": "Custom" } + }, + "CORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Core" + } } } }, @@ -3387,6 +3437,9 @@ { "target": "com.amazonaws.auditmanager#ServiceQuotaExceededException" }, + { + "target": "com.amazonaws.auditmanager#ThrottlingException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } @@ -3743,13 +3796,13 @@ "sourceSetUpOption": { "target": "com.amazonaws.auditmanager#SourceSetUpOption", "traits": { - "smithy.api#documentation": "

The setup option for the data source, which reflects if the evidence collection is\n automated or manual.

" + "smithy.api#documentation": "

The setup option for the data source. This option reflects if the evidence collection\n method is automated or manual. If you don’t provide a value for\n sourceSetUpOption, Audit Manager automatically infers and populates\n the correct value based on the sourceType that you specify.

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

Specifies one of the five types of data sources for evidence collection.

" + "smithy.api#documentation": "

Specifies which type of data source is used to collect evidence.

\n
    \n
  • \n

    The source can be an individual data source type, such as\n AWS_Cloudtrail, AWS_Config,\n AWS_Security_Hub, AWS_API_Call, or MANUAL.\n

    \n
  • \n
  • \n

    The source can also be a managed grouping of data sources, such as a\n Core_Control or a Common_Control.

    \n
  • \n
" } }, "sourceKeyword": { @@ -3769,7 +3822,7 @@ } }, "traits": { - "smithy.api#documentation": "

The control mapping fields that represent the source for evidence collection, along\n with related parameters and metadata. This doesn't contain mappingID.

" + "smithy.api#documentation": "

The mapping attributes that determine the evidence source for a given control, along\n with related parameters and metadata. This doesn't contain mappingID.

" } }, "com.amazonaws.auditmanager#CreateControlMappingSources": { @@ -3905,6 +3958,41 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.auditmanager#DataSourceType": { + "type": "enum", + "members": { + "AWS_CLOUDTRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_Cloudtrail" + } + }, + "AWS_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_Config" + } + }, + "AWS_SECURITY_HUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_Security_Hub" + } + }, + "AWS_API_CALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_API_Call" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, "com.amazonaws.auditmanager#DefaultExportDestination": { "type": "structure", "members": { @@ -6262,7 +6350,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all of the Amazon Web Services that you can choose to include in\n your assessment. When you create an assessment, specify which of these services you want to include to\n narrow the assessment's scope.

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

Gets a list of the Amazon Web Services from which Audit Manager can collect\n evidence.

\n

Audit Manager defines which Amazon Web Services are in scope for an\n assessment. Audit Manager infers this scope by examining the assessment’s controls and\n their data sources, and then mapping this information to one or more of the corresponding\n Amazon Web Services that are in this list.

\n \n

For information about why it's no longer possible to specify services in scope manually, see\n I can't edit the services in scope for my assessment in\n the Troubleshooting section of the Audit Manager user\n guide.

\n
", "smithy.api#http": { "method": "GET", "uri": "/services", @@ -6512,7 +6600,7 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "^[a-zA-Z_0-9-\\s().]+$" + "smithy.api#pattern": "^[a-zA-Z_0-9-\\s().:\\/]+$" } }, "com.amazonaws.auditmanager#Keywords": { @@ -6582,9 +6670,9 @@ "type": "structure", "members": { "controlDomainId": { - "target": "com.amazonaws.auditmanager#UUID", + "target": "com.amazonaws.auditmanager#ControlDomainId", "traits": { - "smithy.api#documentation": "

The unique identifier for the control domain.

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

The unique identifier for the control domain.

\n

Audit Manager supports the control domains that are provided by Amazon Web Services\n Control Catalog. For information about how to find a list of available control domains, see\n \n ListDomains\n in the Amazon Web Services Control\n Catalog API Reference.

", "smithy.api#httpQuery": "controlDomainId", "smithy.api#required": {} } @@ -6988,7 +7076,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the latest analytics data for control domains across all of your active\n assessments.

\n \n

A control domain is listed only if at least one of the controls within that domain\n collected evidence on the lastUpdated date of\n controlDomainInsights. If this condition isn’t met, no data is listed\n for that control domain.

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

Lists the latest analytics data for control domains across all of your active\n assessments.

\n

Audit Manager supports the control domains that are provided by Amazon Web Services\n Control Catalog. For information about how to find a list of available control domains, see\n \n ListDomains\n in the Amazon Web Services Control\n Catalog API Reference.

\n \n

A control domain is listed only if at least one of the controls within that domain\n collected evidence on the lastUpdated date of\n controlDomainInsights. If this condition isn’t met, no data is listed\n for that control domain.

\n
", "smithy.api#http": { "method": "GET", "uri": "/insights/control-domains", @@ -7024,7 +7112,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists analytics data for control domains within a specified active assessment.

\n \n

A control domain is listed only if at least one of the controls within that domain\n collected evidence on the lastUpdated date of\n controlDomainInsights. If this condition isn’t met, no data is listed\n for that domain.

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

Lists analytics data for control domains within a specified active assessment.

\n

Audit Manager supports the control domains that are provided by Amazon Web Services\n Control Catalog. For information about how to find a list of available control domains, see\n \n ListDomains\n in the Amazon Web Services Control\n Catalog API Reference.

\n \n

A control domain is listed only if at least one of the controls within that domain\n collected evidence on the lastUpdated date of\n controlDomainInsights. If this condition isn’t met, no data is listed\n for that domain.

\n
", "smithy.api#http": { "method": "GET", "uri": "/insights/control-domains-by-assessment", @@ -7169,9 +7257,9 @@ "type": "structure", "members": { "controlDomainId": { - "target": "com.amazonaws.auditmanager#UUID", + "target": "com.amazonaws.auditmanager#ControlDomainId", "traits": { - "smithy.api#documentation": "

The unique identifier for the control domain.

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

The unique identifier for the control domain.

\n

Audit Manager supports the control domains that are provided by Amazon Web Services\n Control Catalog. For information about how to find a list of available control domains, see\n \n ListDomains\n in the Amazon Web Services Control\n Catalog API Reference.

", "smithy.api#httpQuery": "controlDomainId", "smithy.api#required": {} } @@ -7254,7 +7342,7 @@ "controlType": { "target": "com.amazonaws.auditmanager#ControlType", "traits": { - "smithy.api#documentation": "

The type of control, such as a standard control or a custom control.

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

A filter that narrows the list of controls to a specific type.

", "smithy.api#httpQuery": "controlType", "smithy.api#required": {} } @@ -7262,16 +7350,23 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

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

The pagination token that's used to fetch the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "

Represents the maximum number of results on a page or for an API request call.

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

The maximum number of results on a page or for an API request call.

", "smithy.api#httpQuery": "maxResults" } + }, + "controlCatalogId": { + "target": "com.amazonaws.auditmanager#ControlCatalogId", + "traits": { + "smithy.api#documentation": "

A filter that narrows the list of controls to a specific resource from the Amazon Web Services \n Control Catalog.

\n

To use this parameter, specify the ARN of the Control Catalog resource. You can specify either \n a control domain, a control objective, or a common control. For information about how to find the ARNs\n for these resources, see \n ListDomains\n , \n ListObjectives\n , and \n ListCommonControls\n .

\n \n

You can only filter by one Control Catalog resource at a time. \n Specifying multiple resource ARNs isn’t currently supported. If you want to filter by more \n than one ARN, we recommend that you run the ListControls operation separately \n for each ARN.

\n
\n

Alternatively, specify UNCATEGORIZED to list controls that aren't\n mapped to a Control Catalog resource. For example, this operation might return a list of \n custom controls that don't belong to any control domain or control objective.

", + "smithy.api#httpQuery": "controlCatalogId" + } } }, "traits": { @@ -7290,7 +7385,7 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

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

Returns a list of keywords that are pre-mapped to the specified control data source.\n

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

Returns a list of keywords that are pre-mapped to the specified control data\n source.

", "smithy.api#http": { "method": "GET", "uri": "/dataSourceKeywords", @@ -7335,9 +7430,9 @@ "type": "structure", "members": { "source": { - "target": "com.amazonaws.auditmanager#SourceType", + "target": "com.amazonaws.auditmanager#DataSourceType", "traits": { - "smithy.api#documentation": "

The control mapping data source that the keywords apply to.

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

The control mapping data source that the keywords apply to.

", "smithy.api#httpQuery": "source", "smithy.api#required": {} } @@ -7367,7 +7462,7 @@ "keywords": { "target": "com.amazonaws.auditmanager#Keywords", "traits": { - "smithy.api#documentation": "

The list of keywords for the event mapping source.

" + "smithy.api#documentation": "

The list of keywords for the control mapping source.

" } }, "nextToken": { @@ -7987,12 +8082,15 @@ "awsServices": { "target": "com.amazonaws.auditmanager#AWSServices", "traits": { - "smithy.api#documentation": "

The Amazon Web Services services that are included in the scope of the assessment.\n

" + "smithy.api#deprecated": { + "message": "You can't specify services in scope when creating/updating an assessment. If you use the parameter to specify one or more AWS services, Audit Manager ignores the input. Instead the value of the parameter will show as empty indicating that the services are defined and managed by Audit Manager." + }, + "smithy.api#documentation": "

The Amazon Web Services services that are included in the scope of the assessment.\n

\n \n

This API parameter is no longer supported. If you use this parameter to specify one\n or more Amazon Web Services, Audit Manager ignores this input. Instead, the\n value for awsServices will show as empty.

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

The wrapper that contains the Amazon Web Services accounts and services that are in\n scope for the assessment.

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

The wrapper that contains the Amazon Web Services accounts that are in\n scope for the assessment.

\n \n

You no longer need to specify which Amazon Web Services are in scope when you\n create or update an assessment. Audit Manager infers the services in scope by\n examining your assessment controls and their data sources, and then mapping this\n information to the relevant Amazon Web Services.

\n

If an underlying data source changes for your assessment, we automatically update the\n services scope as needed to reflect the correct Amazon Web Services. This\n ensures that your assessment collects accurate and comprehensive evidence about all of\n the relevant services in your AWS environment.

\n
", "smithy.api#sensitive": {} } }, @@ -8330,7 +8428,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 300 } } }, @@ -8383,6 +8481,18 @@ "traits": { "smithy.api#enumValue": "MANUAL" } + }, + "COMMON_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Common_Control" + } + }, + "CORE_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Core_Control" + } } } }, @@ -8606,7 +8716,7 @@ "traits": { "smithy.api#documentation": "

The request was denied due to request throttling.

", "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#httpError": 429 } }, "com.amazonaws.auditmanager#Timestamp": { @@ -8750,6 +8860,9 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ThrottlingException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } diff --git a/codegen/sdk/aws-models/b2bi.json b/codegen/sdk/aws-models/b2bi.json index 5b8c4196926..962797f8120 100644 --- a/codegen/sdk/aws-models/b2bi.json +++ b/codegen/sdk/aws-models/b2bi.json @@ -1242,7 +1242,8 @@ "capabilities": { "target": "com.amazonaws.b2bi#PartnershipCapabilities", "traits": { - "smithy.api#documentation": "

Specifies a list of the capabilities associated with this partnership.

" + "smithy.api#documentation": "

Specifies a list of the capabilities associated with this partnership.

", + "smithy.api#required": {} } }, "clientToken": { @@ -2848,6 +2849,20 @@ "output": { "target": "com.amazonaws.b2bi#ListCapabilitiesResponse" }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], "traits": { "smithy.api#documentation": "

Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

", "smithy.api#examples": [ @@ -3053,6 +3068,20 @@ "output": { "target": "com.amazonaws.b2bi#ListProfilesResponse" }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], "traits": { "smithy.api#documentation": "

Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of\n a private network.

", "smithy.api#examples": [ @@ -3217,6 +3246,20 @@ "output": { "target": "com.amazonaws.b2bi#ListTransformersResponse" }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], "traits": { "smithy.api#documentation": "

Lists the available transformers. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.

", "smithy.api#examples": [ @@ -3739,6 +3782,9 @@ { "target": "com.amazonaws.b2bi#AccessDeniedException" }, + { + "target": "com.amazonaws.b2bi#ConflictException" + }, { "target": "com.amazonaws.b2bi#InternalServerException" }, diff --git a/codegen/sdk/aws-models/codepipeline.json b/codegen/sdk/aws-models/codepipeline.json index fd5aa3e825c..777d741a7d5 100644 --- a/codegen/sdk/aws-models/codepipeline.json +++ b/codegen/sdk/aws-models/codepipeline.json @@ -3653,12 +3653,12 @@ "result": { "target": "com.amazonaws.codepipeline#Result", "traits": { - "smithy.api#documentation": "

The specified result for when the failure conditions are met, such as rolling back the stage.

" + "smithy.api#documentation": "

The specified result for when the failure conditions are met, such as rolling back the\n stage.

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

The configuration that specifies the result, such as rollback, to occur upon stage failure.

" + "smithy.api#documentation": "

The configuration that specifies the result, such as rollback, to occur upon stage\n failure.

" } }, "com.amazonaws.codepipeline#FailureDetails": { @@ -3871,7 +3871,22 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to\n return the entire structure of a pipeline in JSON format, which can then be modified and\n used to update the pipeline structure with UpdatePipeline.

" + "smithy.api#documentation": "

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to\n return the entire structure of a pipeline in JSON format, which can then be modified and\n used to update the pipeline structure with UpdatePipeline.

", + "smithy.test#smokeTests": [ + { + "id": "GetPipelineFailure", + "params": { + "name": "fake-pipeline" + }, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] } }, "com.amazonaws.codepipeline#GetPipelineExecution": { @@ -4953,7 +4968,7 @@ "maxResults": { "target": "com.amazonaws.codepipeline#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. Action execution history\n is retained for up to 12 months, based on action execution start times. Default value is\n 100.

\n \n

Detailed execution history is available for executions run on or after February\n 21, 2019.

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

The maximum number of results to return in a single call. To retrieve the remaining\n results, make another call with the returned nextToken value. Action execution history\n is retained for up to 12 months, based on action execution start times. Default value is\n 100.

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

Gets a summary of the most recent executions for a pipeline.

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

Gets a summary of the most recent executions for a pipeline.

\n \n

When applying the filter for pipeline executions that have succeeded in the stage,\n the operation returns all executions in the current pipeline version beginning on\n February 1, 2024.

\n
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5168,7 +5183,20 @@ "outputToken": "nextToken", "items": "pipelines", "pageSize": "maxResults" - } + }, + "smithy.test#smokeTests": [ + { + "id": "ListPipelinesSuccess", + "params": {}, + "vendorParams": { + "region": "us-west-2" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} + } + } + ] } }, "com.amazonaws.codepipeline#ListPipelinesInput": { @@ -5828,7 +5856,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.

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

The specified pipeline execution is outdated and cannot be used as a target pipeline\n execution for rollback.

", "smithy.api#error": "client" } }, @@ -7425,7 +7453,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list that allows you to specify, or override, the source revision for a pipeline\n execution that's being started. A source revision is the version with all the changes to\n your application code, or source artifact, for the pipeline execution.

" + "smithy.api#documentation": "

A list that allows you to specify, or override, the source revision for a pipeline\n execution that's being started. A source revision is the version with all the changes to\n your application code, or source artifact, for the pipeline execution.

\n \n

For the S3_OBJECT_VERSION_ID and S3_OBJECT_KEY types of source revisions, either\n of the types can be used independently, or they can be used together to override the\n source with a specific ObjectKey and VersionID.

\n
" } }, "com.amazonaws.codepipeline#SourceRevisionOverrideList": { @@ -7460,6 +7488,12 @@ "traits": { "smithy.api#enumValue": "S3_OBJECT_VERSION_ID" } + }, + "S3_OBJECT_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_OBJECT_KEY" + } } } }, @@ -7515,7 +7549,7 @@ "onFailure": { "target": "com.amazonaws.codepipeline#FailureConditions", "traits": { - "smithy.api#documentation": "

The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

" + "smithy.api#documentation": "

The method to use when a stage has not completed successfully. For example,\n configuring this field for rollback will roll back a failed stage automatically to the\n last successful pipeline execution in the stage.

" } } }, @@ -7543,7 +7577,7 @@ "type": { "target": "com.amazonaws.codepipeline#ExecutionType", "traits": { - "smithy.api#documentation": "

The type of pipeline execution for the stage, such as a rollback pipeline execution.

" + "smithy.api#documentation": "

The type of pipeline execution for the stage, such as a rollback pipeline\n execution.

" } } }, @@ -7922,12 +7956,12 @@ "stageName": { "target": "com.amazonaws.codepipeline#StageName", "traits": { - "smithy.api#documentation": "

The name of the stage for filtering for pipeline executions where the stage was successful in the current pipeline\n version.

" + "smithy.api#documentation": "

The name of the stage for filtering for pipeline executions where the stage was\n successful in the current pipeline version.

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

Filter for pipeline executions that have successfully completed the stage in the current pipeline version.

" + "smithy.api#documentation": "

Filter for pipeline executions that have successfully completed the stage in the\n current pipeline version.

" } }, "com.amazonaws.codepipeline#Tag": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index d82598e64b9..18f5a6c5681 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -11740,7 +11740,7 @@ "ModelCard": { "target": "com.amazonaws.sagemaker#ModelPackageModelCard", "traits": { - "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" } } }, @@ -21936,7 +21936,7 @@ "ModelCard": { "target": "com.amazonaws.sagemaker#ModelPackageModelCard", "traits": { - "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

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

Provides information about the location that is configured for storing model\n artifacts.

\n

Model artifacts are outputs that result from training a model. They typically consist\n of trained parameters, a model definition that describes how to compute inferences, and\n other metadata. A SageMaker container stores your trained model artifacts in the\n /opt/ml/model directory. After training has completed, by default, these artifacts\n are uploaded to your Amazon S3 bucket as compressed files.

" + "smithy.api#documentation": "

Provides information about the location that is configured for storing model\n artifacts.

\n

Model artifacts are outputs that result from training a model. They typically consist\n of trained parameters, a model definition that describes how to compute inferences, and\n other metadata. A SageMaker container stores your trained model artifacts in the\n /opt/ml/model directory. After training has completed, by default,\n these artifacts are uploaded to your Amazon S3 bucket as compressed files.

" } }, "com.amazonaws.sagemaker#ModelBiasAppSpecification": { @@ -44851,7 +44851,7 @@ "ModelCardContent": { "target": "com.amazonaws.sagemaker#ModelCardContent", "traits": { - "smithy.api#documentation": "

The content of the model card.

" + "smithy.api#documentation": "

The content of the model card. The content must follow the schema described\n in Model\n Package Model Card Schema.

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

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" } }, "com.amazonaws.sagemaker#ModelPackageSecurityConfig": { @@ -50211,6 +50211,12 @@ "traits": { "smithy.api#documentation": "

Settings that control how the endpoint routes incoming traffic to the instances that the\n endpoint hosts.

" } + }, + "InferenceAmiVersion": { + "target": "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion", + "traits": { + "smithy.api#documentation": "

Specifies an option from a collection of preconfigured Amazon Machine Image (AMI)\n images. Each image is configured by Amazon Web Services with a set of software and driver\n versions. Amazon Web Services optimizes these configurations for different machine\n learning workloads.

\n

By selecting an AMI version, you can ensure that your inference environment is\n compatible with specific software requirements, such as CUDA driver versions, Linux\n kernel versions, or Amazon Web Services Neuron driver versions.

" + } } }, "traits": { @@ -50289,6 +50295,17 @@ "smithy.api#documentation": "

Specifies configuration for a core dump from the model container when the process\n crashes.

" } }, + "com.amazonaws.sagemaker#ProductionVariantInferenceAmiVersion": { + "type": "enum", + "members": { + "AL2_GPU_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "al2-ami-sagemaker-inference-gpu-2" + } + } + } + }, "com.amazonaws.sagemaker#ProductionVariantInstanceType": { "type": "enum", "members": { @@ -57741,12 +57758,12 @@ "EnableSessionTagChaining": { "target": "com.amazonaws.sagemaker#EnableSessionTagChaining", "traits": { - "smithy.api#documentation": "

Set to True to allow SageMaker to extract session tags from a \n training job creation role and reuse these tags when assuming the training \n job execution role.

" + "smithy.api#documentation": "

Set to True to allow SageMaker to extract session tags from a training job\n creation role and reuse these tags when assuming the training job execution role.

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

Contains information about attribute-based access control (ABAC) for a training job.\n The session chaining configuration uses Amazon Security Token Service (STS) for your\n training job to request temporary, limited-privilege credentials to tenants. For more\n information, see Attribute-based access control (ABAC) for multi-tenancy\n training.

" + "smithy.api#documentation": "

Contains information about attribute-based access control (ABAC) for a training job.\n The session chaining configuration uses Amazon Security Token Service (STS) for your training job to\n request temporary, limited-privilege credentials to tenants. For more information, see\n Attribute-based access control (ABAC) for multi-tenancy training.

" } }, "com.amazonaws.sagemaker#SessionExpirationDurationInSeconds": { @@ -65835,7 +65852,7 @@ "ModelCard": { "target": "com.amazonaws.sagemaker#ModelPackageModelCard", "traits": { - "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" + "smithy.api#documentation": "

The model card associated with the model package. Since ModelPackageModelCard is\n tied to a model package, it is a specific usage of a model card and its schema is\n simplified compared to the schema of ModelCard. The \n ModelPackageModelCard schema does not include model_package_details,\n and model_overview is composed of the model_creator and\n model_artifact properties. For more information about the model package model\n card schema, see Model\n package model card schema. For more information about\n the model card associated with the model package, see View\n the Details of a Model Version.

" } } }, @@ -67535,7 +67552,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 10 + "max": 20 } } }, diff --git a/codegen/sdk/aws-models/verifiedpermissions.json b/codegen/sdk/aws-models/verifiedpermissions.json index b06b6596ef2..dfcd3abd407 100644 --- a/codegen/sdk/aws-models/verifiedpermissions.json +++ b/codegen/sdk/aws-models/verifiedpermissions.json @@ -111,6 +111,27 @@ "smithy.api#documentation": "

The value of an attribute.

\n

Contains information about the runtime context for a request for which an\n authorization decision is made.

\n

This data type is used as a member of the ContextDefinition structure\n which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.

" } }, + "com.amazonaws.verifiedpermissions#Audience": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.verifiedpermissions#Audiences": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#Audience" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.verifiedpermissions#BatchIsAuthorized": { "type": "operation", "input": { @@ -429,6 +450,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.verifiedpermissions#Claim": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.verifiedpermissions#ClientId": { "type": "string", "traits": { @@ -519,7 +549,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.

\n

This data type is used as a field that is part of an Configuration structure that is\n used as a parameter to CreateIdentitySource.

\n

Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}\n

" + "smithy.api#documentation": "

The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.

\n

This data type part of a Configuration structure that is\n used as a parameter to CreateIdentitySource.

\n

Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}\n

" } }, "com.amazonaws.verifiedpermissions#CognitoUserPoolConfigurationDetail": { @@ -600,10 +630,16 @@ "traits": { "smithy.api#documentation": "

Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool\n and one or more application client IDs.

\n

Example:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}\n

" } + }, + "openIdConnectConfiguration": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.

\n

Example:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}\n

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

Contains configuration information used when creating a new identity source.

\n \n

At this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.

\n

Specifies a userPoolArn, a groupConfiguration, and a\n ClientId.

\n
\n

This data type is used as a request parameter for the CreateIdentitySource\n operation.

" + "smithy.api#documentation": "

Contains configuration information used when creating a new identity source.

\n

This data type is used as a request parameter for the CreateIdentitySource\n operation.

" } }, "com.amazonaws.verifiedpermissions#ConfigurationDetail": { @@ -614,6 +650,12 @@ "traits": { "smithy.api#documentation": "

Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool,\n the policy store entity that you want to assign to user groups,\n and one or more application client IDs.

\n

Example:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}\n

" } + }, + "openIdConnectConfiguration": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectConfigurationDetail", + "traits": { + "smithy.api#documentation": "

Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.

\n

Example:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}\n

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

Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool,\n the policy store entity that you want to assign to user groups,\n and one or more application client IDs.

\n

Example:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}\n

" } + }, + "openIdConnectConfiguration": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectConfigurationItem", + "traits": { + "smithy.api#documentation": "

Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.

\n

Example:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}\n

" + } } }, "traits": { @@ -678,6 +726,9 @@ }, "value": { "target": "com.amazonaws.verifiedpermissions#AttributeValue" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.verifiedpermissions#CreateIdentitySource": { @@ -703,7 +754,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create a reference to an external identity provider (IdP) that is compatible with OpenID Connect (OIDC) authentication protocol, such as Amazon Cognito" }, - "smithy.api#documentation": "

Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).\n

\n

After you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken\n operation. These identities take the form of tokens that contain claims about the user,\n such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and\n access tokens, and Verified Permissions can use either or both. Any combination of identity and access\n tokens results in the same Cedar principal. Verified Permissions automatically translates the\n information about the identities into the standard Cedar attributes that can be\n evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain\n different information, the tokens you choose to use determine which principal attributes\n are available to access when evaluating Cedar policies.

\n \n

If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.

\n
\n \n

To reference a user from this identity source in your Cedar policies, use the following\n syntax.

\n

\n IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId>\n

\n

Where IdentityType is the string that you provide to the\n PrincipalEntityType parameter for this operation. The\n CognitoUserPoolId and CognitoClientId are defined by\n the Amazon Cognito user pool.

\n
\n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

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

Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect\n (OIDC) identity provider (IdP).\n

\n

After you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken or\n BatchIsAuthorizedWithToken API operations. These identities take the form\n of tokens that contain claims about the user, such as IDs, attributes and group\n memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions\n derives information about your user and session from token claims. Access tokens provide\n action context to your policies, and ID tokens provide principal\n Attributes.

\n \n

Tokens from an identity source user continue to be usable until they expire. \n Token revocation and resource deletion have no effect on the validity of a token in your policy store

\n
\n \n

To reference a user from this identity source in your Cedar policies, refer to the\n following syntax examples.

\n
    \n
  • \n

    Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user\n principal attribute], for example\n MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

    \n
  • \n
  • \n

    OpenID Connect (OIDC) provider: Namespace::[Entity\n type]::[principalIdClaim]|[user principal attribute], for example\n MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

    \n
  • \n
\n
\n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n
", "smithy.api#idempotent": {} } }, @@ -727,7 +778,7 @@ "configuration": { "target": "com.amazonaws.verifiedpermissions#Configuration", "traits": { - "smithy.api#documentation": "

Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.

\n \n

At this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.

\n

You must specify a UserPoolArn, and optionally, a\n ClientId.

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

Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.

", "smithy.api#required": {} } }, @@ -1369,6 +1420,16 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.verifiedpermissions#EntityIdPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.verifiedpermissions#EntityIdentifier": { "type": "structure", "members": { @@ -1410,7 +1471,7 @@ "parents": { "target": "com.amazonaws.verifiedpermissions#ParentList", "traits": { - "smithy.api#documentation": "

The parents in the hierarchy that contains the entity.

" + "smithy.api#documentation": "

The parent entities in the hierarchy that contains the entity. A principal or resource\n entity can be defined with at most 99 transitive parents per\n authorization request.

\n

A transitive parent is an entity in the hierarchy of entities including all direct\n parents, and parents of parents. For example, a user can be a member of 91 groups if one\n of those groups is a member of eight groups, for a total of 100: one entity, 91 entity\n parents, and eight parents of parents.

" } } }, @@ -1537,7 +1598,6 @@ "details": { "target": "com.amazonaws.verifiedpermissions#IdentitySourceDetails", "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#deprecated": { "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration" }, @@ -1655,12 +1715,14 @@ "principal": { "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The principal specified in the policy's scope. This element isn't included in the\n response when Principal isn't present in the policy content.

" } }, "resource": { "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The resource specified in the policy's scope. This element isn't included in the\n response when Resource isn't present in the policy content.

" } }, @@ -2341,7 +2403,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to make an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source" }, - "smithy.api#documentation": "

Makes an authorization decision about a service request described in the parameters.\n The principal in this request comes from an external identity source in the form of an identity\n token formatted as a JSON web\n token (JWT). The information in the parameters can also define additional\n context that Verified Permissions can include in the evaluation. The request is evaluated against all\n matching policies in the specified policy store. The result of the decision is either\n Allow or Deny, along with a list of the policies that\n resulted in the decision.

\n

At this time, Verified Permissions accepts tokens from only Amazon Cognito.

\n

Verified Permissions validates each token that is specified in a request by checking its expiration\n date and its signature.

\n \n

If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.

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

Makes an authorization decision about a service request described in the parameters.\n The principal in this request comes from an external identity source in the form of an identity\n token formatted as a JSON web\n token (JWT). The information in the parameters can also define additional\n context that Verified Permissions can include in the evaluation. The request is evaluated against all\n matching policies in the specified policy store. The result of the decision is either\n Allow or Deny, along with a list of the policies that\n resulted in the decision.

\n

At this time, Verified Permissions accepts tokens from only Amazon Cognito.

\n

Verified Permissions validates each token that is specified in a request by checking its expiration\n date and its signature.

\n \n

Tokens from an identity source user continue to be usable until they expire. \n Token revocation and resource deletion have no effect on the validity of a token in your policy store

\n
", "smithy.api#readonly": {} } }, @@ -2790,6 +2852,360 @@ "smithy.api#pattern": "^[A-Za-z0-9-_=+/\\.]*$" } }, + "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfiguration": { + "type": "structure", + "members": { + "principalIdClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#default": "sub", + "smithy.api#documentation": "

The claim that determines the principal in OIDC access tokens. For example,\n sub.

" + } + }, + "audiences": { + "target": "com.amazonaws.verifiedpermissions#Audiences", + "traits": { + "smithy.api#documentation": "

The access token aud claim values that you want to accept in your policy\n store. For example, https://myapp.example.com, https://myapp2.example.com.

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

The configuration of an OpenID Connect (OIDC) identity source for handling access token\n claims. Contains the claim that you want to identify as the principal in an authorization\n request, and the values of the aud claim, or audiences, that you want to\n accept.

\n

This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfigurationDetail": { + "type": "structure", + "members": { + "principalIdClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#default": "sub", + "smithy.api#documentation": "

The claim that determines the principal in OIDC access tokens. For example,\n sub.

" + } + }, + "audiences": { + "target": "com.amazonaws.verifiedpermissions#Audiences", + "traits": { + "smithy.api#documentation": "

The access token aud claim values that you want to accept in your policy\n store. For example, https://myapp.example.com, https://myapp2.example.com.

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

The configuration of an OpenID Connect (OIDC) identity source for handling access token\n claims. Contains the claim that you want to identify as the principal in an authorization\n request, and the values of the aud claim, or audiences, that you want to\n accept.

\n

This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfigurationItem": { + "type": "structure", + "members": { + "principalIdClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#default": "sub", + "smithy.api#documentation": "

The claim that determines the principal in OIDC access tokens. For example,\n sub.

" + } + }, + "audiences": { + "target": "com.amazonaws.verifiedpermissions#Audiences", + "traits": { + "smithy.api#documentation": "

The access token aud claim values that you want to accept in your policy\n store. For example, https://myapp.example.com, https://myapp2.example.com.

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

The configuration of an OpenID Connect (OIDC) identity source for handling access token\n claims. Contains the claim that you want to identify as the principal in an authorization\n request, and the values of the aud claim, or audiences, that you want to\n accept.

\n

This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectConfiguration": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.verifiedpermissions#Issuer", + "traits": { + "smithy.api#documentation": "

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\n endpoint at the path .well-known/openid-configuration.

", + "smithy.api#required": {} + } + }, + "entityIdPrefix": { + "target": "com.amazonaws.verifiedpermissions#EntityIdPrefix", + "traits": { + "smithy.api#documentation": "

A descriptive string that you want to prefix to user entities from your OIDC identity\n provider. For example, if you set an entityIdPrefix of\n MyOIDCProvider, you can reference principals in your policies in the format\n MyCorp::User::MyOIDCProvider|Carlos.

" + } + }, + "groupConfiguration": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfiguration", + "traits": { + "smithy.api#documentation": "

The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.

" + } + }, + "tokenSelection": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelection", + "traits": { + "smithy.api#documentation": "

The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.

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

Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.

\n

This data type is part of a Configuration structure, which is a\n parameter to CreateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectConfigurationDetail": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.verifiedpermissions#Issuer", + "traits": { + "smithy.api#documentation": "

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\n endpoint at the path .well-known/openid-configuration.

", + "smithy.api#required": {} + } + }, + "entityIdPrefix": { + "target": "com.amazonaws.verifiedpermissions#EntityIdPrefix", + "traits": { + "smithy.api#documentation": "

A descriptive string that you want to prefix to user entities from your OIDC identity\n provider. For example, if you set an entityIdPrefix of\n MyOIDCProvider, you can reference principals in your policies in the format\n MyCorp::User::MyOIDCProvider|Carlos.

" + } + }, + "groupConfiguration": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfigurationDetail", + "traits": { + "smithy.api#documentation": "

The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.

" + } + }, + "tokenSelection": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelectionDetail", + "traits": { + "smithy.api#documentation": "

The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.

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

Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.

\n

This data type is part of a ConfigurationDetail structure,\n which is a parameter to GetIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectConfigurationItem": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.verifiedpermissions#Issuer", + "traits": { + "smithy.api#documentation": "

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\n endpoint at the path .well-known/openid-configuration.

", + "smithy.api#required": {} + } + }, + "entityIdPrefix": { + "target": "com.amazonaws.verifiedpermissions#EntityIdPrefix", + "traits": { + "smithy.api#documentation": "

A descriptive string that you want to prefix to user entities from your OIDC identity\n provider. For example, if you set an entityIdPrefix of\n MyOIDCProvider, you can reference principals in your policies in the format\n MyCorp::User::MyOIDCProvider|Carlos.

" + } + }, + "groupConfiguration": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfigurationItem", + "traits": { + "smithy.api#documentation": "

The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.

" + } + }, + "tokenSelection": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelectionItem", + "traits": { + "smithy.api#documentation": "

The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.

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

Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.

\n

This data type is part of a ConfigurationItem structure,\n which is a parameter to ListIdentitySources.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfiguration": { + "type": "structure", + "members": { + "groupClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#documentation": "

The token claim that you want Verified Permissions to interpret as group membership. For example,\n groups.

", + "smithy.api#required": {} + } + }, + "groupEntityType": { + "target": "com.amazonaws.verifiedpermissions#GroupEntityType", + "traits": { + "smithy.api#documentation": "

The policy store entity type that you want to map your users' group claim to. For example,\n MyCorp::UserGroup. A group entity type is an entity that can have a user\n entity type as a member.

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

The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.

\n

This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfigurationDetail": { + "type": "structure", + "members": { + "groupClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#documentation": "

The token claim that you want Verified Permissions to interpret as group membership. For example,\n groups.

", + "smithy.api#required": {} + } + }, + "groupEntityType": { + "target": "com.amazonaws.verifiedpermissions#GroupEntityType", + "traits": { + "smithy.api#documentation": "

The policy store entity type that you want to map your users' group claim to. For example,\n MyCorp::UserGroup. A group entity type is an entity that can have a user\n entity type as a member.

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

The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.

\n

This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfigurationItem": { + "type": "structure", + "members": { + "groupClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#documentation": "

The token claim that you want Verified Permissions to interpret as group membership. For example,\n groups.

", + "smithy.api#required": {} + } + }, + "groupEntityType": { + "target": "com.amazonaws.verifiedpermissions#GroupEntityType", + "traits": { + "smithy.api#documentation": "

The policy store entity type that you want to map your users' group claim to. For example,\n MyCorp::UserGroup. A group entity type is an entity that can have a user\n entity type as a member.

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

The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.

\n

This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySourcea.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfiguration": { + "type": "structure", + "members": { + "principalIdClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#default": "sub", + "smithy.api#documentation": "

The claim that determines the principal in OIDC access tokens. For example,\n sub.

" + } + }, + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "

The ID token audience, or client ID, claim values that you want to accept in your policy\n store from an OIDC identity provider. For example, 1example23456789,\n 2example10111213.

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

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)\n token claims. Contains the claim that you want to identify as the principal in an\n authorization request, and the values of the aud claim, or audiences, that\n you want to accept.

\n

This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfigurationDetail": { + "type": "structure", + "members": { + "principalIdClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#default": "sub", + "smithy.api#documentation": "

The claim that determines the principal in OIDC access tokens. For example,\n sub.

" + } + }, + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "

The ID token audience, or client ID, claim values that you want to accept in your policy\n store from an OIDC identity provider. For example, 1example23456789,\n 2example10111213.

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

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)\n token claims. Contains the claim that you want to identify as the principal in an\n authorization request, and the values of the aud claim, or audiences, that\n you want to accept.

\n

This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfigurationItem": { + "type": "structure", + "members": { + "principalIdClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#default": "sub", + "smithy.api#documentation": "

The claim that determines the principal in OIDC access tokens. For example,\n sub.

" + } + }, + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "

The ID token audience, or client ID, claim values that you want to accept in your policy\n store from an OIDC identity provider. For example, 1example23456789,\n 2example10111213.

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

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)\n token claims. Contains the claim that you want to identify as the principal in an\n authorization request, and the values of the aud claim, or audiences, that\n you want to accept.

\n

This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelection": { + "type": "union", + "members": { + "accessTokenOnly": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfiguration", + "traits": { + "smithy.api#documentation": "

The OIDC configuration for processing access tokens. Contains allowed audience claims,\n for example https://auth.example.com, and the claim that you want to map to the\n principal, for example sub.

" + } + }, + "identityTokenOnly": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfiguration", + "traits": { + "smithy.api#documentation": "

The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\n claims, for example 1example23456789, and the claim that you want to map to\n the principal, for example sub.

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

The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.

\n

This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelectionDetail": { + "type": "union", + "members": { + "accessTokenOnly": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfigurationDetail", + "traits": { + "smithy.api#documentation": "

The OIDC configuration for processing access tokens. Contains allowed audience claims,\n for example https://auth.example.com, and the claim that you want to map to the\n principal, for example sub.

" + } + }, + "identityTokenOnly": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfigurationDetail", + "traits": { + "smithy.api#documentation": "

The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\n claims, for example 1example23456789, and the claim that you want to map to\n the principal, for example sub.

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

The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.

\n

This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelectionItem": { + "type": "union", + "members": { + "accessTokenOnly": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfigurationItem", + "traits": { + "smithy.api#documentation": "

The OIDC configuration for processing access tokens. Contains allowed audience claims,\n for example https://auth.example.com, and the claim that you want to map to the\n principal, for example sub.

" + } + }, + "identityTokenOnly": { + "target": "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfigurationItem", + "traits": { + "smithy.api#documentation": "

The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\n claims, for example 1example23456789, and the claim that you want to map to\n the principal, for example sub.

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

The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.

\n

This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySources.

" + } + }, "com.amazonaws.verifiedpermissions#OpenIdIssuer": { "type": "enum", "members": { @@ -2807,9 +3223,6 @@ "target": "com.amazonaws.verifiedpermissions#EntityIdentifier" }, "traits": { - "smithy.api#length": { - "max": 100 - }, "smithy.api#uniqueItems": {} } }, @@ -3830,10 +4243,16 @@ "traits": { "smithy.api#documentation": "

Contains configuration details of a Amazon Cognito user pool.

" } + }, + "openIdConnectConfiguration": { + "target": "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.

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

Contains an updated configuration to replace the configuration in an existing\n identity source.

\n \n

At this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.

\n

You must specify a userPoolArn, and optionally, a\n ClientId.

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

Contains an update to replace the configuration in an existing\n identity source.

" } }, "com.amazonaws.verifiedpermissions#UpdateIdentitySource": { @@ -3856,7 +4275,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type" }, - "smithy.api#documentation": "

Updates the specified identity source to use a new identity provider (IdP) source, or to change\n the mapping of identities from the IdP to a different principal entity type.

\n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

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

Updates the specified identity source to use a new identity provider (IdP), or to change\n the mapping of identities from the IdP to a different principal entity type.

\n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n
", "smithy.api#idempotent": {} } }, @@ -3932,6 +4351,124 @@ "smithy.api#output": {} } }, + "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectAccessTokenConfiguration": { + "type": "structure", + "members": { + "principalIdClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#default": "sub", + "smithy.api#documentation": "

The claim that determines the principal in OIDC access tokens. For example,\n sub.

" + } + }, + "audiences": { + "target": "com.amazonaws.verifiedpermissions#Audiences", + "traits": { + "smithy.api#documentation": "

The access token aud claim values that you want to accept in your policy\n store. For example, https://myapp.example.com, https://myapp2.example.com.

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

The configuration of an OpenID Connect (OIDC) identity source for handling access token\n claims. Contains the claim that you want to identify as the principal in an authorization\n request, and the values of the aud claim, or audiences, that you want to\n accept.

\n

This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectConfiguration": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.verifiedpermissions#Issuer", + "traits": { + "smithy.api#documentation": "

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\n endpoint at the path .well-known/openid-configuration.

", + "smithy.api#required": {} + } + }, + "entityIdPrefix": { + "target": "com.amazonaws.verifiedpermissions#EntityIdPrefix", + "traits": { + "smithy.api#documentation": "

A descriptive string that you want to prefix to user entities from your OIDC identity\n provider. For example, if you set an entityIdPrefix of\n MyOIDCProvider, you can reference principals in your policies in the format\n MyCorp::User::MyOIDCProvider|Carlos.

" + } + }, + "groupConfiguration": { + "target": "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectGroupConfiguration", + "traits": { + "smithy.api#documentation": "

The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.

" + } + }, + "tokenSelection": { + "target": "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectTokenSelection", + "traits": { + "smithy.api#documentation": "

The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.

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

Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.

\n

This data type is part of a UpdateConfiguration structure,\n which is a parameter to UpdateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectGroupConfiguration": { + "type": "structure", + "members": { + "groupClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#documentation": "

The token claim that you want Verified Permissions to interpret as group membership. For example,\n groups.

", + "smithy.api#required": {} + } + }, + "groupEntityType": { + "target": "com.amazonaws.verifiedpermissions#GroupEntityType", + "traits": { + "smithy.api#documentation": "

The policy store entity type that you want to map your users' group claim to. For example,\n MyCorp::UserGroup. A group entity type is an entity that can have a user\n entity type as a member.

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

The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.

\n

This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectIdentityTokenConfiguration": { + "type": "structure", + "members": { + "principalIdClaim": { + "target": "com.amazonaws.verifiedpermissions#Claim", + "traits": { + "smithy.api#default": "sub", + "smithy.api#documentation": "

The claim that determines the principal in OIDC access tokens. For example,\n sub.

" + } + }, + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "

The ID token audience, or client ID, claim values that you want to accept in your policy\n store from an OIDC identity provider. For example, 1example23456789,\n 2example10111213.

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

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)\n token claims. Contains the claim that you want to identify as the principal in an\n authorization request, and the values of the aud claim, or audiences, that\n you want to accept.

\n

This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.

" + } + }, + "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectTokenSelection": { + "type": "union", + "members": { + "accessTokenOnly": { + "target": "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectAccessTokenConfiguration", + "traits": { + "smithy.api#documentation": "

The OIDC configuration for processing access tokens. Contains allowed audience claims,\n for example https://auth.example.com, and the claim that you want to map to the\n principal, for example sub.

" + } + }, + "identityTokenOnly": { + "target": "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectIdentityTokenConfiguration", + "traits": { + "smithy.api#documentation": "

The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\n claims, for example 1example23456789, and the claim that you want to map to\n the principal, for example sub.

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

The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.

\n

This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.

" + } + }, "com.amazonaws.verifiedpermissions#UpdatePolicy": { "type": "operation", "input": { From 94b2dcaf185e7155a7f781d4dc030cc80cc97f5e Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 7 Jun 2024 18:03:49 +0000 Subject: [PATCH 35/41] feat: update AWS service endpoints metadata --- .../aws/sdk/kotlin/codegen/endpoints.json | 68 ++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) 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 ddc93c85e14..24ae0282309 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 @@ -2682,6 +2682,12 @@ }, "hostname" : "bedrock.ap-southeast-2.amazonaws.com" }, + "bedrock-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "bedrock.ca-central-1.amazonaws.com" + }, "bedrock-eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" @@ -2694,6 +2700,12 @@ }, "hostname" : "bedrock.eu-west-1.amazonaws.com" }, + "bedrock-eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "bedrock.eu-west-2.amazonaws.com" + }, "bedrock-eu-west-3" : { "credentialScope" : { "region" : "eu-west-3" @@ -2736,6 +2748,12 @@ }, "hostname" : "bedrock-runtime.ap-southeast-2.amazonaws.com" }, + "bedrock-runtime-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "bedrock-runtime.ca-central-1.amazonaws.com" + }, "bedrock-runtime-eu-central-1" : { "credentialScope" : { "region" : "eu-central-1" @@ -2748,6 +2766,12 @@ }, "hostname" : "bedrock-runtime.eu-west-1.amazonaws.com" }, + "bedrock-runtime-eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "bedrock-runtime.eu-west-2.amazonaws.com" + }, "bedrock-runtime-eu-west-3" : { "credentialScope" : { "region" : "eu-west-3" @@ -2766,6 +2790,12 @@ }, "hostname" : "bedrock-runtime-fips.us-west-2.amazonaws.com" }, + "bedrock-runtime-sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "bedrock-runtime.sa-east-1.amazonaws.com" + }, "bedrock-runtime-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -2778,6 +2808,12 @@ }, "hostname" : "bedrock-runtime.us-west-2.amazonaws.com" }, + "bedrock-sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "bedrock.sa-east-1.amazonaws.com" + }, "bedrock-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -2790,9 +2826,12 @@ }, "hostname" : "bedrock.us-west-2.amazonaws.com" }, + "ca-central-1" : { }, "eu-central-1" : { }, "eu-west-1" : { }, + "eu-west-2" : { }, "eu-west-3" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-west-2" : { } } @@ -2832,6 +2871,8 @@ }, "cases" : { "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, @@ -10288,9 +10329,21 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "kendra-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-west-1" : { }, "eu-west-2" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "kendra-fips.ca-central-1.amazonaws.com" + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -18624,6 +18677,19 @@ "deprecated" : true, "hostname" : "storagegateway-fips.ca-central-1.amazonaws.com" }, + "ca-west-1" : { + "variants" : [ { + "hostname" : "storagegateway-fips.ca-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-west-1-fips" : { + "credentialScope" : { + "region" : "ca-west-1" + }, + "deprecated" : true, + "hostname" : "storagegateway-fips.ca-west-1.amazonaws.com" + }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, From 13cf05c5ca163dfa462f5d8a422c33854285e24f Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 7 Jun 2024 18:06:38 +0000 Subject: [PATCH 36/41] chore: release 1.2.29 --- CHANGELOG.md | 9 +++++++++ gradle.properties | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e988562c18..29a4fe02c01 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## [1.2.29] - 06/07/2024 + +### Features +* (**auditmanager**) New feature: common controls. When creating custom controls, you can now use pre-grouped AWS data sources based on common compliance themes. Also, the awsServices parameter is deprecated because we now manage services in scope for you. If used, the input is ignored and an empty list is returned. +* (**b2bi**) Added exceptions to B2Bi List operations and ConflictException to B2Bi StartTransformerJob operation. Also made capabilities field explicitly required when creating a Partnership. +* (**codepipeline**) CodePipeline now supports overriding S3 Source Object Key during StartPipelineExecution, as part of Source Overrides. +* (**sagemaker**) This release introduces a new optional parameter: InferenceAmiVersion, in ProductionVariant. +* (**verifiedpermissions**) This release adds OpenIdConnect (OIDC) configuration support for IdentitySources, allowing for external IDPs to be used in authorization requests. + ## [1.2.28] - 06/06/2024 ### Features diff --git a/gradle.properties b/gradle.properties index 6304f2a9afa..d287ac37ed0 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.2.29-SNAPSHOT +sdkVersion=1.2.29 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From 39bc4908fd9a10235170456b9b1f79135af203e0 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Fri, 7 Jun 2024 18:06:40 +0000 Subject: [PATCH 37/41] chore: bump snapshot version to 1.2.30-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index d287ac37ed0..42c7ea08755 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.2.29 +sdkVersion=1.2.30-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From cf6a37c59693d38f5f653b9abdf64891105336f6 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 10 Jun 2024 18:02:02 +0000 Subject: [PATCH 38/41] feat: update AWS API models --- .../sdk/aws-models/application-signals.json | 3192 +++++++++++++++++ codegen/sdk/aws-models/ecs.json | 97 +- codegen/sdk/aws-models/imagebuilder.json | 24 +- 3 files changed, 3292 insertions(+), 21 deletions(-) create mode 100644 codegen/sdk/aws-models/application-signals.json diff --git a/codegen/sdk/aws-models/application-signals.json b/codegen/sdk/aws-models/application-signals.json new file mode 100644 index 00000000000..b292b17c313 --- /dev/null +++ b/codegen/sdk/aws-models/application-signals.json @@ -0,0 +1,3192 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.applicationsignals#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationsignals#ServiceErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

You don't have sufficient permissions to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.applicationsignals#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.applicationsignals#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.applicationsignals#ApplicationSignals": { + "type": "service", + "version": "2024-04-15", + "operations": [ + { + "target": "com.amazonaws.applicationsignals#BatchGetServiceLevelObjectiveBudgetReport" + }, + { + "target": "com.amazonaws.applicationsignals#GetService" + }, + { + "target": "com.amazonaws.applicationsignals#ListServiceDependencies" + }, + { + "target": "com.amazonaws.applicationsignals#ListServiceDependents" + }, + { + "target": "com.amazonaws.applicationsignals#ListServiceOperations" + }, + { + "target": "com.amazonaws.applicationsignals#ListServices" + }, + { + "target": "com.amazonaws.applicationsignals#ListTagsForResource" + }, + { + "target": "com.amazonaws.applicationsignals#StartDiscovery" + }, + { + "target": "com.amazonaws.applicationsignals#TagResource" + }, + { + "target": "com.amazonaws.applicationsignals#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Application Signals", + "arnNamespace": "application-signals", + "endpointPrefix": "application-signals" + }, + "aws.auth#sigv4": { + "name": "application-signals" + }, + "aws.endpoints#dualStackOnlyEndpoints": {}, + "aws.endpoints#standardRegionalEndpoints": {}, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "\n

This is a Preview release of the Application Signals API Reference. Operations and parameters are subject to change before the general availability\n release.

\n
\n

Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. \n It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. \n The application-centric view provides you with unified visibility across your applications, services, and \n dependencies, so you can proactively monitor and efficiently triage any issues that may arise, \n ensuring optimal customer experience.

\n

Application Signals provides the following benefits:

\n
    \n
  • \n

    Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors.

    \n
  • \n
  • \n

    Create and monitor service level objectives (SLOs).

    \n
  • \n
  • \n

    See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.

    \n
  • \n
", + "smithy.api#title": "Amazon CloudWatch Application Signals", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + }, + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "endpoint": { + "url": "https://application-signals-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://application-signals.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For custom endpoint with region not set and fips disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with fips enabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Endpoint": "https://example.com", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals-fips.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals-fips.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals.us-gov-west-1.api.aws" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals-fips.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": true + } + }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals.eu-isoe-west-1.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals-fips.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-signals.us-isof-south-1.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.applicationsignals#Attainment": { + "type": "double" + }, + "com.amazonaws.applicationsignals#AttainmentGoal": { + "type": "double" + }, + "com.amazonaws.applicationsignals#AttributeMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.applicationsignals#AttributeMaps": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#AttributeMap" + } + }, + "com.amazonaws.applicationsignals#Attributes": { + "type": "map", + "key": { + "target": "com.amazonaws.applicationsignals#KeyAttributeName" + }, + "value": { + "target": "com.amazonaws.applicationsignals#KeyAttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.applicationsignals#BatchGetServiceLevelObjectiveBudgetReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#BatchGetServiceLevelObjectiveBudgetReportInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#BatchGetServiceLevelObjectiveBudgetReportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to retrieve one or more service level objective (SLO) budget reports.

\n

An error budget is the amount of time in unhealthy periods that your service can \n accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be\n unmet. For example, an SLO with a threshold of 99.95% and a monthly interval\n translates to an error budget of 21.9 minutes of \n downtime in a 30-day month.

\n

Budget reports include a health indicator, the attainment value, and \n remaining budget.

\n

For more information about SLO error budgets, see \n \n SLO concepts.

", + "smithy.api#http": { + "method": "POST", + "uri": "/budget-report", + "code": 200 + } + } + }, + "com.amazonaws.applicationsignals#BatchGetServiceLevelObjectiveBudgetReportInput": { + "type": "structure", + "members": { + "Timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "SloIds": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveIds", + "traits": { + "smithy.api#documentation": "

An array containing the IDs of the service level objectives that you want to include in the report.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#BatchGetServiceLevelObjectiveBudgetReportOutput": { + "type": "structure", + "members": { + "Timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the report is for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

", + "smithy.api#required": {} + } + }, + "Reports": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReports", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure is one budget report.

", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportErrors", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure includes an error indicating that one \n of the requests in the array was not valid.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#BudgetSecondsRemaining": { + "type": "integer" + }, + "com.amazonaws.applicationsignals#CalendarInterval": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time when you want the first interval to start. Be sure to choose a time that configures the \n intervals the way that you want. For example, if you want weekly intervals\n starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.

\n

When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

\n

As soon as one calendar interval ends, another automatically begins.

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

Specifies the calendar interval unit.

", + "smithy.api#required": {} + } + }, + "Duration": { + "target": "com.amazonaws.applicationsignals#CalendarIntervalDuration", + "traits": { + "smithy.api#documentation": "

Specifies the duration of each calendar interval. For example, if Duration is 1 and\n DurationUnit is MONTH, each interval is one month, aligned with the calendar.

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

If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.

" + } + }, + "com.amazonaws.applicationsignals#CalendarIntervalDuration": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.applicationsignals#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This operation attempted to create a resource that already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.applicationsignals#CreateServiceLevelObjective": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#CreateServiceLevelObjectiveInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#CreateServiceLevelObjectiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#AccessDeniedException" + }, + { + "target": "com.amazonaws.applicationsignals#ConflictException" + }, + { + "target": "com.amazonaws.applicationsignals#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a service level objective (SLO), which can help you ensure that your critical business operations are \n meeting customer expectations. Use SLOs to set and track specific target levels for the\n reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to \n calculate whether the application is performing at the level that you want.

\n

Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch\n measures this target frequently you can find whether it has been breached.

\n

When you create an SLO, you set an attainment goal for it. An \n attainment goal is the \n ratio of good periods that meet the threshold requirements to the total periods within the interval. \n For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the \n periods to be in healthy state.

\n

After you have created an SLO, you can retrieve error budget reports for it. \n An error budget is the number of periods or amount of time that your service can \n accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be\n unmet. for example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month \n translates to an error budget of 21.9 minutes of downtime per month.

\n

When you call this operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, \n if it doesn't already exist in your account. This service-\n linked role has the following permissions:

\n
    \n
  • \n

    \n xray:GetServiceGraph\n

    \n
  • \n
  • \n

    \n logs:StartQuery\n

    \n
  • \n
  • \n

    \n logs:GetQueryResults\n

    \n
  • \n
  • \n

    \n cloudwatch:GetMetricData\n

    \n
  • \n
  • \n

    \n cloudwatch:ListMetrics\n

    \n
  • \n
  • \n

    \n tag:GetResources\n

    \n
  • \n
  • \n

    \n autoscaling:DescribeAutoScalingGroups\n

    \n
  • \n
\n

You can easily set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. \n You can also set SLOs against any CloudWatch metric or math expression that produces a time series.

\n

For more information about SLOs, see \n Service level objectives (SLOs).\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/slo", + "code": 200 + } + } + }, + "com.amazonaws.applicationsignals#CreateServiceLevelObjectiveInput": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveName", + "traits": { + "smithy.api#documentation": "

A name for this SLO.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveDescription", + "traits": { + "smithy.api#documentation": "

An optional description for this SLO.

" + } + }, + "SliConfig": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorConfig", + "traits": { + "smithy.api#documentation": "

A structure that contains information about what service and what performance metric that this SLO will monitor.

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

A structure that contains the attributes that determine the goal of the SLO. This includes\n the time period for evaluation and the attainment threshold.

" + } + }, + "Tags": { + "target": "com.amazonaws.applicationsignals#TagList", + "traits": { + "smithy.api#documentation": "

A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO.\n To be able to associate tags with the SLO when you create the SLO, you must\n have the cloudwatch:TagResource permission.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#CreateServiceLevelObjectiveOutput": { + "type": "structure", + "members": { + "Slo": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjective", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the SLO that you just created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#DeleteServiceLevelObjective": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#DeleteServiceLevelObjectiveInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#DeleteServiceLevelObjectiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified service level objective.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/slo/{Id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.applicationsignals#DeleteServiceLevelObjectiveInput": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveId", + "traits": { + "smithy.api#documentation": "

The ARN or name of the service level objective to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#DeleteServiceLevelObjectiveOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#Dimension": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.applicationsignals#DimensionName", + "traits": { + "smithy.api#documentation": "

The name of the dimension. Dimension names must contain only ASCII characters, must include \n at least one non-whitespace character, and cannot start with a colon (:).\n ASCII\n control characters are not supported as part of dimension names.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.applicationsignals#DimensionValue", + "traits": { + "smithy.api#documentation": "

The value of the dimension. Dimension values must contain only ASCII characters and must include \n at least one non-whitespace character. ASCII\n control characters are not supported as part of dimension values.

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

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique \n identifier for a metric, whenever you add a unique name/value pair to one of \n your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish\n InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

\n

You \n can assign up to 30 dimensions to a metric.

" + } + }, + "com.amazonaws.applicationsignals#DimensionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.applicationsignals#DimensionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.applicationsignals#Dimensions": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#Dimension" + }, + "traits": { + "smithy.api#length": { + "max": 30 + } + } + }, + "com.amazonaws.applicationsignals#DurationUnit": { + "type": "enum", + "members": { + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTH" + } + } + } + }, + "com.amazonaws.applicationsignals#FaultDescription": { + "type": "string" + }, + "com.amazonaws.applicationsignals#GetService": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#GetServiceInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#GetServiceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a service discovered by Application Signals.

", + "smithy.api#http": { + "method": "POST", + "uri": "/service", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceInput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "StartTime", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "EndTime", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceLevelObjective": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#GetServiceLevelObjectiveInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#GetServiceLevelObjectiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about one SLO created in the account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/slo/{Id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceLevelObjectiveInput": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveId", + "traits": { + "smithy.api#documentation": "

The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs \n of SLOs by using the ListServiceLevelObjectives\n operation.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceLevelObjectiveOutput": { + "type": "structure", + "members": { + "Slo": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjective", + "traits": { + "smithy.api#documentation": "

A structure containing the information about the SLO.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#GetServiceOutput": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.applicationsignals#Service", + "traits": { + "smithy.api#documentation": "

A structure containing information about the service.

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

The start time of the data included in the response. In a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057.

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

The end time of the data included in the response. In a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#Goal": { + "type": "structure", + "members": { + "Interval": { + "target": "com.amazonaws.applicationsignals#Interval", + "traits": { + "smithy.api#documentation": "

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

\n

If you omit this parameter, a rolling interval of 7 days is used.

" + } + }, + "AttainmentGoal": { + "target": "com.amazonaws.applicationsignals#AttainmentGoal", + "traits": { + "smithy.api#documentation": "

The threshold that determines if the goal is being met. An attainment goal is the \n ratio of good periods that meet the threshold requirements to the total periods within the interval. \n For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the \n periods to be in healthy state.

\n

If you omit this parameter, 99 is used\n to represent 99% as the attainment goal.

" + } + }, + "WarningThreshold": { + "target": "com.amazonaws.applicationsignals#WarningThreshold", + "traits": { + "smithy.api#documentation": "

The percentage of remaining budget over total budget that you want to get warnings for. \n If you omit this parameter, the default of 50.0 is used.

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

This structure contains the attributes that determine the goal of an SLO. This includes\n the time period for evaluation and the attainment threshold.

" + } + }, + "com.amazonaws.applicationsignals#Interval": { + "type": "union", + "members": { + "RollingInterval": { + "target": "com.amazonaws.applicationsignals#RollingInterval", + "traits": { + "smithy.api#documentation": "

If the interval is a rolling interval, this structure contains the interval specifications.

" + } + }, + "CalendarInterval": { + "target": "com.amazonaws.applicationsignals#CalendarInterval", + "traits": { + "smithy.api#documentation": "

If the interval is a calendar interval, this structure contains the interval specifications.

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

The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.

" + } + }, + "com.amazonaws.applicationsignals#KeyAttributeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]{1,50}$" + } + }, + "com.amazonaws.applicationsignals#KeyAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[ -~]*[!-~]+[ -~]*$" + } + }, + "com.amazonaws.applicationsignals#ListServiceDependencies": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#ListServiceDependenciesInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#ListServiceDependenciesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure \n component that an operation of this service connects with. Dependencies can include Amazon Web Services \n services, Amazon Web Services resources, and third-party services.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/service-dependencies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "pageSize": "MaxResults", + "outputToken": "NextToken", + "items": "ServiceDependencies" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceDependenciesInput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "StartTime", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "EndTime", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationsignals#ListServiceDependenciesMaxResults", + "traits": { + "smithy.api#default": 20, + "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this\n parameter, the default of 50 is used.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationsignals#NextToken", + "traits": { + "smithy.api#documentation": "

Include this value, if it was returned by the previous operation, to get the next set of service dependencies.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceDependenciesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.applicationsignals#ListServiceDependenciesOutput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

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

An array, where each object in the array contains information about one of the dependencies of this service.

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

Include this value in your next use of this API to get next set \n of service dependencies.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceDependents": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#ListServiceDependentsInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#ListServiceDependentsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the list of dependents that invoked the specified service during the provided time range. Dependents include \n other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.

", + "smithy.api#http": { + "method": "POST", + "uri": "/service-dependents", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "pageSize": "MaxResults", + "outputToken": "NextToken", + "items": "ServiceDependents" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceDependentsInput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "StartTime", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "EndTime", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationsignals#ListServiceDependentsMaxResults", + "traits": { + "smithy.api#default": 20, + "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this\n parameter, the default of 50 is used.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationsignals#NextToken", + "traits": { + "smithy.api#documentation": "

Include this value, if it was returned by the previous operation, to get the next set of service dependents.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceDependentsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.applicationsignals#ListServiceDependentsOutput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

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

An array, where each object in the array contains information about one of the dependents of this service.

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

Include this value in your next use of this API to get next set \n of service dependents.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceLevelObjectives": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#ListServiceLevelObjectivesInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#ListServiceLevelObjectivesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of SLOs created in this account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/slos", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "pageSize": "MaxResults", + "outputToken": "NextToken", + "items": "SloSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceLevelObjectivesInput": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

You can use this optional field to specify which services you want to retrieve SLO information for.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
" + } + }, + "OperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

The name of the operation that this SLO is associated with.

", + "smithy.api#httpQuery": "OperationName" + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationsignals#ListServiceLevelObjectivesMaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this\n parameter, the default of 50 is used.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationsignals#NextToken", + "traits": { + "smithy.api#documentation": "

Include this value, if it was returned by the previous operation, to get the next set of service level objectives.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceLevelObjectivesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.applicationsignals#ListServiceLevelObjectivesOutput": { + "type": "structure", + "members": { + "SloSummaries": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveSummaries", + "traits": { + "smithy.api#documentation": "

An array of structures, where each structure contains information about one SLO.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationsignals#NextToken", + "traits": { + "smithy.api#documentation": "

Include this value in your next use of this API to get next set \n of service level objectives.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceOperationMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.applicationsignals#ListServiceOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#ListServiceOperationsInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#ListServiceOperationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the operations of this service that have been discovered by Application Signals.\n Only the operations that were invoked during the specified time range are returned.

", + "smithy.api#http": { + "method": "POST", + "uri": "/service-operations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "pageSize": "MaxResults", + "outputToken": "NextToken", + "items": "ServiceOperations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceOperationsInput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "StartTime", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "EndTime", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

Use this field to specify which service you want to retrieve information for. You must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationsignals#ListServiceOperationMaxResults", + "traits": { + "smithy.api#default": 20, + "smithy.api#documentation": "

The maximum number of results to return in one operation. If you omit this\n parameter, the default of 50 is used.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationsignals#NextToken", + "traits": { + "smithy.api#documentation": "

Include this value, if it was returned by the previous operation, to get the next set of service operations.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#ListServiceOperationsOutput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

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

An array of structures that each contain information about one operation of this service.

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

Include this value in your next use of this API to get next set \n of service operations.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#ListServices": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#ListServicesInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#ListServicesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of services that have been discovered by Application Signals. \n A service represents a minimum logical and transactional unit that completes a business function. Services\n are discovered through Application Signals instrumentation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/services", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "pageSize": "MaxResults", + "outputToken": "NextToken", + "items": "ServiceSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#ListServicesInput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "StartTime", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

", + "smithy.api#httpQuery": "EndTime", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationsignals#ListServicesMaxResults", + "traits": { + "smithy.api#default": 50, + "smithy.api#documentation": "

\n The maximum number \n of results \n to return \n in one operation. \n If you omit this parameter, \n the default of 50 is used.\n

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationsignals#NextToken", + "traits": { + "smithy.api#documentation": "

Include this value, if it was returned by the previous operation, to get the next set of services.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#ListServicesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.applicationsignals#ListServicesOutput": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

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

The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as \n be epoch time in seconds. For example: 1698778057\n

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

An array of structures, where each structure contains some information about a service. To\n get complete information about a service, use \n GetService.

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

Include this value in your next use of this API to get next set \n of services.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.applicationsignals#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.applicationsignals#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.applicationsignals#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.

\n

The ARN format of an Application Signals SLO is \n arn:aws:cloudwatch:Region:account-id:slo:slo-name\n \n

\n

For more information about ARN format, see Resource\n Types Defined by Amazon CloudWatch in the Amazon Web Services General\n Reference.

", + "smithy.api#httpQuery": "ResourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.applicationsignals#TagList", + "traits": { + "smithy.api#documentation": "

The list of tag keys and values associated with the resource you specified.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#Metric": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.applicationsignals#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric. For more information, see \n Namespaces.

" + } + }, + "MetricName": { + "target": "com.amazonaws.applicationsignals#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric to use.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.applicationsignals#Dimensions", + "traits": { + "smithy.api#documentation": "

An array of one or more dimensions to use to define the metric that you want to use. \n For more information, see \n Dimensions.

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

This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions

" + } + }, + "com.amazonaws.applicationsignals#MetricDataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#MetricDataQuery" + } + }, + "com.amazonaws.applicationsignals#MetricDataQuery": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.applicationsignals#MetricId", + "traits": { + "smithy.api#documentation": "

A short name used to tie this object to the results in the response. This Id must be unique \n within a MetricDataQueries array. If you are performing math expressions on this set of data, \n this name represents that data and can serve as a variable in the metric math expression. The valid characters \n are letters, numbers, and underscore. The first character must be a lowercase letter.

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

A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.

\n

Within one MetricDataQuery object, you must specify either \n Expression or MetricStat but not both.

" + } + }, + "Expression": { + "target": "com.amazonaws.applicationsignals#MetricExpression", + "traits": { + "smithy.api#documentation": "

This field can contain a metric math expression to be performed on the other metrics that\n you are retrieving within this MetricDataQueries structure.

\n

A math expression\n can use the Id of the other metrics or queries to refer to those metrics, and can also use \n the Id of other \n expressions to use the result of those expressions. For more information about metric math expressions, see \n Metric Math Syntax and Functions in the\n Amazon CloudWatch User Guide.

\n

Within each MetricDataQuery object, you must specify either \n Expression or MetricStat but not both.

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

A human-readable label for this metric or expression. This is especially useful \n if this is an expression, so that you know\n what the value represents. If the metric or expression is shown in a \n CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch \n generates a default.

\n

You can put dynamic expressions into a label, so that it is more descriptive. \n For more information, see Using Dynamic Labels.

" + } + }, + "ReturnData": { + "target": "com.amazonaws.applicationsignals#ReturnData", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Use this only if you are using a metric math expression for the SLO. \n Specify true for ReturnData for only the one expression result to use as the alarm. For all \n other metrics and expressions in the same CreateServiceLevelObjective operation, specify ReturnData as false.

" + } + }, + "Period": { + "target": "com.amazonaws.applicationsignals#Period", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can\n be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

\n
    \n
  • \n

    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

    \n
  • \n
  • \n

    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

    \n
  • \n
  • \n

    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

    \n
  • \n
" + } + }, + "AccountId": { + "target": "com.amazonaws.applicationsignals#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, \n use this to specify which source account to retrieve this metric from.

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

Use this structure to define a metric or metric math expression that you want to use as for a service level objective.

\n

Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression \n to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. \n The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that \n contain the Expression parameter to perform a math expression. Of those Expression structures, \n exactly one must have true as the value for ReturnData. The result of this expression used for the SLO.

\n

For more information about metric math expressions, see \n CloudWatchUse metric math.

\n

Within each MetricDataQuery object, you must specify either \n Expression or MetricStat but not both.

" + } + }, + "com.amazonaws.applicationsignals#MetricExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.applicationsignals#MetricId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.applicationsignals#MetricLabel": { + "type": "string" + }, + "com.amazonaws.applicationsignals#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.applicationsignals#MetricReference": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.applicationsignals#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric. For more information, see \n CloudWatchNamespaces.

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

Used to display the appropriate statistics in the CloudWatch console.

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

An array of one or more dimensions that further define the metric. \n For more information, see \n CloudWatchDimensions.

" + } + }, + "MetricName": { + "target": "com.amazonaws.applicationsignals#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric.

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

This structure contains information about one CloudWatch metric associated with this entity discovered\n by Application Signals.

" + } + }, + "com.amazonaws.applicationsignals#MetricReferences": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#MetricReference" + } + }, + "com.amazonaws.applicationsignals#MetricStat": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.applicationsignals#Metric", + "traits": { + "smithy.api#documentation": "

The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

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

The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can\n be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected\n at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics\n are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

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

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, \n see CloudWatch statistics definitions.

", + "smithy.api#required": {} + } + }, + "Unit": { + "target": "com.amazonaws.applicationsignals#StandardUnit", + "traits": { + "smithy.api#documentation": "

If you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified\n when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.\n If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

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

This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.

" + } + }, + "com.amazonaws.applicationsignals#MetricType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9 -]+$" + } + }, + "com.amazonaws.applicationsignals#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "[^:].*" + } + }, + "com.amazonaws.applicationsignals#NextToken": { + "type": "string" + }, + "com.amazonaws.applicationsignals#OperationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.applicationsignals#Period": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.applicationsignals#ResourceId": { + "type": "string" + }, + "com.amazonaws.applicationsignals#ResourceNotFoundException": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.applicationsignals#ResourceType", + "traits": { + "smithy.api#documentation": "

The resource type is not valid.

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

Cannot find the resource id.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.applicationsignals#FaultDescription", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Resource not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.applicationsignals#ResourceType": { + "type": "string" + }, + "com.amazonaws.applicationsignals#ReturnData": { + "type": "boolean" + }, + "com.amazonaws.applicationsignals#RollingInterval": { + "type": "structure", + "members": { + "DurationUnit": { + "target": "com.amazonaws.applicationsignals#DurationUnit", + "traits": { + "smithy.api#documentation": "

Specifies the rolling interval unit.

", + "smithy.api#required": {} + } + }, + "Duration": { + "target": "com.amazonaws.applicationsignals#RollingIntervalDuration", + "traits": { + "smithy.api#documentation": "

Specifies the duration of each rolling interval. For example, if Duration is 7 and\n DurationUnit is DAY, each rolling interval is seven days.

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

If the interval for this SLO is a rolling interval, this structure contains the interval specifications.

" + } + }, + "com.amazonaws.applicationsignals#RollingIntervalDuration": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.applicationsignals#SLIPeriodSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 900 + } + } + }, + "com.amazonaws.applicationsignals#Service": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "AttributeMaps": { + "target": "com.amazonaws.applicationsignals#AttributeMaps", + "traits": { + "smithy.api#documentation": "

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

\n

Platform attributes contain information the service's platform.

\n
    \n
  • \n

    \n PlatformType defines the hosted-in platform.

    \n
  • \n
  • \n

    \n EKS.Cluster is the name of the Amazon EKS cluster.

    \n
  • \n
  • \n

    \n K8s.Cluster is the name of the self-hosted Kubernetes cluster.

    \n
  • \n
  • \n

    \n K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

    \n
  • \n
  • \n

    \n EC2.InstanceId is the ID of the Amazon EC2 instance.

    \n
  • \n
  • \n

    \n Host is the name of the host, for all platform types.

    \n
  • \n
\n

Applciation attributes contain information about the application.

\n
    \n
  • \n

    \n AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

    \n
  • \n
  • \n

    \n AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

    \n
  • \n
\n

Telemetry attributes contain telemetry information.

\n
    \n
  • \n

    \n Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

    \n
  • \n
  • \n

    \n Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

    \n
  • \n
  • \n

    \n Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

    \n
  • \n
" + } + }, + "MetricReferences": { + "target": "com.amazonaws.applicationsignals#MetricReferences", + "traits": { + "smithy.api#documentation": "

An array of structures that each contain information about one metric associated with this service.

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

This structure contains information about one of your services that was discovered by Application Signals.\n

" + } + }, + "com.amazonaws.applicationsignals#ServiceDependencies": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceDependency" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.applicationsignals#ServiceDependency": { + "type": "structure", + "members": { + "OperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

The name of the operation in this service that calls the dependency.

", + "smithy.api#required": {} + } + }, + "DependencyKeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "DependencyOperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

The name of the called operation in the dependency.

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

An array of structures that each contain information about one metric associated with this service dependency\n that was discovered by\n Application Signals.

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

This structure contains information about one dependency\n of this service.

" + } + }, + "com.amazonaws.applicationsignals#ServiceDependent": { + "type": "structure", + "members": { + "OperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.

" + } + }, + "DependentKeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "DependentOperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation\n is displayed here.

" + } + }, + "MetricReferences": { + "target": "com.amazonaws.applicationsignals#MetricReferences", + "traits": { + "smithy.api#documentation": "

An array of structures that each contain information about one metric associated with this service dependent\n that was discovered by\n Application Signals.

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

This structure contains information about a service dependent that was discovered by Application Signals. A \n dependent is an entity that invoked the specified service during the provided time range. Dependents include \n other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.

" + } + }, + "com.amazonaws.applicationsignals#ServiceDependents": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceDependent" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.applicationsignals#ServiceErrorMessage": { + "type": "string" + }, + "com.amazonaws.applicationsignals#ServiceLevelIndicator": { + "type": "structure", + "members": { + "SliMetric": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetric", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the metric that the SLO monitors.

", + "smithy.api#required": {} + } + }, + "MetricThreshold": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricThreshold", + "traits": { + "smithy.api#documentation": "

The value that the SLI metric is compared to.

", + "smithy.api#required": {} + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorComparisonOperator", + "traits": { + "smithy.api#documentation": "

The arithmetic operation used when comparing the specified metric to the\n threshold.

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

This structure contains information about the performance metric that an SLO monitors.

" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelIndicatorComparisonOperator": { + "type": "enum", + "members": { + "GREATER_THAN_OR_EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualTo" + } + }, + "GREATER_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThan" + } + }, + "LESS_THAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThan" + } + }, + "LESS_THAN_OR_EQUAL_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualTo" + } + } + } + }, + "com.amazonaws.applicationsignals#ServiceLevelIndicatorConfig": { + "type": "structure", + "members": { + "SliMetricConfig": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricConfig", + "traits": { + "smithy.api#documentation": "

Use this structure to specify the metric to be used for the SLO.

", + "smithy.api#required": {} + } + }, + "MetricThreshold": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricThreshold", + "traits": { + "smithy.api#documentation": "

The value that the SLI metric is compared to.

", + "smithy.api#required": {} + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorComparisonOperator", + "traits": { + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified metric to the\n threshold.

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

This structure specifies the information about the service and the performance metric that an SLO is to monitor.

" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetric": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

This is a string-to-string map that contains information about the type of object that this SLO is related to. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object that this SLO is related to.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
" + } + }, + "OperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

If the SLO monitors a specific operation of the service, this field displays that operation name.

" + } + }, + "MetricType": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricType", + "traits": { + "smithy.api#documentation": "

If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals \n collects, this field displays which of those metrics is used.

" + } + }, + "MetricDataQueries": { + "target": "com.amazonaws.applicationsignals#MetricDataQueries", + "traits": { + "smithy.api#documentation": "

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, \n this structure includes the information about that metric or expression.

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

This structure contains the information about the metric that is used for the SLO.

" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricConfig": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service \n the SLO metric is related to. To do so, you must specify at least the Type, \n Name, and Environment attributes.

\n

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
" + } + }, + "OperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.

" + } + }, + "MetricType": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricType", + "traits": { + "smithy.api#documentation": "

If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals \n collects, use this field to specify which of those metrics is used.

" + } + }, + "Statistic": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorStatistic", + "traits": { + "smithy.api#documentation": "

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, \n see CloudWatch statistics definitions.

" + } + }, + "PeriodSeconds": { + "target": "com.amazonaws.applicationsignals#SLIPeriodSeconds", + "traits": { + "smithy.api#documentation": "

The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the \n SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.

" + } + }, + "MetricDataQueries": { + "target": "com.amazonaws.applicationsignals#MetricDataQueries", + "traits": { + "smithy.api#documentation": "

If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, \n use this structure to specify that metric or expression.

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

Use this structure to specify the information for the metric that the SLO will monitor.

" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricThreshold": { + "type": "double" + }, + "com.amazonaws.applicationsignals#ServiceLevelIndicatorMetricType": { + "type": "enum", + "members": { + "LATENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATENCY" + } + }, + "AVAILABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABILITY" + } + } + } + }, + "com.amazonaws.applicationsignals#ServiceLevelIndicatorStatistic": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^[a-zA-Z0-9.]+$" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjective": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveArn", + "traits": { + "smithy.api#documentation": "

The ARN of this SLO.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveName", + "traits": { + "smithy.api#documentation": "

The name of this SLO.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveDescription", + "traits": { + "smithy.api#documentation": "

The description that you created for this SLO.

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

The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as \n yyyy-MM-dd'T'HH:mm:ss. For example, \n 2019-07-01T23:59:59.

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

The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as \n yyyy-MM-dd'T'HH:mm:ss. For example, \n 2019-07-01T23:59:59.

", + "smithy.api#required": {} + } + }, + "Sli": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicator", + "traits": { + "smithy.api#documentation": "

A structure containing information about the performance metric that this SLO monitors.

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

A structure containing information about one service level objective (SLO) that has been created in Application Signals.\n Creating SLOs can help you ensure your services are \n performing to the level that you expect. SLOs help you set and track a specific target level for the\n reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is \n a key performance metric, to \n calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.

" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:application-signals:[^:]*:[^:]*:slo/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReport": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SLO that this report is for.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveName", + "traits": { + "smithy.api#documentation": "

The name of the SLO that this report is for.

", + "smithy.api#required": {} + } + }, + "BudgetStatus": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetStatus", + "traits": { + "smithy.api#documentation": "

The status of this SLO, as it relates to the error budget for the entire time interval.

\n
    \n
  • \n

    \n OK means that the SLO had remaining budget above the warning threshold,\n as of the time that you specified in TimeStamp.

    \n
  • \n
  • \n

    \n WARNING means that the SLO's remaining budget was below the warning threshold,\n as of the time that you specified in TimeStamp.

    \n
  • \n
  • \n

    \n BREACHED means that the SLO's budget was exhausted,\n as of the time that you specified in TimeStamp.

    \n
  • \n
  • \n

    \n INSUFFICIENT_DATA means that the specifed start and end times were before the\n SLO was created, or that attainment data is missing.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "Attainment": { + "target": "com.amazonaws.applicationsignals#Attainment", + "traits": { + "smithy.api#documentation": "

A number between 0 and 100 that represents the percentage of time periods that the service has \n attained the SLO's attainment goal, as of the time of the request.

" + } + }, + "TotalBudgetSeconds": { + "target": "com.amazonaws.applicationsignals#TotalBudgetSeconds", + "traits": { + "smithy.api#documentation": "

The total number of seconds in the error budget for the interval.

" + } + }, + "BudgetSecondsRemaining": { + "target": "com.amazonaws.applicationsignals#BudgetSecondsRemaining", + "traits": { + "smithy.api#documentation": "

The budget amount remaining before the SLO status becomes BREACHING, at the time specified in\n the \n Timestemp parameter of the request. If this value is negative, then the SLO is already in BREACHING\n status.

" + } + }, + "Sli": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicator", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the performance metric that this SLO monitors.

" + } + }, + "Goal": { + "target": "com.amazonaws.applicationsignals#Goal" + } + }, + "traits": { + "smithy.api#documentation": "

A structure containing an SLO budget report that you have requested.

" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportError": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveName", + "traits": { + "smithy.api#documentation": "

The name of the SLO that this error is related to.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveArn", + "traits": { + "smithy.api#documentation": "

The ARN of the SLO that this error is related to.

", + "smithy.api#required": {} + } + }, + "ErrorCode": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportErrorCode", + "traits": { + "smithy.api#documentation": "

The error code for this error.

", + "smithy.api#required": {} + } + }, + "ErrorMessage": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportErrorMessage", + "traits": { + "smithy.api#documentation": "

The message for this error.

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

A structure containing information about one error that occurred during a \n BatchGetServiceLevelObjectiveBudgetReport\n operation.

" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportErrorCode": { + "type": "string" + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportErrorMessage": { + "type": "string" + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReportError" + }, + "traits": { + "smithy.api#length": { + "max": 50 + } + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReports": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetReport" + }, + "traits": { + "smithy.api#length": { + "max": 50 + } + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveBudgetStatus": { + "type": "enum", + "members": { + "OK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OK" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "BREACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BREACHED" + } + }, + "INSUFFICIENT_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_DATA" + } + } + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$|^arn:aws:application-signals:[^:]*:[^:]*:slo/[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveIds": { + "type": "list", + "member": { + "target": "smithy.api#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9A-Za-z][-._0-9A-Za-z ]{0,126}[0-9A-Za-z]$" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveResource": { + "type": "resource", + "identifiers": { + "Id": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveId" + } + }, + "create": { + "target": "com.amazonaws.applicationsignals#CreateServiceLevelObjective" + }, + "read": { + "target": "com.amazonaws.applicationsignals#GetServiceLevelObjective" + }, + "update": { + "target": "com.amazonaws.applicationsignals#UpdateServiceLevelObjective" + }, + "delete": { + "target": "com.amazonaws.applicationsignals#DeleteServiceLevelObjective" + }, + "list": { + "target": "com.amazonaws.applicationsignals#ListServiceLevelObjectives" + }, + "traits": { + "aws.api#arn": { + "template": "{Id}", + "absolute": false + } + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveSummary" + } + }, + "com.amazonaws.applicationsignals#ServiceLevelObjectiveSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveArn", + "traits": { + "smithy.api#documentation": "

The ARN of this service level objective.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveName", + "traits": { + "smithy.api#documentation": "

The name of the service level objective.

", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

This is a string-to-string map. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this service level objective is for.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
" + } + }, + "OperationName": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

If this service level objective is specific to a single operation, this \n field displays the name of that operation.

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

The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

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

A structure that contains information about one service level objective (SLO) created in Application Signals.

" + } + }, + "com.amazonaws.applicationsignals#ServiceOperation": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.applicationsignals#OperationName", + "traits": { + "smithy.api#documentation": "

The name of the operation, discovered by Application Signals.

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

An array of structures that each contain information about one metric associated with this service operation\n that was discovered by\n Application Signals.

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

This structure contains information about an operation discovered by Application Signals. An operation\n is a specific function performed by a service that was discovered by Application Signals, and is often an API \n that is called by an upstream dependent.\n

" + } + }, + "com.amazonaws.applicationsignals#ServiceOperations": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceOperation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.applicationsignals#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This request exceeds a service quota.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.applicationsignals#ServiceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#ServiceSummary" + } + }, + "com.amazonaws.applicationsignals#ServiceSummary": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.applicationsignals#Attributes", + "traits": { + "smithy.api#documentation": "

This is a string-to-string map that help identify the objects discovered by Application Signals. It can \n include the following fields.

\n
    \n
  • \n

    \n Type designates the type of object this is.

    \n
  • \n
  • \n

    \n ResourceType specifies the type of the resource. This field is used only\n when the value of the Type field is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Name specifies the name of the object. This is used only if the value of the Type field\n is Service, RemoteService, or AWS::Service.

    \n
  • \n
  • \n

    \n Identifier identifies the resource objects of this resource. \n This is used only if the value of the Type field\n is Resource or AWS::Resource.

    \n
  • \n
  • \n

    \n Environment specifies the location where this object is hosted, or what it belongs to.

    \n
  • \n
", + "smithy.api#required": {} + } + }, + "AttributeMaps": { + "target": "com.amazonaws.applicationsignals#AttributeMaps", + "traits": { + "smithy.api#documentation": "

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.

\n

Platform attributes contain information the service's platform.

\n
    \n
  • \n

    \n PlatformType defines the hosted-in platform.

    \n
  • \n
  • \n

    \n EKS.Cluster is the name of the Amazon EKS cluster.

    \n
  • \n
  • \n

    \n K8s.Cluster is the name of the self-hosted Kubernetes cluster.

    \n
  • \n
  • \n

    \n K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.

    \n
  • \n
  • \n

    \n EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.

    \n
  • \n
  • \n

    \n EC2.InstanceId is the ID of the Amazon EC2 instance.

    \n
  • \n
  • \n

    \n Host is the name of the host, for all platform types.

    \n
  • \n
\n

Applciation attributes contain information about the application.

\n
    \n
  • \n

    \n AWS.Application is the application's name in Amazon Web Services Service Catalog AppRegistry.

    \n
  • \n
  • \n

    \n AWS.Application.ARN is the application's ARN in Amazon Web Services Service Catalog AppRegistry.

    \n
  • \n
\n

Telemetry attributes contain telemetry information.

\n
    \n
  • \n

    \n Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.

    \n
  • \n
  • \n

    \n Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.

    \n
  • \n
  • \n

    \n Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

    \n
  • \n
" + } + }, + "MetricReferences": { + "target": "com.amazonaws.applicationsignals#MetricReferences", + "traits": { + "smithy.api#documentation": "

An array of structures that each contain information about one metric associated with this service.

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

This structure contains information about one of your services that\n was discoverd by Application Signals

" + } + }, + "com.amazonaws.applicationsignals#StandardUnit": { + "type": "enum", + "members": { + "MICROSECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Microseconds" + } + }, + "MILLISECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Milliseconds" + } + }, + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Seconds" + } + }, + "BYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes" + } + }, + "KILOBYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes" + } + }, + "MEGABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes" + } + }, + "GIGABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes" + } + }, + "TERABYTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes" + } + }, + "BITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits" + } + }, + "KILOBITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits" + } + }, + "MEGABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits" + } + }, + "GIGABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits" + } + }, + "TERABITS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Percent" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count" + } + }, + "BYTES_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bytes/Second" + } + }, + "KILOBYTES_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobytes/Second" + } + }, + "MEGABYTES_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabytes/Second" + } + }, + "GIGABYTES_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabytes/Second" + } + }, + "TERABYTES_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabytes/Second" + } + }, + "BITS_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bits/Second" + } + }, + "KILOBITS_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Kilobits/Second" + } + }, + "MEGABITS_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Megabits/Second" + } + }, + "GIGABITS_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Gigabits/Second" + } + }, + "TERABITS_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terabits/Second" + } + }, + "COUNT_SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Count/Second" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + } + } + }, + "com.amazonaws.applicationsignals#StartDiscovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#StartDiscoveryInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#StartDiscoveryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#AccessDeniedException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Enables this Amazon Web Services account to be able to use CloudWatch Application Signals \n by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service-\n linked role has the following permissions:

\n
    \n
  • \n

    \n xray:GetServiceGraph\n

    \n
  • \n
  • \n

    \n logs:StartQuery\n

    \n
  • \n
  • \n

    \n logs:GetQueryResults\n

    \n
  • \n
  • \n

    \n cloudwatch:GetMetricData\n

    \n
  • \n
  • \n

    \n cloudwatch:ListMetrics\n

    \n
  • \n
  • \n

    \n tag:GetResources\n

    \n
  • \n
  • \n

    \n autoscaling:DescribeAutoScalingGroups\n

    \n
  • \n
\n

After completing this step, you still need to instrument your Java and Python applications to send data \n to Application Signals. For more information, see \n \n Enabling Application Signals.

", + "smithy.api#http": { + "method": "POST", + "uri": "/start-discovery", + "code": 200 + } + } + }, + "com.amazonaws.applicationsignals#StartDiscoveryInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#StartDiscoveryOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#Stat": { + "type": "string" + }, + "com.amazonaws.applicationsignals#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.applicationsignals#TagKey", + "traits": { + "smithy.api#documentation": "

A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your \n resources.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.applicationsignals#TagValue", + "traits": { + "smithy.api#documentation": "

The value for the specified tag key.

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

A key-value pair associated with a resource. Tags can help you organize and categorize your resources.

" + } + }, + "com.amazonaws.applicationsignals#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.applicationsignals#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.applicationsignals#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationsignals#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.applicationsignals#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.applicationsignals#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationsignals#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user\n permission to access or change only resources with certain tag values.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

\n

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, \n this tag is appended to the list of tags associated\n with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces\n the previous value for that tag.

\n

You can associate as many as 50 tags with a CloudWatch resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tag-resource", + "code": 200 + } + } + }, + "com.amazonaws.applicationsignals#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.applicationsignals#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.

\n

The ARN format of an Application Signals SLO is \n arn:aws:cloudwatch:Region:account-id:slo:slo-name\n \n

\n

For more information about ARN format, see Resource\n Types Defined by Amazon CloudWatch in the Amazon Web Services General\n Reference.

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

The list of key-value pairs to associate with the alarm.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.applicationsignals#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was throttled because of quota limits.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.applicationsignals#TotalBudgetSeconds": { + "type": "integer" + }, + "com.amazonaws.applicationsignals#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.applicationsignals#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from the specified resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/untag-resource", + "code": 200 + } + } + }, + "com.amazonaws.applicationsignals#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.applicationsignals#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.

\n

The ARN format of an Application Signals SLO is \n arn:aws:cloudwatch:Region:account-id:slo:slo-name\n \n

\n

For more information about ARN format, see Resource\n Types Defined by Amazon CloudWatch in the Amazon Web Services General\n Reference.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.applicationsignals#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#UpdateServiceLevelObjective": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationsignals#UpdateServiceLevelObjectiveInput" + }, + "output": { + "target": "com.amazonaws.applicationsignals#UpdateServiceLevelObjectiveOutput" + }, + "errors": [ + { + "target": "com.amazonaws.applicationsignals#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationsignals#ThrottlingException" + }, + { + "target": "com.amazonaws.applicationsignals#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing service level objective (SLO). If you omit parameters, the previous values\n of those parameters are retained.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/slo/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.applicationsignals#UpdateServiceLevelObjectiveInput": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) or name of the service level objective that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjectiveDescription", + "traits": { + "smithy.api#documentation": "

An optional description for the SLO.

" + } + }, + "SliConfig": { + "target": "com.amazonaws.applicationsignals#ServiceLevelIndicatorConfig", + "traits": { + "smithy.api#documentation": "

A structure that contains information about what performance metric this SLO will monitor.

" + } + }, + "Goal": { + "target": "com.amazonaws.applicationsignals#Goal", + "traits": { + "smithy.api#documentation": "

A structure that contains the attributes that determine the goal of the SLO. This includes\n the time period for evaluation and the attainment threshold.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationsignals#UpdateServiceLevelObjectiveOutput": { + "type": "structure", + "members": { + "Slo": { + "target": "com.amazonaws.applicationsignals#ServiceLevelObjective", + "traits": { + "smithy.api#documentation": "

A structure that contains information about the SLO that you just updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationsignals#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.applicationsignals#ValidationExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ValidationError", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The resource is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.applicationsignals#ValidationExceptionMessage": { + "type": "string" + }, + "com.amazonaws.applicationsignals#WarningThreshold": { + "type": "double" + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/ecs.json b/codegen/sdk/aws-models/ecs.json index c5ebc25fcce..c9ef466b671 100644 --- a/codegen/sdk/aws-models/ecs.json +++ b/codegen/sdk/aws-models/ecs.json @@ -1681,7 +1681,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" + "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.

\n

With FARGATE_SPOT, you can run interruption\n\t\t\ttolerant tasks at a rate that's discounted compared to the FARGATE price.\n\t\t\t\tFARGATE_SPOT runs tasks on spare compute capacity. When Amazon Web Services needs the\n\t\t\tcapacity back, your tasks are interrupted with a two-minute warning.\n\t\t\t\tFARGATE_SPOT only supports Linux tasks with the X86_64 architecture on\n\t\t\tplatform version 1.3.0 or later.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "com.amazonaws.ecs#CapacityProviderStrategyItemBase": { @@ -1882,10 +1882,16 @@ "traits": { "smithy.api#documentation": "

The details of the execute command configuration.

" } + }, + "managedStorageConfiguration": { + "target": "com.amazonaws.ecs#ManagedStorageConfiguration", + "traits": { + "smithy.api#documentation": "

The details of the managed storage configuration.

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

The execute command configuration for the cluster.

" + "smithy.api#documentation": "

The execute command and managed storage configuration for the cluster.

" } }, "com.amazonaws.ecs#ClusterContainsContainerInstancesException": { @@ -4163,6 +4169,12 @@ "traits": { "smithy.api#documentation": "

The details of the volume that was configuredAtLaunch. You can configure\n\t\t\tdifferent settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume\n\t\t\tmust match the name from the task definition.

" } + }, + "fargateEphemeralStorage": { + "target": "com.amazonaws.ecs#DeploymentEphemeralStorage", + "traits": { + "smithy.api#documentation": "

The Fargate ephemeral storage settings for the deployment.

" + } } }, "traits": { @@ -4294,6 +4306,20 @@ } } }, + "com.amazonaws.ecs#DeploymentEphemeralStorage": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

Specify an Key Management Service key ID to encrypt the ephemeral storage for deployment.

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

The amount of ephemeral storage to allocate for the deployment.

" + } + }, "com.amazonaws.ecs#DeploymentRolloutState": { "type": "enum", "members": { @@ -6255,7 +6281,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile). This configuration maps to the HEALTHCHECK parameter of docker run.

\n \n

The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.

\n
\n

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n

The health check is designed to make sure that your containers survive agent restarts,\n\t\t\tupgrades, or temporary unavailability.

\n

Amazon ECS performs health checks on containers with the default that launched the\n\t\t\tcontainer instance or the task.

\n

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n
    \n
  • \n

    \n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.

    \n
  • \n
  • \n

    \n UNHEALTHY-The container health check has failed.

    \n
  • \n
  • \n

    \n UNKNOWN-The container health check is being evaluated,\n\t\t\t\t\tthere's no container health check defined, or Amazon ECS doesn't have the health\n\t\t\t\t\tstatus of the container.

    \n
  • \n
\n

The following describes the possible healthStatus values based on the\n\t\t\tcontainer health checker status of essential containers in the task with the following\n\t\t\tpriority order (high to low):

\n
    \n
  • \n

    \n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.

    \n
  • \n
  • \n

    \n UNKNOWN-Any essential container running within the task is\n\t\t\t\t\tin an UNKNOWN state and no other essential containers have an\n\t\t\t\t\t\tUNHEALTHY state.

    \n
  • \n
  • \n

    \n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.

    \n
  • \n
\n

Consider the following task health example with 2 containers.

\n
    \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, the task health is UNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, the task health is UNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tthe task health is UNKNOWN.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tthe task health is HEALTHY.

    \n
  • \n
\n

Consider the following task health example with 3 containers.

\n
    \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is UNKNOWN, the task health is\n\t\t\t\t\t\tUNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tUNKNOWN.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is UNKNOWN, the task health is\n\t\t\t\t\tUNKNOWN.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tHEALTHY.

    \n
  • \n
\n

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n

The following are notes about container health check support:

\n
    \n
  • \n

    When the Amazon ECS agent cannot connect to the Amazon ECS service, the service reports\n\t\t\t\t\tthe container as UNHEALTHY.

    \n
  • \n
  • \n

    The health check statuses are the \"last heard from\" response from the Amazon ECS\n\t\t\t\t\tagent. There are no assumptions made about the status of the container health\n\t\t\t\t\tchecks.

    \n
  • \n
  • \n

    Container health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS container agent.

    \n
  • \n
  • \n

    Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more\n\t\t\t\t\tinformation, see Fargate\n\t\t\t\t\t\tplatform versions.

    \n
  • \n
  • \n

    Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.

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

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile). This configuration maps to the HEALTHCHECK parameter of docker run.

\n \n

The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.

\n
\n

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n

The health check is designed to make sure that your containers survive agent restarts,\n\t\t\tupgrades, or temporary unavailability.

\n

Amazon ECS performs health checks on containers with the default that launched the\n\t\t\tcontainer instance or the task.

\n

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n
    \n
  • \n

    \n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.

    \n
  • \n
  • \n

    \n UNHEALTHY-The container health check has failed.

    \n
  • \n
  • \n

    \n UNKNOWN-The container health check is being evaluated,\n\t\t\t\t\tthere's no container health check defined, or Amazon ECS doesn't have the health\n\t\t\t\t\tstatus of the container.

    \n
  • \n
\n

The following describes the possible healthStatus values based on the\n\t\t\tcontainer health checker status of essential containers in the task with the following\n\t\t\tpriority order (high to low):

\n
    \n
  • \n

    \n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.

    \n
  • \n
  • \n

    \n UNKNOWN-Any essential container running within the task is\n\t\t\t\t\tin an UNKNOWN state and no other essential containers have an\n\t\t\t\t\t\tUNHEALTHY state.

    \n
  • \n
  • \n

    \n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.

    \n
  • \n
\n

Consider the following task health example with 2 containers.

\n
    \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, the task health is UNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, the task health is UNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tthe task health is UNKNOWN.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tthe task health is HEALTHY.

    \n
  • \n
\n

Consider the following task health example with 3 containers.

\n
    \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is UNKNOWN, the task health is\n\t\t\t\t\t\tUNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tUNKNOWN, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is UNHEALTHY and Container2 is\n\t\t\t\t\tHEALTHY, and Container3 is HEALTHY, the task health is\n\t\t\t\t\t\tUNHEALTHY.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tUNKNOWN.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is UNKNOWN,\n\t\t\t\t\tand Container3 is UNKNOWN, the task health is\n\t\t\t\t\tUNKNOWN.

    \n
  • \n
  • \n

    If Container1 is HEALTHY and Container2 is HEALTHY,\n\t\t\t\t\tand Container3 is HEALTHY, the task health is\n\t\t\t\t\tHEALTHY.

    \n
  • \n
\n

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n

The following are notes about container health check support:

\n
    \n
  • \n

    If the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this won't\n\t\t\t\t\tcause a container to transition to an UNHEALTHY status. This is by design,\n\t\t\t\t\tto ensure that containers remain running during agent restarts or temporary\n\t\t\t\t\tunavailability. The health check status is the \"last heard from\" response from the Amazon ECS\n\t\t\t\t\tagent, so if the container was considered HEALTHY prior to the disconnect,\n\t\t\t\t\tthat status will remain until the agent reconnects and another health check occurs.\n\t\t\t\t\tThere are no assumptions made about the status of the container health checks.

    \n
  • \n
  • \n

    Container health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS container agent.

    \n
  • \n
  • \n

    Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more\n\t\t\t\t\tinformation, see Fargate\n\t\t\t\t\t\tplatform versions.

    \n
  • \n
  • \n

    Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.

    \n
  • \n
" } }, "com.amazonaws.ecs#HealthStatus": { @@ -8002,6 +8028,26 @@ } } }, + "com.amazonaws.ecs#ManagedStorageConfiguration": { + "type": "structure", + "members": { + "kmsKeyId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "

Specify a Key Management Service key ID to encrypt the managed storage.

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

Specify the Key Management Service key ID for the Fargate ephemeral storage.

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

The managed storage configuration for the cluster.

" + } + }, "com.amazonaws.ecs#ManagedTerminationProtection": { "type": "enum", "members": { @@ -9196,7 +9242,7 @@ "runtimePlatform": { "target": "com.amazonaws.ecs#RuntimePlatform", "traits": { - "smithy.api#documentation": "

The operating system that your tasks definitions run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n

When you specify a task definition in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.

" + "smithy.api#documentation": "

The operating system that your tasks definitions run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

" } } }, @@ -9334,14 +9380,14 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value for the specified resource type.

\n

If the GPU type is used, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.

\n

If the InferenceAccelerator type is used, the value matches\n\t\t\tthe deviceName for an InferenceAccelerator specified in a task definition.

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

The value for the specified resource type.

\n

When the type is GPU, the value is the number of physical GPUs the\n\t\t\tAmazon ECS container agent reserves for the container. The number of GPUs that's reserved for\n\t\t\tall containers in a task can't exceed the number of available GPUs on the container\n\t\t\tinstance that the task is launched on.

\n

When the type is InferenceAccelerator, the value matches\n\t\t\tthe deviceName for an InferenceAccelerator specified in a task definition.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.ecs#ResourceType", "traits": { - "smithy.api#documentation": "

The type of resource to assign to a container. The supported values are\n\t\t\t\tGPU or InferenceAccelerator.

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

The type of resource to assign to a container.

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

An object that represents the Amazon Web Services Private Certificate Authority certificate.

" + "smithy.api#documentation": "

The certificate root authority that secures your service.

" } }, "com.amazonaws.ecs#ServiceConnectTlsConfiguration": { @@ -10112,7 +10158,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that represents the configuration for Service Connect TLS.

" + "smithy.api#documentation": "

The key that encrypts and decrypts your resources for Service Connect TLS.

" } }, "com.amazonaws.ecs#ServiceEvent": { @@ -10676,7 +10722,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a running task. Any tags associated with the task will be deleted.

\n

When StopTask is called on a task, the equivalent of docker\n\t\t\t\tstop is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL value is sent.

\n \n

The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

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

Stops a running task. Any tags associated with the task will be deleted.

\n

When StopTask is called on a task, the equivalent of docker\n\t\t\t\tstop is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL value is sent.

\n

For Windows containers, POSIX signals do not work and runtime stops the container by sending\n\t\t\ta CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown\n\t\t\t\tof (Windows) container #25982 on GitHub.

\n \n

The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n
" } }, "com.amazonaws.ecs#StopTaskRequest": { @@ -11419,6 +11465,12 @@ "traits": { "smithy.api#documentation": "

The ephemeral storage settings for the task.

" } + }, + "fargateEphemeralStorage": { + "target": "com.amazonaws.ecs#TaskEphemeralStorage", + "traits": { + "smithy.api#documentation": "

The Fargate ephemeral storage settings for the task.

" + } } }, "traits": { @@ -11684,6 +11736,27 @@ } } }, + "com.amazonaws.ecs#TaskEphemeralStorage": { + "type": "structure", + "members": { + "sizeInGiB": { + "target": "com.amazonaws.ecs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total amount, in GiB, of the ephemeral storage to set for the task. The minimum \t\t\n\t\t\tsupported value is 20 GiB and the maximum supported value is\u2028 200 \n\t\t\tGiB.

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

Specify an Key Management Service key ID to encrypt the ephemeral storage for the task.

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

The amount of ephemeral storage to allocate for the task.

" + } + }, "com.amazonaws.ecs#TaskField": { "type": "enum", "members": { @@ -12013,6 +12086,12 @@ "traits": { "smithy.api#documentation": "

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50

    \n
  • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only\n one value.

    \n
  • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8

    \n
  • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8

    \n
  • \n
  • \n

    If your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.

    \n
  • \n
  • \n

    Tag keys and values are case-sensitive.

    \n
  • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.

    \n
  • \n
" } + }, + "fargateEphemeralStorage": { + "target": "com.amazonaws.ecs#DeploymentEphemeralStorage", + "traits": { + "smithy.api#documentation": "

The Fargate ephemeral storage settings for the task set.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/imagebuilder.json b/codegen/sdk/aws-models/imagebuilder.json index 81ac6538833..fead5ea44b3 100644 --- a/codegen/sdk/aws-models/imagebuilder.json +++ b/codegen/sdk/aws-models/imagebuilder.json @@ -547,7 +547,7 @@ "com.amazonaws.imagebuilder#ComponentBuildVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" } }, "com.amazonaws.imagebuilder#ComponentConfiguration": { @@ -926,13 +926,13 @@ "com.amazonaws.imagebuilder#ComponentVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):component/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" } }, "com.amazonaws.imagebuilder#ComponentVersionArnOrBuildVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):component/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" } }, "com.amazonaws.imagebuilder#ComponentVersionList": { @@ -5455,13 +5455,13 @@ "com.amazonaws.imagebuilder#ImageBuildVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" } }, "com.amazonaws.imagebuilder#ImageBuilderArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\\.(?:x|[0-9]+)\\.(?:x|[0-9]+))(?:/[0-9]+)?)?$" } }, "com.amazonaws.imagebuilder#ImagePackage": { @@ -6424,13 +6424,13 @@ "com.amazonaws.imagebuilder#ImageVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" } }, "com.amazonaws.imagebuilder#ImageVersionArnOrBuildVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" + "smithy.api#pattern": "^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" } }, "com.amazonaws.imagebuilder#ImageVersionList": { @@ -12676,7 +12676,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" + "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$" } }, "com.amazonaws.imagebuilder#WorkflowConfiguration": { @@ -12882,7 +12882,7 @@ "com.amazonaws.imagebuilder#WorkflowNameArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/x\\.x\\.x$" + "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/x\\.x\\.x$" } }, "com.amazonaws.imagebuilder#WorkflowParameter": { @@ -13464,13 +13464,13 @@ "com.amazonaws.imagebuilder#WorkflowVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" + "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+\\.[0-9]+\\.[0-9]+$" } }, "com.amazonaws.imagebuilder#WorkflowVersionArnOrBuildVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" + "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$" } }, "com.amazonaws.imagebuilder#WorkflowVersionList": { @@ -13482,7 +13482,7 @@ "com.amazonaws.imagebuilder#WorkflowWildcardVersionArn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws):workflow/(build|test|distribution)/[a-z0-9-_]+/(?:[0-9]+|x)\\.(?:[0-9]+|x)\\.(?:[0-9]+|x)$" + "smithy.api#pattern": "^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/(?:[0-9]+|x)\\.(?:[0-9]+|x)\\.(?:[0-9]+|x)$" } }, "com.amazonaws.imagebuilder#imagebuilder": { From 5528e56988ca3e1da8e49e6ec9ca32d6c705ad44 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 10 Jun 2024 18:02:02 +0000 Subject: [PATCH 39/41] feat: update AWS service endpoints metadata --- .../src/main/resources/aws/sdk/kotlin/codegen/endpoints.json | 1 + 1 file changed, 1 insertion(+) 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 24ae0282309..6829e1310d5 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 @@ -14832,6 +14832,7 @@ "deprecated" : true, "hostname" : "redshift-serverless-fips.us-west-2.amazonaws.com" }, + "me-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { "variants" : [ { From eac1f909252e12188f38f6295ea72ccfad2cc80d Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 10 Jun 2024 18:04:50 +0000 Subject: [PATCH 40/41] chore: release 1.2.30 --- CHANGELOG.md | 7 +++++++ codegen/sdk/packages.json | 6 ++++++ gradle.properties | 2 +- 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 29a4fe02c01..5edb439fba3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [1.2.30] - 06/10/2024 + +### Features +* (**applicationsignals**) This is the initial SDK release for Amazon CloudWatch Application Signals. Amazon CloudWatch Application Signals provides curated application performance monitoring for developers to monitor and troubleshoot application health using pre-built dashboards and Service Level Objectives. +* (**ecs**) This release introduces a new cluster configuration to support the customer-managed keys for ECS managed storage encryption. +* (**imagebuilder**) This release updates the regex pattern for Image Builder ARNs. + ## [1.2.29] - 06/07/2024 ### Features diff --git a/codegen/sdk/packages.json b/codegen/sdk/packages.json index d40f6448602..89583789401 100644 --- a/codegen/sdk/packages.json +++ b/codegen/sdk/packages.json @@ -138,6 +138,12 @@ "artifactName": "applicationinsights", "brazilName": "AwsSdkKotlinApplicationInsights" }, + { + "sdkId": "Application Signals", + "namespace": "aws.sdk.kotlin.services.applicationsignals", + "artifactName": "applicationsignals", + "brazilName": "AwsSdkKotlinApplicationSignals" + }, { "sdkId": "ApplicationCostProfiler", "namespace": "aws.sdk.kotlin.services.applicationcostprofiler", diff --git a/gradle.properties b/gradle.properties index 42c7ea08755..1c38dbc9ecc 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.2.30-SNAPSHOT +sdkVersion=1.2.30 # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ From d93c138551e934c2c2e1994f663ab0bce33b1624 Mon Sep 17 00:00:00 2001 From: aws-sdk-kotlin-ci Date: Mon, 10 Jun 2024 18:04:52 +0000 Subject: [PATCH 41/41] chore: bump snapshot version to 1.2.31-SNAPSHOT --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 1c38dbc9ecc..521e02899f8 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.2.30 +sdkVersion=1.2.31-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/