From 9437d07ba03173c7489d04efbb4cdf36083a010c Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Tue, 24 Sep 2024 18:08:06 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/bedrock.json | 12 +- codegen/sdk-codegen/aws-models/budgets.json | 150 +++++++- codegen/sdk-codegen/aws-models/kinesis.json | 15 +- .../aws-models/pinpoint-sms-voice-v2.json | 334 ++++++++++++++++-- codegen/sdk-codegen/aws-models/sagemaker.json | 119 ++++++- 5 files changed, 573 insertions(+), 57 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/bedrock.json b/codegen/sdk-codegen/aws-models/bedrock.json index ce5b6e03875..2960229ef59 100644 --- a/codegen/sdk-codegen/aws-models/bedrock.json +++ b/codegen/sdk-codegen/aws-models/bedrock.json @@ -1051,7 +1051,7 @@ "clientRequestToken": { "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, @@ -1084,7 +1084,7 @@ "inferenceConfig": { "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", "traits": { - "smithy.api#documentation": "

Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.

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

Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model or inference profile, and model evaluation job that use human workers support two models or inference profiles.

", "smithy.api#required": {} } }, @@ -2386,7 +2386,7 @@ "modelIdentifier": { "target": "com.amazonaws.bedrock#EvaluationModelIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Bedrock model specified.

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

The ARN of the Amazon Bedrock model or inference profile specified.

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

Contains the ARN of the Amazon Bedrock models specified in your model evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.

\n

The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, \"temperature\":\"0.25\" key value pair would need to be formatted as \\\"temperature\\\":\\\"0.25\\\" to successfully accepted in the request.

" + "smithy.api#documentation": "

Contains the ARN of the Amazon Bedrock model or inference profile specified in your model evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.

\n

The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, \"temperature\":\"0.25\" key value pair would need to be formatted as \\\"temperature\\\":\\\"0.25\\\" to successfully accepted in the request.

" } }, "com.amazonaws.bedrock#EvaluationConfig": { @@ -2693,7 +2693,7 @@ "bedrockModel": { "target": "com.amazonaws.bedrock#EvaluationBedrockModel", "traits": { - "smithy.api#documentation": "

Defines the Amazon Bedrock model and inference parameters you want used.

" + "smithy.api#documentation": "

Defines the Amazon Bedrock model or inference profile and inference parameters you want used.

" } } }, @@ -2720,7 +2720,7 @@ "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-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:inference-profile/(([a-z]{2}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))|(([a-z]{2}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))$" } }, "com.amazonaws.bedrock#EvaluationModelIdentifiers": { diff --git a/codegen/sdk-codegen/aws-models/budgets.json b/codegen/sdk-codegen/aws-models/budgets.json index 00dc803101d..0fea2c0505a 100644 --- a/codegen/sdk-codegen/aws-models/budgets.json +++ b/codegen/sdk-codegen/aws-models/budgets.json @@ -340,6 +340,108 @@ }, "type": "endpoint" }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-e" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://budgets.global.cloud.adc-e.uk", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-f" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://budgets.global.csp.hci.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-isof-south-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -858,6 +960,50 @@ "UseDualStack": false } }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "url": "https://budgets.global.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://budgets.global.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -3861,7 +4007,7 @@ "min": 25, "max": 684 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::(\\d{12}|aws):policy(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso|-iso-[a-z]{1})?:iam::(\\d{12}|aws):policy(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" } }, "com.amazonaws.budgets#PolicyId": { @@ -3978,7 +4124,7 @@ "min": 32, "max": 618 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::\\d{12}:role(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso|-iso-[a-z]{1})?:iam::\\d{12}:role(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" } }, "com.amazonaws.budgets#Roles": { diff --git a/codegen/sdk-codegen/aws-models/kinesis.json b/codegen/sdk-codegen/aws-models/kinesis.json index 4176b38755d..035a669dd78 100644 --- a/codegen/sdk-codegen/aws-models/kinesis.json +++ b/codegen/sdk-codegen/aws-models/kinesis.json @@ -300,7 +300,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

\n

You can add tags to the stream when making a CreateStream request by\n setting the Tags parameter. If you pass Tags parameter, in\n addition to having kinesis:createStream permission, you must also have\n kinesis:addTagsToStream permission for the stream that will be created.\n Tags will take effect from the CREATING status of the stream.

" } }, "com.amazonaws.kinesis#CreateStreamInput": { @@ -324,6 +324,12 @@ "traits": { "smithy.api#documentation": "

Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,\n you can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data\n streams.

" } + }, + "Tags": { + "target": "com.amazonaws.kinesis#TagMap", + "traits": { + "smithy.api#documentation": "

A set of up to 10 key-value pairs to use to create the tags.

" + } } }, "traits": { @@ -1296,6 +1302,9 @@ { "target": "com.amazonaws.kinesis#LimitExceededException" }, + { + "target": "com.amazonaws.kinesis#ResourceInUseException" + }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } @@ -6929,7 +6938,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

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

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operation, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" @@ -7889,7 +7898,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

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

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operation, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "data" diff --git a/codegen/sdk-codegen/aws-models/pinpoint-sms-voice-v2.json b/codegen/sdk-codegen/aws-models/pinpoint-sms-voice-v2.json index e5717832f6b..e3bb2990252 100644 --- a/codegen/sdk-codegen/aws-models/pinpoint-sms-voice-v2.json +++ b/codegen/sdk-codegen/aws-models/pinpoint-sms-voice-v2.json @@ -204,14 +204,14 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The pool to update with the new Identity. This value can be either the PoolId or\n PoolArn, and you can find these values using DescribePools.

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

The pool to update with the new Identity. This value can be either the PoolId or\n PoolArn, and you can find these values using DescribePools.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

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

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -1149,7 +1149,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

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

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -2339,7 +2339,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.

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

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -2478,7 +2478,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

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

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } } @@ -2551,7 +2551,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn to remove the phone number from.

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

The OptOutListName or OptOutListArn to remove the phone number from.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -2644,7 +2644,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

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

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } } @@ -3134,6 +3134,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource you're deleting the resource-based policy from.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource that the resource-based policy was deleted from.

" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The JSON formatted resource-based policy that was deleted.

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

The time when the resource-based policy was created, in UNIX epoch time format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride": { "type": "operation", "input": { @@ -3581,7 +3651,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

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

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -3684,7 +3754,7 @@ "OptOutListNames": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList", "traits": { - "smithy.api#documentation": "

The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.

" + "smithy.api#documentation": "

The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "NextToken": { @@ -3698,6 +3768,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return per each request.

" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "

Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.

" + } } }, "traits": { @@ -3762,7 +3838,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

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

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -3865,7 +3941,7 @@ "PhoneNumberIds": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList", "traits": { - "smithy.api#documentation": "

The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.

" + "smithy.api#documentation": "

The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "Filters": { @@ -3885,6 +3961,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return per each request.

" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "

Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.

" + } } }, "traits": { @@ -3949,7 +4031,7 @@ "PoolIds": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdList", "traits": { - "smithy.api#documentation": "

The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.

" + "smithy.api#documentation": "

The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "Filters": { @@ -3969,6 +4051,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return per each request.

" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "

Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.

" + } } }, "traits": { @@ -4780,7 +4868,7 @@ "SenderIds": { "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdList", "traits": { - "smithy.api#documentation": "

An array of SenderIdAndCountry objects to search for.

" + "smithy.api#documentation": "

An array of SenderIdAndCountry objects to search for.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "Filters": { @@ -4800,6 +4888,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return per each request.

" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "

Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

" + } } }, "traits": { @@ -5074,14 +5168,14 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.

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

The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.

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

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -5740,6 +5834,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The JSON formatted string that contains the resource-based policy attached to the AWS End User Messaging SMS and Voice resource.

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

The time when the resource-based policy was created, in UNIX epoch time format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { "type": "string", "traits": { @@ -6027,7 +6191,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.

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

The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -6665,6 +6829,21 @@ "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata" } }, + "com.amazonaws.pinpointsmsvoicev2#Owner": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SELF", + "name": "SELF" + }, + { + "value": "SHARED", + "name": "SHARED" + } + ] + } + }, "com.amazonaws.pinpointsmsvoicev2#PhoneNumber": { "type": "string", "traits": { @@ -7016,6 +7195,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValue" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicy" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride" }, @@ -7094,6 +7276,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSet" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicy" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities" }, @@ -7112,6 +7297,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValue" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicy" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber" }, @@ -8454,7 +8642,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

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

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -8556,7 +8744,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn to add the phone number to.

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

The OptOutListName or OptOutListArn to add the phone number to.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -8737,6 +8925,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for\n sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about\n resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to.

", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The JSON formatted resource-based policy to attach.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The JSON formatted Resource Policy.

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

The time when the resource-based policy was created, in UNIX epoch time format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationBehavior": { "type": "string", "traits": { @@ -9824,7 +10089,7 @@ "PhoneNumberId": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.

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

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } } @@ -10119,13 +10384,13 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.

" + "smithy.api#documentation": "

The name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The pool to associated with the phone number. You can use the PoolId or PoolArn.

" + "smithy.api#documentation": "

The pool to associated with the phone number. You can use the PoolId or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "RegistrationId": { @@ -10484,6 +10749,15 @@ "smithy.api#error": "client" } }, + "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, "com.amazonaws.pinpointsmsvoicev2#ResourceType": { "type": "string", "traits": { @@ -10539,6 +10813,10 @@ { "value": "protect-configuration", "name": "PROTECT_CONFIGURATION" + }, + { + "value": "policy", + "name": "POLICY" } ] } @@ -10707,7 +10985,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#VerificationMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

" + "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "ConfigurationSetName": { @@ -10796,7 +11074,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#MediaMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

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

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -10916,7 +11194,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

" + "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "MessageBody": { @@ -11047,7 +11325,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "

The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

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

The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -12469,7 +12747,7 @@ "PhoneNumberId": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.

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

The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -12665,7 +12943,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.

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

The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -12696,7 +12974,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.

" + "smithy.api#documentation": "

The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "SharedRoutesEnabled": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 905c17b98d8..274f94fe93d 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -2076,7 +2076,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications.

" } }, "com.amazonaws.sagemaker#AppList": { @@ -6701,7 +6701,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1 + "min": 0 } } }, @@ -7618,7 +7618,7 @@ "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#AppLifecycleManagement", "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor\n applications.

" } } }, @@ -30353,12 +30353,50 @@ "target": "com.amazonaws.sagemaker#AppType" } }, + "com.amazonaws.sagemaker#HiddenInstanceTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppInstanceType" + } + }, "com.amazonaws.sagemaker#HiddenMlToolsList": { "type": "list", "member": { "target": "com.amazonaws.sagemaker#MlTools" } }, + "com.amazonaws.sagemaker#HiddenSageMakerImage": { + "type": "structure", + "members": { + "SageMakerImageName": { + "target": "com.amazonaws.sagemaker#SageMakerImageName", + "traits": { + "smithy.api#documentation": "

\n The SageMaker image name that you are hiding from the Studio user interface.\n

" + } + }, + "VersionAliases": { + "target": "com.amazonaws.sagemaker#VersionAliasesList", + "traits": { + "smithy.api#documentation": "

\n The version aliases you are hiding from the Studio user interface.\n

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

The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker\n image name and version aliases.

" + } + }, + "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HiddenSageMakerImage" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.sagemaker#HolidayConfig": { "type": "list", "member": { @@ -31089,9 +31127,7 @@ "PreHumanTaskLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

\n

For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n \n

\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n \n

\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n \n

\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

\n \n

\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

\n \n

\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n \n

\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

\n \n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n \n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n \n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n \n

\n 3D Point Cloud Modalities\n

\n

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

\n

\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

\n \n

\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

\n \n

\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

\n \n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n

\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

\n \n

\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

\n \n

\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n \n

\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

\n \n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n \n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n \n

\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

\n \n

\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

\n \n

\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

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

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

\n

For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n \n

\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n \n

\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n \n

\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

\n \n

\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

\n \n

\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n \n

\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

\n \n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n \n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n \n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n \n

\n 3D Point Cloud Modalities\n

\n

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

\n

\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

\n \n

\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

\n \n

\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

\n \n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n

\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

\n \n

\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

\n \n

\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n \n

\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

\n \n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n \n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n \n

\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

\n \n

\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

\n \n

\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

\n " } }, "TaskKeywords": { @@ -31147,9 +31183,7 @@ "AnnotationConsolidationConfig": { "target": "com.amazonaws.sagemaker#AnnotationConsolidationConfig", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Configures how labels are consolidated across human workers.

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

Configures how labels are consolidated across human workers.

" } }, "PublicWorkforceTaskPrice": { @@ -32419,7 +32453,7 @@ "IdleTimeoutInMinutes": { "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", "traits": { - "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it down.

" + "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it\n down.

" } }, "MinIdleTimeoutInMinutes": { @@ -32820,6 +32854,16 @@ "smithy.api#pattern": "^(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)$" } }, + "com.amazonaws.sagemaker#ImageVersionAliasPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$" + } + }, "com.amazonaws.sagemaker#ImageVersionArn": { "type": "string", "traits": { @@ -36147,9 +36191,7 @@ "PreHumanTaskLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each\n data object is sent to a worker.

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

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each\n data object is sent to a worker.

" } }, "AnnotationConsolidationLambdaArn": { @@ -44688,6 +44730,12 @@ "traits": { "smithy.api#enumValue": "InferenceOptimization" } + }, + "PERFORMANCE_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PerformanceEvaluation" + } } } }, @@ -59430,6 +59478,17 @@ } } }, + "com.amazonaws.sagemaker#SageMakerImageName": { + "type": "enum", + "members": { + "sagemaker_distribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sagemaker_distribution" + } + } + } + }, "com.amazonaws.sagemaker#SageMakerImageVersionAlias": { "type": "string", "traits": { @@ -60910,7 +60969,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications in a space.

" } }, "com.amazonaws.sagemaker#SpaceArn": { @@ -60932,7 +60991,7 @@ "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications in\n a space.

" } } }, @@ -61017,7 +61076,7 @@ "IdleTimeoutInMinutes": { "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", "traits": { - "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it down.

" + "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it\n down.

" } } }, @@ -61040,7 +61099,7 @@ "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of JupyterLab applications in\n a space.

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

The Applications supported in Studio that are hidden from the Studio left navigation\n pane.

" } + }, + "HiddenInstanceTypes": { + "target": "com.amazonaws.sagemaker#HiddenInstanceTypesList", + "traits": { + "smithy.api#documentation": "

\n The instance types you are hiding from the Studio user interface.\n

" + } + }, + "HiddenSageMakerImageVersionAliases": { + "target": "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList", + "traits": { + "smithy.api#documentation": "

\n The version aliases you are hiding from the Studio user interface.\n

" + } } }, "traits": { @@ -70456,7 +70527,7 @@ "AutoMountHomeEFS": { "target": "com.amazonaws.sagemaker#AutoMountHomeEFS", "traits": { - "smithy.api#documentation": "

Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

" + "smithy.api#documentation": "

Indicates whether auto-mounting of an EFS volume is supported for the user profile. The\n DefaultAsDomain value is only supported for user profiles. Do not use the\n DefaultAsDomain value when setting this parameter for a domain.

" } } }, @@ -70657,6 +70728,18 @@ } } }, + "com.amazonaws.sagemaker#VersionAliasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ImageVersionAliasPattern" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.sagemaker#VersionId": { "type": "string", "traits": {