From 895b8c0020c4facb6ae81f3886557a89ac954847 Mon Sep 17 00:00:00 2001 From: John DiSanti Date: Thu, 12 May 2022 10:17:39 -0700 Subject: [PATCH] Prep for release (#1386) * Version bump * Update SDK models * Revert the S3 model since checksum support hasn't landed yet --- aws/sdk/aws-models/backup.json | 109 +- .../aws-models/chime-sdk-media-pipelines.json | 1276 +++++++++++++ aws/sdk/aws-models/cloudcontrol.json | 54 +- aws/sdk/aws-models/codeguru-reviewer.json | 58 +- aws/sdk/aws-models/compute-optimizer.json | 6 +- aws/sdk/aws-models/datasync.json | 28 +- aws/sdk/aws-models/ec2.json | 432 ++++- aws/sdk/aws-models/eks.json | 58 +- aws/sdk/aws-models/elasticmapreduce.json | 488 +++-- aws/sdk/aws-models/evidently.json | 12 +- aws/sdk/aws-models/iot.json | 15 + aws/sdk/aws-models/iotsecuretunneling.json | 168 +- aws/sdk/aws-models/ivschat.json | 1626 +++++++++++++++++ aws/sdk/aws-models/kendra.json | 91 +- .../kinesis-video-archived-media.json | 333 +++- aws/sdk/aws-models/kinesisvideo.json | 610 ++++++- aws/sdk/aws-models/lightsail.json | 14 +- aws/sdk/aws-models/location.json | 263 +-- aws/sdk/aws-models/mediaconvert.json | 85 +- aws/sdk/aws-models/mediapackage.json | 12 +- .../migration-hub-refactor-spaces.json | 2 +- aws/sdk/aws-models/mobile.json | 2 +- aws/sdk/aws-models/organizations.json | 74 +- aws/sdk/aws-models/outposts.json | 199 +- aws/sdk/aws-models/rds.json | 93 +- aws/sdk/aws-models/redshift.json | 20 +- aws/sdk/aws-models/sagemaker.json | 81 +- aws/sdk/aws-models/secretsmanager.json | 8 +- aws/sdk/aws-models/securityhub.json | 4 +- aws/sdk/aws-models/ssm-contacts.json | 34 +- aws/sdk/aws-models/ssm.json | 77 +- aws/sdk/aws-models/synthetics.json | 56 +- aws/sdk/aws-models/wafv2.json | 314 +++- gradle.properties | 4 +- 34 files changed, 6069 insertions(+), 637 deletions(-) create mode 100644 aws/sdk/aws-models/chime-sdk-media-pipelines.json create mode 100644 aws/sdk/aws-models/ivschat.json diff --git a/aws/sdk/aws-models/backup.json b/aws/sdk/aws-models/backup.json index 78472ee8e..0c98c38a3 100644 --- a/aws/sdk/aws-models/backup.json +++ b/aws/sdk/aws-models/backup.json @@ -2014,6 +2014,9 @@ "input": { "target": "com.amazonaws.backup#DeleteBackupSelectionInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -2063,6 +2066,9 @@ "input": { "target": "com.amazonaws.backup#DeleteBackupVaultInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -2094,6 +2100,9 @@ "input": { "target": "com.amazonaws.backup#DeleteBackupVaultAccessPolicyInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -2149,6 +2158,9 @@ "input": { "target": "com.amazonaws.backup#DeleteBackupVaultLockConfigurationInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -2194,6 +2206,9 @@ "input": { "target": "com.amazonaws.backup#DeleteBackupVaultNotificationsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -2236,6 +2251,9 @@ "input": { "target": "com.amazonaws.backup#DeleteFrameworkInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#ConflictException" @@ -2280,6 +2298,9 @@ "input": { "target": "com.amazonaws.backup#DeleteRecoveryPointInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -2336,6 +2357,9 @@ "input": { "target": "com.amazonaws.backup#DeleteReportPlanInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#ConflictException" @@ -3411,6 +3435,9 @@ "input": { "target": "com.amazonaws.backup#DisassociateRecoveryPointInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -3585,7 +3612,7 @@ "ControlScope": { "target": "com.amazonaws.backup#ControlScope", "traits": { - "smithy.api#documentation": "

The scope of a control. The control scope defines what the control will evaluate. Three\n examples of control scopes are: a specific backup plan, all backup plans with a specific\n tag, or all backup plans. For more information, see ControlScope.

" + "smithy.api#documentation": "

The scope of a control. The control scope defines what the control will evaluate. Three\n examples of control scopes are: a specific backup plan, all backup plans with a specific\n tag, or all backup plans. For more information, see \n ControlScope.\n

" } } }, @@ -4156,6 +4183,9 @@ }, "com.amazonaws.backup#GetSupportedResourceTypes": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.backup#GetSupportedResourceTypesOutput" }, @@ -4363,6 +4393,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "BackupJobs", "pageSize": "MaxResults" } } @@ -4432,6 +4463,20 @@ "smithy.api#documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the\n specified account ID.

\n

If used from an Organizations management account, passing * returns\n all jobs across the organization.

", "smithy.api#httpQuery": "accountId" } + }, + "ByCompleteAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeAfter" + } + }, + "ByCompleteBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only backup jobs completed before a date expressed in Unix format and\n Coordinated Universal Time (UTC).

", + "smithy.api#httpQuery": "completeBefore" + } } } }, @@ -4484,6 +4529,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "BackupPlanTemplatesList", "pageSize": "MaxResults" } } @@ -4557,6 +4603,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "BackupPlanVersionsList", "pageSize": "MaxResults" } } @@ -4638,6 +4685,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "BackupPlansList", "pageSize": "MaxResults" } } @@ -4718,6 +4766,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "BackupSelectionsList", "pageSize": "MaxResults" } } @@ -4799,6 +4848,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "BackupVaultList", "pageSize": "MaxResults" } } @@ -4865,6 +4915,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "CopyJobs", "pageSize": "MaxResults" } } @@ -4934,6 +4985,20 @@ "smithy.api#documentation": "

The account ID to list the jobs from. Returns only copy jobs associated with the\n specified account ID.

", "smithy.api#httpQuery": "accountId" } + }, + "ByCompleteBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeBefore" + } + }, + "ByCompleteAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeAfter" + } } } }, @@ -5053,6 +5118,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Results", "pageSize": "MaxResults" } } @@ -5126,6 +5192,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "RecoveryPoints", "pageSize": "MaxResults" } } @@ -5242,6 +5309,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "RecoveryPoints", "pageSize": "MaxResults" } } @@ -5483,6 +5551,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "RestoreJobs", "pageSize": "MaxResults" } } @@ -5531,6 +5600,20 @@ "smithy.api#documentation": "

Returns only restore jobs associated with the specified job status.

", "smithy.api#httpQuery": "status" } + }, + "ByCompleteBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs completed before a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeBefore" + } + }, + "ByCompleteAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only copy jobs completed after a date expressed in Unix format and Coordinated\n Universal Time (UTC).

", + "smithy.api#httpQuery": "completeAfter" + } } } }, @@ -5749,6 +5832,9 @@ "input": { "target": "com.amazonaws.backup#PutBackupVaultAccessPolicyInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -5797,6 +5883,9 @@ "input": { "target": "com.amazonaws.backup#PutBackupVaultLockConfigurationInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -5860,6 +5949,9 @@ "input": { "target": "com.amazonaws.backup#PutBackupVaultNotificationsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -6958,6 +7050,9 @@ "input": { "target": "com.amazonaws.backup#StopBackupJobInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -7033,6 +7128,9 @@ "input": { "target": "com.amazonaws.backup#TagResourceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -7100,6 +7198,9 @@ "input": { "target": "com.amazonaws.backup#UntagResourceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -7332,6 +7433,9 @@ "input": { "target": "com.amazonaws.backup#UpdateGlobalSettingsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" @@ -7462,6 +7566,9 @@ "input": { "target": "com.amazonaws.backup#UpdateRegionSettingsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.backup#InvalidParameterValueException" diff --git a/aws/sdk/aws-models/chime-sdk-media-pipelines.json b/aws/sdk/aws-models/chime-sdk-media-pipelines.json new file mode 100644 index 000000000..4d2650ca1 --- /dev/null +++ b/aws/sdk/aws-models/chime-sdk-media-pipelines.json @@ -0,0 +1,1276 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.chimesdkmediapipelines#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn[\\/\\:\\-\\_\\.a-zA-Z0-9]+$" + } + }, + "com.amazonaws.chimesdkmediapipelines#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn[\\/\\:\\-\\_\\.a-zA-Z0-9]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#ArtifactsConfiguration": { + "type": "structure", + "members": { + "Audio": { + "target": "com.amazonaws.chimesdkmediapipelines#AudioArtifactsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the audio artifacts.

", + "smithy.api#required": {} + } + }, + "Video": { + "target": "com.amazonaws.chimesdkmediapipelines#VideoArtifactsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the video artifacts.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.chimesdkmediapipelines#ContentArtifactsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the content artifacts.

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

The configuration for the artifacts.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ArtifactsState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#AttendeeIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#AudioArtifactsConfiguration": { + "type": "structure", + "members": { + "MuxType": { + "target": "com.amazonaws.chimesdkmediapipelines#AudioMuxType", + "traits": { + "smithy.api#documentation": "

The MUX type of the audio artifact configuration object.

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

The audio artifact configuration object.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#AudioMuxType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AudioOnly", + "name": "AudioOnly" + }, + { + "value": "AudioWithActiveSpeakerVideo", + "name": "AudioWithActiveSpeakerVideo" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#BadRequestException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmediapipelines#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmediapipelines#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

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

The input parameters don't match the service's restrictions.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chimesdkmediapipelines#ChimeSDKMediaPipelinesService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Chime SDK Media Pipelines", + "arnNamespace": "chime", + "cloudFormationName": "ChimeSDKMediaPipelines", + "cloudTrailEventSource": "chimesdkmediapipelines.amazonaws.com", + "endpointPrefix": "media-pipelines-chime" + }, + "aws.auth#sigv4": { + "name": "chime" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines \n and capture audio, video, events, and data messages from Amazon Chime SDK meetings. For more information about media pipleines, see \n Amzon Chime SDK media pipelines.\n

", + "smithy.api#title": "Amazon Chime SDK Media Pipelines" + }, + "version": "2021-07-15", + "operations": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaCapturePipeline" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipeline" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaCapturePipeline" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelines" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ListTagsForResource" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#TagResource" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UntagResource" + } + ] + }, + "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingConfiguration": { + "type": "structure", + "members": { + "SourceConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#SourceConfiguration", + "traits": { + "smithy.api#documentation": "

The source configuration for a specified media capture pipline.

" + } + }, + "ArtifactsConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the artifacts in an Amazon Chime SDK meeting.

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

The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ClientRequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[-_a-zA-Z0-9]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#ContentArtifactsConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsState", + "traits": { + "smithy.api#documentation": "

Indicates whether the content artifact is enabled or disabled.

", + "smithy.api#required": {} + } + }, + "MuxType": { + "target": "com.amazonaws.chimesdkmediapipelines#ContentMuxType", + "traits": { + "smithy.api#documentation": "

The MUX type of the artifact configuration.

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

The content artifact object.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ContentMuxType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ContentOnly", + "name": "ContentOnly" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaCapturePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaCapturePipelineRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#CreateMediaCapturePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a media capture pipeline.

", + "smithy.api#http": { + "method": "POST", + "uri": "/sdk-media-capture-pipelines", + "code": 201 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaCapturePipelineRequest": { + "type": "structure", + "members": { + "SourceType": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSourceType", + "traits": { + "smithy.api#documentation": "

Source type from which the media artifacts are captured. A Chime SDK Meeting \n is the only supported source.

", + "smithy.api#required": {} + } + }, + "SourceArn": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "

ARN of the source from which the media artifacts are captured.

", + "smithy.api#required": {} + } + }, + "SinkType": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSinkType", + "traits": { + "smithy.api#documentation": "

Destination type to which the media artifacts are saved. You must use an S3 bucket.

", + "smithy.api#required": {} + } + }, + "SinkArn": { + "target": "com.amazonaws.chimesdkmediapipelines#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the sink type.

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

The token assigned to the client making the pipeline request.

", + "smithy.api#idempotencyToken": {} + } + }, + "ChimeSdkMeetingConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

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

The list of tags.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#CreateMediaCapturePipelineResponse": { + "type": "structure", + "members": { + "MediaCapturePipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipeline", + "traits": { + "smithy.api#documentation": "

A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipelineRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the media capture pipeline.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/sdk-media-capture-pipelines/{MediaPipelineId}", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#DeleteMediaCapturePipelineRequest": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the media capture pipeline being deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BadRequest", + "name": "BadRequest" + }, + { + "value": "Forbidden", + "name": "Forbidden" + }, + { + "value": "NotFound", + "name": "NotFound" + }, + { + "value": "ResourceLimitExceeded", + "name": "ResourceLimitExceeded" + }, + { + "value": "ServiceFailure", + "name": "ServiceFailure" + }, + { + "value": "ServiceUnavailable", + "name": "ServiceUnavailable" + }, + { + "value": "Throttling", + "name": "Throttling" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#ExternalUserIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#ExternalUserIdType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ExternalUserIdType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmediapipelines#ForbiddenException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmediapipelines#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmediapipelines#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

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

The client is permanently forbidden from making the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.chimesdkmediapipelines#GetMediaCapturePipeline": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaCapturePipelineRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#GetMediaCapturePipelineResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an existing media capture pipeline.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sdk-media-capture-pipelines/{MediaPipelineId}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#GetMediaCapturePipelineRequest": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the pipeline that you want to get.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#GetMediaCapturePipelineResponse": { + "type": "structure", + "members": { + "MediaCapturePipeline": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipeline", + "traits": { + "smithy.api#documentation": "

The media capture pipeline object.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#GuidString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$" + } + }, + "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelines": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of media capture pipelines.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sdk-media-capture-pipelines", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The token used to retrieve the next page of results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmediapipelines#ResultMax", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in a single call. Valid Range: 1 - 99.

", + "smithy.api#httpQuery": "max-results" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListMediaCapturePipelinesResponse": { + "type": "structure", + "members": { + "MediaCapturePipelines": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummaryList", + "traits": { + "smithy.api#documentation": "

The media capture pipeline objects in the list.

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

The token used to retrieve the next page of results.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags applied to an Amazon Chime SDK media capture pipeline.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The resource ARN.

", + "smithy.api#httpQuery": "arn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.chimesdkmediapipelines#TagList", + "traits": { + "smithy.api#documentation": "

The tag key-value pairs.

" + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaCapturePipeline": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of a media capture pipeline.

" + } + }, + "MediaPipelineArn": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of a media capture pipeline.

" + } + }, + "SourceType": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSourceType", + "traits": { + "smithy.api#documentation": "

Source type from which media artifacts are saved. You must use ChimeMeeting.

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

ARN of the source from which the media artifacts are saved.

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

The status of the media capture pipeline.

" + } + }, + "SinkType": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaPipelineSinkType", + "traits": { + "smithy.api#documentation": "

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

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

ARN of the destination to which the media artifacts are saved.

" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the capture pipeline was created, in ISO 8601 format.

" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.chimesdkmediapipelines#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the capture pipeline was updated, in ISO 8601 format.

" + } + }, + "ChimeSdkMeetingConfiguration": { + "target": "com.amazonaws.chimesdkmediapipelines#ChimeSdkMeetingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

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

A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummary": { + "type": "structure", + "members": { + "MediaPipelineId": { + "target": "com.amazonaws.chimesdkmediapipelines#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of a media capture pipeline.

" + } + }, + "MediaPipelineArn": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The ARN of a media capture pipeline.

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

A summary of a media capture pipeline.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#MediaCapturePipelineSummary" + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaPipelineSinkType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "S3Bucket", + "name": "S3Bucket" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaPipelineSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ChimeSdkMeeting", + "name": "ChimeSdkMeeting" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#MediaPipelineStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Initializing", + "name": "Initializing" + }, + { + "value": "InProgress", + "name": "InProgress" + }, + { + "value": "Failed", + "name": "Failed" + }, + { + "value": "Stopping", + "name": "Stopping" + }, + { + "value": "Stopped", + "name": "Stopped" + } + ] + } + }, + "com.amazonaws.chimesdkmediapipelines#NotFoundException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmediapipelines#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmediapipelines#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

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

One or more of the resources in the request does not exist in the system.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.chimesdkmediapipelines#ResourceLimitExceededException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmediapipelines#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmediapipelines#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

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

The request exceeds the resource limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.chimesdkmediapipelines#ResultMax": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#SelectedVideoStreams": { + "type": "structure", + "members": { + "AttendeeIds": { + "target": "com.amazonaws.chimesdkmediapipelines#AttendeeIdList", + "traits": { + "smithy.api#documentation": "

The attendee IDs of the streams selected for a media capture pipeline.

" + } + }, + "ExternalUserIds": { + "target": "com.amazonaws.chimesdkmediapipelines#ExternalUserIdList", + "traits": { + "smithy.api#documentation": "

The external user IDs of the streams selected for a media capture pipeline.

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

The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#ServiceFailureException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmediapipelines#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmediapipelines#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

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

The service encountered an unexpected error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmediapipelines#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmediapipelines#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

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

The service is currently unavailable.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.chimesdkmediapipelines#SourceConfiguration": { + "type": "structure", + "members": { + "SelectedVideoStreams": { + "target": "com.amazonaws.chimesdkmediapipelines#SelectedVideoStreams", + "traits": { + "smithy.api#documentation": "

The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.

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

Source configuration for a specified media capture pipeline.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.chimesdkmediapipelines#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.chimesdkmediapipelines#TagKey", + "traits": { + "smithy.api#documentation": "

The key of the tag.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.chimesdkmediapipelines#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

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

Describes a tag applied to a resource.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmediapipelines#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags?operation=tag-resource", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The resource ARN.

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

The tag key-value pairs.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.chimesdkmediapipelines#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#ThrottledClientException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmediapipelines#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmediapipelines#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

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

The client exceeded its request rate limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmediapipelines#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmediapipelines#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmediapipelines#String", + "traits": { + "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

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

The client is not currently authorized to make the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.chimesdkmediapipelines#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmediapipelines#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmediapipelines#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmediapipelines#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmediapipelines#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags?operation=untag-resource", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmediapipelines#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmediapipelines#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The resource ARN.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.chimesdkmediapipelines#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmediapipelines#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.chimesdkmediapipelines#VideoArtifactsConfiguration": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.chimesdkmediapipelines#ArtifactsState", + "traits": { + "smithy.api#documentation": "

Indicates whether the video artifact is enabled or disabled.

", + "smithy.api#required": {} + } + }, + "MuxType": { + "target": "com.amazonaws.chimesdkmediapipelines#VideoMuxType", + "traits": { + "smithy.api#documentation": "

The MUX type of the video artifact configuration object.

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

The video artifact configuration object.

" + } + }, + "com.amazonaws.chimesdkmediapipelines#VideoMuxType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VideoOnly", + "name": "VideoOnly" + } + ] + } + } + } +} diff --git a/aws/sdk/aws-models/cloudcontrol.json b/aws/sdk/aws-models/cloudcontrol.json index a25406094..682d78b2a 100644 --- a/aws/sdk/aws-models/cloudcontrol.json +++ b/aws/sdk/aws-models/cloudcontrol.json @@ -1,33 +1,5 @@ { "smithy": "1.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, "shapes": { "com.amazonaws.cloudcontrol#AlreadyExistsException": { "type": "structure", @@ -119,9 +91,7 @@ "traits": { "aws.api#service": { "sdkId": "CloudControl", - "arnNamespace": "cloudcontrolapi", - "cloudFormationName": "CloudControl", - "cloudTrailEventSource": "cloudcontrol.amazonaws.com", + "cloudTrailEventSource": "cloudcontrolapi.amazonaws.com", "endpointPrefix": "cloudcontrolapi" }, "aws.auth#sigv4": { @@ -439,7 +409,8 @@ "smithy.api#length": { "min": 1, "max": 1024 - } + }, + "smithy.api#pattern": "^.+$" } }, "com.amazonaws.cloudcontrol#GeneralServiceException": { @@ -815,7 +786,8 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "ResourceRequestStatusSummaries" } } }, @@ -857,6 +829,9 @@ "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudcontrol#ListResources": { @@ -925,7 +900,8 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "pageSize": "MaxResults" + "pageSize": "MaxResults", + "items": "ResourceDescriptions" } } }, @@ -992,6 +968,9 @@ "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudcontrol#MaxResults": { @@ -1134,6 +1113,7 @@ "min": 1, "max": 65536 }, + "smithy.api#pattern": "^[\\s\\S]*$", "smithy.api#sensitive": {} } }, @@ -1227,8 +1207,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 16384 + "max": 65536 }, + "smithy.api#pattern": "^[\\s\\S]*$", "smithy.api#sensitive": {} } }, @@ -1395,7 +1376,8 @@ "smithy.api#length": { "min": 0, "max": 1024 - } + }, + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.cloudcontrol#ThrottlingException": { diff --git a/aws/sdk/aws-models/codeguru-reviewer.json b/aws/sdk/aws-models/codeguru-reviewer.json index e139a3f9a..985e4ad8b 100644 --- a/aws/sdk/aws-models/codeguru-reviewer.json +++ b/aws/sdk/aws-models/codeguru-reviewer.json @@ -414,7 +414,13 @@ "AnalysisTypes": { "target": "com.amazonaws.codegurureviewer#AnalysisTypes", "traits": { - "smithy.api#documentation": "

They types of analysis performed during a repository analysis or a pull request review. You can specify either \n Security, CodeQuality, or both.

" + "smithy.api#documentation": "

The types of analysis performed during a repository analysis or a pull request review. You can specify either \n Security, CodeQuality, or both.

" + } + }, + "ConfigFileState": { + "target": "com.amazonaws.codegurureviewer#ConfigFileState", + "traits": { + "smithy.api#documentation": "

The state of the aws-codeguru-reviewer.yml configuration file that allows\n the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists\n with errors at the root directory of your repository.

" } } }, @@ -571,6 +577,25 @@ } } }, + "com.amazonaws.codegurureviewer#ConfigFileState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Present", + "name": "PRESENT" + }, + { + "value": "Absent", + "name": "ABSENT" + }, + { + "value": "PresentWithErrors", + "name": "PRESENT_WITH_ERRORS" + } + ] + } + }, "com.amazonaws.codegurureviewer#ConflictException": { "type": "structure", "members": { @@ -1167,6 +1192,12 @@ "smithy.api#box": {} } }, + "com.amazonaws.codegurureviewer#LinesOfCodeCount": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.codegurureviewer#ListCodeReviews": { "type": "operation", "input": { @@ -1497,6 +1528,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "RepositoryAssociationSummaries", "pageSize": "MaxResults" } } @@ -1637,19 +1669,19 @@ } } }, - "com.amazonaws.codegurureviewer#MeteredLinesOfCodeCount": { - "type": "long", - "traits": { - "smithy.api#box": {} - } - }, "com.amazonaws.codegurureviewer#Metrics": { "type": "structure", "members": { "MeteredLinesOfCodeCount": { - "target": "com.amazonaws.codegurureviewer#MeteredLinesOfCodeCount", + "target": "com.amazonaws.codegurureviewer#LinesOfCodeCount", + "traits": { + "smithy.api#documentation": "

\n MeteredLinesOfCodeCount is the number of lines of code in the repository where the code review happened. \n This does not include non-code lines such as comments and blank lines.\n

" + } + }, + "SuppressedLinesOfCodeCount": { + "target": "com.amazonaws.codegurureviewer#LinesOfCodeCount", "traits": { - "smithy.api#documentation": "

\n MeteredLinesOfCode is the number of lines of code in the repository where the code review happened. \n This does not include non-code lines such as comments and blank lines.\n

" + "smithy.api#documentation": "

\n SuppressedLinesOfCodeCount is the number of lines of code in the repository\n where the code review happened that CodeGuru Reviewer did not analyze. The lines suppressed in the\n analysis is based on the excludeFiles variable in the\n aws-codeguru-reviewer.yml file. This number does not include non-code lines\n such as comments and blank lines.

" } }, "FindingsCount": { @@ -1667,11 +1699,17 @@ "type": "structure", "members": { "MeteredLinesOfCodeCount": { - "target": "com.amazonaws.codegurureviewer#MeteredLinesOfCodeCount", + "target": "com.amazonaws.codegurureviewer#LinesOfCodeCount", "traits": { "smithy.api#documentation": "

\n Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, \n this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already \n existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments \n and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in \n a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, \n MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of\n code for a total of 2,725 lines of code.\n

" } }, + "SuppressedLinesOfCodeCount": { + "target": "com.amazonaws.codegurureviewer#LinesOfCodeCount", + "traits": { + "smithy.api#documentation": "

Lines of code suppressed in the code review based on the excludeFiles\n element in the aws-codeguru-reviewer.yml file. For full repository analyses,\n this number includes all lines of code in the files that are suppressed. For pull requests,\n this number only includes the changed lines of code that are\n suppressed. In both cases, this number does not include non-code lines such as comments and\n import statements. For example, if you initiate a full repository analysis on a repository\n containing 5 files, each file with 100 lines of code, and 2 files are listed as excluded in\n the aws-codeguru-reviewer.yml file, then\n SuppressedLinesOfCodeCount returns 200 (2 * 100) as the total number of\n lines of code suppressed. However, if you submit a pull request for the same repository,\n then SuppressedLinesOfCodeCount only includes the lines in the 2 files\n that changed. If only 1 of the 2 files changed in the pull request, then\n SuppressedLinesOfCodeCount returns 100 (1 * 100) as the total number of\n lines of code suppressed.

" + } + }, "FindingsCount": { "target": "com.amazonaws.codegurureviewer#FindingsCount", "traits": { diff --git a/aws/sdk/aws-models/compute-optimizer.json b/aws/sdk/aws-models/compute-optimizer.json index f1f2a584f..29b2f0fa7 100644 --- a/aws/sdk/aws-models/compute-optimizer.json +++ b/aws/sdk/aws-models/compute-optimizer.json @@ -488,7 +488,7 @@ "resourceType": { "target": "com.amazonaws.computeoptimizer#ResourceType", "traits": { - "smithy.api#documentation": "

The target resource type of the recommendation preference to delete.

\n

The Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.

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

The target resource type of the recommendation preference to delete.

\n

The Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.

\n \n

The valid values for this parameter are Ec2Instance and\n AutoScalingGroup.

\n ", "smithy.api#required": {} } }, @@ -2796,7 +2796,7 @@ "resourceType": { "target": "com.amazonaws.computeoptimizer#ResourceType", "traits": { - "smithy.api#documentation": "

The target resource type of the recommendation preference for which to return\n preferences.

\n

The Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.

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

The target resource type of the recommendation preference for which to return\n preferences.

\n

The Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.

\n \n

The valid values for this parameter are Ec2Instance and\n AutoScalingGroup.

\n ", "smithy.api#required": {} } }, @@ -3984,7 +3984,7 @@ "resourceType": { "target": "com.amazonaws.computeoptimizer#ResourceType", "traits": { - "smithy.api#documentation": "

The target resource type of the recommendation preference to create.

\n

The Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.

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

The target resource type of the recommendation preference to create.

\n

The Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.

\n \n

The valid values for this parameter are Ec2Instance and\n AutoScalingGroup.

\n ", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/datasync.json b/aws/sdk/aws-models/datasync.json index ee8d051df..dc4bc0a1a 100644 --- a/aws/sdk/aws-models/datasync.json +++ b/aws/sdk/aws-models/datasync.json @@ -2863,6 +2863,9 @@ }, "errorCode": { "target": "com.amazonaws.datasync#string" + }, + "datasyncErrorCode": { + "target": "com.amazonaws.datasync#string" } }, "traits": { @@ -3535,6 +3538,21 @@ ] } }, + "com.amazonaws.datasync#ObjectTags": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRESERVE", + "name": "PRESERVE" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.datasync#OnPremConfig": { "type": "structure", "members": { @@ -3603,7 +3621,7 @@ "VerifyMode": { "target": "com.amazonaws.datasync#VerifyMode", "traits": { - "smithy.api#documentation": "

A value that determines whether a data integrity verification should be performed at\n the end of a task execution after all data and metadata have been transferred. \n For more information, see \n Configure task settings.\n

\n

Default value: POINT_IN_TIME_CONSISTENT.

\n

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.\n

\n \n

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination \n at the end of the transfer \n to verify that source and destination are fully \n synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

\n

NONE: No additional verification is done at the end of the \n transfer, but all data transmissions are integrity-checked with \n checksum verification during the transfer.

" + "smithy.api#documentation": "

A value that determines whether a data integrity verification should be performed at\n the end of a task execution after all data and metadata have been transferred. \n For more information, see \n Configure task settings.\n

\n

Default value: POINT_IN_TIME_CONSISTENT.

\n

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.\n

\n \n

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination \n at the end of the transfer \n to verify that source and destination are fully \n synchronized. This option isn't supported when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes.

\n

NONE: No additional verification is done at the end of the \n transfer, but all data transmissions are integrity-checked with \n checksum verification during the transfer.

" } }, "OverwriteMode": { @@ -3621,7 +3639,7 @@ "Mtime": { "target": "com.amazonaws.datasync#Mtime", "traits": { - "smithy.api#documentation": "

A value that indicates the last time that a file was modified (that is, a file was\n written to) before the PREPARING phase. This option is required for cases when you need to run\n the same task more than one time.

\n

Default value: PRESERVE.

\n

PRESERVE: Preserve original Mtime (recommended)

\n

NONE: Ignore Mtime.

\n \n

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

\n

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

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

A value that indicates the last time that a file was modified (that is, a file was\n written to) before the PREPARING phase. This option is required for cases when you need to run\n the same task more than one time.

\n

Default Value: PRESERVE\n

\n

PRESERVE: Preserve original Mtime (recommended)

\n

NONE: Ignore Mtime.

\n \n

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

\n

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

\n " } }, "Uid": { @@ -3683,6 +3701,12 @@ "traits": { "smithy.api#documentation": "

A value that determines which components of the SMB security descriptor are copied from source\n to destination objects.\n

\n

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

\n

Default value: OWNER_DACL.

\n\n

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

\n \n

When choosing this option, DataSync does NOT copy the NTFS system access control lists\n (SACLs), which are used by administrators to log attempts to access a secured object.

\n \n

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

\n \n

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

\n \n

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

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

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

\n

Default Value: PRESERVE\n

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index a2bb01bf7..a39065371 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -1363,6 +1363,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether to enable or disable host recovery for the Dedicated Host. \n\t\t\tHost recovery is disabled by default. For more information, see \n\t\t\t\n\t\t\tHost recovery in the Amazon EC2 User Guide.

\n\t\t

Default: off\n

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

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.

" + } } } }, @@ -2760,6 +2766,9 @@ { "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirements" }, + { + "target": "com.amazonaws.ec2#GetInstanceUefiData" + }, { "target": "com.amazonaws.ec2#GetIpamAddressHistory" }, @@ -13614,13 +13623,6 @@ "com.amazonaws.ec2#CreateSubnetCidrReservationRequest": { "type": "structure", "members": { - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the subnet CIDR reservation.

", - "smithy.api#xmlName": "TagSpecification" - } - }, "SubnetId": { "target": "com.amazonaws.ec2#SubnetId", "traits": { @@ -13653,6 +13655,13 @@ "traits": { "smithy.api#documentation": "

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

" } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the subnet CIDR reservation.

", + "smithy.api#xmlName": "TagSpecification" + } } } }, @@ -15082,6 +15091,18 @@ "smithy.api#xmlName": "SecurityGroupId" } }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the endpoint.

" + } + }, + "DnsOptions": { + "target": "com.amazonaws.ec2#DnsOptionsSpecification", + "traits": { + "smithy.api#documentation": "

The DNS options for the endpoint.

" + } + }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -15177,6 +15198,13 @@ "smithy.api#xmlName": "GatewayLoadBalancerArn" } }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The supported IP address types. The possible values are ipv4 and ipv6.

", + "smithy.api#xmlName": "SupportedIpAddressType" + } + }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -29805,7 +29833,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n\t\t ", "smithy.api#xmlName": "Filter" } }, @@ -29881,7 +29909,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n\t\t ", "smithy.api#xmlName": "Filter" } }, @@ -30027,7 +30055,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -30117,7 +30145,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -32549,6 +32577,59 @@ ] } }, + "com.amazonaws.ec2#DnsOptions": { + "type": "structure", + "members": { + "DnsRecordIpType": { + "target": "com.amazonaws.ec2#DnsRecordIpType", + "traits": { + "aws.protocols#ec2QueryName": "DnsRecordIpType", + "smithy.api#documentation": "

The DNS records created for the endpoint.

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

Describes the DNS options for an endpoint.

" + } + }, + "com.amazonaws.ec2#DnsOptionsSpecification": { + "type": "structure", + "members": { + "DnsRecordIpType": { + "target": "com.amazonaws.ec2#DnsRecordIpType", + "traits": { + "smithy.api#documentation": "

The DNS records created for the endpoint.

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

Describes the DNS options for an endpoint.

" + } + }, + "com.amazonaws.ec2#DnsRecordIpType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ipv4", + "name": "ipv4" + }, + { + "value": "dualstack", + "name": "dualstack" + }, + { + "value": "ipv6", + "name": "ipv6" + }, + { + "value": "service-defined", + "name": "service_defined" + } + ] + } + }, "com.amazonaws.ec2#DnsServersOptionsModifyStructure": { "type": "structure", "members": { @@ -37941,6 +38022,58 @@ } } }, + "com.amazonaws.ec2#GetInstanceUefiData": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#GetInstanceUefiDataRequest" + }, + "output": { + "target": "com.amazonaws.ec2#GetInstanceUefiDataResult" + }, + "traits": { + "smithy.api#documentation": "

A binary representation of the UEFI variable store. Only non-volatile variables are\n stored. This is a base64 encoded and zlib compressed binary value that must be properly\n encoded.

\n

When you use register-image\n to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData\n parameter. You can modify the UEFI data by using the python-uefivars tool\n on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can \n inspect and modify, and then convert back into the binary format to use with register-image.

\n

For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#GetInstanceUefiDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#documentation": "

The ID of the instance from which to retrieve the UEFI data.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "InstanceId" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

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

" + } + } + } + }, + "com.amazonaws.ec2#GetInstanceUefiDataResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance from which to retrieve the UEFI data.

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

Base64 representation of the non-volatile UEFI variable store.

", + "smithy.api#xmlName": "uefiData" + } + } + } + }, "com.amazonaws.ec2#GetIpamAddressHistory": { "type": "operation", "input": { @@ -39975,6 +40108,14 @@ "smithy.api#documentation": "

Indicates whether the Dedicated Host is in a host resource group. If \n\t\t\tmemberOfServiceLinkedResourceGroup is \n\t\t\ttrue, the host is in a host resource group; otherwise, it is not.

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

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.

", + "smithy.api#xmlName": "outpostArn" + } } }, "traits": { @@ -40855,6 +40996,14 @@ "smithy.api#xmlName": "bootMode" } }, + "TpmSupport": { + "target": "com.amazonaws.ec2#TpmSupportValues", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0. \n For more information, see NitroTPM in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "tpmSupport" + } + }, "DeprecationTime": { "target": "com.amazonaws.ec2#String", "traits": { @@ -40943,6 +41092,22 @@ "smithy.api#xmlName": "bootMode" } }, + "TpmSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the image is configured for NitroTPM support, the value is v2.0.

", + "smithy.api#xmlName": "tpmSupport" + } + }, + "UefiData": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "UefiData", + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon Elastic Compute Cloud User Guide.

", + "smithy.api#xmlName": "uefiData" + } + }, "LastLaunchedTime": { "target": "com.amazonaws.ec2#AttributeValue", "traits": { @@ -40992,6 +41157,14 @@ "value": "bootMode", "name": "bootMode" }, + { + "value": "tpmSupport", + "name": "tpmSupport" + }, + { + "value": "uefiData", + "name": "uefiData" + }, { "value": "lastLaunchedTime", "name": "lastLaunchedTime" @@ -42873,6 +43046,14 @@ "smithy.api#xmlName": "ipv6Address" } }, + "TpmSupport": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TpmSupport", + "smithy.api#documentation": "

If the instance is configured for NitroTPM support, the value is v2.0.\n For more information, see NitroTPM in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "tpmSupport" + } + }, "MaintenanceOptions": { "target": "com.amazonaws.ec2#InstanceMaintenanceOptions", "traits": { @@ -47423,6 +47604,34 @@ { "value": "m6a.metal", "name": "m6a_metal" + }, + { + "value": "i4i.large", + "name": "i4i_large" + }, + { + "value": "i4i.xlarge", + "name": "i4i_xlarge" + }, + { + "value": "i4i.2xlarge", + "name": "i4i_2xlarge" + }, + { + "value": "i4i.4xlarge", + "name": "i4i_4xlarge" + }, + { + "value": "i4i.8xlarge", + "name": "i4i_8xlarge" + }, + { + "value": "i4i.16xlarge", + "name": "i4i_16xlarge" + }, + { + "value": "i4i.32xlarge", + "name": "i4i_32xlarge" } ] } @@ -47938,6 +48147,25 @@ } } }, + "com.amazonaws.ec2#IpAddressType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ipv4", + "name": "ipv4" + }, + { + "value": "dualstack", + "name": "dualstack" + }, + { + "value": "ipv6", + "name": "ipv6" + } + ] + } + }, "com.amazonaws.ec2#IpPermission": { "type": "structure", "members": { @@ -48895,6 +49123,18 @@ { "value": "delete-failed", "name": "delete_failed" + }, + { + "value": "isolate-in-progress", + "name": "isolate_in_progress" + }, + { + "value": "isolate-complete", + "name": "isolate_complete" + }, + { + "value": "restore-in-progress", + "name": "restore_in_progress" } ] } @@ -49243,6 +49483,18 @@ { "value": "delete-failed", "name": "delete_failed" + }, + { + "value": "isolate-in-progress", + "name": "isolate_in_progress" + }, + { + "value": "isolate-complete", + "name": "isolate_complete" + }, + { + "value": "restore-in-progress", + "name": "restore_in_progress" } ] } @@ -49310,6 +49562,18 @@ { "value": "delete-failed", "name": "delete_failed" + }, + { + "value": "isolate-in-progress", + "name": "isolate_in_progress" + }, + { + "value": "isolate-complete", + "name": "isolate_complete" + }, + { + "value": "restore-in-progress", + "name": "restore_in_progress" } ] } @@ -56459,6 +56723,18 @@ "smithy.api#xmlName": "RemoveSecurityGroupId" } }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "smithy.api#documentation": "

The IP address type for the endpoint.

" + } + }, + "DnsOptions": { + "target": "com.amazonaws.ec2#DnsOptionsSpecification", + "traits": { + "smithy.api#documentation": "

The DNS options for the endpoint.

" + } + }, "PrivateDnsEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -56556,6 +56832,20 @@ "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service\n configuration.

", "smithy.api#xmlName": "RemoveGatewayLoadBalancerArn" } + }, + "AddSupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IP address types to add to your service configuration.

", + "smithy.api#xmlName": "AddSupportedIpAddressType" + } + }, + "RemoveSupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "

The IP address types to remove from your service configuration.

", + "smithy.api#xmlName": "RemoveSupportedIpAddressType" + } } } }, @@ -62544,6 +62834,18 @@ "traits": { "smithy.api#documentation": "

The boot mode of the AMI. For more information, see Boot modes in the\n Amazon Elastic Compute Cloud User Guide.

" } + }, + "TpmSupport": { + "target": "com.amazonaws.ec2#TpmSupportValues", + "traits": { + "smithy.api#documentation": "

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "UefiData": { + "target": "com.amazonaws.ec2#StringType", + "traits": { + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon Elastic Compute Cloud User Guide.

" + } } }, "traits": { @@ -69380,6 +69682,14 @@ "smithy.api#xmlName": "gatewayLoadBalancerArnSet" } }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#SupportedIpAddressTypes", + "traits": { + "aws.protocols#ec2QueryName": "SupportedIpAddressTypeSet", + "smithy.api#documentation": "

The supported IP address types.

", + "smithy.api#xmlName": "supportedIpAddressTypeSet" + } + }, "BaseEndpointDnsNames": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { @@ -69434,6 +69744,21 @@ } } }, + "com.amazonaws.ec2#ServiceConnectivityType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ipv4", + "name": "ipv4" + }, + { + "value": "ipv6", + "name": "ipv6" + } + ] + } + }, "com.amazonaws.ec2#ServiceDetail": { "type": "structure", "members": { @@ -69548,6 +69873,14 @@ "smithy.api#documentation": "

The verification state of the VPC endpoint service.

\n

Consumers of the endpoint service cannot use the private name when the state is not verified.

", "smithy.api#xmlName": "privateDnsNameVerificationState" } + }, + "SupportedIpAddressTypes": { + "target": "com.amazonaws.ec2#SupportedIpAddressTypes", + "traits": { + "aws.protocols#ec2QueryName": "SupportedIpAddressTypeSet", + "smithy.api#documentation": "

The supported IP address types.

", + "smithy.api#xmlName": "supportedIpAddressTypeSet" + } } }, "traits": { @@ -72105,7 +72438,7 @@ "target": "com.amazonaws.ec2#StopInstancesResult" }, "traits": { - "smithy.api#documentation": "

Stops an Amazon EBS-backed instance.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Stops an Amazon EBS-backed instance. For more information, see Stop and start\n your instance in the Amazon EC2 User Guide.

\n

You can use the Stop action to hibernate an instance if the instance is enabled for\n hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your instance in the\n Amazon EC2 User Guide.

\n

We don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.

\n

You can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.

\n

When you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.

\n

Stopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

When you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#StopInstancesRequest": { @@ -72291,6 +72624,15 @@ } } }, + "com.amazonaws.ec2#StringType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64000 + } + } + }, "com.amazonaws.ec2#Subnet": { "type": "structure", "members": { @@ -72803,6 +73145,21 @@ ] } }, + "com.amazonaws.ec2#SupportedIpAddressTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceConnectivityType", + "traits": { + "smithy.api#xmlName": "item" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, "com.amazonaws.ec2#Tag": { "type": "structure", "members": { @@ -73578,6 +73935,17 @@ "smithy.api#documentation": "

The minimum and maximum amount of total local storage, in GB.

" } }, + "com.amazonaws.ec2#TpmSupportValues": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "v2.0", + "name": "v2_0" + } + ] + } + }, "com.amazonaws.ec2#TrafficDirection": { "type": "string", "traits": { @@ -78715,7 +79083,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "VpcEndpointId", - "smithy.api#documentation": "

The ID of the VPC endpoint.

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

The ID of the endpoint.

", "smithy.api#xmlName": "vpcEndpointId" } }, @@ -78747,7 +79115,7 @@ "target": "com.amazonaws.ec2#State", "traits": { "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the VPC endpoint.

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

The state of the endpoint.

", "smithy.api#xmlName": "state" } }, @@ -78771,7 +79139,7 @@ "target": "com.amazonaws.ec2#ValueStringList", "traits": { "aws.protocols#ec2QueryName": "SubnetIdSet", - "smithy.api#documentation": "

(Interface endpoint) One or more subnets in which the endpoint is located.

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

(Interface endpoint) The subnets for the endpoint.

", "smithy.api#xmlName": "subnetIdSet" } }, @@ -78783,6 +79151,22 @@ "smithy.api#xmlName": "groupSet" } }, + "IpAddressType": { + "target": "com.amazonaws.ec2#IpAddressType", + "traits": { + "aws.protocols#ec2QueryName": "IpAddressType", + "smithy.api#documentation": "

The IP address type for the endpoint.

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

The DNS options for the endpoint.

", + "smithy.api#xmlName": "dnsOptions" + } + }, "PrivateDnsEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -78795,7 +79179,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "RequesterManaged", - "smithy.api#documentation": "

Indicates whether the VPC endpoint is being managed by its service.

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

Indicates whether the endpoint is being managed by its service.

", "smithy.api#xmlName": "requesterManaged" } }, @@ -78819,7 +79203,7 @@ "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { "aws.protocols#ec2QueryName": "CreationTimestamp", - "smithy.api#documentation": "

The date and time that the VPC endpoint was created.

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

The date and time that the endpoint was created.

", "smithy.api#xmlName": "creationTimestamp" } }, @@ -78827,7 +79211,7 @@ "target": "com.amazonaws.ec2#TagList", "traits": { "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the VPC endpoint.

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

Any tags assigned to the endpoint.

", "smithy.api#xmlName": "tagSet" } }, @@ -78835,7 +79219,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC endpoint.

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

The ID of the Amazon Web Services account that owns the endpoint.

", "smithy.api#xmlName": "ownerId" } }, @@ -78843,7 +79227,7 @@ "target": "com.amazonaws.ec2#LastError", "traits": { "aws.protocols#ec2QueryName": "LastError", - "smithy.api#documentation": "

The last error that occurred for VPC endpoint.

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

The last error that occurred for endpoint.

", "smithy.api#xmlName": "lastError" } } @@ -78918,6 +79302,14 @@ "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.

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

The IP address type for the endpoint.

", + "smithy.api#xmlName": "ipAddressType" + } } }, "traits": { diff --git a/aws/sdk/aws-models/eks.json b/aws/sdk/aws-models/eks.json index 552940ff7..4c3a3d4e7 100644 --- a/aws/sdk/aws-models/eks.json +++ b/aws/sdk/aws-models/eks.json @@ -56,6 +56,14 @@ { "value": "BOTTLEROCKET_x86_64", "name": "BOTTLEROCKET_x86_64" + }, + { + "value": "BOTTLEROCKET_ARM_64_NVIDIA", + "name": "BOTTLEROCKET_ARM_64_NVIDIA" + }, + { + "value": "BOTTLEROCKET_x86_64_NVIDIA", + "name": "BOTTLEROCKET_x86_64_NVIDIA" } ] } @@ -1381,13 +1389,13 @@ "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. If you specify launchTemplate, then don't specify diskSize,\n or the node group 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. If you specify launchTemplate, then don't specify diskSize,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support 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 \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 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 \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#required": {} } }, @@ -1400,19 +1408,19 @@ "amiType": { "target": "com.amazonaws.eks#AMITypes", "traits": { - "smithy.api#documentation": "

The AMI type for your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type. Non-GPU instances should use the\n AL2_x86_64 AMI type. Arm instances should use the\n AL2_ARM_64 AMI type. All types use the Amazon EKS optimized\n Amazon Linux 2 AMI. 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. 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. GPU instance types should use the\n AL2_x86_64_GPU AMI type. Non-GPU instances should use the\n AL2_x86_64 AMI type. Arm instances should use the\n AL2_ARM_64 AMI type. All types use the Amazon EKS optimized\n Amazon Linux 2 AMI. 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. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

" } }, "remoteAccess": { "target": "com.amazonaws.eks#RemoteAccessConfig", "traits": { - "smithy.api#documentation": "

The remote access (SSH) configuration to use with your node group. If you specify launchTemplate,\n then don't specify remoteAccess, 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 remote access (SSH) configuration to use with your node group. If you specify launchTemplate,\n then don't specify remoteAccess, 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.

" } }, "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,\n or the node group 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,\n or the node group 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#required": {} } }, @@ -1425,7 +1433,7 @@ "taints": { "target": "com.amazonaws.eks#taintsList", "traits": { - "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group.

" + "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

" } }, "tags": { @@ -1462,13 +1470,13 @@ "version": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Kubernetes version to use for your managed nodes. By default, the Kubernetes\n version of the cluster is used, and this is the only accepted specified value.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version,\n or the node group 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\n version of the cluster is used, and this is the only accepted specified value.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support 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\n version is used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group 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 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\n version is used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

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

Returns descriptive information about an update against your Amazon EKS\n cluster or associated managed node group.

\n

When the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.

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

Returns descriptive information about an update against your Amazon EKS\n cluster or associated managed node group or Amazon EKS add-on.

\n

When the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.

", "smithy.api#http": { "method": "GET", "uri": "/clusters/{name}/updates/{updateId}", @@ -2493,14 +2501,14 @@ "nodegroupName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EKS node group associated with the update.

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

The name of the Amazon EKS node group associated with the update. This\n parameter is required if the update is a node group update.

", "smithy.api#httpQuery": "nodegroupName" } }, "addonName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The name of the add-on. The name must match one of the names returned by \n ListAddons\n .

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

The name of the add-on. The name must match one of the names returned by \n ListAddons\n . This parameter is required if the update is an add-on update.

", "smithy.api#httpQuery": "addonName" } } @@ -2882,7 +2890,7 @@ "type": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The type of the identity provider configuration.

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

The type of the identity provider configuration. The only type available is\n oidc.

", "smithy.api#required": {} } }, @@ -3007,7 +3015,7 @@ "code": { "target": "com.amazonaws.eks#NodegroupIssueCode", "traits": { - "smithy.api#documentation": "

A brief description of the error.

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

A brief description of the error.

\n " } }, "message": { @@ -3045,7 +3053,7 @@ "ipFamily": { "target": "com.amazonaws.eks#IpFamily", "traits": { - "smithy.api#documentation": "

Specify which IP version is used to assign Kubernetes Pod and Service IP addresses. If\n you don't specify a value, ipv4 is used by default. You can only specify an\n IP family when you create a cluster and can't change this value once the cluster is\n created. If you specify ipv6, the VPC and subnets that you specify for\n cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them.

\n

You can only specify ipv6 for 1.21 and later clusters that use version\n 1.10.0 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure\n that your VPC meets the requirements and that you're familiar with the considerations\n listed in Assigning\n IPv6 addresses to Pods and Services in the Amazon EKS User Guide. If\n you specify ipv6, Kubernetes assigns Service and Pod addresses from the\n unique local address range (fc00::/7). You can't specify a custom IPv6 CIDR\n block.

" + "smithy.api#documentation": "

Specify which IP family is used to assign Kubernetes pod and service IP addresses. If\n you don't specify a value, ipv4 is used by default. You can only specify an\n IP family when you create a cluster and can't change this value once the cluster is\n created. If you specify ipv6, the VPC and subnets that you specify for\n cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them. You can't\n specify ipv6 for clusters in China Regions.

\n

You can only specify ipv6 for 1.21 and later clusters that use version\n 1.10.1 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure\n that your VPC meets the requirements listed in the considerations listed in Assigning IPv6\n addresses to pods and services in the Amazon EKS User Guide.\n Kubernetes assigns services IPv6 addresses from the unique local address range\n (fc00::/7). You can't specify a custom IPv6 CIDR block. Pod addresses are assigned from\n the subnet's IPv6 CIDR.

" } } }, @@ -3059,19 +3067,19 @@ "serviceIpv4Cidr": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The CIDR block that Kubernetes Pod and Service IP addresses are assigned from.\n Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node\n is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes\n assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this\n was specified, then it was specified when the cluster was created and it can't be\n changed.

" + "smithy.api#documentation": "

The CIDR block that Kubernetes pod and service IP addresses are assigned from.\n Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node\n is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes\n assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this\n was specified, then it was specified when the cluster was created and it can't be\n changed.

" } }, "serviceIpv6Cidr": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The CIDR block that Kubernetes Pod and Service IP addresses are assigned from if you\n created a 1.21 or later cluster with version 1.10.0 or later of the Amazon VPC CNI add-on and\n specified ipv6 for ipFamily when you\n created the cluster. Kubernetes assigns addresses from the unique local address range\n (fc00::/7).

" + "smithy.api#documentation": "

The CIDR block that Kubernetes pod and service IP addresses are assigned from if you\n created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and\n specified ipv6 for ipFamily when you\n created the cluster. Kubernetes assigns service addresses from the unique local address\n range (fc00::/7) because you can't specify a custom IPv6 CIDR block when\n you create the cluster.

" } }, "ipFamily": { "target": "com.amazonaws.eks#IpFamily", "traits": { - "smithy.api#documentation": "

The IP family used to assign Kubernetes Pod and Service IP addresses. The IP family is\n always ipv4, unless you have a 1.21 or later cluster running\n version 1.10.0 or later of the Amazon VPC CNI add-on and specified ipv6 when you\n created the cluster.

" + "smithy.api#documentation": "

The IP family used to assign Kubernetes pod and service IP addresses. The IP family is\n always ipv4, unless you have a 1.21 or later cluster running\n version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 when you\n created the cluster.

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

An object representing a node group launch template specification. The launch template\n cannot 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

Specify either name or id, but not both.

" + "smithy.api#documentation": "

An object representing a node group launch template specification. The launch template\n cannot 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

Specify either name or id, but not both.

" } }, "com.amazonaws.eks#ListAddons": { @@ -3887,7 +3895,7 @@ "taints": { "target": "com.amazonaws.eks#taintsList", "traits": { - "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group when they are\n created. Effect is one of No_Schedule, Prefer_No_Schedule, or\n No_Execute. Kubernetes taints can be used together with tolerations to\n control how workloads are scheduled to your nodes.

" + "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group when they are\n created. Effect is one of No_Schedule, Prefer_No_Schedule, or\n No_Execute. Kubernetes taints can be used together with tolerations to\n control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups.

" } }, "resources": { @@ -4541,7 +4549,7 @@ } }, "traits": { - "smithy.api#documentation": "

Required resources (such as Service Linked Roles) were created and are still propagating. Retry later.

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

Required resources (such as service-linked roles) were created and are still propagating. Retry later.

", "smithy.api#error": "client", "smithy.api#httpError": 428 } @@ -4722,7 +4730,7 @@ } }, "traits": { - "smithy.api#documentation": "

A property that allows a node to repel a set of pods.

" + "smithy.api#documentation": "

A property that allows a node to repel a set of pods. For more information, see Node taints on managed node groups.

" } }, "com.amazonaws.eks#TaintEffect": { @@ -5197,7 +5205,7 @@ "taints": { "target": "com.amazonaws.eks#UpdateTaintsPayload", "traits": { - "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group after the\n update.

" + "smithy.api#documentation": "

The Kubernetes taints to be applied to the nodes in the node group after the\n update. For more information, see Node taints on managed node groups.

" } }, "scalingConfig": { @@ -5288,13 +5296,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\n version of the node group does not change. You can specify the Kubernetes version of the\n cluster to update the node group to the latest AMI version of the cluster's Kubernetes\n version. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n version, 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 Kubernetes version to update to. If no version is specified, then the Kubernetes\n version of the node group does not change. You can specify the Kubernetes version of the\n cluster to update the node group to the latest AMI version of the cluster's Kubernetes\n version. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n version, 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.

" } }, "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\n used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\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 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\n used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\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.

" } }, "launchTemplate": { @@ -5491,7 +5499,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing the details of an update to a taints payload.

" + "smithy.api#documentation": "

An object representing the details of an update to a taints payload. For more information, see Node taints on managed node groups.

" } }, "com.amazonaws.eks#UpdateType": { diff --git a/aws/sdk/aws-models/elasticmapreduce.json b/aws/sdk/aws-models/elasticmapreduce.json index 4e9c84246..7770d7ca0 100644 --- a/aws/sdk/aws-models/elasticmapreduce.json +++ b/aws/sdk/aws-models/elasticmapreduce.json @@ -69,7 +69,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds an instance fleet to a running cluster.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x.

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

Adds an instance fleet to a running cluster.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x.

\n " } }, "com.amazonaws.emr#AddInstanceFleetInput": { @@ -193,7 +193,7 @@ } ], "traits": { - "smithy.api#documentation": "

AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed\n in each job flow.

\n

If your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using SSH to connect to the master node and submitting queries\n directly to the software running on the master node, such as Hive and Hadoop. For more\n information on how to do this, see Add More than 256 Steps to a\n Cluster in the Amazon EMR Management Guide.

\n

A step specifies the location of a JAR file stored either on the master node of the\n cluster or in Amazon S3. Each step is performed by the main function of the main class of\n the JAR file. The main class can be specified either in the manifest of the JAR or by using\n the MainFunction parameter of the step.

\n

Amazon EMR executes each step in the order listed. For a step to be considered complete,\n the main function must exit with a zero exit code and all Hadoop jobs started while the\n step was running must have completed and run successfully.

\n

You can only add steps to a cluster that is in one of the following states: STARTING,\n BOOTSTRAPPING, RUNNING, or WAITING.

\n \n

The string values passed into HadoopJarStep object cannot exceed a total of 10240 characters.

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

AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed\n in each job flow.

\n

If your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using SSH to connect to the master node and submitting queries\n directly to the software running on the master node, such as Hive and Hadoop. For more\n information on how to do this, see Add More than 256 Steps to a\n Cluster in the Amazon EMR Management Guide.

\n

A step specifies the location of a JAR file stored either on the master node of the\n cluster or in Amazon S3. Each step is performed by the main function of the main\n class of the JAR file. The main class can be specified either in the manifest of the JAR or\n by using the MainFunction parameter of the step.

\n

Amazon EMR executes each step in the order listed. For a step to be considered\n complete, the main function must exit with a zero exit code and all Hadoop jobs started\n while the step was running must have completed and run successfully.

\n

You can only add steps to a cluster that is in one of the following states: STARTING,\n BOOTSTRAPPING, RUNNING, or WAITING.

\n \n

The string values passed into HadoopJarStep object cannot exceed a total\n of 10240 characters.

\n " } }, "com.amazonaws.emr#AddJobFlowStepsInput": { @@ -249,7 +249,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR Studio. Tags make it easier to associate resources in\n various ways, such as grouping clusters to track your Amazon EMR resource allocation costs.\n For more information, see Tag Clusters.

" + "smithy.api#documentation": "

Adds tags to an Amazon EMR resource, such as a cluster or an Amazon EMR\n Studio. Tags make it easier to associate resources in various ways, such as grouping\n clusters to track your Amazon EMR resource allocation costs. For more information,\n see Tag\n Clusters.

" } }, "com.amazonaws.emr#AddTagsInput": { @@ -265,13 +265,13 @@ "Tags": { "target": "com.amazonaws.emr#TagList", "traits": { - "smithy.api#documentation": "

A list of tags to associate with a resource. Tags are\n user-defined key-value pairs that consist of a required key string with a maximum of 128\n characters, and an optional value string with a maximum of 256 characters.

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

A list of tags to associate with a resource. Tags are user-defined key-value pairs that\n consist of a required key string with a maximum of 128 characters, and an optional value\n string with a maximum of 256 characters.

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

This input identifies an Amazon EMR resource and a list of tags to attach.

" + "smithy.api#documentation": "

This input identifies an Amazon EMR resource and a list of tags to\n attach.

" } }, "com.amazonaws.emr#AddTagsOutput": { @@ -329,7 +329,7 @@ } }, "traits": { - "smithy.api#documentation": "

With Amazon EMR release version 4.0 and later, the only accepted parameter is the\n application name. To pass arguments to applications, you use configuration classifications\n specified using configuration JSON objects. For more information, see Configuring\n Applications.

\n

With earlier Amazon EMR releases, the application is any Amazon or third-party software\n that you can add to the cluster. This structure contains a list of strings that indicates\n the software to use with the cluster and accepts a user argument list. Amazon EMR accepts\n and forwards the argument list to the corresponding installation script as bootstrap action\n argument.

" + "smithy.api#documentation": "

With Amazon EMR release version 4.0 and later, the only accepted parameter is\n the application name. To pass arguments to applications, you use configuration\n classifications specified using configuration JSON objects. For more information, see\n Configuring Applications.

\n

With earlier Amazon EMR releases, the application is any Amazon or third-party\n software that you can add to the cluster. This structure contains a list of strings that\n indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation\n script as bootstrap action argument.

" } }, "com.amazonaws.emr#ApplicationList": { @@ -381,7 +381,7 @@ } }, "traits": { - "smithy.api#documentation": "

An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically\n adds and terminates EC2 instances in response to the value of a CloudWatch metric. See\n PutAutoScalingPolicy.

" + "smithy.api#documentation": "

An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. An automatic scaling policy defines how an instance group\n dynamically adds and terminates EC2 instances in response to the value of a CloudWatch\n metric. See PutAutoScalingPolicy.

" } }, "com.amazonaws.emr#AutoScalingPolicyDescription": { @@ -407,7 +407,7 @@ } }, "traits": { - "smithy.api#documentation": "

An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically\n adds and terminates EC2 instances in response to the value of a CloudWatch metric. See\n PutAutoScalingPolicy.

" + "smithy.api#documentation": "

An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates EC2 instances in response to the value of a CloudWatch\n metric. See PutAutoScalingPolicy.

" } }, "com.amazonaws.emr#AutoScalingPolicyState": { @@ -506,12 +506,12 @@ "IdleTimeout": { "target": "com.amazonaws.emr#Long", "traits": { - "smithy.api#documentation": "

Specifies the amount of idle time in seconds after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).

" + "smithy.api#documentation": "

Specifies the amount of idle time in seconds after which the cluster automatically\n terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven\n days).

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

An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

" + "smithy.api#documentation": "

An auto-termination policy for an Amazon EMR cluster. An auto-termination policy\n defines the amount of idle time in seconds after which a cluster automatically terminates.\n For alternative cluster termination options, see Control cluster\n termination.

" } }, "com.amazonaws.emr#BlockPublicAccessConfiguration": { @@ -520,14 +520,14 @@ "BlockPublicSecurityGroupRules": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Amazon EMR block public access is enabled (true) or\n disabled (false). By default, the value is false for accounts\n that have created EMR clusters before July 2019. For accounts created after this, the\n default is true.

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

Indicates whether Amazon EMR block public access is enabled (true)\n or disabled (false). By default, the value is false for accounts\n that have created EMR clusters before July 2019. For accounts created after this, the\n default is true.

", "smithy.api#required": {} } }, "PermittedPublicSecurityGroupRuleRanges": { "target": "com.amazonaws.emr#PortRanges", "traits": { - "smithy.api#documentation": "

Specifies ports and port ranges that are permitted to have security group rules that\n allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is\n specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR allows\n cluster creation if a security group associated with the cluster has a rule that allows\n inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source.

\n

By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in\n the list of PermittedPublicSecurityGroupRuleRanges.

" + "smithy.api#documentation": "

Specifies ports and port ranges that are permitted to have security group rules that\n allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is\n specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR\n allows cluster creation if a security group associated with the cluster has a rule that\n allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the\n source.

\n

By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in\n the list of PermittedPublicSecurityGroupRuleRanges.

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

A configuration for Amazon EMR block public access. When\n BlockPublicSecurityGroupRules is set to true, Amazon EMR\n prevents cluster creation if one of the cluster's security groups has a rule that allows\n inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an\n exception using PermittedPublicSecurityGroupRuleRanges.

" + "smithy.api#documentation": "

A configuration for Amazon EMR block public access. When\n BlockPublicSecurityGroupRules is set to true, Amazon EMR prevents cluster creation if one of the cluster's security groups has a rule that allows\n inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an\n exception using PermittedPublicSecurityGroupRuleRanges.

" } }, "com.amazonaws.emr#BlockPublicAccessConfigurationMetadata": { @@ -649,7 +649,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR\n versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in\n each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee\n that a step will be canceled, even if the request is successfully submitted. When you use Amazon EMR versions 5.28.0 and later, you can cancel steps that are in a PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.

" + "smithy.api#documentation": "

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in\n each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee\n that a step will be canceled, even if the request is successfully submitted. When you use\n Amazon EMR versions 5.28.0 and later, you can cancel steps that are in a\n PENDING or RUNNING state. In earlier versions of Amazon EMR, you can only cancel steps that are in a PENDING state.

" } }, "com.amazonaws.emr#CancelStepsInfo": { @@ -675,7 +675,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specification of the status of a CancelSteps request. Available only in Amazon EMR\n version 4.8.0 and later, excluding version 5.0.0.

" + "smithy.api#documentation": "

Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.

" } }, "com.amazonaws.emr#CancelStepsInfoList": { @@ -837,19 +837,19 @@ "InstanceCollectionType": { "target": "com.amazonaws.emr#InstanceCollectionType", "traits": { - "smithy.api#documentation": "\n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

\n \n

The instance group configuration of the cluster. A value of INSTANCE_GROUP\n indicates a uniform instance group configuration. A value of INSTANCE_FLEET\n indicates an instance fleets configuration.

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

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n \n

The instance group configuration of the cluster. A value of INSTANCE_GROUP\n indicates a uniform instance group configuration. A value of INSTANCE_FLEET\n indicates an instance fleets configuration.

" } }, "LogUri": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The path to the Amazon S3 location where logs for this cluster are stored.

" + "smithy.api#documentation": "

The path to the Amazon S3 location where logs for this cluster are\n stored.

" } }, "LogEncryptionKmsKeyId": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The KMS key used for encrypting log files. This attribute is\n only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" + "smithy.api#documentation": "

The KMS key used for encrypting log files. This attribute is only\n available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" } }, "RequestedAmiVersion": { @@ -867,7 +867,7 @@ "ReleaseLabel": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source application\n packages installed on the cluster. Release labels are in the form emr-x.x.x,\n where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more\n information about Amazon EMR release versions and included application versions and\n features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release\n label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use\n AmiVersion.

" + "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source\n application packages installed on the cluster. Release labels are in the form\n emr-x.x.x, where x.x.x is an Amazon EMR release version such as\n emr-5.14.0. For more information about Amazon EMR release versions\n and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR\n releases version 4.0 and later. Earlier versions use AmiVersion.

" } }, "AutoTerminate": { @@ -879,13 +879,13 @@ "TerminationProtected": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from\n being terminated by an API call or user intervention, or in the event of a cluster\n error.

" + "smithy.api#documentation": "

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances\n from being terminated by an API call or user intervention, or in the event of a cluster\n error.

" } }, "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated\n with the cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.

" + "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals\n in the Amazon Web Services account can perform EMR cluster actions on the cluster that their\n IAM policies allow. When false, only the IAM principal that created the\n cluster and the Amazon Web Services account root user can perform EMR actions, regardless of\n IAM permissions policies attached to other IAM principals.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.

" } }, "Applications": { @@ -903,7 +903,7 @@ "ServiceRole": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on\n your behalf.

" + "smithy.api#documentation": "

The IAM role that Amazon EMR assumes in order to access Amazon Web Services\n resources on your behalf.

" } }, "NormalizedInstanceHours": { @@ -921,7 +921,7 @@ "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied\n to the EMR cluster.

" + "smithy.api#documentation": "

Applies only to Amazon EMR releases 4.x and later. The list of Configurations\n supplied to the EMR cluster.

" } }, "SecurityConfiguration": { @@ -939,7 +939,7 @@ "ScaleDownBehavior": { "target": "com.amazonaws.emr#ScaleDownBehavior", "traits": { - "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic scale-in\n activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR\n indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of\n when the request to terminate the instance was submitted. This option is only available\n with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny\n list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of\n the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes\n first and blocks instance termination if it could lead to HDFS corruption.\n TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0\n and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" + "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } }, "CustomAmiId": { @@ -951,7 +951,7 @@ "EbsRootVolumeSize": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for\n each EC2 instance. Available in Amazon EMR version 4.x and later.

" + "smithy.api#documentation": "

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\n used for each EC2 instance. Available in Amazon EMR version 4.x and later.

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

Placement group configured for an Amazon EMR cluster.

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

The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.

" + } } }, "traits": { @@ -1338,7 +1344,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Amazon EMR releases 4.x or later.

\n \n

An optional configuration specification to be used when provisioning cluster instances,\n which can include configurations for applications and software bundled with Amazon EMR. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file. For more information, see Configuring\n Applications.

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

Amazon EMR releases 4.x or later.

\n \n

An optional configuration specification to be used when provisioning cluster instances,\n which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional\n nested configurations. A classification refers to an application-specific configuration\n file. Properties are the settings you want to change in that file. For more information,\n see Configuring Applications.

" } }, "com.amazonaws.emr#ConfigurationList": { @@ -1380,7 +1386,7 @@ "SecurityConfiguration": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The security configuration details in JSON format. For JSON parameters and examples, see\n Use Security\n Configurations to Set Up Cluster Security in the Amazon EMR Management\n Guide.

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

The security configuration details in JSON format. For JSON parameters and examples, see\n Use Security\n Configurations to Set Up Cluster Security in the Amazon EMR\n Management Guide.

", "smithy.api#required": {} } } @@ -1458,60 +1464,60 @@ "SubnetIds": { "target": "com.amazonaws.emr#SubnetIdList", "traits": { - "smithy.api#documentation": "

A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC\n specified by VpcId. Studio users can create a Workspace in any of the\n specified subnets.

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

A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have\n a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId.\n Studio users can create a Workspace in any of the specified subnets.

", "smithy.api#required": {} } }, "ServiceRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The IAM role that the Amazon EMR Studio assumes. The service role provides a\n way for Amazon EMR Studio to interoperate with other Amazon Web Services services.

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

The IAM role that the Amazon EMR Studio assumes. The service role provides a way\n for Amazon EMR Studio to interoperate with other Amazon Web Services\n services.

", "smithy.api#required": {} } }, "UserRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use Amazon Web Services SSO authentication. The\n permissions attached to the UserRole can be scoped down for each user or group using\n session policies.

" + "smithy.api#documentation": "

The IAM user role that users and groups assume when logged in to an Amazon EMR\n Studio. Only specify a UserRole when you use Amazon Web Services SSO\n authentication. The permissions attached to the UserRole can be scoped down\n for each user or group using session policies.

" } }, "WorkspaceSecurityGroupId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The ID of the Amazon EMR Studio Workspace security group. The Workspace security group\n allows outbound network traffic to resources in the Engine security group, and it must be\n in the same VPC specified by VpcId.

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

The ID of the Amazon EMR Studio Workspace security group. The Workspace security\n group allows outbound network traffic to resources in the Engine security group, and it\n must be in the same VPC specified by VpcId.

", "smithy.api#required": {} } }, "EngineSecurityGroupId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The ID of the Amazon EMR Studio Engine security group. The Engine security group allows\n inbound network traffic from the Workspace security group, and it must be in the same VPC\n specified by VpcId.

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

The ID of the Amazon EMR Studio Engine security group. The Engine security group\n allows inbound network traffic from the Workspace security group, and it must be in the\n same VPC specified by VpcId.

", "smithy.api#required": {} } }, "DefaultS3Location": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

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

The Amazon S3 location to back up Amazon EMR Studio Workspaces and\n notebook files.

", "smithy.api#required": {} } }, "IdpAuthUrl": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.

" + "smithy.api#documentation": "

The authentication endpoint of your identity provider (IdP). Specify this value when you\n use IAM authentication and want to let federated users log in to a Studio\n with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects\n users to this endpoint to enter credentials.

" } }, "IdpRelayStateParameterName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.

" + "smithy.api#documentation": "

The name that your identity provider (IdP) uses for its RelayState\n parameter. For example, RelayState or TargetSource. Specify this\n value when you use IAM authentication and want to let federated users log in\n to a Studio using the Studio URL. The RelayState parameter differs by\n IdP.

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

A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that\n consist of a required key string with a maximum of 128 characters, and an optional value\n string with a maximum of 256 characters.

" + "smithy.api#documentation": "

A list of tags to associate with the Amazon EMR Studio. Tags are user-defined\n key-value pairs that consist of a required key string with a maximum of 128 characters, and\n an optional value string with a maximum of 256 characters.

" } } } @@ -1538,6 +1544,9 @@ "input": { "target": "com.amazonaws.emr#CreateStudioSessionMappingInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerError" @@ -1547,7 +1556,7 @@ } ], "traits": { - "smithy.api#documentation": "

Maps a user or group to the Amazon EMR Studio specified by StudioId, and\n applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping to assign users to a Studio when you use Amazon Web Services SSO authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.

" + "smithy.api#documentation": "

Maps a user or group to the Amazon EMR Studio specified by\n StudioId, and applies a session policy to refine Studio permissions for that\n user or group. Use CreateStudioSessionMapping to assign users to a Studio when\n you use Amazon Web Services SSO authentication. For instructions on how to assign users to a\n Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.

" } }, "com.amazonaws.emr#CreateStudioSessionMappingInput": { @@ -1556,33 +1565,33 @@ "StudioId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The ID of the Amazon EMR Studio to which the user or group will be mapped.

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

The ID of the Amazon EMR Studio to which the user or group will be\n mapped.

", "smithy.api#required": {} } }, "IdentityId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity\n Store. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified, but not both.

" + "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO\n Identity Store. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API\n Reference. Either IdentityName or IdentityId must\n be specified, but not both.

" } }, "IdentityName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified, but not both.

" + "smithy.api#documentation": "

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API\n Reference. Either IdentityName or IdentityId must\n be specified, but not both.

" } }, "IdentityType": { "target": "com.amazonaws.emr#IdentityType", "traits": { - "smithy.api#documentation": "

Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.

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

Specifies whether the identity to map to the Amazon EMR Studio is a user or a\n group.

", "smithy.api#required": {} } }, "SessionPolicyArn": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the session policy that will be applied to the user\n or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an EMR Studio User Role with Session Policies.

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

The Amazon Resource Name (ARN) for the session policy that will be applied to the user\n or group. You should specify the ARN for the session policy that you want to apply, not the\n ARN of your user role. For more information, see Create an EMR Studio User\n Role with Session Policies.

", "smithy.api#required": {} } } @@ -1632,6 +1641,9 @@ "input": { "target": "com.amazonaws.emr#DeleteStudioInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerException" @@ -1661,6 +1673,9 @@ "input": { "target": "com.amazonaws.emr#DeleteStudioSessionMappingInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerError" @@ -1686,19 +1701,19 @@ "IdentityId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR\n Studio. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified.

" + "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API\n Reference. Either IdentityName or IdentityId must\n be specified.

" } }, "IdentityName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of the user name or group to remove from the Amazon EMR Studio. For more information, see\n UserName and DisplayName in the Amazon Web Services SSO Store API Reference.\n Either IdentityName or IdentityId must be specified.

" + "smithy.api#documentation": "

The name of the user name or group to remove from the Amazon EMR Studio. For\n more information, see UserName and DisplayName in the Amazon Web Services SSO Store API Reference.\n Either IdentityName or IdentityId must be specified.

" } }, "IdentityType": { "target": "com.amazonaws.emr#IdentityType", "traits": { - "smithy.api#documentation": "

Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.

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

Specifies whether the identity to delete from the Amazon EMR Studio is a user or\n a group.

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

Provides EMR release label details, such as releases available the region where the API request is run, and the available applications for a specific EMR release label. Can also list EMR release versions that support a specified version of Spark.

" + "smithy.api#documentation": "

Provides EMR release label details, such as releases available the region where the API\n request is run, and the available applications for a specific EMR release label. Can also\n list EMR release versions that support a specified version of Spark.

" } }, "com.amazonaws.emr#DescribeReleaseLabelInput": { @@ -1997,7 +2012,7 @@ "Applications": { "target": "com.amazonaws.emr#SimplifiedApplicationList", "traits": { - "smithy.api#documentation": "

The list of applications available for the target release label. Name is the name of the application. Version is the concise version of the application.

" + "smithy.api#documentation": "

The list of applications available for the target release label. Name is\n the name of the application. Version is the concise version of the\n application.

" } }, "NextToken": { @@ -2005,6 +2020,12 @@ "traits": { "smithy.api#documentation": "

The pagination token. Reserved for future use. Currently set to null.

" } + }, + "AvailableOSReleases": { + "target": "com.amazonaws.emr#OSReleaseList", + "traits": { + "smithy.api#documentation": "

The list of available Amazon Linux release versions for an Amazon EMR release. \n Contains a Label field that is formatted as shown in \n Amazon Linux 2 Release Notes\n . For example, 2.0.20220218.1.

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

Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio\n access URL, and so on.

" + "smithy.api#documentation": "

Returns details for the specified Amazon EMR Studio including ID, Name, VPC,\n Studio access URL, and so on.

" } }, "com.amazonaws.emr#DescribeStudioInput": { @@ -2270,7 +2291,7 @@ "EbsBlockDeviceConfigs": { "target": "com.amazonaws.emr#EbsBlockDeviceConfigList", "traits": { - "smithy.api#documentation": "

An array of Amazon EBS volume specifications attached to a cluster instance.

" + "smithy.api#documentation": "

An array of Amazon EBS volume specifications attached to a cluster\n instance.

" } }, "EbsOptimized": { @@ -2316,19 +2337,19 @@ "Ec2KeyName": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node\n as a user named \"hadoop\".

" + "smithy.api#documentation": "

The name of the Amazon EC2 key pair to use when connecting with SSH into the\n master node as a user named \"hadoop\".

" } }, "Ec2SubnetId": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster\n to launch. If you do not specify this value, and your account supports EC2-Classic, the\n cluster launches in EC2-Classic.

" + "smithy.api#documentation": "

Set this parameter to the identifier of the Amazon VPC subnet where you want the\n cluster to launch. If you do not specify this value, and your account supports EC2-Classic,\n the cluster launches in EC2-Classic.

" } }, "RequestedEc2SubnetIds": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "

Applies to clusters configured with the instance fleets option. Specifies the unique\n identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances.\n Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit\n from among the list of RequestedEc2SubnetIds, and then launches all cluster\n instances within that Subnet. If this value is not specified, and the account and Region\n support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and\n uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is\n not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you.\n RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot\n be specified together.

" + "smithy.api#documentation": "

Applies to clusters configured with the instance fleets option. Specifies the unique\n identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster\n instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2\n subnet with the best fit from among the list of RequestedEc2SubnetIds, and\n then launches all cluster instances within that Subnet. If this value is not specified, and\n the account and Region support EC2-Classic networks, the cluster launches instances in the\n EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this\n setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR\n chooses the subnet for you. RequestedEc2SubnetIDs and\n RequestedEc2AvailabilityZones cannot be specified together.

" } }, "Ec2AvailabilityZone": { @@ -2340,7 +2361,7 @@ "RequestedEc2AvailabilityZones": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "

Applies to clusters configured with the instance fleets option. Specifies one or more\n Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network\n configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from\n among the list of RequestedEc2AvailabilityZones, and then launches all cluster\n instances within that Availability Zone. If you do not specify this value, Amazon EMR\n chooses the Availability Zone for you. RequestedEc2SubnetIDs and\n RequestedEc2AvailabilityZones cannot be specified together.

" + "smithy.api#documentation": "

Applies to clusters configured with the instance fleets option. Specifies one or more\n Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network\n configuration is supported. Amazon EMR chooses the Availability Zone with the best\n fit from among the list of RequestedEc2AvailabilityZones, and then launches\n all cluster instances within that Availability Zone. If you do not specify this value,\n Amazon EMR chooses the Availability Zone for you.\n RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot\n be specified together.

" } }, "IamInstanceProfile": { @@ -2358,13 +2379,13 @@ "EmrManagedSlaveSecurityGroup": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the core and task nodes.

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the core and task\n nodes.

" } }, "ServiceAccessSecurityGroup": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the Amazon EMR service to access\n clusters in VPC private subnets.

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the Amazon EMR\n service to access clusters in VPC private subnets.

" } }, "AdditionalMasterSecurityGroups": { @@ -2376,7 +2397,7 @@ "AdditionalSlaveSecurityGroups": { "target": "com.amazonaws.emr#StringList", "traits": { - "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the core and task nodes.

" + "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the core and task\n nodes.

" } } }, @@ -2398,7 +2419,7 @@ "name": "elasticmapreduce" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon EMR is a web service that makes it easier to process large amounts of data\n efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do\n tasks such as web indexing, data mining, log file analysis, machine learning, scientific\n simulation, and data warehouse management.

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

Amazon EMR is a web service that makes it easier to process large amounts of\n data efficiently. Amazon EMR uses Hadoop processing combined with several Amazon Web Services services to do tasks such as web indexing, data mining, log file analysis,\n machine learning, scientific simulation, and data warehouse management.

", "smithy.api#title": "Amazon EMR", "smithy.api#xmlNamespace": { "uri": "http://elasticmapreduce.amazonaws.com/doc/2009-03-31" @@ -2626,7 +2647,7 @@ "Message": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

The descriptive message including the error the Amazon EMR service has identified as the\n cause of step failure. This is text from an error log that describes the root cause of the\n failure.

" + "smithy.api#documentation": "

The descriptive message including the error the Amazon EMR service has\n identified as the cause of step failure. This is text from an error log that describes the\n root cause of the failure.

" } }, "LogFile": { @@ -2658,7 +2679,7 @@ "ClusterId": { "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "

Specifies the ID of the Amazon EMR cluster for which the auto-termination policy will be fetched.

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

Specifies the ID of the Amazon EMR cluster for which the auto-termination policy\n will be fetched.

", "smithy.api#required": {} } } @@ -2670,7 +2691,7 @@ "AutoTerminationPolicy": { "target": "com.amazonaws.emr#AutoTerminationPolicy", "traits": { - "smithy.api#documentation": "

Specifies the auto-termination policy that is attached to an Amazon EMR cluster.

" + "smithy.api#documentation": "

Specifies the auto-termination policy that is attached to an Amazon EMR cluster.\n

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

Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the\n current Region. For more information see Configure Block\n Public Access for Amazon EMR in the Amazon EMR Management\n Guide.

" + "smithy.api#documentation": "

Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the current Region. For more information see Configure Block\n Public Access for Amazon EMR in the Amazon EMR\n Management Guide.

" } }, "com.amazonaws.emr#GetBlockPublicAccessConfigurationInput": { @@ -2705,7 +2726,7 @@ "BlockPublicAccessConfiguration": { "target": "com.amazonaws.emr#BlockPublicAccessConfiguration", "traits": { - "smithy.api#documentation": "

A configuration for Amazon EMR block public access. The configuration applies to all\n clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges in the\n BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating the block public\n access configuration to remove the exception.

\n \n

For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an EMR cluster in a Region\n before this date, block public access is enabled by default in that Region.

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

A configuration for Amazon EMR block public access. The configuration applies to\n all clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges in the\n BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating the block public\n access configuration to remove the exception.

\n \n

For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an EMR cluster in a Region\n before this date, block public access is enabled by default in that Region.

\n ", "smithy.api#required": {} } }, @@ -2748,7 +2769,7 @@ "ManagedScalingPolicy": { "target": "com.amazonaws.emr#ManagedScalingPolicy", "traits": { - "smithy.api#documentation": "

Specifies the managed scaling policy that is attached to an Amazon EMR cluster.

" + "smithy.api#documentation": "

Specifies the managed scaling policy that is attached to an Amazon EMR cluster.\n

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

Fetches mapping details for the specified Amazon EMR Studio and identity (user or\n group).

" + "smithy.api#documentation": "

Fetches mapping details for the specified Amazon EMR Studio and identity (user\n or group).

" } }, "com.amazonaws.emr#GetStudioSessionMappingInput": { @@ -2786,13 +2807,13 @@ "IdentityId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group. For more information, see\n UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified.

" + "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group. For more information, see\n UserId and GroupId in the Amazon Web Services SSO Identity Store API\n Reference. Either IdentityName or IdentityId must\n be specified.

" } }, "IdentityName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of the user or group to fetch. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified.

" + "smithy.api#documentation": "

The name of the user or group to fetch. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API\n Reference. Either IdentityName or IdentityId must\n be specified.

" } }, "IdentityType": { @@ -2810,7 +2831,7 @@ "SessionMapping": { "target": "com.amazonaws.emr#SessionMappingDetail", "traits": { - "smithy.api#documentation": "

The session mapping details for the specified Amazon EMR Studio and identity, including\n session policy ARN and creation time.

" + "smithy.api#documentation": "

The session mapping details for the specified Amazon EMR Studio and identity,\n including session policy ARN and creation time.

" } } } @@ -3020,13 +3041,13 @@ "TargetOnDemandCapacity": { "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

The target capacity of On-Demand units for the instance fleet, which determines how many\n On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to\n provision On-Demand Instances as specified by InstanceTypeConfig. Each\n instance configuration has a specified WeightedCapacity. When an On-Demand\n Instance is provisioned, the WeightedCapacity units count toward the target\n capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled,\n even if this results in an overage. For example, if there are 2 units remaining to fulfill\n capacity, and Amazon EMR can only provision an instance with a\n WeightedCapacity of 5 units, the instance is provisioned, and the target\n capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity\n units that have been provisioned for the instance fleet.

\n \n

If not specified or set to 0, only Spot Instances are provisioned for the instance\n fleet using TargetSpotCapacity. At least one of\n TargetSpotCapacity and TargetOnDemandCapacity should be\n greater than 0. For a master instance fleet, only one of TargetSpotCapacity\n and TargetOnDemandCapacity can be specified, and its value must be\n 1.

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

The target capacity of On-Demand units for the instance fleet, which determines how many\n On-Demand Instances to provision. When the instance fleet launches, Amazon EMR\n tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an\n On-Demand Instance is provisioned, the WeightedCapacity units count toward the\n target capacity. Amazon EMR provisions instances until the target capacity is\n totally fulfilled, even if this results in an overage. For example, if there are 2 units\n remaining to fulfill capacity, and Amazon EMR can only provision an instance with a\n WeightedCapacity of 5 units, the instance is provisioned, and the target\n capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity\n units that have been provisioned for the instance fleet.

\n \n

If not specified or set to 0, only Spot Instances are provisioned for the instance\n fleet using TargetSpotCapacity. At least one of\n TargetSpotCapacity and TargetOnDemandCapacity should be\n greater than 0. For a master instance fleet, only one of TargetSpotCapacity\n and TargetOnDemandCapacity can be specified, and its value must be\n 1.

\n " } }, "TargetSpotCapacity": { "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

The target capacity of Spot units for the instance fleet, which determines how many Spot\n Instances to provision. When the instance fleet launches, Amazon EMR tries to provision\n Spot Instances as specified by InstanceTypeConfig. Each instance\n configuration has a specified WeightedCapacity. When a Spot instance is\n provisioned, the WeightedCapacity units count toward the target capacity.\n Amazon EMR provisions instances until the target capacity is totally fulfilled, even if\n this results in an overage. For example, if there are 2 units remaining to fulfill\n capacity, and Amazon EMR can only provision an instance with a\n WeightedCapacity of 5 units, the instance is provisioned, and the target\n capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units\n that have been provisioned for the instance fleet.

\n \n

If not specified or set to 0, only On-Demand Instances are provisioned for the\n instance fleet. At least one of TargetSpotCapacity and\n TargetOnDemandCapacity should be greater than 0. For a master instance\n fleet, only one of TargetSpotCapacity and\n TargetOnDemandCapacity can be specified, and its value must be 1.

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

The target capacity of Spot units for the instance fleet, which determines how many Spot\n Instances to provision. When the instance fleet launches, Amazon EMR tries to\n provision Spot Instances as specified by InstanceTypeConfig. Each\n instance configuration has a specified WeightedCapacity. When a Spot instance\n is provisioned, the WeightedCapacity units count toward the target capacity.\n Amazon EMR provisions instances until the target capacity is totally fulfilled,\n even if this results in an overage. For example, if there are 2 units remaining to fulfill\n capacity, and Amazon EMR can only provision an instance with a\n WeightedCapacity of 5 units, the instance is provisioned, and the target\n capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units\n that have been provisioned for the instance fleet.

\n \n

If not specified or set to 0, only On-Demand Instances are provisioned for the\n instance fleet. At least one of TargetSpotCapacity and\n TargetOnDemandCapacity should be greater than 0. For a master instance\n fleet, only one of TargetSpotCapacity and\n TargetOnDemandCapacity can be specified, and its value must be 1.

\n " } }, "ProvisionedOnDemandCapacity": { @@ -3044,7 +3065,7 @@ "InstanceTypeSpecifications": { "target": "com.amazonaws.emr#InstanceTypeSpecificationList", "traits": { - "smithy.api#documentation": "

An array of specifications for the instance types that comprise an instance fleet.

" + "smithy.api#documentation": "

An array of specifications for the instance types that comprise an instance\n fleet.

" } }, "LaunchSpecifications": { @@ -3055,7 +3076,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an instance fleet, which is a group of EC2 instances that host a particular\n node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of\n a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a\n defined target capacity.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

Describes an instance fleet, which is a group of EC2 instances that host a particular\n node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can\n consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned\n to meet a defined target capacity.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetConfig": { @@ -3077,13 +3098,13 @@ "TargetOnDemandCapacity": { "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

The target capacity of On-Demand units for the instance fleet, which determines how many\n On-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries to\n provision On-Demand Instances as specified by InstanceTypeConfig. Each\n instance configuration has a specified WeightedCapacity. When an On-Demand\n Instance is provisioned, the WeightedCapacity units count toward the target\n capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled,\n even if this results in an overage. For example, if there are 2 units remaining to fulfill\n capacity, and Amazon EMR can only provision an instance with a\n WeightedCapacity of 5 units, the instance is provisioned, and the target\n capacity is exceeded by 3 units.

\n \n

If not specified or set to 0, only Spot Instances are provisioned for the instance\n fleet using TargetSpotCapacity. At least one of\n TargetSpotCapacity and TargetOnDemandCapacity should be\n greater than 0. For a master instance fleet, only one of TargetSpotCapacity\n and TargetOnDemandCapacity can be specified, and its value must be\n 1.

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

The target capacity of On-Demand units for the instance fleet, which determines how many\n On-Demand Instances to provision. When the instance fleet launches, Amazon EMR\n tries to provision On-Demand Instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an\n On-Demand Instance is provisioned, the WeightedCapacity units count toward the\n target capacity. Amazon EMR provisions instances until the target capacity is\n totally fulfilled, even if this results in an overage. For example, if there are 2 units\n remaining to fulfill capacity, and Amazon EMR can only provision an instance with a\n WeightedCapacity of 5 units, the instance is provisioned, and the target\n capacity is exceeded by 3 units.

\n \n

If not specified or set to 0, only Spot Instances are provisioned for the instance\n fleet using TargetSpotCapacity. At least one of\n TargetSpotCapacity and TargetOnDemandCapacity should be\n greater than 0. For a master instance fleet, only one of TargetSpotCapacity\n and TargetOnDemandCapacity can be specified, and its value must be\n 1.

\n " } }, "TargetSpotCapacity": { "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

The target capacity of Spot units for the instance fleet, which determines how many Spot\n Instances to provision. When the instance fleet launches, Amazon EMR tries to provision\n Spot Instances as specified by InstanceTypeConfig. Each instance\n configuration has a specified WeightedCapacity. When a Spot Instance is\n provisioned, the WeightedCapacity units count toward the target capacity.\n Amazon EMR provisions instances until the target capacity is totally fulfilled, even if\n this results in an overage. For example, if there are 2 units remaining to fulfill\n capacity, and Amazon EMR can only provision an instance with a\n WeightedCapacity of 5 units, the instance is provisioned, and the target\n capacity is exceeded by 3 units.

\n \n

If not specified or set to 0, only On-Demand Instances are provisioned for the\n instance fleet. At least one of TargetSpotCapacity and\n TargetOnDemandCapacity should be greater than 0. For a master instance\n fleet, only one of TargetSpotCapacity and\n TargetOnDemandCapacity can be specified, and its value must be 1.

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

The target capacity of Spot units for the instance fleet, which determines how many Spot\n Instances to provision. When the instance fleet launches, Amazon EMR tries to\n provision Spot Instances as specified by InstanceTypeConfig. Each\n instance configuration has a specified WeightedCapacity. When a Spot Instance\n is provisioned, the WeightedCapacity units count toward the target capacity.\n Amazon EMR provisions instances until the target capacity is totally fulfilled,\n even if this results in an overage. For example, if there are 2 units remaining to fulfill\n capacity, and Amazon EMR can only provision an instance with a\n WeightedCapacity of 5 units, the instance is provisioned, and the target\n capacity is exceeded by 3 units.

\n \n

If not specified or set to 0, only On-Demand Instances are provisioned for the\n instance fleet. At least one of TargetSpotCapacity and\n TargetOnDemandCapacity should be greater than 0. For a master instance\n fleet, only one of TargetSpotCapacity and\n TargetOnDemandCapacity can be specified, and its value must be 1.

\n " } }, "InstanceTypeConfigs": { @@ -3100,7 +3121,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration that defines an instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

The configuration that defines an instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetConfigList": { @@ -3142,7 +3163,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configuration parameters for an instance fleet modification request.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

Configuration parameters for an instance fleet modification request.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetProvisioningSpecifications": { @@ -3157,12 +3178,12 @@ "OnDemandSpecification": { "target": "com.amazonaws.emr#OnDemandProvisioningSpecification", "traits": { - "smithy.api#documentation": "

The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in\n Amazon EMR version 5.12.1 and later.

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

The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR version 5.12.1 and later.

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

The launch specification for Spot Instances in the fleet, which determines the defined\n duration, provisioning timeout behavior, and allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions. On-Demand and Spot Instance allocation strategies are\n available in Amazon EMR version 5.12.1 and later.

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

The launch specification for Spot Instances in the fleet, which determines the defined\n duration, provisioning timeout behavior, and allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot Instance allocation\n strategies are available in Amazon EMR version 5.12.1 and later.

\n " } }, "com.amazonaws.emr#InstanceFleetState": { @@ -3217,7 +3238,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides status change reason details for the instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

Provides status change reason details for the instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetStateChangeReasonCode": { @@ -3266,7 +3287,7 @@ } }, "traits": { - "smithy.api#documentation": "

The status of the instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

The status of the instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetTimeline": { @@ -3292,7 +3313,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides historical timestamps for the instance fleet, including the time of creation,\n the time it became ready to run jobs, and the time of termination.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

Provides historical timestamps for the instance fleet, including the time of creation,\n the time it became ready to run jobs, and the time of termination.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceFleetType": { @@ -3344,7 +3365,7 @@ "BidPrice": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

" + "smithy.api#documentation": "

If specified, indicates that the instance group uses Spot Instances. This is the maximum\n price you are willing to pay for Spot Instances. Specify OnDemandPrice to set\n the amount equal to the On-Demand price, or specify an amount in USD.

" } }, "InstanceType": { @@ -3374,7 +3395,7 @@ "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "\n

Amazon EMR releases 4.x or later.

\n \n

The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a\n separate configuration for each instance group (master, core, and task).

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

Amazon EMR releases 4.x or later.

\n \n

The list of configurations supplied for an Amazon EMR cluster instance group.\n You can specify a separate configuration for each instance group (master, core, and\n task).

" } }, "ConfigurationsVersion": { @@ -3404,7 +3425,7 @@ "EbsOptimized": { "target": "com.amazonaws.emr#BooleanObject", "traits": { - "smithy.api#documentation": "

If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an\n optimized configuration stack and provides additional, dedicated capacity for Amazon EBS\n I/O.

" + "smithy.api#documentation": "

If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an\n optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

" } }, "ShrinkPolicy": { @@ -3416,7 +3437,7 @@ "AutoScalingPolicy": { "target": "com.amazonaws.emr#AutoScalingPolicyDescription", "traits": { - "smithy.api#documentation": "

An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically\n adds and terminates EC2 instances in response to the value of a CloudWatch metric. See\n PutAutoScalingPolicy.

" + "smithy.api#documentation": "

An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates EC2 instances in response to the value of a CloudWatch\n metric. See PutAutoScalingPolicy.

" } }, "CustomAmiId": { @@ -3455,7 +3476,7 @@ "BidPrice": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

" + "smithy.api#documentation": "

If specified, indicates that the instance group uses Spot Instances. This is the maximum\n price you are willing to pay for Spot Instances. Specify OnDemandPrice to set\n the amount equal to the On-Demand price, or specify an amount in USD.

" } }, "InstanceType": { @@ -3487,7 +3508,7 @@ "AutoScalingPolicy": { "target": "com.amazonaws.emr#AutoScalingPolicy", "traits": { - "smithy.api#documentation": "

An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically\n adds and terminates EC2 instances in response to the value of a CloudWatch metric. See\n PutAutoScalingPolicy.

" + "smithy.api#documentation": "

An automatic scaling policy for a core instance group or task instance group in an\n Amazon EMR cluster. The automatic scaling policy defines how an instance group\n dynamically adds and terminates EC2 instances in response to the value of a CloudWatch\n metric. See PutAutoScalingPolicy.

" } }, "CustomAmiId": { @@ -3539,7 +3560,7 @@ "BidPrice": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

" + "smithy.api#documentation": "

If specified, indicates that the instance group uses Spot Instances. This is the maximum\n price you are willing to pay for Spot Instances. Specify OnDemandPrice to set\n the amount equal to the On-Demand price, or specify an amount in USD.

" } }, "InstanceType": { @@ -3566,7 +3587,7 @@ "State": { "target": "com.amazonaws.emr#InstanceGroupState", "traits": { - "smithy.api#documentation": "

State of instance group. The following values are no longer supported: STARTING, TERMINATED, and\n FAILED.

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

State of instance group. The following values are no longer supported: STARTING,\n TERMINATED, and FAILED.

", "smithy.api#required": {} } }, @@ -3661,6 +3682,12 @@ "smithy.api#documentation": "

Policy for customizing shrink operations.

" } }, + "ReconfigurationType": { + "target": "com.amazonaws.emr#ReconfigurationType", + "traits": { + "smithy.api#documentation": "

Type of reconfiguration requested. Valid values are MERGE and OVERWRITE.

" + } + }, "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { @@ -4076,7 +4103,7 @@ "EbsConfiguration": { "target": "com.amazonaws.emr#EbsConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance\n as defined by InstanceType.

" + "smithy.api#documentation": "

The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each\n instance as defined by InstanceType.

" } }, "Configurations": { @@ -4093,7 +4120,7 @@ } }, "traits": { - "smithy.api#documentation": "

An instance type configuration for each instance type in an instance fleet, which\n determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot\n target capacities. When you use an allocation strategy, you can include a maximum of 30 instance type configurations for a fleet. For more information about how to use an allocation strategy, see Configure Instance Fleets. Without an allocation strategy, you may specify a maximum of five instance type configurations for a fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

An instance type configuration for each instance type in an instance fleet, which\n determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand\n and Spot target capacities. When you use an allocation strategy, you can include a maximum\n of 30 instance type configurations for a fleet. For more information about how to use an\n allocation strategy, see Configure Instance\n Fleets. Without an allocation strategy, you may specify a maximum of five\n instance type configurations for a fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceTypeConfigList": { @@ -4138,7 +4165,7 @@ "EbsBlockDevices": { "target": "com.amazonaws.emr#EbsBlockDeviceList", "traits": { - "smithy.api#documentation": "

The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each instance\n as defined by InstanceType.

" + "smithy.api#documentation": "

The configuration of Amazon Elastic Block Store (Amazon EBS) attached to each\n instance as defined by InstanceType.

" } }, "EbsOptimized": { @@ -4155,7 +4182,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration specification for each instance type in an instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

The configuration specification for each instance type in an instance fleet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#InstanceTypeSpecificationList": { @@ -4245,13 +4272,13 @@ "LogEncryptionKmsKeyId": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The KMS key used for encrypting log files. This attribute is\n only available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" + "smithy.api#documentation": "

The KMS key used for encrypting log files. This attribute is only\n available with EMR version 5.30.0 and later, excluding EMR 6.0.0.

" } }, "AmiVersion": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and\n later, ReleaseLabel is used. To specify a custom AMI, use\n CustomAmiID.

" + "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR\n releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use\n CustomAmiID.

" } }, "ExecutionStatusDetail": { @@ -4289,7 +4316,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated\n with the cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.

" + "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals\n in the Amazon Web Services account can perform EMR cluster actions that their IAM policies\n allow. When false, only the IAM principal that created the cluster and the\n Amazon Web Services account root user can perform EMR actions, regardless of IAM\n permissions policies attached to other IAM principals.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console.

" } }, "JobFlowRole": { @@ -4301,7 +4328,7 @@ "ServiceRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your\n behalf.

" + "smithy.api#documentation": "

The IAM role that is assumed by the Amazon EMR service to access Amazon Web Services resources on your behalf.

" } }, "AutoScalingRole": { @@ -4313,7 +4340,7 @@ "ScaleDownBehavior": { "target": "com.amazonaws.emr#ScaleDownBehavior", "traits": { - "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic scale-in\n activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR\n indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of\n when the request to terminate the instance was submitted. This option is only available\n with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny\n list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of\n the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes\n first and blocks instance termination if it could lead to HDFS corruption.\n TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and\n later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" + "smithy.api#documentation": "

The way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } } }, @@ -4449,7 +4476,7 @@ "InstanceFleets": { "target": "com.amazonaws.emr#InstanceFleetConfigList", "traits": { - "smithy.api#documentation": "\n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

\n \n

Describes the EC2 instances and instance configurations for clusters that use the\n instance fleet configuration.

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

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n \n

Describes the EC2 instances and instance configurations for clusters that use the\n instance fleet configuration.

" } }, "Ec2KeyName": { @@ -4467,49 +4494,49 @@ "KeepJobFlowAliveWhenNoSteps": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the cluster should remain available after completing all steps. Defaults to true. For more information about configuring cluster termination, see Control Cluster Termination in the EMR Management Guide.

" + "smithy.api#documentation": "

Specifies whether the cluster should remain available after completing all steps.\n Defaults to true. For more information about configuring cluster termination,\n see Control Cluster Termination in the EMR Management\n Guide.

" } }, "TerminationProtected": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being\n terminated by API call, user intervention, or in the event of a job-flow error.

" + "smithy.api#documentation": "

Specifies whether to lock the cluster to prevent the Amazon EC2 instances from\n being terminated by API call, user intervention, or in the event of a job-flow\n error.

" } }, "HadoopVersion": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the\n cluster. Valid inputs are \"0.18\" (no longer maintained), \"0.20\" (no longer maintained),\n \"0.20.205\" (no longer maintained), \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not set this\n value, the default of 0.18 is used, unless the AmiVersion parameter is set in\n the RunJobFlow call, in which case the default version of Hadoop for that AMI version is\n used.

" + "smithy.api#documentation": "

Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version\n for the cluster. Valid inputs are \"0.18\" (no longer maintained), \"0.20\" (no longer\n maintained), \"0.20.205\" (no longer maintained), \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not\n set this value, the default of 0.18 is used, unless the AmiVersion parameter\n is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI\n version is used.

" } }, "Ec2SubnetId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Applies to clusters that use the uniform instance group configuration. To launch the\n cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier\n of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this\n value and your account supports EC2-Classic, the cluster launches in EC2-Classic.

" + "smithy.api#documentation": "

Applies to clusters that use the uniform instance group configuration. To launch the\n cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the\n identifier of the Amazon VPC subnet where you want the cluster to launch. If you do\n not specify this value and your account supports EC2-Classic, the cluster launches in\n EC2-Classic.

" } }, "Ec2SubnetIds": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet\n IDs are specified, Amazon EMR evaluates them and launches instances in the optimal\n subnet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet\n IDs are specified, Amazon EMR evaluates them and launches instances in the optimal\n subnet.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "EmrManagedMasterSecurityGroup": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the master node. If you specify EmrManagedMasterSecurityGroup, you must also specify EmrManagedSlaveSecurityGroup.

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the master node. If you\n specify EmrManagedMasterSecurityGroup, you must also specify\n EmrManagedSlaveSecurityGroup.

" } }, "EmrManagedSlaveSecurityGroup": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the core and task nodes. If you specify EmrManagedSlaveSecurityGroup, you must also specify EmrManagedMasterSecurityGroup.

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the core and task nodes. If\n you specify EmrManagedSlaveSecurityGroup, you must also specify\n EmrManagedMasterSecurityGroup.

" } }, "ServiceAccessSecurityGroup": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the Amazon EMR service to access\n clusters in VPC private subnets.

" + "smithy.api#documentation": "

The identifier of the Amazon EC2 security group for the Amazon EMR\n service to access clusters in VPC private subnets.

" } }, "AdditionalMasterSecurityGroups": { @@ -4521,12 +4548,12 @@ "AdditionalSlaveSecurityGroups": { "target": "com.amazonaws.emr#SecurityGroupsList", "traits": { - "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the core and task nodes.

" + "smithy.api#documentation": "

A list of additional Amazon EC2 security group IDs for the core and task\n nodes.

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

A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid\n JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be\n used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount\n (all three must be present), but we don't recommend this configuration.

" + "smithy.api#documentation": "

A description of the Amazon EC2 instance on which the cluster (job flow) runs. A\n valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They\n cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and\n InstanceCount (all three must be present), but we don't recommend this\n configuration.

" } }, "com.amazonaws.emr#JobFlowInstancesDetail": { @@ -4561,7 +4588,7 @@ "InstanceCount": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance\n serves as both the master and core and task node. If the value is greater than 1, one\n instance is the master node and all others are core and task nodes.

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

The number of Amazon EC2 instances in the cluster. If the value is 1, the same\n instance serves as both the master and core and task node. If the value is greater than 1,\n one instance is the master node and all others are core and task nodes.

", "smithy.api#required": {} } }, @@ -4574,13 +4601,13 @@ "NormalizedInstanceHours": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

An approximation of the cost of the cluster, represented in m1.small/hours. This value\n is increased one time for every hour that an m1.small instance runs. Larger instances are\n weighted more heavily, so an Amazon EC2 instance that is roughly four times more expensive\n would result in the normalized instance hours being increased incrementally four times.\n This result is only an approximation and does not reflect the actual billing rate.

" + "smithy.api#documentation": "

An approximation of the cost of the cluster, represented in m1.small/hours. This value\n is increased one time for every hour that an m1.small instance runs. Larger instances are\n weighted more heavily, so an Amazon EC2 instance that is roughly four times more\n expensive would result in the normalized instance hours being increased incrementally four\n times. This result is only an approximation and does not reflect the actual billing\n rate.

" } }, "Ec2KeyName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of an Amazon EC2 key pair that can be used to connect to the master node using\n SSH.

" + "smithy.api#documentation": "

The name of an Amazon EC2 key pair that can be used to connect to the master\n node using SSH.

" } }, "Ec2SubnetId": { @@ -4604,7 +4631,7 @@ "TerminationProtected": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the Amazon EC2 instances in the cluster are protected from termination\n by API calls, user intervention, or in the event of a job-flow error.

" + "smithy.api#documentation": "

Specifies whether the Amazon EC2 instances in the cluster are protected from\n termination by API calls, user intervention, or in the event of a job-flow error.

" } }, "HadoopVersion": { @@ -4615,7 +4642,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.

" + "smithy.api#documentation": "

Specify the type of Amazon EC2 instances that the cluster (job flow) runs\n on.

" } }, "com.amazonaws.emr#KerberosAttributes": { @@ -4767,7 +4794,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter\n the list of clusters based on certain criteria; for example, filtering by cluster creation\n date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but\n returns a marker to track the paging of the cluster list across multiple ListClusters\n calls.

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

Provides the status of all clusters visible to this Amazon Web Services account. Allows\n you to filter the list of clusters based on certain criteria; for example, filtering by\n cluster creation date and time or by status. This call returns a maximum of 50 clusters in\n unsorted order per call, but returns a marker to track the paging of the cluster list\n across multiple ListClusters calls.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -4793,7 +4820,7 @@ "ClusterStates": { "target": "com.amazonaws.emr#ClusterStateList", "traits": { - "smithy.api#documentation": "

The cluster state filters to apply when listing clusters. Clusters that change state while this action runs may be not be returned as expected in the list of clusters.

" + "smithy.api#documentation": "

The cluster state filters to apply when listing clusters. Clusters that change state\n while this action runs may be not be returned as expected in the list of clusters.

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

Lists all available details about the instance fleets in a cluster.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

Lists all available details about the instance fleets in a cluster.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5157,19 +5184,19 @@ "Filters": { "target": "com.amazonaws.emr#ReleaseLabelFilter", "traits": { - "smithy.api#documentation": "

Filters the results of the request. Prefix specifies the prefix of release labels to return. Application specifies the application (with/without version) of release labels to return.

" + "smithy.api#documentation": "

Filters the results of the request. Prefix specifies the prefix of release\n labels to return. Application specifies the application (with/without version)\n of release labels to return.

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

Specifies the next page of results. If NextToken is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The ListReleaseLabels request fails if the identity (Amazon Web Services account ID) and all filtering parameters are different from the original request, or if the NextToken is expired or tampered with.

" + "smithy.api#documentation": "

Specifies the next page of results. If NextToken is not specified, which is\n usually the case for the first request of ListReleaseLabels, the first page of results are\n determined by other filtering parameters or by the latest version. The\n ListReleaseLabels request fails if the identity (Amazon Web Services account\n ID) and all filtering parameters are different from the original request, or if the\n NextToken is expired or tampered with.

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

Defines the maximum number of release labels to return in a single response. The default is 100.

" + "smithy.api#documentation": "

Defines the maximum number of release labels to return in a single response. The default\n is 100.

" } } } @@ -5186,7 +5213,7 @@ "NextToken": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

Used to paginate the next page of results if specified in the next ListReleaseLabels request.

" + "smithy.api#documentation": "

Used to paginate the next page of results if specified in the next\n ListReleaseLabels request.

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

Provides a list of steps for the cluster in reverse order unless you specify\n stepIds with the request or filter by StepStates. You can\n specify a maximum of 10 stepIDs. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker, which is a pagination token that indicates the next set of steps to retrieve.

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

Provides a list of steps for the cluster in reverse order unless you specify\n stepIds with the request or filter by StepStates. You can\n specify a maximum of 10 stepIDs. The CLI automatically\n paginates results to return a list greater than 50 steps. To return more than 50 steps\n using the CLI, specify a Marker, which is a pagination token\n that indicates the next set of steps to retrieve.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5294,7 +5321,7 @@ "Marker": { "target": "com.amazonaws.emr#Marker", "traits": { - "smithy.api#documentation": "

The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.

" + "smithy.api#documentation": "

The maximum number of steps that a single ListSteps action returns is 50.\n To return a longer list of steps, use multiple ListSteps actions along with\n the Marker parameter, which is a pagination token that indicates the next set\n of results to retrieve.

" } } }, @@ -5314,7 +5341,7 @@ "Marker": { "target": "com.amazonaws.emr#Marker", "traits": { - "smithy.api#documentation": "

The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.

" + "smithy.api#documentation": "

The maximum number of steps that a single ListSteps action returns is 50.\n To return a longer list of steps, use multiple ListSteps actions along with\n the Marker parameter, which is a pagination token that indicates the next set\n of results to retrieve.

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

Returns a list of all user or group session mappings for the Amazon EMR Studio specified by\n StudioId.

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

Returns a list of all user or group session mappings for the Amazon EMR Studio\n specified by StudioId.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5376,7 +5403,7 @@ "SessionMappings": { "target": "com.amazonaws.emr#SessionMappingSummaryList", "traits": { - "smithy.api#documentation": "

A list of session mapping summary objects. Each object includes session mapping details\n such as creation time, identity type (user or group), and Amazon EMR Studio ID.

" + "smithy.api#documentation": "

A list of session mapping summary objects. Each object includes session mapping details\n such as creation time, identity type (user or group), and Amazon EMR Studio\n ID.

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

Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list\n includes details such as ID, Studio Access URL, and creation time for each Studio.

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

Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list includes details such as ID, Studio Access URL, and\n creation time for each Studio.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5454,7 +5481,7 @@ } }, "traits": { - "smithy.api#documentation": "

Managed scaling policy for an Amazon EMR cluster. The policy specifies the limits for\n resources that can be added or terminated from a cluster. The policy only applies to the\n core and task nodes. The master node cannot be scaled after initial configuration.

" + "smithy.api#documentation": "

Managed scaling policy for an Amazon EMR cluster. The policy specifies the\n limits for resources that can be added or terminated from a cluster. The policy only\n applies to the core and task nodes. The master node cannot be scaled after initial\n configuration.

" } }, "com.amazonaws.emr#Marker": { @@ -5502,7 +5529,7 @@ } }, "traits": { - "smithy.api#documentation": "

A CloudWatch dimension, which is specified using a Key (known as a\n Name in CloudWatch), Value pair. By default, Amazon EMR uses\n one dimension whose Key is JobFlowID and Value is a\n variable representing the cluster ID, which is ${emr.clusterId}. This enables\n the rule to bootstrap when the cluster ID becomes available.

" + "smithy.api#documentation": "

A CloudWatch dimension, which is specified using a Key (known as a\n Name in CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and\n Value is a variable representing the cluster ID, which is\n ${emr.clusterId}. This enables the rule to bootstrap when the cluster ID\n becomes available.

" } }, "com.amazonaws.emr#MetricDimensionList": { @@ -5544,7 +5571,7 @@ "StepConcurrencyLevel": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The number of steps that can be executed concurrently. You can specify a minimum of 1 step and a maximum of 256 steps. We recommend that you do not change this parameter while steps are running or the ActionOnFailure setting may not behave as expected. For more information see Step$ActionOnFailure.

" + "smithy.api#documentation": "

The number of steps that can be executed concurrently. You can specify a minimum of 1\n step and a maximum of 256 steps. We recommend that you do not change this parameter while\n steps are running or the ActionOnFailure setting may not behave as expected.\n For more information see Step$ActionOnFailure.

" } } } @@ -5565,6 +5592,9 @@ "input": { "target": "com.amazonaws.emr#ModifyInstanceFleetInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerException" @@ -5574,7 +5604,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the target On-Demand and target Spot capacities for the instance fleet with the\n specified InstanceFleetID within the cluster specified using ClusterID. The call either\n succeeds or fails atomically.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

Modifies the target On-Demand and target Spot capacities for the instance fleet with the\n specified InstanceFleetID within the cluster specified using ClusterID. The call either\n succeeds or fails atomically.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } }, "com.amazonaws.emr#ModifyInstanceFleetInput": { @@ -5601,6 +5631,9 @@ "input": { "target": "com.amazonaws.emr#ModifyInstanceGroupsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerError" @@ -5819,7 +5852,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.

" + "smithy.api#documentation": "

Details for a notebook execution. The details include information such as the unique ID\n and status of the notebook execution.

" } }, "com.amazonaws.emr#NotebookExecutionSummaryList": { @@ -5828,19 +5861,39 @@ "target": "com.amazonaws.emr#NotebookExecutionSummary" } }, + "com.amazonaws.emr#OSRelease": { + "type": "structure", + "members": { + "Label": { + "target": "com.amazonaws.emr#String", + "traits": { + "smithy.api#documentation": "

The Amazon Linux release specified for a cluster in the RunJobFlow request. The format is as shown in \n Amazon Linux 2 Release Notes\n . For example, 2.0.20220218.1.

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

The Amazon Linux release specified for a cluster in the RunJobFlow request.

" + } + }, + "com.amazonaws.emr#OSReleaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.emr#OSRelease" + } + }, "com.amazonaws.emr#OnDemandCapacityReservationOptions": { "type": "structure", "members": { "UsageStrategy": { "target": "com.amazonaws.emr#OnDemandCapacityReservationUsageStrategy", "traits": { - "smithy.api#documentation": "

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

\n

If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price).

\n

If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.

" + "smithy.api#documentation": "

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand\n capacity.

\n

If you specify use-capacity-reservations-first, the fleet uses unused\n Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If\n multiple instance pools have unused Capacity Reservations, the On-Demand allocation\n strategy (lowest-price) is applied. If the number of unused Capacity\n Reservations is less than the On-Demand target capacity, the remaining On-Demand target\n capacity is launched according to the On-Demand allocation strategy\n (lowest-price).

\n

If you do not specify a value, the fleet fulfills the On-Demand capacity according to\n the chosen On-Demand allocation strategy.

" } }, "CapacityReservationPreference": { "target": "com.amazonaws.emr#OnDemandCapacityReservationPreference", "traits": { - "smithy.api#documentation": "

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

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

Indicates the instance's Capacity Reservation preferences. Possible preferences\n include:

\n " } }, "CapacityReservationResourceGroupArn": { @@ -5851,7 +5904,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

" + "smithy.api#documentation": "

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand\n capacity.

" } }, "com.amazonaws.emr#OnDemandCapacityReservationPreference": { @@ -5897,19 +5950,19 @@ "AllocationStrategy": { "target": "com.amazonaws.emr#OnDemandProvisioningAllocationStrategy", "traits": { - "smithy.api#documentation": "

Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is lowest-price (the default), which launches the lowest price first.

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

Specifies the strategy to use in launching On-Demand instance fleets. Currently, the\n only option is lowest-price (the default), which launches the lowest price\n first.

", "smithy.api#required": {} } }, "CapacityReservationOptions": { "target": "com.amazonaws.emr#OnDemandCapacityReservationOptions", "traits": { - "smithy.api#documentation": "

The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.

" + "smithy.api#documentation": "

The launch specification for On-Demand instances in the instance fleet, which determines\n the allocation strategy.

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

The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in\n Amazon EMR version 5.12.1 and later.

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

The launch specification for On-Demand Instances in the instance fleet, which\n determines the allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is\n available in Amazon EMR version 5.12.1 and later.

\n " } }, "com.amazonaws.emr#OptionalArnType": { @@ -5934,12 +5987,12 @@ "PlacementStrategy": { "target": "com.amazonaws.emr#PlacementGroupStrategy", "traits": { - "smithy.api#documentation": "

EC2 Placement Group strategy associated with instance role.

\n

Starting with Amazon EMR version 5.23.0, the only supported placement strategy is\n SPREAD for the MASTER instance role.

" + "smithy.api#documentation": "

EC2 Placement Group strategy associated with instance role.

\n

Starting with Amazon EMR version 5.23.0, the only supported placement strategy\n is SPREAD for the MASTER instance role.

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

Placement group configuration for an Amazon EMR cluster. The configuration specifies the\n placement strategy that can be applied to instance roles during cluster creation.

\n

To use this configuration, consider attaching managed policy\n AmazonElasticMapReducePlacementGroupPolicy to the EMR role.

" + "smithy.api#documentation": "

Placement group configuration for an Amazon EMR cluster. The configuration\n specifies the placement strategy that can be applied to instance roles during cluster\n creation.

\n

To use this configuration, consider attaching managed policy\n AmazonElasticMapReducePlacementGroupPolicy to the EMR role.

" } }, "com.amazonaws.emr#PlacementGroupConfigList": { @@ -5977,13 +6030,13 @@ "AvailabilityZone": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used\n for uniform instance groups, while AvailabilityZones (plural) is used for\n instance fleets.

" + "smithy.api#documentation": "

The Amazon EC2 Availability Zone for the cluster. AvailabilityZone\n is used for uniform instance groups, while AvailabilityZones (plural) is used\n for instance fleets.

" } }, "AvailabilityZones": { "target": "com.amazonaws.emr#XmlStringMaxLen256List", "traits": { - "smithy.api#documentation": "

When multiple Availability Zones are specified, Amazon EMR evaluates them and launches\n instances in the optimal Availability Zone. AvailabilityZones is used for\n instance fleets, while AvailabilityZone (singular) is used for uniform\n instance groups.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions.

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

When multiple Availability Zones are specified, Amazon EMR evaluates them and\n launches instances in the optimal Availability Zone. AvailabilityZones is used\n for instance fleets, while AvailabilityZone (singular) is used for uniform\n instance groups.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions.

\n " } } }, @@ -6037,7 +6090,7 @@ "target": "com.amazonaws.emr#PutAutoScalingPolicyOutput" }, "traits": { - "smithy.api#documentation": "

Creates or updates an automatic scaling policy for a core instance group or task\n instance group in an Amazon EMR cluster. The automatic scaling policy defines how an\n instance group dynamically adds and terminates EC2 instances in response to the value of a\n CloudWatch metric.

" + "smithy.api#documentation": "

Creates or updates an automatic scaling policy for a core instance group or task\n instance group in an Amazon EMR cluster. The automatic scaling policy defines how\n an instance group dynamically adds and terminates EC2 instances in response to the value of\n a CloudWatch metric.

" } }, "com.amazonaws.emr#PutAutoScalingPolicyInput": { @@ -6104,7 +6157,7 @@ "target": "com.amazonaws.emr#PutAutoTerminationPolicyOutput" }, "traits": { - "smithy.api#documentation": "\n

Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and later. For more information, see Using an auto-termination policy.

\n \n

Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

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

Auto-termination is supported in Amazon EMR versions 5.30.0 and 6.1.0 and\n later. For more information, see Using an\n auto-termination policy.

\n \n

Creates or updates an auto-termination policy for an Amazon EMR cluster. An\n auto-termination policy defines the amount of idle time in seconds after which a cluster\n automatically terminates. For alternative cluster termination options, see Control\n cluster termination.

" } }, "com.amazonaws.emr#PutAutoTerminationPolicyInput": { @@ -6113,7 +6166,7 @@ "ClusterId": { "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "

Specifies the ID of the Amazon EMR cluster to which the auto-termination policy will be attached.

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

Specifies the ID of the Amazon EMR cluster to which the auto-termination policy\n will be attached.

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

Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account\n in the current Region. For more information see Configure Block\n Public Access for Amazon EMR in the Amazon EMR Management\n Guide.

" + "smithy.api#documentation": "

Creates or updates an Amazon EMR block public access configuration for your\n Amazon Web Services account in the current Region. For more information see Configure Block\n Public Access for Amazon EMR in the Amazon EMR\n Management Guide.

" } }, "com.amazonaws.emr#PutBlockPublicAccessConfigurationInput": { @@ -6155,7 +6208,7 @@ "BlockPublicAccessConfiguration": { "target": "com.amazonaws.emr#BlockPublicAccessConfiguration", "traits": { - "smithy.api#documentation": "

A configuration for Amazon EMR block public access. The configuration applies to all\n clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges in the\n BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating\n BlockPublicSecurityGroupRules to remove the exception.

\n \n

For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an EMR cluster in a Region\n before this date, block public access is enabled by default in that Region.

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

A configuration for Amazon EMR block public access. The configuration applies to\n all clusters created in your account for the current Region. The configuration specifies\n whether block public access is enabled. If block public access is enabled, security groups\n associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or\n ::/0 on a port, unless the port is specified as an exception using\n PermittedPublicSecurityGroupRuleRanges in the\n BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception,\n and public access is allowed on this port. You can change this by updating\n BlockPublicSecurityGroupRules to remove the exception.

\n \n

For accounts that created clusters in a Region before November 25, 2019, block public\n access is disabled by default in that Region. To use this feature, you must manually\n enable and configure it. For accounts that did not create an EMR cluster in a Region\n before this date, block public access is enabled by default in that Region.

\n ", "smithy.api#required": {} } } @@ -6174,7 +6227,7 @@ "target": "com.amazonaws.emr#PutManagedScalingPolicyOutput" }, "traits": { - "smithy.api#documentation": "

Creates or updates a managed scaling policy for an Amazon EMR cluster. The managed\n scaling policy defines the limits for resources, such as EC2 instances that can be added or\n terminated from a cluster. The policy only applies to the core and task nodes. The master\n node cannot be scaled after initial configuration.

" + "smithy.api#documentation": "

Creates or updates a managed scaling policy for an Amazon EMR cluster. The\n managed scaling policy defines the limits for resources, such as EC2 instances that can be\n added or terminated from a cluster. The policy only applies to the core and task nodes. The\n master node cannot be scaled after initial configuration.

" } }, "com.amazonaws.emr#PutManagedScalingPolicyInput": { @@ -6200,6 +6253,21 @@ "type": "structure", "members": {} }, + "com.amazonaws.emr#ReconfigurationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OVERWRITE", + "name": "OVERWRITE" + }, + { + "value": "MERGE", + "name": "MERGE" + } + ] + } + }, "com.amazonaws.emr#ReleaseLabelFilter": { "type": "structure", "members": { @@ -6273,7 +6341,7 @@ "ClusterId": { "target": "com.amazonaws.emr#ClusterId", "traits": { - "smithy.api#documentation": "

Specifies the ID of the Amazon EMR cluster from which the auto-termination policy will be removed.

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

Specifies the ID of the Amazon EMR cluster from which the auto-termination\n policy will be removed.

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

Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources in\n various ways, such as grouping clusters to track your Amazon EMR resource allocation costs.\n For more information, see Tag Clusters.

\n

The following example removes the stack tag with value Prod from a cluster:

" + "smithy.api#documentation": "

Removes tags from an Amazon EMR resource, such as a cluster or Amazon EMR Studio. Tags make it easier to associate resources in various ways, such as grouping\n clusters to track your Amazon EMR resource allocation costs. For more information,\n see Tag\n Clusters.

\n

The following example removes the stack tag with value Prod from a cluster:

" } }, "com.amazonaws.emr#RemoveTagsInput": { @@ -6337,7 +6405,7 @@ "ResourceId": { "target": "com.amazonaws.emr#ResourceId", "traits": { - "smithy.api#documentation": "

The Amazon EMR resource identifier from which tags will be removed. For example, a\n cluster identifier or an Amazon EMR Studio ID.

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

The Amazon EMR resource identifier from which tags will be removed. For example,\n a cluster identifier or an Amazon EMR Studio ID.

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

This input identifies an Amazon EMR resource and a list of tags to remove.

" + "smithy.api#documentation": "

This input identifies an Amazon EMR resource and a list of tags to\n remove.

" } }, "com.amazonaws.emr#RemoveTagsOutput": { @@ -6392,7 +6460,7 @@ } ], "traits": { - "smithy.api#documentation": "

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the\n steps specified. After the steps complete, the cluster stops and the HDFS partition is\n lost. To prevent loss of data, configure the last step of the job flow to store results in\n Amazon S3. If the JobFlowInstancesConfig\n KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster\n transitions to the WAITING state rather than shutting down after the steps have completed.

\n

For additional protection, you can set the JobFlowInstancesConfig\n TerminationProtected parameter to TRUE to lock the cluster and\n prevent it from being terminated by API call, user intervention, or in the event of a job\n flow error.

\n

A maximum of 256 steps are allowed in each job flow.

\n

If your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using the SSH shell to connect to the master node and submitting\n queries directly to the software running on the master node, such as Hive and Hadoop. For\n more information on how to do this, see Add More than 256 Steps to a\n Cluster in the Amazon EMR Management Guide.

\n

For long running clusters, we recommend that you periodically store your results.

\n \n

The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets\n parameters or InstanceGroups parameters, but not both.

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

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the\n steps specified. After the steps complete, the cluster stops and the HDFS partition is\n lost. To prevent loss of data, configure the last step of the job flow to store results in\n Amazon S3. If the JobFlowInstancesConfig\n KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster\n transitions to the WAITING state rather than shutting down after the steps have completed.

\n

For additional protection, you can set the JobFlowInstancesConfig\n TerminationProtected parameter to TRUE to lock the cluster and\n prevent it from being terminated by API call, user intervention, or in the event of a job\n flow error.

\n

A maximum of 256 steps are allowed in each job flow.

\n

If your cluster is long-running (such as a Hive data warehouse) or complex, you may\n require more than 256 steps to process your data. You can bypass the 256-step limitation in\n various ways, including using the SSH shell to connect to the master node and submitting\n queries directly to the software running on the master node, such as Hive and Hadoop. For\n more information on how to do this, see Add More than 256 Steps to a\n Cluster in the Amazon EMR Management Guide.

\n

For long running clusters, we recommend that you periodically store your results.

\n \n

The instance fleets configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain\n InstanceFleets parameters or InstanceGroups parameters, but not both.

\n " } }, "com.amazonaws.emr#RunJobFlowInput": { @@ -6408,13 +6476,13 @@ "LogUri": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 to write the log files of the job flow. If a value is not\n provided, logs are not created.

" + "smithy.api#documentation": "

The location in Amazon S3 to write the log files of the job flow. If a value is\n not provided, logs are not created.

" } }, "LogEncryptionKmsKeyId": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The KMS key used for encrypting log files. If a value is not\n provided, the logs remain encrypted by AES-256. This attribute is only available with\n Amazon EMR version 5.30.0 and later, excluding Amazon EMR 6.0.0.

" + "smithy.api#documentation": "

The KMS key used for encrypting log files. If a value is not\n provided, the logs remain encrypted by AES-256. This attribute is only available with\n Amazon EMR version 5.30.0 and later, excluding Amazon EMR 6.0.0.

" } }, "AdditionalInfo": { @@ -6426,13 +6494,13 @@ "AmiVersion": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and\n later, ReleaseLabel is used. To specify a custom AMI, use\n CustomAmiID.

" + "smithy.api#documentation": "

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR\n releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use\n CustomAmiID.

" } }, "ReleaseLabel": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source application\n packages installed on the cluster. Release labels are in the form emr-x.x.x,\n where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more\n information about Amazon EMR release versions and included application versions and\n features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release\n label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use\n AmiVersion.

" + "smithy.api#documentation": "

The Amazon EMR release label, which determines the version of open-source\n application packages installed on the cluster. Release labels are in the form\n emr-x.x.x, where x.x.x is an Amazon EMR release version such as\n emr-5.14.0. For more information about Amazon EMR release versions\n and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR\n releases version 4.0 and later. Earlier versions use AmiVersion.

" } }, "Instances": { @@ -6457,31 +6525,31 @@ "SupportedProducts": { "target": "com.amazonaws.emr#SupportedProductsList", "traits": { - "smithy.api#documentation": "\n

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use\n Applications.

\n \n

A list of strings that indicates third-party software to use. For more information, see\n the Amazon EMR\n Developer Guide. Currently supported values are:

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

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and\n later, use Applications.

\n \n

A list of strings that indicates third-party software to use. For more information, see\n the Amazon EMR Developer Guide. Currently supported values are:

\n " } }, "NewSupportedProducts": { "target": "com.amazonaws.emr#NewSupportedProductsList", "traits": { - "smithy.api#documentation": "\n

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use\n Applications.

\n \n

A list of strings that indicates third-party software to use with the job flow that\n accepts a user argument list. EMR accepts and forwards the argument list to the\n corresponding installation script as bootstrap action arguments. For more information, see\n \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide. Supported\n values are:

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

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and\n later, use Applications.

\n \n

A list of strings that indicates third-party software to use with the job flow that\n accepts a user argument list. EMR accepts and forwards the argument list to the\n corresponding installation script as bootstrap action arguments. For more information, see\n \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide.\n Supported values are:

\n " } }, "Applications": { "target": "com.amazonaws.emr#ApplicationList", "traits": { - "smithy.api#documentation": "

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications\n for Amazon EMR to install and configure when launching the cluster. For a list of\n applications available for each Amazon EMR release version, see the Amazon EMRRelease\n Guide.

" + "smithy.api#documentation": "

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of\n applications for Amazon EMR to install and configure when launching the cluster.\n For a list of applications available for each Amazon EMR release version, see the\n Amazon EMRRelease\n Guide.

" } }, "Configurations": { "target": "com.amazonaws.emr#ConfigurationList", "traits": { - "smithy.api#documentation": "

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR\n cluster you are creating.

" + "smithy.api#documentation": "

For Amazon EMR releases 4.0 and later. The list of configurations supplied for\n the EMR cluster you are creating.

" } }, "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "\n

The VisibleToAllUsers parameter is no longer supported. By default, the value is set to true. Setting it to false now has no effect.

\n \n

Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

\n

When set to false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

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

The VisibleToAllUsers parameter is no longer supported. By default, the value is set\n to true. Setting it to false now has no effect.

\n \n

Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster\n that their IAM policies allow. This value defaults to true for clusters\n created using the EMR API or the CLI\n create-cluster command.

\n

When set to false, only the IAM principal that created the cluster and the\n Amazon Web Services account root user can perform EMR actions for the cluster, regardless\n of the IAM permissions policies attached to other IAM principals. For more information, see\n Understanding the EMR Cluster VisibleToAllUsers Setting in the\n Amazon EMRManagement Guide.

" } }, "JobFlowRole": { @@ -6493,13 +6561,13 @@ "ServiceRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on\n your behalf.

" + "smithy.api#documentation": "

The IAM role that Amazon EMR assumes in order to access Amazon Web Services\n resources on your behalf.

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

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

" + "smithy.api#documentation": "

A list of tags to associate with a cluster and propagate to Amazon EC2\n instances.

" } }, "SecurityConfiguration": { @@ -6517,19 +6585,19 @@ "ScaleDownBehavior": { "target": "com.amazonaws.emr#ScaleDownBehavior", "traits": { - "smithy.api#documentation": "

Specifies the way that individual Amazon EC2 instances terminate when an automatic\n scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at\n the instance-hour boundary, regardless of when the request to terminate the instance was\n submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default\n for clusters created using that version. TERMINATE_AT_TASK_COMPLETION\n indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before\n terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either\n behavior, Amazon EMR removes the least active nodes first and blocks instance termination\n if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available\n only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR\n earlier than 5.1.0.

" + "smithy.api#documentation": "

Specifies the way that individual Amazon EC2 instances terminate when an\n automatic scale-in activity occurs or an instance group is resized.\n TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates\n nodes at the instance-hour boundary, regardless of when the request to terminate the\n instance was submitted. This option is only available with Amazon EMR 5.1.0 and\n later and is the default for clusters created using that version.\n TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes\n to a deny list and drains tasks from nodes before terminating the Amazon EC2\n instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to\n HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } }, "CustomAmiId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon\n EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2\n instances. For more information about custom AMIs in Amazon EMR, see Using a Custom\n AMI in the Amazon EMR Management Guide. If omitted, the\n cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR\n versions 2.x and 3.x, use AmiVersion instead.

\n

For information about creating a custom AMI, see Creating an Amazon EBS-Backed\n Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances. For information about finding an AMI ID, see Finding a Linux\n AMI.

" + "smithy.api#documentation": "

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon\n EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches\n cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see\n Using a\n Custom AMI in the Amazon EMR Management Guide. If\n omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified.\n For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.

\n

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux\n Instances. For information about finding an AMI ID, see Finding a Linux\n AMI.

" } }, "EbsRootVolumeSize": { "target": "com.amazonaws.emr#Integer", "traits": { - "smithy.api#documentation": "

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for\n each EC2 instance. Available in Amazon EMR version 4.x and later.

" + "smithy.api#documentation": "

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is\n used for each EC2 instance. Available in Amazon EMR version 4.x and later.

" } }, "RepoUpgradeOnBoot": { @@ -6564,6 +6632,12 @@ }, "AutoTerminationPolicy": { "target": "com.amazonaws.emr#AutoTerminationPolicy" + }, + "OSReleaseLabel": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

Specifies a particular Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If a release is not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch.

" + } } }, "traits": { @@ -6775,13 +6849,13 @@ "IdentityName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API\n Reference.

" + "smithy.api#documentation": "

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API\n Reference.

" } }, "IdentityType": { "target": "com.amazonaws.emr#IdentityType", "traits": { - "smithy.api#documentation": "

Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.

" + "smithy.api#documentation": "

Specifies whether the identity mapped to the Amazon EMR Studio is a user or a\n group.

" } }, "SessionPolicyArn": { @@ -6804,7 +6878,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details for an Amazon EMR Studio session mapping including creation time, user or group\n ID, Studio ID, and so on.

" + "smithy.api#documentation": "

Details for an Amazon EMR Studio session mapping including creation time, user\n or group ID, Studio ID, and so on.

" } }, "com.amazonaws.emr#SessionMappingSummary": { @@ -6819,19 +6893,19 @@ "IdentityId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity\n Store.

" + "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO\n Identity Store.

" } }, "IdentityName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API\n Reference.

" + "smithy.api#documentation": "

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API\n Reference.

" } }, "IdentityType": { "target": "com.amazonaws.emr#IdentityType", "traits": { - "smithy.api#documentation": "

Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.

" + "smithy.api#documentation": "

Specifies whether the identity mapped to the Amazon EMR Studio is a user or a\n group.

" } }, "SessionPolicyArn": { @@ -6848,7 +6922,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details for an Amazon EMR Studio session mapping. The details do not include the time\n the session mapping was last modified.

" + "smithy.api#documentation": "

Details for an Amazon EMR Studio session mapping. The details do not include the\n time the session mapping was last modified.

" } }, "com.amazonaws.emr#SessionMappingSummaryList": { @@ -6862,13 +6936,16 @@ "input": { "target": "com.amazonaws.emr#SetTerminationProtectionInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerError" } ], "traits": { - "smithy.api#documentation": "

SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster\n cannot be terminated by user intervention, an API call, or in the event of a job-flow\n error. The cluster still terminates upon successful completion of the job flow. Calling\n SetTerminationProtection on a cluster is similar to calling the Amazon EC2\n DisableAPITermination API on all EC2 instances in a cluster.

\n

\n SetTerminationProtection is used to prevent accidental termination of a\n cluster and to ensure that in the event of an error, the instances persist so that you can\n recover any data stored in their ephemeral instance storage.

\n

To terminate a cluster that has been locked by setting\n SetTerminationProtection to true, you must first unlock the\n job flow by a subsequent call to SetTerminationProtection in which you set the\n value to false.

\n

For more information, seeManaging Cluster\n Termination in the Amazon EMR Management Guide.

" + "smithy.api#documentation": "

SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster\n cannot be terminated by user intervention, an API call, or in the event of a job-flow\n error. The cluster still terminates upon successful completion of the job flow. Calling\n SetTerminationProtection on a cluster is similar to calling the Amazon EC2\n DisableAPITermination API on all EC2 instances in a cluster.

\n

\n SetTerminationProtection is used to prevent accidental termination of a\n cluster and to ensure that in the event of an error, the instances persist so that you can\n recover any data stored in their ephemeral instance storage.

\n

To terminate a cluster that has been locked by setting\n SetTerminationProtection to true, you must first unlock the\n job flow by a subsequent call to SetTerminationProtection in which you set the\n value to false.

\n

For more information, seeManaging Cluster\n Termination in the Amazon EMR Management Guide.

" } }, "com.amazonaws.emr#SetTerminationProtectionInput": { @@ -6884,7 +6961,7 @@ "TerminationProtected": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2\n instances in the cluster from shutting down due to API calls, user intervention, or\n job-flow error.

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

A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or\n job-flow error.

", "smithy.api#required": {} } } @@ -6898,13 +6975,16 @@ "input": { "target": "com.amazonaws.emr#SetVisibleToAllUsersInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerError" } ], "traits": { - "smithy.api#documentation": "\n

The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be visible to all users in your account.\n To restrict cluster access using an IAM policy, see Identity and Access Management for EMR.\n

\n \n

Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.

\n

This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

\n

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

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

The SetVisibleToAllUsers parameter is no longer supported. Your cluster may be\n visible to all users in your account. To restrict cluster access using an IAM policy, see Identity and Access\n Management for EMR.

\n \n

Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When\n true, IAM principals in the Amazon Web Services account can perform EMR\n cluster actions that their IAM policies allow. When false, only\n the IAM principal that created the cluster and the Amazon Web Services account root user can\n perform EMR actions on the cluster, regardless of IAM permissions policies attached to\n other IAM principals.

\n

This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

\n

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the\n Amazon EMRManagement Guide.

" } }, "com.amazonaws.emr#SetVisibleToAllUsersInput": { @@ -6920,7 +7000,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

A value of true indicates that an IAM principal in the Amazon Web Services account can perform\n EMR actions on the cluster that the IAM policies attached to the principal allow. A\n value of false indicates that only the IAM principal that created the cluster and the Amazon Web Services root user can perform EMR actions on the cluster.

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

A value of true indicates that an IAM principal in the Amazon Web Services account can perform EMR actions on the cluster that the IAM policies attached\n to the principal allow. A value of false indicates that only the IAM principal\n that created the cluster and the Amazon Web Services root user can perform EMR actions on\n the cluster.

", "smithy.api#required": {} } } @@ -7033,7 +7113,7 @@ "BlockDurationMinutes": { "target": "com.amazonaws.emr#WholeNumber", "traits": { - "smithy.api#documentation": "

The defined duration for Spot Instances (also known as Spot blocks) in minutes. When\n specified, the Spot Instance does not terminate before the defined duration expires, and\n defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240,\n 300, or 360. The duration period starts as soon as a Spot Instance receives its instance\n ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and\n provides a Spot Instance termination notice, which gives the instance a two-minute warning\n before it terminates.

\n \n

Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.\n

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

The defined duration for Spot Instances (also known as Spot blocks) in minutes. When\n specified, the Spot Instance does not terminate before the defined duration expires, and\n defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240,\n 300, or 360. The duration period starts as soon as a Spot Instance receives its instance\n ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination\n and provides a Spot Instance termination notice, which gives the instance a two-minute\n warning before it terminates.

\n \n

Spot Instances with a defined duration (also known as Spot blocks) are no longer\n available to new customers from July 1, 2021. For customers who have previously used the\n feature, we will continue to support Spot Instances with a defined duration until\n December 31, 2022.

\n " } }, "AllocationStrategy": { @@ -7044,7 +7124,7 @@ } }, "traits": { - "smithy.api#documentation": "

The launch specification for Spot Instances in the instance fleet, which determines the\n defined duration, provisioning timeout behavior, and allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and\n later, excluding 5.0.x versions. Spot Instance allocation strategy is available in\n Amazon EMR version 5.12.1 and later.

\n \n \n

Spot Instances with a defined duration (also known as Spot blocks) are no longer available to new customers from July 1, 2021. For customers who have previously used the feature, we will continue to support Spot Instances with a defined duration until December 31, 2022.\n

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

The launch specification for Spot Instances in the instance fleet, which determines the\n defined duration, provisioning timeout behavior, and allocation strategy.

\n \n

The instance fleet configuration is available only in Amazon EMR versions\n 4.8.0 and later, excluding 5.0.x versions. Spot Instance allocation strategy is\n available in Amazon EMR version 5.12.1 and later.

\n \n \n

Spot Instances with a defined duration (also known as Spot blocks) are no longer\n available to new customers from July 1, 2021. For customers who have previously used the\n feature, we will continue to support Spot Instances with a defined duration until\n December 31, 2022.

\n " } }, "com.amazonaws.emr#SpotProvisioningTimeoutAction": { @@ -7121,7 +7201,7 @@ "ServiceRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR\n role) for the notebook execution.

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

The name or ARN of the IAM role that is used as the service role for Amazon EMR\n (the EMR role) for the notebook execution.

", "smithy.api#required": {} } }, @@ -7201,7 +7281,7 @@ "ActionOnFailure": { "target": "com.amazonaws.emr#ActionOnFailure", "traits": { - "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER,\n CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility.\n We recommend using TERMINATE_CLUSTER instead.

\n

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

\n

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.

" + "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are\n TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.\n TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend\n using TERMINATE_CLUSTER instead.

\n

If a cluster's StepConcurrencyLevel is greater than 1, do not\n use AddJobFlowSteps to submit a step with this parameter set to\n CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not\n submitted and the action fails with a message that the ActionOnFailure setting\n is not valid.

\n

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a\n step is running, the ActionOnFailure parameter may not behave as you expect.\n In this case, for a step that fails with this parameter set to\n CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a\n step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does\n not terminate.

" } }, "Status": { @@ -7243,7 +7323,7 @@ "ActionOnFailure": { "target": "com.amazonaws.emr#ActionOnFailure", "traits": { - "smithy.api#documentation": "

The action to take when the step fails. Use one of the following values:

\n \n

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submit a step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not submitted and the action fails with a message that the ActionOnFailure setting is not valid.

\n

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, the ActionOnFailure parameter may not behave as you expect. In this case, for a step that fails with this parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.

" + "smithy.api#documentation": "

The action to take when the step fails. Use one of the following values:

\n \n

If a cluster's StepConcurrencyLevel is greater than 1, do not\n use AddJobFlowSteps to submit a step with this parameter set to\n CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is not\n submitted and the action fails with a message that the ActionOnFailure setting\n is not valid.

\n

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a\n step is running, the ActionOnFailure parameter may not behave as you expect.\n In this case, for a step that fails with this parameter set to\n CANCEL_AND_WAIT, pending steps and the running step are not canceled; for a\n step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does\n not terminate.

" } }, "HadoopJarStep": { @@ -7504,7 +7584,7 @@ "ActionOnFailure": { "target": "com.amazonaws.emr#ActionOnFailure", "traits": { - "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER,\n CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility.

" + "smithy.api#documentation": "

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER,\n CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward\n compatibility.

" } }, "Status": { @@ -7555,6 +7635,9 @@ "input": { "target": "com.amazonaws.emr#StopNotebookExecutionInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerError" @@ -7651,19 +7734,19 @@ "UserRole": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole when you use IAM authentication.

" + "smithy.api#documentation": "

The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A\n Studio only requires a UserRole when you use IAM\n authentication.

" } }, "WorkspaceSecurityGroupId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The ID of the Workspace security group associated with the Amazon EMR Studio. The\n Workspace security group allows outbound network traffic to resources in the Engine\n security group and to the internet.

" + "smithy.api#documentation": "

The ID of the Workspace security group associated with the Amazon EMR Studio.\n The Workspace security group allows outbound network traffic to resources in the Engine\n security group and to the internet.

" } }, "EngineSecurityGroupId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The ID of the Engine security group associated with the Amazon EMR Studio. The Engine\n security group allows inbound network traffic from resources in the Workspace security\n group.

" + "smithy.api#documentation": "

The ID of the Engine security group associated with the Amazon EMR Studio. The\n Engine security group allows inbound network traffic from resources in the Workspace\n security group.

" } }, "Url": { @@ -7681,13 +7764,13 @@ "DefaultS3Location": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook\n files.

" + "smithy.api#documentation": "

The Amazon S3 location to back up Amazon EMR Studio Workspaces and\n notebook files.

" } }, "IdpAuthUrl": { "target": "com.amazonaws.emr#XmlString", "traits": { - "smithy.api#documentation": "

Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.

" + "smithy.api#documentation": "

Your identity provider's authentication endpoint. Amazon EMR Studio redirects\n federated users to this endpoint for authentication when logging in to a Studio with the\n Studio URL.

" } }, "IdpRelayStateParameterName": { @@ -7704,7 +7787,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details for an Amazon EMR Studio including ID, creation time, name, and so on.

" + "smithy.api#documentation": "

Details for an Amazon EMR Studio including ID, creation time, name, and so\n on.

" } }, "com.amazonaws.emr#StudioSummary": { @@ -7725,7 +7808,7 @@ "VpcId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR\n Studio.

" + "smithy.api#documentation": "

The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.

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

Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The details\n do not include subnets, IAM roles, security groups, or tags associated with the\n Studio.

" + "smithy.api#documentation": "

Details for an Amazon EMR Studio, including ID, Name, VPC, and Description. The\n details do not include subnets, IAM roles, security groups, or tags associated with the\n Studio.

" } }, "com.amazonaws.emr#StudioSummaryList": { @@ -7812,7 +7895,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping\n clusters to track your Amazon EMR resource allocation costs. For more information, see\n Tag\n Clusters.

" + "smithy.api#documentation": "

A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as\n grouping clusters to track your Amazon EMR resource allocation costs. For more\n information, see Tag Clusters.

" } }, "com.amazonaws.emr#TagList": { @@ -7826,13 +7909,16 @@ "input": { "target": "com.amazonaws.emr#TerminateJobFlowsInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerError" } ], "traits": { - "smithy.api#documentation": "

TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut\n down, any step not yet completed is canceled and the EC2 instances on which the cluster is\n running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri\n was specified when the cluster was created.

\n

The maximum number of clusters allowed is 10. The call to TerminateJobFlows\n is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5\n minutes for the cluster to completely terminate and release allocated resources, such as\n Amazon EC2 instances.

" + "smithy.api#documentation": "

TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut\n down, any step not yet completed is canceled and the EC2 instances on which the cluster is\n running are stopped. Any log files not already saved are uploaded to Amazon S3 if a\n LogUri was specified when the cluster was created.

\n

The maximum number of clusters allowed is 10. The call to TerminateJobFlows\n is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5\n minutes for the cluster to completely terminate and release allocated resources, such as\n Amazon EC2 instances.

" } }, "com.amazonaws.emr#TerminateJobFlowsInput": { @@ -7970,6 +8056,9 @@ "input": { "target": "com.amazonaws.emr#UpdateStudioInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerException" @@ -7979,7 +8068,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.

" + "smithy.api#documentation": "

Updates an Amazon EMR Studio configuration, including attributes such as name,\n description, and subnets.

" } }, "com.amazonaws.emr#UpdateStudioInput": { @@ -8007,7 +8096,7 @@ "SubnetIds": { "target": "com.amazonaws.emr#SubnetIdList", "traits": { - "smithy.api#documentation": "

A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio.

" + "smithy.api#documentation": "

A list of subnet IDs to associate with the Amazon EMR Studio. The list can\n include new subnet IDs, but must also include all of the subnet IDs previously associated\n with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets.\n The subnets must belong to the same VPC as the Studio.

" } }, "DefaultS3Location": { @@ -8023,6 +8112,9 @@ "input": { "target": "com.amazonaws.emr#UpdateStudioSessionMappingInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.emr#InternalServerError" @@ -8032,7 +8124,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the session policy attached to the user or group for the specified Amazon EMR\n Studio.

" + "smithy.api#documentation": "

Updates the session policy attached to the user or group for the specified Amazon EMR Studio.

" } }, "com.amazonaws.emr#UpdateStudioSessionMappingInput": { @@ -8048,13 +8140,13 @@ "IdentityId": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group. For more information, see\n UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified.

" + "smithy.api#documentation": "

The globally unique identifier (GUID) of the user or group. For more information, see\n UserId and GroupId in the Amazon Web Services SSO Identity Store API\n Reference. Either IdentityName or IdentityId must\n be specified.

" } }, "IdentityName": { "target": "com.amazonaws.emr#XmlStringMaxLen256", "traits": { - "smithy.api#documentation": "

The name of the user or group to update. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference.\n Either IdentityName or IdentityId must be specified.

" + "smithy.api#documentation": "

The name of the user or group to update. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API\n Reference. Either IdentityName or IdentityId must\n be specified.

" } }, "IdentityType": { diff --git a/aws/sdk/aws-models/evidently.json b/aws/sdk/aws-models/evidently.json index 12a129075..cb357e5b7 100644 --- a/aws/sdk/aws-models/evidently.json +++ b/aws/sdk/aws-models/evidently.json @@ -2000,7 +2000,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the results of a running or completed experiment.

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

Retrieves the results of a running or completed experiment. No results are available until\n there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment.

\n

Experiment\n results are available up to 63 days after the start of the experiment. They are not available after that because\n of CloudWatch data retention policies.

", "smithy.api#http": { "method": "POST", "uri": "/projects/{project}/experiments/{experiment}/results", @@ -2036,7 +2036,7 @@ "endTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the experiment ended, if it is completed.

" + "smithy.api#documentation": "

The date and time that the experiment ended, if it is completed. This must be no longer than 30 days \n after the experiment start time.

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

The timestamps of each result returned.

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

If the experiment doesn't yet have enough events to provide valid results, this \n field is returned with the message Not enough events to generate results. If there are \n enough events to provide valid results, this field is not returned.

" + } } } }, @@ -4141,7 +4147,7 @@ "analysisCompleteTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time to end the experiment.

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

The date and time to end the experiment. This must be no more than 30 days after\n the experiment starts.

", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/iot.json b/aws/sdk/aws-models/iot.json index 2c7b94e58..c81d91429 100644 --- a/aws/sdk/aws-models/iot.json +++ b/aws/sdk/aws-models/iot.json @@ -3447,6 +3447,12 @@ "smithy.api#box": {} } }, + "com.amazonaws.iot#BooleanWrapperObject": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.iot#Bucket": { "type": "structure", "members": { @@ -3840,6 +3846,9 @@ { "target": "com.amazonaws.iot#InvalidRequestException" }, + { + "target": "com.amazonaws.iot#LimitExceededException" + }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, @@ -15914,6 +15923,9 @@ "traits": { "smithy.api#documentation": "

A key-value map that pairs the patterns that need to be replaced in a managed \n template job document schema. You can use the description of each key as a guidance \n to specify the inputs during runtime when creating a job.

" } + }, + "isConcurrent": { + "target": "com.amazonaws.iot#BooleanWrapperObject" } }, "traits": { @@ -16377,6 +16389,9 @@ "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job completed.

" } + }, + "isConcurrent": { + "target": "com.amazonaws.iot#BooleanWrapperObject" } }, "traits": { diff --git a/aws/sdk/aws-models/iotsecuretunneling.json b/aws/sdk/aws-models/iotsecuretunneling.json index 84e99d1d8..caa781f30 100644 --- a/aws/sdk/aws-models/iotsecuretunneling.json +++ b/aws/sdk/aws-models/iotsecuretunneling.json @@ -44,6 +44,25 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.iotsecuretunneling#ClientMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SOURCE", + "name": "SOURCE" + }, + { + "value": "DESTINATION", + "name": "DESTINATION" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, "com.amazonaws.iotsecuretunneling#CloseTunnel": { "type": "operation", "input": { @@ -58,7 +77,7 @@ } ], "traits": { - "smithy.api#documentation": "

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel\n\t\t\trequest is received, we close the WebSocket connections between the client and proxy\n\t\t\tserver so no data can be transmitted.

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

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel\n\t\t\trequest is received, we close the WebSocket connections between the client and proxy\n\t\t\tserver so no data can be transmitted.

\n\t\t

Requires permission to access the CloseTunnel action.

", "smithy.api#http": { "method": "DELETE", "uri": "/tunnels/{tunnelId}", @@ -81,7 +100,7 @@ "target": "com.amazonaws.iotsecuretunneling#DeleteFlag", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

When set to true, AWS IoT Secure Tunneling deletes the tunnel data\n\t\t\timmediately.

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

When set to true, IoT Secure Tunneling deletes the tunnel data\n\t\t\timmediately.

", "smithy.api#httpQuery": "delete" } } @@ -146,7 +165,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a tunnel identified by the unique tunnel id.

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

Gets information about a tunnel identified by the unique tunnel id.

\n\t\t

Requires permission to access the DescribeTunnel action.

", "smithy.api#http": { "method": "GET", "uri": "/tunnels/{tunnelId}", @@ -181,7 +200,7 @@ "com.amazonaws.iotsecuretunneling#Description": { "type": "string", "traits": { - "smithy.api#pattern": "[^\\p{C}]{1,2048}" + "smithy.api#pattern": "^[^\\p{C}]{1,2048}$" } }, "com.amazonaws.iotsecuretunneling#DestinationConfig": { @@ -196,7 +215,7 @@ "services": { "target": "com.amazonaws.iotsecuretunneling#ServiceList", "traits": { - "smithy.api#documentation": "

A list of service names that identity the target application. The AWS IoT client running on the destination device reads\n\t\t\tthis value and uses it to look up a port or an IP address and a port. The AWS IoT client\n\t\t\tinstantiates the local proxy which uses this information to connect to the destination\n\t\t\tapplication.

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

A list of service names that identify the target application. The IoT client\n\t\t\trunning on the destination device reads this value and uses it to look up a port or an\n\t\t\tIP address and a port. The IoT client instantiates the local proxy, which uses this\n\t\t\tinformation to connect to the destination application.

", "smithy.api#required": {} } } @@ -210,6 +229,21 @@ }, "com.amazonaws.iotsecuretunneling#IoTSecuredTunneling": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "IoTSecureTunneling", + "arnNamespace": "iotsecuredtunneling", + "cloudFormationName": "IoTSecureTunneling", + "cloudTrailEventSource": "iotsecuretunneling.amazonaws.com", + "endpointPrefix": "api.tunneling.iot" + }, + "aws.auth#sigv4": { + "name": "IoTSecuredTunneling" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "IoT Secure Tunneling\n\t\t

IoT Secure Tunneling creates remote connections to devices deployed in the\n\t\t\tfield.

\n\t\t

For more information about how IoT Secure Tunneling works, see IoT\n\t\t\t\tSecure Tunneling.

", + "smithy.api#title": "AWS IoT Secure Tunneling" + }, "version": "2018-10-05", "operations": [ { @@ -227,28 +261,16 @@ { "target": "com.amazonaws.iotsecuretunneling#OpenTunnel" }, + { + "target": "com.amazonaws.iotsecuretunneling#RotateTunnelAccessToken" + }, { "target": "com.amazonaws.iotsecuretunneling#TagResource" }, { "target": "com.amazonaws.iotsecuretunneling#UntagResource" } - ], - "traits": { - "aws.api#service": { - "sdkId": "IoTSecureTunneling", - "arnNamespace": "iotsecuredtunneling", - "cloudFormationName": "IoTSecureTunneling", - "cloudTrailEventSource": "iotsecuretunneling.amazonaws.com", - "endpointPrefix": "api.tunneling.iot" - }, - "aws.auth#sigv4": { - "name": "iotsecuredtunneling" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS IoT Secure Tunneling\n\t\t

AWS IoT Secure Tunnling enables you to create remote connections to devices\n\t\t\tdeployed in the field.

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

For more information about how AWS IoT Secure Tunneling works, see AWS IoT Secure Tunneling.

", - "smithy.api#title": "AWS IoT Secure Tunneling" - } + ] }, "com.amazonaws.iotsecuretunneling#LimitExceededException": { "type": "structure", @@ -258,6 +280,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceededException", + "httpResponseCode": 403 + }, "smithy.api#documentation": "

Thrown when a tunnel limit is exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -318,7 +344,7 @@ "target": "com.amazonaws.iotsecuretunneling#ListTunnelsResponse" }, "traits": { - "smithy.api#documentation": "

List all tunnels for an AWS account. Tunnels are listed by creation time in\n\t\t\tdescending order, newer tunnels will be listed before older tunnels.

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

List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in\n\t\t\tdescending order, newer tunnels will be listed before older tunnels.

\n\t\t

Requires permission to access the ListTunnels action.

", "smithy.api#http": { "method": "GET", "uri": "/tunnels", @@ -352,7 +378,7 @@ "nextToken": { "target": "com.amazonaws.iotsecuretunneling#NextToken", "traits": { - "smithy.api#documentation": "

A token to retrieve the next set of results.

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

To retrieve the next set of results, the nextToken value from a previous response;\n\t\t\totherwise null to receive the first set of results.

", "smithy.api#httpQuery": "nextToken" } } @@ -364,13 +390,13 @@ "tunnelSummaries": { "target": "com.amazonaws.iotsecuretunneling#TunnelSummaryList", "traits": { - "smithy.api#documentation": "

A short description of the tunnels in an AWS account.

" + "smithy.api#documentation": "

A short description of the tunnels in an Amazon Web Services account.

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

A token to used to retrieve the next set of results.

" + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional\n\t\t\tresults.

" } } } @@ -387,7 +413,7 @@ "com.amazonaws.iotsecuretunneling#NextToken": { "type": "string", "traits": { - "smithy.api#pattern": "[a-zA-Z0-9_=-]{1,4096}" + "smithy.api#pattern": "^[a-zA-Z0-9_=-]{1,4096}$" } }, "com.amazonaws.iotsecuretunneling#OpenTunnel": { @@ -404,7 +430,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new tunnel, and returns two client access tokens for clients to use to\n\t\t\tconnect to the AWS IoT Secure Tunneling proxy server.

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

Creates a new tunnel, and returns two client access tokens for clients to use to\n\t\t\tconnect to the IoT Secure Tunneling proxy server.

\n\t\t

Requires permission to access the OpenTunnel action.

", "smithy.api#http": { "method": "POST", "uri": "/tunnels", @@ -453,19 +479,19 @@ "tunnelArn": { "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name for the tunnel. The tunnel ARN format is\n\t\t\t\tarn:aws:tunnel:::tunnel/\n

" + "smithy.api#documentation": "

The Amazon Resource Name for the tunnel.

" } }, "sourceAccessToken": { "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", "traits": { - "smithy.api#documentation": "

The access token the source local proxy uses to connect to AWS IoT Secure\n\t\t\tTunneling.

" + "smithy.api#documentation": "

The access token the source local proxy uses to connect to IoT Secure\n\t\t\tTunneling.

" } }, "destinationAccessToken": { "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", "traits": { - "smithy.api#documentation": "

The access token the destination local proxy uses to connect to AWS IoT Secure\n\t\t\tTunneling.

" + "smithy.api#documentation": "

The access token the destination local proxy uses to connect to IoT Secure\n\t\t\tTunneling.

" } } } @@ -478,11 +504,83 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceNotFoundException", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

Thrown when an operation is attempted on a resource that does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, + "com.amazonaws.iotsecuretunneling#RotateTunnelAccessToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotsecuretunneling#RotateTunnelAccessTokenRequest" + }, + "output": { + "target": "com.amazonaws.iotsecuretunneling#RotateTunnelAccessTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotsecuretunneling#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Revokes the current client access token (CAT) and returns new CAT for clients to\n\t\t\tuse when reconnecting to secure tunneling to access the same tunnel.

\n\t\t

Requires permission to access the RotateTunnelAccessToken action.

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

Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel\n\t\t\t\tduration is 12 hours and the tunnel has already been open for 4 hours. When you\n\t\t\t\trotate the access tokens, the new tokens that are generated can only be used for the\n\t\t\t\tremaining 8 hours.

\n\t\t ", + "smithy.api#http": { + "method": "POST", + "uri": "/tunnel/{tunnelId}/rotate", + "code": 200 + } + } + }, + "com.amazonaws.iotsecuretunneling#RotateTunnelAccessTokenRequest": { + "type": "structure", + "members": { + "tunnelId": { + "target": "com.amazonaws.iotsecuretunneling#TunnelId", + "traits": { + "smithy.api#documentation": "

The tunnel for which you want to rotate the access tokens.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientMode": { + "target": "com.amazonaws.iotsecuretunneling#ClientMode", + "traits": { + "smithy.api#documentation": "

The mode of the client that will use the client token, which can be either the source\n\t\t\tor destination, or both source and destination.

", + "smithy.api#required": {} + } + }, + "destinationConfig": { + "target": "com.amazonaws.iotsecuretunneling#DestinationConfig" + } + } + }, + "com.amazonaws.iotsecuretunneling#RotateTunnelAccessTokenResponse": { + "type": "structure", + "members": { + "tunnelArn": { + "target": "com.amazonaws.iotsecuretunneling#TunnelArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name for the tunnel.

" + } + }, + "sourceAccessToken": { + "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", + "traits": { + "smithy.api#documentation": "

The client access token that the source local proxy uses to connect to IoT Secure\n\t\t\tTunneling.

" + } + }, + "destinationAccessToken": { + "target": "com.amazonaws.iotsecuretunneling#ClientAccessToken", + "traits": { + "smithy.api#documentation": "

The client access token that the destination local proxy uses to connect to IoT\n\t\t\tSecure Tunneling.

" + } + } + } + }, "com.amazonaws.iotsecuretunneling#Service": { "type": "string", "traits": { @@ -490,7 +588,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9:_-]+" + "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iotsecuretunneling#ServiceList": { @@ -622,7 +720,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9:_-]+" + "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iotsecuretunneling#TimeoutConfig": { @@ -661,7 +759,7 @@ "tunnelArn": { "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is\n\t\t\t\tarn:aws:tunnel:::tunnel/\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a tunnel.

" } }, "status": { @@ -735,7 +833,7 @@ "com.amazonaws.iotsecuretunneling#TunnelId": { "type": "string", "traits": { - "smithy.api#pattern": "[a-zA-Z0-9_\\-+=:]{1,128}" + "smithy.api#pattern": "^[a-zA-Z0-9_\\-+=:]{1,128}$" } }, "com.amazonaws.iotsecuretunneling#TunnelStatus": { @@ -765,7 +863,7 @@ "tunnelArn": { "target": "com.amazonaws.iotsecuretunneling#TunnelArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name of the tunnel. The tunnel ARN format is\n\t\t\t\tarn:aws:tunnel:::tunnel/\n

" + "smithy.api#documentation": "

The Amazon Resource Name of the tunnel.

" } }, "status": { diff --git a/aws/sdk/aws-models/ivschat.json b/aws/sdk/aws-models/ivschat.json new file mode 100644 index 000000000..c8938e1a7 --- /dev/null +++ b/aws/sdk/aws-models/ivschat.json @@ -0,0 +1,1626 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.ivschat#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.ivschat#AmazonInteractiveVideoServiceChat": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "ivschat", + "arnNamespace": "ivschat", + "cloudFormationName": "IVSChat", + "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE", + "endpointPrefix": "ivschat" + }, + "aws.auth#sigv4": { + "name": "ivschat" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "amz-sdk-invocation-id", + "amz-sdk-request", + "X-Api-Key", + "X-Amz-Content-Sha256", + "Content-Type", + "X-Amz-User-Agent" + ], + "additionalExposedHeaders": [ + "date", + "x-amz-apigw-id", + "x-amzn-trace-id", + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-errormessage" + ] + }, + "smithy.api#documentation": "

\n Introduction\n

\n

The Amazon IVS Chat control-plane API enables you to create and manage Amazon IVS Chat\n resources. You also need to integrate with the Amazon IVS Chat Messaging\n API, to enable users to interact with chat rooms in real time.

\n

The API is an AWS regional service. For a list of supported regions and Amazon IVS Chat\n HTTPS service endpoints, see the Amazon IVS Chat information on the Amazon IVS page in the\n AWS General Reference.

\n

\n Notes on terminology:\n

\n \n\n

\n Resources\n

\n

The following resource is part of Amazon IVS Chat:

\n \n\n

\n API Access Security\n

\n

Your Amazon IVS Chat applications (service applications and clients) must be authenticated\n and authorized to access Amazon IVS Chat resources. Note the differences between these\n concepts:

\n \n

Users (viewers) connect to a room using secure access tokens that you create using the\n CreateChatToken endpoint through the AWS SDK. You call CreateChatToken for\n every user’s chat session, passing identity and authorization information about the\n user.

\n

\n Signing API Requests\n

\n

HTTP API requests must be signed with an AWS SigV4 signature using your AWS security\n credentials. The AWS Command Line Interface (CLI) and the AWS SDKs take care of signing the\n underlying API calls for you. However, if your application calls the Amazon IVS Chat HTTP API\n directly, it’s your responsibility to sign the requests.

\n\n\n\n\n

You generate a signature using valid AWS credentials for an IAM role that has permission\n to perform the requested action. For example, DeleteMessage requests must be made using an IAM\n role that has the ivschat:DeleteMessage permission.

\n

For more information:

\n \n\n

\n Messaging Endpoints\n

\n \n

\n Chat Token Endpoint\n

\n \n\n\n

\n Room Endpoints\n

\n \n\n

\n Tags Endpoints\n

\n \n\n\n

All the above are HTTP operations. There is a separate messaging API\n for managing Chat resources; see the Amazon IVS Chat Messaging API\n Reference.

", + "smithy.api#title": "Amazon Interactive Video Service Chat" + }, + "version": "2020-07-14", + "operations": [ + { + "target": "com.amazonaws.ivschat#CreateChatToken" + }, + { + "target": "com.amazonaws.ivschat#CreateRoom" + }, + { + "target": "com.amazonaws.ivschat#DeleteMessage" + }, + { + "target": "com.amazonaws.ivschat#DeleteRoom" + }, + { + "target": "com.amazonaws.ivschat#DisconnectUser" + }, + { + "target": "com.amazonaws.ivschat#GetRoom" + }, + { + "target": "com.amazonaws.ivschat#ListRooms" + }, + { + "target": "com.amazonaws.ivschat#ListTagsForResource" + }, + { + "target": "com.amazonaws.ivschat#SendEvent" + }, + { + "target": "com.amazonaws.ivschat#TagResource" + }, + { + "target": "com.amazonaws.ivschat#UntagResource" + }, + { + "target": "com.amazonaws.ivschat#UpdateRoom" + } + ] + }, + "com.amazonaws.ivschat#ChatToken": { + "type": "string" + }, + "com.amazonaws.ivschat#ChatTokenAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.ivschat#String" + }, + "value": { + "target": "com.amazonaws.ivschat#String" + } + }, + "com.amazonaws.ivschat#ChatTokenCapabilities": { + "type": "list", + "member": { + "target": "com.amazonaws.ivschat#ChatTokenCapability" + } + }, + "com.amazonaws.ivschat#ChatTokenCapability": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SEND_MESSAGE", + "name": "SEND_MESSAGE" + }, + { + "value": "DISCONNECT_USER", + "name": "DISCONNECT_USER" + }, + { + "value": "DELETE_MESSAGE", + "name": "DELETE_MESSAGE" + } + ] + } + }, + "com.amazonaws.ivschat#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.ivschat#ResourceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.ivschat#ResourceType", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.ivschat#CreateChatToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#CreateChatTokenRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#CreateChatTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#PendingVerification" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an encrypted token that is used to establish an individual WebSocket connection\n to a room. The token is valid for one minute, and a connection (session) established with\n the token is valid for the specified duration.

\n

Encryption keys are owned by Amazon IVS Chat and never used directly by your\n application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateChatToken", + "code": 200 + } + } + }, + "com.amazonaws.ivschat#CreateChatTokenRequest": { + "type": "structure", + "members": { + "roomIdentifier": { + "target": "com.amazonaws.ivschat#RoomIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the room that the client is trying to access. Currently this must be an\n ARN.

", + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.ivschat#UserID", + "traits": { + "smithy.api#documentation": "

Application-provided ID that uniquely identifies the user associated with this token.\n This can be any UTF-8 encoded text.

", + "smithy.api#required": {} + } + }, + "capabilities": { + "target": "com.amazonaws.ivschat#ChatTokenCapabilities", + "traits": { + "smithy.api#documentation": "

Set of capabilities that the user is allowed to perform in the room. Default: None (the\n capability to view messages is implicitly included in all requests).

" + } + }, + "sessionDurationInMinutes": { + "target": "com.amazonaws.ivschat#SessionDurationInMinutes", + "traits": { + "smithy.api#documentation": "

Session duration (in minutes), after which the session expires. Default: 60 (1\n hour).

" + } + }, + "attributes": { + "target": "com.amazonaws.ivschat#ChatTokenAttributes", + "traits": { + "smithy.api#documentation": "

Application-provided attributes to encode into the token and attach to a chat session.\n Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1\n KB total.

" + } + } + } + }, + "com.amazonaws.ivschat#CreateChatTokenResponse": { + "type": "structure", + "members": { + "token": { + "target": "com.amazonaws.ivschat#ChatToken", + "traits": { + "smithy.api#documentation": "

The issued client token, encrypted.

" + } + }, + "tokenExpirationTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time after which the token is no longer valid and cannot be used to connect to a room.\n This is an ISO 8601 timestamp; note that this is returned as a\n string.

" + } + }, + "sessionExpirationTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time after which an end user's session is no longer valid. This is an ISO 8601\n timestamp; note that this is returned as a string.

" + } + } + } + }, + "com.amazonaws.ivschat#CreateRoom": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#CreateRoomRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#CreateRoomResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#ConflictException" + }, + { + "target": "com.amazonaws.ivschat#PendingVerification" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a room that allows clients to connect and pass messages.

", + "smithy.api#http": { + "method": "POST", + "uri": "/CreateRoom", + "code": 200 + } + } + }, + "com.amazonaws.ivschat#CreateRoomRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivschat#RoomName", + "traits": { + "smithy.api#documentation": "

Room name. The value does not need to be unique.

" + } + }, + "maximumMessageRatePerSecond": { + "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", + "traits": { + "smithy.api#documentation": "

Maximum number of messages per second that a client can send to the room. Default:\n 10.

" + } + }, + "maximumMessageLength": { + "target": "com.amazonaws.ivschat#RoomMaxMessageLength", + "traits": { + "smithy.api#documentation": "

Maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" + } + }, + "messageReviewHandler": { + "target": "com.amazonaws.ivschat#MessageReviewHandler", + "traits": { + "smithy.api#documentation": "

Configuration information for optional review of messages.

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

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value).

" + } + } + } + }, + "com.amazonaws.ivschat#CreateRoomResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivschat#RoomArn", + "traits": { + "smithy.api#documentation": "

Room ARN, assigned by the system.

" + } + }, + "id": { + "target": "com.amazonaws.ivschat#RoomID", + "traits": { + "smithy.api#documentation": "

Room ID, generated by the system. This is a relative identifier, the part of the ARN\n that uniquely identifies the room.

" + } + }, + "name": { + "target": "com.amazonaws.ivschat#RoomName", + "traits": { + "smithy.api#documentation": "

Room name, from the request (if specified).

" + } + }, + "createTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time when the room was created. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" + } + }, + "updateTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time of the room’s last update. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" + } + }, + "maximumMessageRatePerSecond": { + "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", + "traits": { + "smithy.api#documentation": "

Maximum number of messages per second that a client can send to the room, from the\n request.

" + } + }, + "maximumMessageLength": { + "target": "com.amazonaws.ivschat#RoomMaxMessageLength", + "traits": { + "smithy.api#documentation": "

Maximum number of characters in a single message, from the request.

" + } + }, + "messageReviewHandler": { + "target": "com.amazonaws.ivschat#MessageReviewHandler", + "traits": { + "smithy.api#documentation": "

Configuration information for optional review of messages.

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

Tags attached to the resource, from the request.

" + } + } + } + }, + "com.amazonaws.ivschat#DeleteMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#DeleteMessageRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#DeleteMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ThrottlingException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends an event to a specific room which directs clients to delete a specific message;\n that is, unrender it from view and delete it from the client’s chat history. This event’s\n EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation\n in the Amazon IVS Chat Messaging API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteMessage", + "code": 200 + } + } + }, + "com.amazonaws.ivschat#DeleteMessageRequest": { + "type": "structure", + "members": { + "roomIdentifier": { + "target": "com.amazonaws.ivschat#RoomIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the room where the message should be deleted. Currently this must be an\n ARN.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.ivschat#MessageID", + "traits": { + "smithy.api#documentation": "

ID of the message to be deleted. This is the Id field in the received\n message (see Message\n (Subscribe) in the Chat Messaging API).

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.ivschat#Reason", + "traits": { + "smithy.api#documentation": "

Reason for deleting the message.

" + } + } + } + }, + "com.amazonaws.ivschat#DeleteMessageResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ivschat#ID", + "traits": { + "smithy.api#documentation": "

Operation identifier, generated by Amazon IVS Chat.

" + } + } + } + }, + "com.amazonaws.ivschat#DeleteRoom": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#DeleteRoomRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified room.

", + "smithy.api#http": { + "method": "POST", + "uri": "/DeleteRoom", + "code": 204 + } + } + }, + "com.amazonaws.ivschat#DeleteRoomRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.ivschat#RoomIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the room to be deleted. Currently this must be an ARN.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivschat#DisconnectUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#DisconnectUserRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#DisconnectUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ThrottlingException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation\n in the Amazon IVS Chat Messaging API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/DisconnectUser", + "code": 200 + } + } + }, + "com.amazonaws.ivschat#DisconnectUserRequest": { + "type": "structure", + "members": { + "roomIdentifier": { + "target": "com.amazonaws.ivschat#RoomIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the room from which the user's clients should be disconnected. Currently\n this must be an ARN.

", + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.ivschat#UserID", + "traits": { + "smithy.api#documentation": "

ID of the user (connection) to disconnect from the room.

", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.ivschat#Reason", + "traits": { + "smithy.api#documentation": "

Reason for disconnecting the user.

" + } + } + } + }, + "com.amazonaws.ivschat#DisconnectUserResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ivschat#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.ivschat#EventAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.ivschat#String" + }, + "value": { + "target": "com.amazonaws.ivschat#String" + } + }, + "com.amazonaws.ivschat#EventName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.ivschat#FallbackResult": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOW", + "name": "ALLOW" + }, + { + "value": "DENY", + "name": "DENY" + } + ] + } + }, + "com.amazonaws.ivschat#FieldName": { + "type": "string" + }, + "com.amazonaws.ivschat#GetRoom": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#GetRoomRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#GetRoomResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the specified room.

", + "smithy.api#http": { + "method": "POST", + "uri": "/GetRoom", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivschat#GetRoomRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.ivschat#RoomIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the room for which the configuration is to be retrieved. Currently this\n must be an ARN.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivschat#GetRoomResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivschat#RoomArn", + "traits": { + "smithy.api#documentation": "

Room ARN, from the request (if identifier was an ARN).

" + } + }, + "id": { + "target": "com.amazonaws.ivschat#RoomID", + "traits": { + "smithy.api#documentation": "

Room ID, generated by the system. This is a relative identifier, the part of the ARN\n that uniquely identifies the room.

" + } + }, + "name": { + "target": "com.amazonaws.ivschat#RoomName", + "traits": { + "smithy.api#documentation": "

Room name. The value does not need to be unique.

" + } + }, + "createTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time when the room was created. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" + } + }, + "updateTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time of the room’s last update. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" + } + }, + "maximumMessageRatePerSecond": { + "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", + "traits": { + "smithy.api#documentation": "

Maximum number of messages per second that a client can send to the room. Default:\n 10.

" + } + }, + "maximumMessageLength": { + "target": "com.amazonaws.ivschat#RoomMaxMessageLength", + "traits": { + "smithy.api#documentation": "

Maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" + } + }, + "messageReviewHandler": { + "target": "com.amazonaws.ivschat#MessageReviewHandler", + "traits": { + "smithy.api#documentation": "

Configuration information for optional review of messages.

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

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value).

" + } + } + } + }, + "com.amazonaws.ivschat#ID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.ivschat#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.ivschat#LambdaArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 170 + }, + "smithy.api#pattern": "^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+" + } + }, + "com.amazonaws.ivschat#Limit": { + "type": "integer" + }, + "com.amazonaws.ivschat#ListRooms": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#ListRoomsRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#ListRoomsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets summary information about all your rooms in the AWS region where the API request is\n processed. Results are sorted in descending order of updateTime.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListRooms", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivschat#ListRoomsRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivschat#RoomName", + "traits": { + "smithy.api#documentation": "

Filters the list to match the specified room name.

" + } + }, + "nextToken": { + "target": "com.amazonaws.ivschat#PaginationToken", + "traits": { + "smithy.api#documentation": "

The first room to retrieve. This is used for pagination; see the nextToken\n response field.

" + } + }, + "maxResults": { + "target": "com.amazonaws.ivschat#MaxRoomResults", + "traits": { + "smithy.api#documentation": "

Maximum number of rooms to return. Default: 50.

" + } + }, + "messageReviewHandlerUri": { + "target": "com.amazonaws.ivschat#LambdaArn", + "traits": { + "smithy.api#documentation": "

Filters the list to match the specified message review handler URI.

" + } + } + } + }, + "com.amazonaws.ivschat#ListRoomsResponse": { + "type": "structure", + "members": { + "rooms": { + "target": "com.amazonaws.ivschat#RoomList", + "traits": { + "smithy.api#documentation": "

List of the matching rooms (summary information only).

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ivschat#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more rooms than maxResults, use nextToken in the\n request to get the next set.

" + } + } + } + }, + "com.amazonaws.ivschat#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#InternalServerException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about AWS tags for the specified ARN.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivschat#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ivschat#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to be retrieved. The ARN must be URL-encoded.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivschat#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.ivschat#Tags", + "traits": { + "smithy.api#documentation": "

Tags to attach to the resource. Array of maps, each of the form string:string\n (key:value).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivschat#MaxRoomResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ivschat#MessageID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.ivschat#MessageReviewHandler": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.ivschat#LambdaArn", + "traits": { + "smithy.api#documentation": "

Identifier of the message review handler. Currently this must be an ARN of a lambda function.

" + } + }, + "fallbackResult": { + "target": "com.amazonaws.ivschat#FallbackResult", + "traits": { + "smithy.api#documentation": "

Specifies the fallback behavior (whether the message is allowed or denied) if the handler\n does not return a valid response, encounters an error or times out. If allowed, the message is\n delivered with returned content to all users connected to the room. If denied, the message is\n not delivered to any user. Default: ALLOW.

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

Configuration information for optional message review.

" + } + }, + "com.amazonaws.ivschat#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.ivschat#PendingVerification": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.ivschat#Reason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.ivschat#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivschat#ResourceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.ivschat#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.ivschat#ResourceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.ivschat#ResourceType", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.ivschat#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ROOM", + "name": "ROOM" + } + ] + } + }, + "com.amazonaws.ivschat#RoomArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivschat#RoomID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.ivschat#RoomIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivschat#RoomList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivschat#RoomSummary" + } + }, + "com.amazonaws.ivschat#RoomMaxMessageLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.ivschat#RoomName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.ivschat#RoomSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivschat#RoomArn", + "traits": { + "smithy.api#documentation": "

Room ARN.

" + } + }, + "id": { + "target": "com.amazonaws.ivschat#RoomID", + "traits": { + "smithy.api#documentation": "

Room ID, generated by the system. This is a relative identifier, the part of the ARN that\n uniquely identifies the room.

" + } + }, + "name": { + "target": "com.amazonaws.ivschat#RoomName", + "traits": { + "smithy.api#documentation": "

Room name. The value does not need to be unique.

" + } + }, + "messageReviewHandler": { + "target": "com.amazonaws.ivschat#MessageReviewHandler", + "traits": { + "smithy.api#documentation": "

Configuration information for optional review of messages.

" + } + }, + "createTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time when the room was created. This is an ISO 8601 timestamp; note that this is\n returned as a string.

" + } + }, + "updateTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time of the room’s last update. This is an ISO 8601 timestamp; note that this is\n returned as a string.

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

Tags attached to the resource.

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

Summary information about a room.

" + } + }, + "com.amazonaws.ivschat#SendEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#SendEventRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#SendEventResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ThrottlingException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends an event to a room. Use this within your application’s business logic to send\n events to clients of a room; e.g., to notify clients to change the way the chat UI is\n rendered.

", + "smithy.api#http": { + "method": "POST", + "uri": "/SendEvent", + "code": 200 + } + } + }, + "com.amazonaws.ivschat#SendEventRequest": { + "type": "structure", + "members": { + "roomIdentifier": { + "target": "com.amazonaws.ivschat#RoomIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the room to which the event will be sent. Currently this must be an\n ARN.

", + "smithy.api#required": {} + } + }, + "eventName": { + "target": "com.amazonaws.ivschat#EventName", + "traits": { + "smithy.api#documentation": "

Application-defined name of the event to send to clients.

", + "smithy.api#required": {} + } + }, + "attributes": { + "target": "com.amazonaws.ivschat#EventAttributes", + "traits": { + "smithy.api#documentation": "

Application-defined metadata to attach to the event sent to clients. The maximum length\n of the metadata is 1 KB total.

" + } + } + } + }, + "com.amazonaws.ivschat#SendEventResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.ivschat#ID", + "traits": { + "smithy.api#documentation": "

An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent\n operations for this message, such as DeleteMessage.

" + } + } + } + }, + "com.amazonaws.ivschat#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.ivschat#ResourceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.ivschat#ResourceType", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "limit": { + "target": "com.amazonaws.ivschat#Limit", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.ivschat#SessionDurationInMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 180 + } + } + }, + "com.amazonaws.ivschat#String": { + "type": "string" + }, + "com.amazonaws.ivschat#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.ivschat#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivschat#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ivschat#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#InternalServerException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates tags for the AWS resource with the specified ARN.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.ivschat#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ivschat#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to be tagged. The ARN must be URL-encoded.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.ivschat#Tags", + "traits": { + "smithy.api#documentation": "

Array of tags to be added or updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivschat#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ivschat#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.ivschat#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.ivschat#TagKey" + }, + "value": { + "target": "com.amazonaws.ivschat#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.ivschat#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.ivschat#ResourceId", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.ivschat#ResourceType", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "limit": { + "target": "com.amazonaws.ivschat#Limit", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.ivschat#Time": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.ivschat#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#InternalServerException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from the resource with the specified ARN.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ivschat#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.ivschat#ResourceArn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource to be untagged. The ARN must be URL-encoded.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.ivschat#TagKeyList", + "traits": { + "smithy.api#documentation": "

Array of tags to be removed.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ivschat#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.ivschat#UpdateRoom": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivschat#UpdateRoomRequest" + }, + "output": { + "target": "com.amazonaws.ivschat#UpdateRoomResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivschat#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivschat#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivschat#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a room’s configuration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateRoom", + "code": 200 + } + } + }, + "com.amazonaws.ivschat#UpdateRoomRequest": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.ivschat#RoomIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the room to be updated. Currently this must be an ARN.

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

Room name. The value does not need to be unique.

" + } + }, + "maximumMessageRatePerSecond": { + "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", + "traits": { + "smithy.api#documentation": "

The maximum number of messages per second that a client can send to the room. Default:\n 10.

" + } + }, + "maximumMessageLength": { + "target": "com.amazonaws.ivschat#RoomMaxMessageLength", + "traits": { + "smithy.api#documentation": "

The maximum number of characters in a single message. Messages are expected to be UTF-8\n encoded and this limit applies specifically to rune/code-point count, not number of bytes.\n Default: 500.

" + } + }, + "messageReviewHandler": { + "target": "com.amazonaws.ivschat#MessageReviewHandler", + "traits": { + "smithy.api#documentation": "

Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.

" + } + } + } + }, + "com.amazonaws.ivschat#UpdateRoomResponse": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivschat#RoomArn", + "traits": { + "smithy.api#documentation": "

Room ARN, from the request (if identifier was an ARN).

" + } + }, + "id": { + "target": "com.amazonaws.ivschat#RoomID", + "traits": { + "smithy.api#documentation": "

Room ID, generated by the system. This is a relative identifier, the part of the ARN\n that uniquely identifies the room.

" + } + }, + "name": { + "target": "com.amazonaws.ivschat#RoomName", + "traits": { + "smithy.api#documentation": "

Room name, from the request.

" + } + }, + "createTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time when the room was created. This is an ISO 8601 timestamp; note that this\n is returned as a string.

" + } + }, + "updateTime": { + "target": "com.amazonaws.ivschat#Time", + "traits": { + "smithy.api#documentation": "

Time of the room’s last update. This is an ISO 8601 timestamp; note\n that this is returned as a string.

" + } + }, + "maximumMessageRatePerSecond": { + "target": "com.amazonaws.ivschat#RoomMaxMessageRatePerSecond", + "traits": { + "smithy.api#documentation": "

Maximum number of messages per second that a client can send to the room, from the\n request.

" + } + }, + "maximumMessageLength": { + "target": "com.amazonaws.ivschat#RoomMaxMessageLength", + "traits": { + "smithy.api#documentation": "

Maximum number of characters in a single message, from the request.

" + } + }, + "messageReviewHandler": { + "target": "com.amazonaws.ivschat#MessageReviewHandler", + "traits": { + "smithy.api#documentation": "

Configuration information for optional review of messages.

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

Tags attached to the resource.

" + } + } + } + }, + "com.amazonaws.ivschat#UserID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.ivschat#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.ivschat#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.ivschat#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

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

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.ivschat#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivschat#FieldName", + "traits": { + "smithy.api#documentation": "

Name of the field which failed validation.

", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.ivschat#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Explanation of the reason for the validation error.

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

This object is used in the ValidationException error.

" + } + }, + "com.amazonaws.ivschat#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivschat#ValidationExceptionField" + } + }, + "com.amazonaws.ivschat#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + } + } +} diff --git a/aws/sdk/aws-models/kendra.json b/aws/sdk/aws-models/kendra.json index 7101e463c..1b629f508 100644 --- a/aws/sdk/aws-models/kendra.json +++ b/aws/sdk/aws-models/kendra.json @@ -4805,7 +4805,7 @@ } }, "traits": { - "smithy.api#documentation": "

A custom attribute value assigned to a document.

\n

For more information on how to create custom document attributes, see \n Custom \n Attributes.

" + "smithy.api#documentation": "

A document attribute or metadata field. To create custom document \n attributes, see Custom attributes.

" } }, "com.amazonaws.kendra#DocumentAttributeCondition": { @@ -4934,7 +4934,7 @@ } }, "traits": { - "smithy.api#documentation": "

The value of a custom document attribute. You can only provide one\n value for a custom attribute.

" + "smithy.api#documentation": "

The value of a document attribute. You can only provide one\n value for a document attribute.

" } }, "com.amazonaws.kendra#DocumentAttributeValueCountPair": { @@ -4943,7 +4943,7 @@ "DocumentAttributeValue": { "target": "com.amazonaws.kendra#DocumentAttributeValue", "traits": { - "smithy.api#documentation": "

The value of the attribute. For example, \"HR.\"

" + "smithy.api#documentation": "

The value of the attribute. For example, \"HR\".

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

The number of documents in the response that have the attribute\n value for the key.

" } + }, + "FacetResults": { + "target": "com.amazonaws.kendra#FacetResultList", + "traits": { + "smithy.api#documentation": "

Contains the results of a document attribute that is a nested facet. \n A FacetResult contains the counts for each facet nested \n within a facet.

\n

For example, the document attribute or facet \"Department\" includes a \n value called \"Engineering\". In addition, the document attribute \n or facet \"SubDepartment\" includes the values \"Frontend\" and \"Backend\" \n for documents assigned to \"Engineering\". You can display nested facets \n in the search results so that documents can be searched not only by \n department but also by a sub department within a department. The counts \n for documents that belong to \"Frontend\" and \"Backend\" within \"Engineering\" \n are returned for a query.

" + } } }, "traits": { @@ -5619,10 +5625,22 @@ "traits": { "smithy.api#documentation": "

The unique key for the document attribute.

" } + }, + "Facets": { + "target": "com.amazonaws.kendra#FacetList", + "traits": { + "smithy.api#documentation": "

An array of document attributes that are nested facets within a facet.

\n

For example, the document attribute or facet \"Department\" includes a \n value called \"Engineering\". In addition, the document attribute or \n facet \"SubDepartment\" includes the values \"Frontend\" and \"Backend\" for documents \n assigned to \"Engineering\". You can display nested facets in the search results \n so that documents can be searched not only by department but also by a sub \n department within a department. This helps your users further narrow their \n search.

\n

You can only have one nested facet within a facet. If you want to increase \n this limit, contact Support.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.kendra#TopDocumentAttributeValueCountPairsSize", + "traits": { + "smithy.api#documentation": "

Maximum number of facet values per facet. The default is 10. You can use \n this to limit the number of facet values to less than 10. If you want to \n increase the default, contact Support.

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

Information about a document attribute

" + "smithy.api#documentation": "

Information about a document attribute. You can use document \n attributes as facets.

\n

For example, the document attribute or facet \"Department\" includes \n the values \"HR\", \"Engineering\", and \"Accounting\". You can display these \n values in the search results so that documents can be searched by department.

\n

You can display up to 10 facet values per facet for a query. If you want to \n increase this limit, contact Support.

" } }, "com.amazonaws.kendra#FacetList": { @@ -7283,7 +7301,12 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of FAQ lists associated with an index.

" + "smithy.api#documentation": "

Gets a list of FAQ lists associated with an index.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, "com.amazonaws.kendra#ListFaqsRequest": { @@ -7356,7 +7379,12 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of groups that are mapped to users before a \n given ordering or timestamp identifier.

\n

\n ListGroupsOlderThanOrderingId is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.

" + "smithy.api#documentation": "

Provides a list of groups that are mapped to users before a \n given ordering or timestamp identifier.

\n

\n ListGroupsOlderThanOrderingId is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, "com.amazonaws.kendra#ListGroupsOlderThanOrderingIdRequest": { @@ -7510,7 +7538,12 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the block lists used for query suggestions for an index.

\n

For information on the current quota limits for block lists, see \n Quotas \n for Amazon Kendra.

\n

\n ListQuerySuggestionsBlockLists is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.

" + "smithy.api#documentation": "

Lists the block lists used for query suggestions for an index.

\n

For information on the current quota limits for block lists, see \n Quotas \n for Amazon Kendra.

\n

\n ListQuerySuggestionsBlockLists is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, "com.amazonaws.kendra#ListQuerySuggestionsBlockListsRequest": { @@ -7632,7 +7665,12 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the Amazon Kendra thesauri associated with an index.

" + "smithy.api#documentation": "

Lists the Amazon Kendra thesauri associated with an index.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } } }, "com.amazonaws.kendra#ListThesauriRequest": { @@ -8479,13 +8517,13 @@ "Facets": { "target": "com.amazonaws.kendra#FacetList", "traits": { - "smithy.api#documentation": "

An array of documents attributes. Amazon Kendra returns a count for\n each attribute key specified. You can use this information to help\n narrow the search for your user.

" + "smithy.api#documentation": "

An array of documents attributes. Amazon Kendra returns a count for\n each attribute key specified. This helps your users narrow their search.

" } }, "RequestedDocumentAttributes": { "target": "com.amazonaws.kendra#DocumentAttributeKeyList", "traits": { - "smithy.api#documentation": "

An array of document attributes to include in the response. No other\n document attributes are included in the response. By default all\n document attributes are included in the response.

" + "smithy.api#documentation": "

An array of document attributes to include in the response. \n You can limit the response to include certain document attributes. \n By default all document attributes are included in the response.

" } }, "QueryResultTypeFilter": { @@ -8627,7 +8665,7 @@ "DocumentAttributes": { "target": "com.amazonaws.kendra#DocumentAttributeList", "traits": { - "smithy.api#documentation": "

An array of document attributes for the document that the query\n result maps to. For example, the document author (Author) or the source\n URI (SourceUri) of the document.

" + "smithy.api#documentation": "

An array of document attributes assigned to a document in \n the search results. For example, the document author (_author) \n or the source URI (_source_uri) of the document.

" } }, "ScoreAttributes": { @@ -8812,33 +8850,33 @@ "Domain": { "target": "com.amazonaws.kendra#Domain", "traits": { - "smithy.api#documentation": "

The configuration information to connect to your Quip data source domain.

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

The Quip site domain.

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

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the\n key-value pairs\n that are\n required to connect to your Quip file system. Windows is currently the\n only supported type. The secret must contain a JSON structure with the following\n keys:

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

The Amazon Resource Name (ARN) of an Secrets Manager secret \n that contains the key-value pairs that are required to connect to your \n Quip. The secret must contain a JSON structure with the following keys:

\n ", "smithy.api#required": {} } }, "CrawlFileComments": { "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

Specify whether to crawl file comments in your Quip data source. \n You can specify one or more of these options.

" + "smithy.api#documentation": "

Specify whether to crawl file comments in Quip. \n You can specify one or more of these options.

" } }, "CrawlChatRooms": { "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

Specify whether to crawl chat rooms in your Quip data source. \n You can specify one or more of these options.

" + "smithy.api#documentation": "

Specify whether to crawl chat rooms in Quip. \n You can specify one or more of these options.

" } }, "CrawlAttachments": { "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "

Specify whether to crawl attachments in your Quip data source. \n You can specify one or more of these options.

" + "smithy.api#documentation": "

Specify whether to crawl attachments in Quip. \n You can specify one or more of these options.

" } }, "FolderIds": { @@ -8850,37 +8888,37 @@ "ThreadFieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip threads.

" + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map \n attributes or field names of Quip threads to Amazon Kendra index \n field names. To create custom fields, use the UpdateIndex \n API before you map to Quip fields. For more information, see \n Mapping \n data source fields. The Quip field names must exist in your \n Quip custom metadata.

" } }, "MessageFieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip messages.

" + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map \n attributes or field names of Quip messages to Amazon Kendra index \n field names. To create custom fields, use the UpdateIndex \n API before you map to Quip fields. For more information, see \n Mapping \n data source fields. The Quip field names must exist in your \n Quip custom metadata.

" } }, "AttachmentFieldMappings": { "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", "traits": { - "smithy.api#documentation": "

A list of field mappings to apply when indexing Quip attachments.

" + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map \n attributes or field names of Quip attachments to Amazon Kendra index \n field names. To create custom fields, use the UpdateIndex \n API before you map to Quip fields. For more information, see \n Mapping \n data source fields. The Quip field names must exist in your \n Quip custom metadata.

" } }, "InclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns to include certain files in your Quip file\n system. Files that match the patterns are included in the index. Files that don't match\n the patterns are excluded from the index. If a file matches both an inclusion pattern\n and an exclusion pattern, the exclusion pattern takes\n precedence,\n and the file isn't included in the index.

" + "smithy.api#documentation": "

A list of regular expression patterns to include certain files in your Quip file\n system. Files that match the patterns are included in the index. Files that don't match\n the patterns are excluded from the index. If a file matches both an inclusion pattern\n and an exclusion pattern, the exclusion pattern takes\n precedence, and the file isn't included in the index.

" } }, "ExclusionPatterns": { "target": "com.amazonaws.kendra#DataSourceInclusionsExclusionsStrings", "traits": { - "smithy.api#documentation": "

A list of regular expression patterns to exclude certain files in your Quip file\n system. Files that match the patterns are excluded from the index. Files that don’t\n match the patterns are included in the index. If a file matches both an inclusion\n pattern and an exclusion pattern, the exclusion pattern takes\n precedence,\n and the file isn't included in the index.

" + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain files in your Quip file\n system. Files that match the patterns are excluded from the index. Files that don’t\n match the patterns are included in the index. If a file matches both an inclusion\n pattern and an exclusion pattern, the exclusion pattern takes\n precedence, and the file isn't included in the index.

" } }, "VpcConfiguration": { "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", "traits": { - "smithy.api#documentation": "

Configuration information for connecting to an Amazon Virtual Private Cloud\n (VPC)\n for your Quip. Your Quip instance must reside inside your VPC.

" + "smithy.api#documentation": "

Configuration information for an Amazon Virtual Private Cloud\n (VPC) to connect to your Quip. For more information, see \n Configuring \n a VPC.

" } } }, @@ -10993,6 +11031,15 @@ "smithy.api#pattern": "^\\P{C}*$" } }, + "com.amazonaws.kendra#TopDocumentAttributeValueCountPairsSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 5000 + } + } + }, "com.amazonaws.kendra#UntagResource": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/kinesis-video-archived-media.json b/aws/sdk/aws-models/kinesis-video-archived-media.json index 246030df8..7c144a7b8 100644 --- a/aws/sdk/aws-models/kinesis-video-archived-media.json +++ b/aws/sdk/aws-models/kinesis-video-archived-media.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.kinesisvideoarchivedmedia#AWSAcuityReader": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Kinesis Video Archived Media", + "arnNamespace": "kinesisvideo", + "cloudFormationName": "KinesisVideoArchivedMedia", + "cloudTrailEventSource": "kinesisvideoarchivedmedia.amazonaws.com", + "endpointPrefix": "kinesisvideo" + }, + "aws.auth#sigv4": { + "name": "kinesisvideo" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

", + "smithy.api#title": "Amazon Kinesis Video Streams Archived Media" + }, "version": "2017-09-30", "operations": [ { @@ -42,28 +57,16 @@ { "target": "com.amazonaws.kinesisvideoarchivedmedia#GetHLSStreamingSessionURL" }, + { + "target": "com.amazonaws.kinesisvideoarchivedmedia#GetImages" + }, { "target": "com.amazonaws.kinesisvideoarchivedmedia#GetMediaForFragmentList" }, { "target": "com.amazonaws.kinesisvideoarchivedmedia#ListFragments" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Kinesis Video Archived Media", - "arnNamespace": "kinesisvideo", - "cloudFormationName": "KinesisVideoArchivedMedia", - "cloudTrailEventSource": "kinesisvideoarchivedmedia.amazonaws.com", - "endpointPrefix": "kinesisvideo" - }, - "aws.auth#sigv4": { - "name": "kinesisvideo" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

", - "smithy.api#title": "Amazon Kinesis Video Streams Archived Media" - } + ] }, "com.amazonaws.kinesisvideoarchivedmedia#ClientLimitExceededException": { "type": "structure", @@ -292,6 +295,57 @@ } } }, + "com.amazonaws.kinesisvideoarchivedmedia#Format": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "JPEG", + "name": "JPEG" + }, + { + "value": "PNG", + "name": "PNG" + } + ] + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#FormatConfig": { + "type": "map", + "key": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#FormatConfigKey" + }, + "value": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#FormatConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#FormatConfigKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "JPEGQuality", + "name": "JPEGQuality" + } + ] + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#FormatConfigValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9]+$" + } + }, "com.amazonaws.kinesisvideoarchivedmedia#Fragment": { "type": "structure", "members": { @@ -704,6 +758,146 @@ } } }, + "com.amazonaws.kinesisvideoarchivedmedia#GetImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#GetImagesInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#GetImagesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideoarchivedmedia#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideoarchivedmedia#NotAuthorizedException" + }, + { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

", + "smithy.api#http": { + "method": "POST", + "uri": "/getImages", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#GetImagesInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

" + } + }, + "ImageSelectorType": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ImageSelectorType", + "traits": { + "smithy.api#documentation": "

The origin of the Server or Producer timestamps to use to generate the images.

", + "smithy.api#required": {} + } + }, + "StartTimestamp": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", + "traits": { + "smithy.api#documentation": "

The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

", + "smithy.api#required": {} + } + }, + "EndTimestamp": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", + "traits": { + "smithy.api#documentation": "

The end timestamp for the range of images to be generated.

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

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 3000 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available.\n

\n \n

The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.

\n ", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Format", + "traits": { + "smithy.api#documentation": "

The format that will be used to encode the image.

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

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image.\n The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. \n If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.

" + } + }, + "WidthPixels": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#WidthPixels", + "traits": { + "smithy.api#documentation": "

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, \n the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. \n If neither parameter is provided, the original image size from the stream will be returned.

" + } + }, + "HeightPixels": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#HeightPixels", + "traits": { + "smithy.api#documentation": "

The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the \n specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, \n the original image size will be returned.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#GetImagesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of images to be returned by the API.

\n \n

The default limit is 100 images per API response. The additional results will be paginated.

\n " + } + }, + "NextToken": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#NextToken", + "traits": { + "smithy.api#documentation": "

A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.

" + } + } + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#GetImagesMaxResults": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#GetImagesOutput": { + "type": "structure", + "members": { + "Images": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Images", + "traits": { + "smithy.api#documentation": "

The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. \n If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.

" + } + }, + "NextToken": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#NextToken", + "traits": { + "smithy.api#documentation": "

The encrypted token that was used in the request to get more images.

" + } + } + } + }, "com.amazonaws.kinesisvideoarchivedmedia#GetMediaForFragmentList": { "type": "operation", "input": { @@ -899,6 +1093,87 @@ "smithy.api#documentation": "

The start and end of the timestamp range for the requested media.

\n

This value should not be present if PlaybackType is\n LIVE.

" } }, + "com.amazonaws.kinesisvideoarchivedmedia#HeightPixels": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 2160 + } + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#Image": { + "type": "structure", + "members": { + "TimeStamp": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Timestamp", + "traits": { + "smithy.api#documentation": "

An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination\n window.

" + } + }, + "Error": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ImageError", + "traits": { + "smithy.api#documentation": "

The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if:

\n \n " + } + }, + "ImageContent": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#ImageContent", + "traits": { + "smithy.api#documentation": "

An attribute of the Image object that is Base64 encoded.

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

A structure that contains the Timestamp, Error, and ImageContent.

" + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#ImageContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6291456 + } + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#ImageError": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NO_MEDIA", + "name": "NO_MEDIA" + }, + { + "value": "MEDIA_ERROR", + "name": "MEDIA_ERROR" + } + ] + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#ImageSelectorType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRODUCER_TIMESTAMP", + "name": "PRODUCER_TIMESTAMP" + }, + { + "value": "SERVER_TIMESTAMP", + "name": "SERVER_TIMESTAMP" + } + ] + } + }, + "com.amazonaws.kinesisvideoarchivedmedia#Images": { + "type": "list", + "member": { + "target": "com.amazonaws.kinesisvideoarchivedmedia#Image" + } + }, "com.amazonaws.kinesisvideoarchivedmedia#InvalidArgumentException": { "type": "structure", "members": { @@ -1054,7 +1329,7 @@ "min": 1, "max": 4096 }, - "smithy.api#pattern": "[a-zA-Z0-9+/]+={0,2}" + "smithy.api#pattern": "^[a-zA-Z0-9+/]+={0,2}$" } }, "com.amazonaws.kinesisvideoarchivedmedia#NoDataRetentionException": { @@ -1096,7 +1371,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "arn:[a-z\\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+" + "smithy.api#pattern": "^arn:[a-z\\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+$" } }, "com.amazonaws.kinesisvideoarchivedmedia#ResourceNotFoundException": { @@ -1112,6 +1387,16 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.kinesisvideoarchivedmedia#SamplingInterval": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 3000, + "max": 20000 + } + } + }, "com.amazonaws.kinesisvideoarchivedmedia#StreamName": { "type": "string", "traits": { @@ -1119,7 +1404,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesisvideoarchivedmedia#Timestamp": { @@ -1159,6 +1444,16 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.kinesisvideoarchivedmedia#WidthPixels": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 3840 + } + } } } } diff --git a/aws/sdk/aws-models/kinesisvideo.json b/aws/sdk/aws-models/kinesisvideo.json index 3a2302f6d..2117b4da1 100644 --- a/aws/sdk/aws-models/kinesisvideo.json +++ b/aws/sdk/aws-models/kinesisvideo.json @@ -60,6 +60,10 @@ { "value": "GET_CLIP", "name": "GET_CLIP" + }, + { + "value": "GET_IMAGES", + "name": "GET_IMAGES" } ] } @@ -85,7 +89,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have reached the maximum limit of active signaling channels for this AWS account\n in this region.

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

You have reached the maximum limit of active signaling channels for this Amazon Web Services account\n in this region.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -166,7 +170,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesisvideo#ChannelNameCondition": { @@ -226,6 +230,10 @@ { "value": "SINGLE_MASTER", "name": "SINGLE_MASTER" + }, + { + "value": "FULL_MESH", + "name": "FULL_MESH" } ] } @@ -254,6 +262,21 @@ ] } }, + "com.amazonaws.kinesisvideo#ConfigurationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, "com.amazonaws.kinesisvideo#CreateSignalingChannel": { "type": "operation", "input": { @@ -297,7 +320,7 @@ "ChannelName": { "target": "com.amazonaws.kinesisvideo#ChannelName", "traits": { - "smithy.api#documentation": "

A name for the signaling channel that you are creating. It must be unique for each AWS\n account and AWS Region.

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

A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

", "smithy.api#required": {} } }, @@ -397,13 +420,13 @@ "KmsKeyId": { "target": "com.amazonaws.kinesisvideo#KmsKeyId", "traits": { - "smithy.api#documentation": "

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.

\n

If no key ID is specified, the default, Kinesis Video-managed key\n (aws/kinesisvideo) is used.

\n

For more information, see DescribeKey.

" + "smithy.api#documentation": "

The ID of the Key Management Service (KMS) key that you want Kinesis Video\n Streams to use to encrypt stream data.

\n

If no key ID is specified, the default, Kinesis Video-managed key\n (aws/kinesisvideo) is used.

\n

For more information, see DescribeKey.

" } }, "DataRetentionInHours": { "target": "com.amazonaws.kinesisvideo#DataRetentionInHours", "traits": { - "smithy.api#documentation": "

The number of hours that you want to retain the data in the stream. Kinesis Video\n Streams retains the data in a data store that is associated with the stream.

\n

The default value is 0, indicating that the stream does not persist data.

\n

When the DataRetentionInHours value is 0, consumers can still consume\n the fragments that remain in the service host buffer, which has a retention time limit\n of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the\n buffer when either limit is reached.

" + "smithy.api#documentation": "

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

\n

The default value is 0, indicating that the stream does not persist data.

\n

When the DataRetentionInHours value is 0, consumers can still consume\n the fragments that remain in the service host buffer, which has a retention time limit\n of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the\n buffer when either limit is reached.

" } }, "Tags": { @@ -564,6 +587,124 @@ "type": "structure", "members": {} }, + "com.amazonaws.kinesisvideo#DescribeImageGenerationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#DescribeImageGenerationConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#DescribeImageGenerationConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

", + "smithy.api#http": { + "method": "POST", + "uri": "/describeImageGenerationConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#DescribeImageGenerationConfigurationInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#DescribeImageGenerationConfigurationOutput": { + "type": "structure", + "members": { + "ImageGenerationConfiguration": { + "target": "com.amazonaws.kinesisvideo#ImageGenerationConfiguration", + "traits": { + "smithy.api#documentation": "

The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#DescribeNotificationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#DescribeNotificationConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#DescribeNotificationConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the NotificationConfiguration for a given Kinesis video stream.

", + "smithy.api#http": { + "method": "POST", + "uri": "/describeNotificationConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#DescribeNotificationConfigurationInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream from which to retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to retrieve the notification configuration. You must specify either the StreamName or the StreamARN.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#DescribeNotificationConfigurationOutput": { + "type": "structure", + "members": { + "NotificationConfiguration": { + "target": "com.amazonaws.kinesisvideo#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "

The structure that contains the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

" + } + } + } + }, "com.amazonaws.kinesisvideo#DescribeSignalingChannel": { "type": "operation", "input": { @@ -682,6 +823,26 @@ } } }, + "com.amazonaws.kinesisvideo#DestinationRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 14 + }, + "smithy.api#pattern": "^[a-z]+(-[a-z]+)?-[a-z]+-[0-9]$" + } + }, + "com.amazonaws.kinesisvideo#DestinationUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9]+:(//)?([^/]+)/?([^*]*)$" + } + }, "com.amazonaws.kinesisvideo#DeviceName": { "type": "string", "traits": { @@ -689,7 +850,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesisvideo#DeviceStreamLimitExceededException": { @@ -708,6 +869,57 @@ "com.amazonaws.kinesisvideo#ErrorMessage": { "type": "string" }, + "com.amazonaws.kinesisvideo#Format": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "JPEG", + "name": "JPEG" + }, + { + "value": "PNG", + "name": "PNG" + } + ] + } + }, + "com.amazonaws.kinesisvideo#FormatConfig": { + "type": "map", + "key": { + "target": "com.amazonaws.kinesisvideo#FormatConfigKey" + }, + "value": { + "target": "com.amazonaws.kinesisvideo#FormatConfigValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.kinesisvideo#FormatConfigKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "JPEGQuality", + "name": "JPEGQuality" + } + ] + } + }, + "com.amazonaws.kinesisvideo#FormatConfigValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9]+$" + } + }, "com.amazonaws.kinesisvideo#GetDataEndpoint": { "type": "operation", "input": { @@ -800,7 +1012,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides an endpoint for the specified signaling channel to send and receive messages.\n This API uses the SingleMasterChannelEndpointConfiguration input parameter,\n which consists of the Protocols and Role properties.

\n

\n Protocols is used to determine the communication mechanism. For example,\n if you specify WSS as the protocol, this API produces a secure websocket\n endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS\n endpoint.

\n

\n Role determines the messaging permissions. A MASTER role\n results in this API generating an endpoint that a client can use to communicate with any\n of the viewers on the channel. A VIEWER role results in this API generating\n an endpoint that a client can use to communicate only with a\n MASTER.

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

Provides an endpoint for the specified signaling channel to send and receive messages.\n This API uses the SingleMasterChannelEndpointConfiguration input parameter,\n which consists of the Protocols and Role properties.

\n

\n Protocols is used to determine the communication mechanism. For example,\n if you specify WSS as the protocol, this API produces a secure websocket\n endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS\n endpoint.

\n

\n Role determines the messaging permissions. A MASTER role\n results in this API generating an endpoint that a client can use to communicate with any\n of the viewers on the channel. A VIEWER role results in this API generating\n an endpoint that a client can use to communicate only with a MASTER.\n

", "smithy.api#http": { "method": "POST", "uri": "/getSignalingChannelEndpoint", @@ -837,6 +1049,114 @@ } } }, + "com.amazonaws.kinesisvideo#HeightPixels": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 2160 + } + } + }, + "com.amazonaws.kinesisvideo#ImageGenerationConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.kinesisvideo#ConfigurationStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled.

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

The origin of the Server or Producer timestamps to use to generate the images.

", + "smithy.api#required": {} + } + }, + "DestinationConfig": { + "target": "com.amazonaws.kinesisvideo#ImageGenerationDestinationConfig", + "traits": { + "smithy.api#documentation": "

The structure that contains the information required to deliver images to a customer.

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

The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, \n because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the \n Image from the StartTimestamp will be returned if available.

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

The accepted image format.

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

The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated.\n The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. \n The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. \n If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality\n key will be set to 80.

" + } + }, + "WidthPixels": { + "target": "com.amazonaws.kinesisvideo#WidthPixels", + "traits": { + "smithy.api#documentation": "

The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and \n HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is \n provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

" + } + }, + "HeightPixels": { + "target": "com.amazonaws.kinesisvideo#HeightPixels", + "traits": { + "smithy.api#documentation": "

The height of the output image that is used in conjunction with the WidthPixels parameter. When both\n HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. \n If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio.\n If neither parameter is provided, the original image size will be returned.

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

The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream.

" + } + }, + "com.amazonaws.kinesisvideo#ImageGenerationDestinationConfig": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.kinesisvideo#DestinationUri", + "traits": { + "smithy.api#documentation": "

The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.

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

The AWS Region of the S3 bucket where images will be delivered. This DestinationRegion must match the Region where the stream is located.

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

The structure that contains the information required to deliver images to a customer.

" + } + }, + "com.amazonaws.kinesisvideo#ImageSelectorType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SERVER_TIMESTAMP", + "name": "SERVER_TIMESTAMP" + }, + { + "value": "PRODUCER_TIMESTAMP", + "name": "PRODUCER_TIMESTAMP" + } + ] + } + }, "com.amazonaws.kinesisvideo#InvalidArgumentException": { "type": "structure", "members": { @@ -878,6 +1198,24 @@ }, "com.amazonaws.kinesisvideo#KinesisVideo_20170930": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Kinesis Video", + "arnNamespace": "kinesisvideo", + "cloudFormationName": "KinesisVideo", + "cloudTrailEventSource": "kinesisvideo.amazonaws.com", + "endpointPrefix": "kinesisvideo" + }, + "aws.auth#sigv4": { + "name": "kinesisvideo" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

", + "smithy.api#title": "Amazon Kinesis Video Streams", + "smithy.api#xmlNamespace": { + "uri": "https://kinesisvideo.amazonaws.com/doc/2017-09-30/" + } + }, "version": "2017-09-30", "operations": [ { @@ -892,6 +1230,12 @@ { "target": "com.amazonaws.kinesisvideo#DeleteStream" }, + { + "target": "com.amazonaws.kinesisvideo#DescribeImageGenerationConfiguration" + }, + { + "target": "com.amazonaws.kinesisvideo#DescribeNotificationConfiguration" + }, { "target": "com.amazonaws.kinesisvideo#DescribeSignalingChannel" }, @@ -932,30 +1276,18 @@ "target": "com.amazonaws.kinesisvideo#UpdateDataRetention" }, { - "target": "com.amazonaws.kinesisvideo#UpdateSignalingChannel" + "target": "com.amazonaws.kinesisvideo#UpdateImageGenerationConfiguration" }, { - "target": "com.amazonaws.kinesisvideo#UpdateStream" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Kinesis Video", - "arnNamespace": "kinesisvideo", - "cloudFormationName": "KinesisVideo", - "cloudTrailEventSource": "kinesisvideo.amazonaws.com", - "endpointPrefix": "kinesisvideo" + "target": "com.amazonaws.kinesisvideo#UpdateNotificationConfiguration" }, - "aws.auth#sigv4": { - "name": "kinesisvideo" + { + "target": "com.amazonaws.kinesisvideo#UpdateSignalingChannel" }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

", - "smithy.api#title": "Amazon Kinesis Video Streams", - "smithy.api#xmlNamespace": { - "uri": "https://kinesisvideo.amazonaws.com/doc/2017-09-30/" + { + "target": "com.amazonaws.kinesisvideo#UpdateStream" } - } + ] }, "com.amazonaws.kinesisvideo#KmsKeyId": { "type": "string", @@ -964,7 +1296,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": ".+" + "smithy.api#pattern": "^.+$" } }, "com.amazonaws.kinesisvideo#ListOfProtocols": { @@ -999,7 +1331,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an array of ChannelInfo objects. Each object describes a\n signaling channel. To retrieve only those channels that satisfy a specific condition, you can\n specify a ChannelNameCondition.

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

Returns an array of ChannelInfo objects. Each object describes a\n signaling channel. To retrieve only those channels that satisfy a specific condition,\n you can specify a ChannelNameCondition.

", "smithy.api#http": { "method": "POST", "uri": "/listSignalingChannels", @@ -1281,7 +1613,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+(,[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+)*" + "smithy.api#pattern": "^[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+(,[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+)*$" } }, "com.amazonaws.kinesisvideo#MessageTtlSeconds": { @@ -1301,7 +1633,20 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "[a-zA-Z0-9+/=]*" + "smithy.api#pattern": "^[a-zA-Z0-9+/=]*$" + } + }, + "com.amazonaws.kinesisvideo#NoDataRetentionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.kinesisvideo#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The Stream data retention in hours is equal to zero.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, "com.amazonaws.kinesisvideo#NotAuthorizedException": { @@ -1317,6 +1662,43 @@ "smithy.api#httpError": 401 } }, + "com.amazonaws.kinesisvideo#NotificationConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.kinesisvideo#ConfigurationStatus", + "traits": { + "smithy.api#documentation": "

Indicates if a notification configuration is enabled or disabled.

", + "smithy.api#required": {} + } + }, + "DestinationConfig": { + "target": "com.amazonaws.kinesisvideo#NotificationDestinationConfig", + "traits": { + "smithy.api#documentation": "

The destination information required to deliver a notification to a customer.

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

The structure that contains the notification information for the KVS images delivery. If this parameter is null, the configuration will be deleted from the stream.

" + } + }, + "com.amazonaws.kinesisvideo#NotificationDestinationConfig": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.kinesisvideo#DestinationUri", + "traits": { + "smithy.api#documentation": "

The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.

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

The structure that contains the information required to deliver a notification to a customer.

" + } + }, "com.amazonaws.kinesisvideo#ResourceARN": { "type": "string", "traits": { @@ -1324,7 +1706,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+" + "smithy.api#pattern": "^arn:[a-z\\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+$" } }, "com.amazonaws.kinesisvideo#ResourceEndpoint": { @@ -1364,7 +1746,7 @@ } }, "traits": { - "smithy.api#documentation": "

The signaling channel is currently not available for this operation.

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

The resource is currently not available for this operation. New resources cannot be\n created with the same name as existing resources. Also, resources cannot be updated or\n deleted unless they are in an ACTIVE state.

\n

If this exception is returned, do not use it to determine whether the requested\n resource already exists. Instead, it is recommended you use the resource-specific\n describe API, for example, DescribeStream for video streams.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1397,6 +1779,16 @@ } } }, + "com.amazonaws.kinesisvideo#SamplingInterval": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 3000, + "max": 20000 + } + } + }, "com.amazonaws.kinesisvideo#SingleMasterChannelEndpointConfiguration": { "type": "structure", "members": { @@ -1423,7 +1815,7 @@ "MessageTtlSeconds": { "target": "com.amazonaws.kinesisvideo#MessageTtlSeconds", "traits": { - "smithy.api#documentation": "

The period of time a signaling channel retains underlivered messages before they are\n discarded.

" + "smithy.api#documentation": "

The period of time a signaling channel retains undelivered messages before they are\n discarded.

" } } }, @@ -1484,7 +1876,7 @@ "KmsKeyId": { "target": "com.amazonaws.kinesisvideo#KmsKeyId", "traits": { - "smithy.api#documentation": "

The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams\n uses to encrypt data on the stream.

" + "smithy.api#documentation": "

The ID of the Key Management Service (KMS) key that Kinesis Video Streams\n uses to encrypt data on the stream.

" } }, "Version": { @@ -1529,7 +1921,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesisvideo#StreamNameCondition": { @@ -1646,7 +2038,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to a signaling channel. A tag is a\n key-value pair (the value is optional) that you can define and assign to AWS resources.\n If you specify a tag that already exists, the tag value is replaced with the value that\n you specify in the request. For more information, see Using Cost Allocation\n Tags in the AWS Billing and Cost Management User\n Guide.

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

Adds one or more tags to a signaling channel. A tag is a\n key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources.\n If you specify a tag that already exists, the tag value is replaced with the value that\n you specify in the request. For more information, see Using Cost Allocation\n Tags in the Billing and Cost Management and Cost Management User\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/TagResource", @@ -1706,7 +2098,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to a stream. A tag is a key-value pair\n (the value is optional) that you can define and assign to AWS resources. If you specify\n a tag that already exists, the tag value is replaced with the value that you specify in\n the request. For more information, see Using Cost Allocation\n Tags in the AWS Billing and Cost Management User Guide.

\n

You must provide either the StreamName or the\n StreamARN.

\n

This operation requires permission for the KinesisVideo:TagStream\n action.

\n

Kinesis video streams support up to 50 tags.

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

Adds one or more tags to a stream. A tag is a key-value pair\n (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify\n a tag that already exists, the tag value is replaced with the value that you specify in\n the request. For more information, see Using Cost Allocation\n Tags in the Billing and Cost Management and Cost Management User Guide.

\n

You must provide either the StreamName or the\n StreamARN.

\n

This operation requires permission for the KinesisVideo:TagStream\n action.

\n

A Kinesis video stream can support up to 50 tags.

", "smithy.api#http": { "method": "POST", "uri": "/tagStream", @@ -1749,7 +2141,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" } }, "com.amazonaws.kinesisvideo#TagsPerResourceExceededLimitException": { @@ -1760,7 +2152,7 @@ } }, "traits": { - "smithy.api#documentation": "

You have exceeded the limit of tags that you can associate with the resource.\n Kinesis video streams support up to 50 tags.

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

You have exceeded the limit of tags that you can associate with the resource.\n A Kinesis video stream can support up to 50 tags.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1978,6 +2370,134 @@ "type": "structure", "members": {} }, + "com.amazonaws.kinesisvideo#UpdateImageGenerationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#UpdateImageGenerationConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#UpdateImageGenerationConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#NoDataRetentionException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceInUseException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the StreamInfo and ImageProcessingConfiguration fields.

", + "smithy.api#http": { + "method": "POST", + "uri": "/updateImageGenerationConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#UpdateImageGenerationConfigurationInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream from which to update the image generation configuration. You must specify either the StreamName or the StreamARN.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the image generation configuration. You must specify either the StreamName \n or the StreamARN.

" + } + }, + "ImageGenerationConfiguration": { + "target": "com.amazonaws.kinesisvideo#ImageGenerationConfiguration", + "traits": { + "smithy.api#documentation": "

The structure that contains the information required for the KVS images delivery. If the structure is null, the configuration will be deleted from the stream.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#UpdateImageGenerationConfigurationOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.kinesisvideo#UpdateNotificationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisvideo#UpdateNotificationConfigurationInput" + }, + "output": { + "target": "com.amazonaws.kinesisvideo#UpdateNotificationConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisvideo#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesisvideo#ClientLimitExceededException" + }, + { + "target": "com.amazonaws.kinesisvideo#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisvideo#NoDataRetentionException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceInUseException" + }, + { + "target": "com.amazonaws.kinesisvideo#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the notification information for a stream.

", + "smithy.api#http": { + "method": "POST", + "uri": "/updateNotificationConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.kinesisvideo#UpdateNotificationConfigurationInput": { + "type": "structure", + "members": { + "StreamName": { + "target": "com.amazonaws.kinesisvideo#StreamName", + "traits": { + "smithy.api#documentation": "

The name of the stream from which to update the notification configuration. You must specify either the StreamName or the StreamARN.

" + } + }, + "StreamARN": { + "target": "com.amazonaws.kinesisvideo#ResourceARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the notification configuration. You must specify either the StreamName or the StreamARN.

" + } + }, + "NotificationConfiguration": { + "target": "com.amazonaws.kinesisvideo#NotificationConfiguration", + "traits": { + "smithy.api#documentation": "

The structure containing the information required for notifications. If the structure is null, the configuration will be deleted from the stream.

" + } + } + } + }, + "com.amazonaws.kinesisvideo#UpdateNotificationConfigurationOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.kinesisvideo#UpdateSignalingChannel": { "type": "operation", "input": { @@ -2128,7 +2648,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[a-zA-Z0-9]+" + "smithy.api#pattern": "^[a-zA-Z0-9]+$" } }, "com.amazonaws.kinesisvideo#VersionMismatchException": { @@ -2143,6 +2663,16 @@ "smithy.api#error": "client", "smithy.api#httpError": 400 } + }, + "com.amazonaws.kinesisvideo#WidthPixels": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 3840 + } + } } } } diff --git a/aws/sdk/aws-models/lightsail.json b/aws/sdk/aws-models/lightsail.json index 3e888844b..595901aa3 100644 --- a/aws/sdk/aws-models/lightsail.json +++ b/aws/sdk/aws-models/lightsail.json @@ -4575,7 +4575,7 @@ "tlsPolicyName": { "target": "com.amazonaws.lightsail#string", "traits": { - "smithy.api#documentation": "

The name of the TLS policy to apply to the load balancer.

\n\n

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can\n specify.

\n\n

For more information about load balancer TLS policies, see Load balancer TLS security policies in the Amazon Lightsail Developer\n Guide.

" + "smithy.api#documentation": "

The name of the TLS policy to apply to the load balancer.

\n\n

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can\n specify.

\n\n

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

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

Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.

\n\n

For more information about load balancer TLS security policies, see Load balancer TLS security policies in the Amazon Lightsail Developer\n Guide.

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

Returns a list of TLS security policies that you can apply to Lightsail load\n balancers.

\n\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/ls/api/2016-11-28/GetLoadBalancerTlsPolicies", @@ -14093,7 +14093,7 @@ "tlsPolicyName": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the TLS security policy for the load balancer.

\n\n

The following TLS security policy names are possible:

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

The name of the TLS security policy for the load balancer.

" } } }, @@ -14681,7 +14681,7 @@ "name": { "target": "com.amazonaws.lightsail#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the TLS security policy.

\n\n

The following TLS security policy names are possible:

\n\n \n\n

You can specify either of these values for the tlsSecurityPolicyName request\n parameter in the CreateLoadBalancer action, and the attributeValue request parameter in\n the UpdateLoadBalancerAttribute action.

" + "smithy.api#documentation": "

The name of the TLS security policy.

" } }, "isDefault": { @@ -14699,7 +14699,7 @@ "protocols": { "target": "com.amazonaws.lightsail#StringList", "traits": { - "smithy.api#documentation": "

The protocols used in a given TLS security policy.

\n\n

The following protocols are possible:

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

The protocols used in a given TLS security policy.

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

Describes the TLS security policies that are available for Lightsail load\n balancers.

\n\n

For more information about load balancer TLS security policies, see Load balancer TLS security policies in the Amazon Lightsail\n Developer Guide.

" + "smithy.api#documentation": "

Describes the TLS security policies that are available for Lightsail load\n balancers.

\n\n

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load\n balancers in the Amazon Lightsail Developer\n Guide.

" } }, "com.amazonaws.lightsail#LoadBalancerTlsPolicyList": { @@ -19029,7 +19029,7 @@ "attributeValue": { "target": "com.amazonaws.lightsail#StringMax256", "traits": { - "smithy.api#documentation": "

The value that you want to specify for the attribute name.

\n

The following values are supported depending on what you specify for the\n attributeName request parameter:

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

The value that you want to specify for the attribute name.

\n

The following values are supported depending on what you specify for the\n attributeName request parameter:

\n ", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/location.json b/aws/sdk/aws-models/location.json index 2ba744cd7..527b78f71 100644 --- a/aws/sdk/aws-models/location.json +++ b/aws/sdk/aws-models/location.json @@ -325,7 +325,7 @@ } ], "traits": { - "smithy.api#documentation": "

Evaluates device positions against the geofence geometries from a given geofence\n collection.

\n

This operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:

\n \n \n

The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.

\n \n \n

Geofence evaluation uses the given device position. It does not account for the \n optional Accuracy of a DevicePositionUpdate.

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

Evaluates device positions against the geofence geometries from a given geofence\n collection.

\n

This operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:

\n \n \n

The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.

\n \n \n

Geofence evaluation uses the given device position. It does not account for the\n optional Accuracy of a DevicePositionUpdate.

\n \n \n

The DeviceID is used as a string to represent the device. You do not\n need to have a Tracker associated with the DeviceID.

\n ", "smithy.api#endpoint": { "hostPrefix": "geofencing." }, @@ -887,7 +887,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Calculates a route given the following required parameters:\n DeparturePosition and DestinationPosition. Requires that\n you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.

\n

Additional options include:

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

\n Calculates a route given the following required parameters:\n DeparturePosition and DestinationPosition. Requires that\n you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.

\n

Additional options include:

\n ", "smithy.api#endpoint": { "hostPrefix": "routes." }, @@ -944,7 +944,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Calculates a\n route matrix given the following required parameters:\n DeparturePositions and DestinationPositions.\n CalculateRouteMatrix calculates routes and returns the travel time and \n travel distance from each departure position to each destination position in the \n request. For example, given departure positions A and B, and destination positions \n X and Y, CalculateRouteMatrix will return time and distance for routes \n from A to X, A to Y, B to X, and B to Y (in that order). The number of results returned \n (and routes calculated) will be the number of DeparturePositions \n times the number of DestinationPositions.

\n \n

Your account is charged for each route calculated, not the number of requests.

\n \n

Requires that you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating routes.

\n

Additional options include:

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

\n Calculates a route\n matrix given the following required parameters:\n DeparturePositions and DestinationPositions.\n CalculateRouteMatrix calculates routes and returns the travel time and\n travel distance from each departure position to each destination position in the\n request. For example, given departure positions A and B, and destination positions X and\n Y, CalculateRouteMatrix will return time and distance for routes from A to\n X, A to Y, B to X, and B to Y (in that order). The number of results returned (and\n routes calculated) will be the number of DeparturePositions times the\n number of DestinationPositions.

\n \n

Your account is charged for each route calculated, not the number of\n requests.

\n \n

Requires that you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating routes.

\n

Additional options include:

\n ", "smithy.api#endpoint": { "hostPrefix": "routes." }, @@ -961,7 +961,7 @@ "CalculatorName": { "target": "com.amazonaws.location#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the route calculator resource that you want to use to calculate the route matrix.

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

The name of the route calculator resource that you want to use to calculate the route\n matrix.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -969,7 +969,7 @@ "DeparturePositions": { "target": "com.amazonaws.location#PositionList", "traits": { - "smithy.api#documentation": "

The list of departure (origin) positions for the route matrix. An array of points,\n each of which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-123.115,\n 49.285].

\n \n

Depending on the data provider selected in the route calculator resource there may be additional\n restrictions on the inputs you can choose. See \n Position restrictions in the Amazon Location Service Developer Guide.

\n \n \n

For route calculators that use Esri as the data provider, if you specify a \n departure that's not located on a road, Amazon Location moves the position \n to the nearest road. The snapped value is available in the result in \n SnappedDeparturePositions.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

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

The list of departure (origin) positions for the route matrix. An array of points,\n each of which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-123.115,\n 49.285].

\n \n

Depending on the data provider selected in the route calculator resource there may\n be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer\n Guide.

\n \n \n

For route calculators that use Esri as the data provider, if you specify a\n departure that's not located on a road, Amazon Location moves the\n position to the nearest road. The snapped value is available in the\n result in SnappedDeparturePositions.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#length": { "min": 1, "max": 350 @@ -980,7 +980,7 @@ "DestinationPositions": { "target": "com.amazonaws.location#PositionList", "traits": { - "smithy.api#documentation": "

The list of destination positions for the route matrix. An array of points, each of\n which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-122.339,\n 47.615]\n

\n \n

Depending on the data provider selected in the route calculator resource there may be additional\n restrictions on the inputs you can choose. See \n Position restrictions in the Amazon Location Service Developer Guide.

\n \n \n

For route calculators that use Esri as the data provider, if you specify a \n destination that's not located on a road, Amazon Location moves the position \n to the nearest road. The snapped value is available in the result in \n SnappedDestinationPositions.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

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

The list of destination positions for the route matrix. An array of points, each of\n which is itself a 2-value array defined in WGS 84 format:\n [longitude, latitude]. For example, [-122.339,\n 47.615]\n

\n \n

Depending on the data provider selected in the route calculator resource there may\n be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer\n Guide.

\n \n \n

For route calculators that use Esri as the data provider, if you specify a\n destination that's not located on a road, Amazon Location moves the\n position to the nearest road. The snapped value is available in the\n result in SnappedDestinationPositions.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#length": { "min": 1, "max": 350 @@ -1032,14 +1032,14 @@ "RouteMatrix": { "target": "com.amazonaws.location#RouteMatrix", "traits": { - "smithy.api#documentation": "

The calculated route matrix containing the results for all pairs of \n DeparturePositions to DestinationPositions. \n Each row corresponds to one entry in DeparturePositions. Each\n entry in the row corresponds to the route from that entry in\n DeparturePositions to an entry in DestinationPositions. \n

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

The calculated route matrix containing the results for all pairs of\n DeparturePositions to DestinationPositions. Each row\n corresponds to one entry in DeparturePositions. Each entry in the row\n corresponds to the route from that entry in DeparturePositions to an entry\n in DestinationPositions.

", "smithy.api#required": {} } }, "SnappedDeparturePositions": { "target": "com.amazonaws.location#PositionList", "traits": { - "smithy.api#documentation": "

For routes calculated using an Esri route calculator resource, departure positions \n are snapped to the closest road. For Esri route calculator resources, this returns \n the list of departure/origin positions used for calculation of the \n RouteMatrix.

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

For routes calculated using an Esri route calculator resource, departure positions are\n snapped to the closest road. For Esri route calculator resources, this returns the list\n of departure/origin positions used for calculation of the\n RouteMatrix.

", "smithy.api#length": { "min": 1, "max": 350 @@ -1049,7 +1049,7 @@ "SnappedDestinationPositions": { "target": "com.amazonaws.location#PositionList", "traits": { - "smithy.api#documentation": "

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

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

The list of destination positions for the route matrix used for calculation of the\n RouteMatrix.

", "smithy.api#length": { "min": 1, "max": 350 @@ -1059,7 +1059,7 @@ "Summary": { "target": "com.amazonaws.location#CalculateRouteMatrixSummary", "traits": { - "smithy.api#documentation": "

Contains information about the route matrix, DataSource,\n DistanceUnit, RouteCount and ErrorCount.

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

Contains information about the route matrix, DataSource,\n DistanceUnit, RouteCount and\n ErrorCount.

", "smithy.api#required": {} } } @@ -1074,14 +1074,14 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of traffic and road network data used to calculate the routes.\n Indicates one of the available providers:

\n \n

For more information about data providers, see Amazon Location Service data providers.

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

The data provider of traffic and road network data used to calculate the routes.\n Indicates one of the available providers:

\n \n

For more information about data providers, see Amazon Location Service data\n providers.

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

The count of cells in the route matrix. Equal to the number of DeparturePositions\n multiplied by the number of DestinationPositions.

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

The count of cells in the route matrix. Equal to the number of\n DeparturePositions multiplied by the number of\n DestinationPositions.

", "smithy.api#range": { "min": 1, "max": 160000 @@ -1092,7 +1092,7 @@ "ErrorCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

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

The count of error results in the route matrix. If this number is 0, all routes were\n calculated successfully.

", "smithy.api#range": { "min": 1, "max": 160000 @@ -1118,7 +1118,7 @@ "CalculatorName": { "target": "com.amazonaws.location#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the route calculator resource that you want to use to calculate the route.

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

The name of the route calculator resource that you want to use to calculate the route.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1126,21 +1126,21 @@ "DeparturePosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The start position for the route. Defined in WGS 84 format:\n [longitude, latitude].

\n \n \n

If you specify a departure that's not located on a road, Amazon Location moves the\n position to the nearest road. If Esri is the provider for your route calculator, \n specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

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

The start position for the route. Defined in World Geodetic\n System (WGS 84) format:\n [longitude, latitude].

\n \n \n

If you specify a departure that's not located on a road, Amazon Location moves the position\n to the nearest road. If Esri is the provider for your route calculator,\n specifying a route that is longer than 400 km returns a 400\n RoutesValidationException error.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#required": {} } }, "DestinationPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The finish position for the route. Defined in WGS 84 format:\n [longitude, latitude].

\n \n \n

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

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

The finish position for the route. Defined in World Geodetic\n System (WGS 84) format:\n [longitude, latitude].

\n \n \n

If you specify a destination that's not located on a road, Amazon Location moves the position\n to the nearest road.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#required": {} } }, "WaypointPositions": { "target": "com.amazonaws.location#WaypointPositionList", "traits": { - "smithy.api#documentation": "

Specifies an ordered list of up to 23 intermediate positions to include along a route\n between the departure position and destination position.

\n \n \n

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

\n

Specifying more than 23 waypoints returns a 400 ValidationException\n error.

\n

If Esri is the provider for your route calculator, specifying a \n route that is longer than 400 km returns a 400 RoutesValidationException error.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

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

Specifies an ordered list of up to 23 intermediate positions to include along a route\n between the departure position and destination position.

\n \n \n

If you specify a waypoint position that's not located on a road, Amazon Location moves the position\n to the nearest road.

\n

Specifying more than 23 waypoints returns a 400 ValidationException\n error.

\n

If Esri is the provider for your route calculator, specifying a route that is\n longer than 400 km returns a 400 RoutesValidationException\n error.

\n \n

Valid Values: [-180 to 180,-90 to 90]\n

", "smithy.api#length": { "max": 23 } @@ -1196,7 +1196,7 @@ "Legs": { "target": "com.amazonaws.location#LegList", "traits": { - "smithy.api#documentation": "

Contains details about each path between a pair of positions included along a route\n such as: StartPosition, EndPosition, Distance,\n DurationSeconds, Geometry, and Steps. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.

\n

For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby road:

\n \n

A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:

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

Contains details about each path between a pair of positions included along a route\n such as: StartPosition, EndPosition, Distance,\n DurationSeconds, Geometry, and Steps. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.

\n

For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby\n road:

\n \n

A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:

\n ", "smithy.api#required": {} } }, @@ -1232,7 +1232,7 @@ "Distance": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The total distance covered by the route. The sum of the distance travelled between\n every stop on the route.

\n \n

If Esri is the data source for the route calculator, the route distance can’t \n be greater than 400 km. If the route exceeds 400 km, the response is a \n 400 RoutesValidationException error.

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

The total distance covered by the route. The sum of the distance travelled between\n every stop on the route.

\n \n

If Esri is the data source for the route calculator, the route distance can’t be\n greater than 400 km. If the route exceeds 400 km, the response is a 400\n RoutesValidationException error.

\n ", "smithy.api#range": { "min": 0 }, @@ -1382,7 +1382,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" + "smithy.api#documentation": "

No longer used. If included, the only allowed value is\n RequestBasedUsage.

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

Creates a place index resource in your AWS account. Use a place index resource to\n geocode addresses and other text queries by using the SearchPlaceIndexForText operation,\n and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and\n enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.

\n \n

If your application is tracking or routing assets you use in your business, such \n as delivery vehicles or employees, you may only use HERE as your geolocation \n provider. See section 82 of the AWS\n service terms for more details.

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

Creates a place index resource in your AWS account. Use a place index resource to\n geocode addresses and other text queries by using the\n SearchPlaceIndexForText operation, and reverse geocode coordinates by\n using the SearchPlaceIndexForPosition operation, and enable autosuggestions\n by using the SearchPlaceIndexForSuggestions operation.

\n \n

If your application is tracking or routing assets you use in your business, such\n as delivery vehicles or employees, you may only use HERE as your geolocation\n provider. See section 82 of the AWS\n service terms for more details.

\n ", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -1588,14 +1588,14 @@ "IndexName": { "target": "com.amazonaws.location#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the place index resource.

\n

Requirements:

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

The name of the place index resource.

\n

Requirements:

\n ", "smithy.api#required": {} } }, "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the geospatial data provider for the new place index.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example, entering\n HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data providers\n on the Amazon Location Service Developer Guide.

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

Specifies the geospatial data provider for the new place index.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service Developer Guide.

", "smithy.api#required": {} } }, @@ -1606,7 +1606,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" + "smithy.api#documentation": "

No longer used. If included, the only allowed value is\n RequestBasedUsage.

" } }, "Description": { @@ -1624,7 +1624,7 @@ "Tags": { "target": "com.amazonaws.location#TagMap", "traits": { - "smithy.api#documentation": "

Applies one or more tags to the place index resource. A tag is a key-value pair that helps you\n manage, identify, search, and filter your resources.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

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

Applies one or more tags to the place index resource. A tag is a key-value pair that\n helps you manage, identify, search, and filter your resources.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " } } } @@ -1642,14 +1642,14 @@ "IndexArn": { "target": "com.amazonaws.location#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource\n across AWS.

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

The Amazon Resource Name (ARN) for the place index resource. Used to specify a\n resource across AWS.

\n ", "smithy.api#required": {} } }, "CreateTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp for when the place index resource was created in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.

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

The timestamp for when the place index resource was created in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.

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

Creates a route calculator resource in your AWS account.

\n

You can send requests to a route calculator resource to estimate travel time,\n distance, and get directions. A route calculator sources traffic and road network data\n from your chosen data provider.

\n \n

If your application is tracking or routing assets you use in your business, such \n as delivery vehicles or employees, you may only use HERE as your geolocation \n provider. See section 82 of the AWS\n service terms for more details.

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

Creates a route calculator resource in your AWS account.

\n

You can send requests to a route calculator resource to estimate travel time,\n distance, and get directions. A route calculator sources traffic and road network data\n from your chosen data provider.

\n \n

If your application is tracking or routing assets you use in your business, such\n as delivery vehicles or employees, you may only use HERE as your geolocation\n provider. See section 82 of the AWS\n service terms for more details.

\n ", "smithy.api#endpoint": { "hostPrefix": "routes." }, @@ -1698,14 +1698,14 @@ "CalculatorName": { "target": "com.amazonaws.location#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the route calculator resource.

\n

Requirements:

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

The name of the route calculator resource.

\n

Requirements:

\n ", "smithy.api#required": {} } }, "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the data provider of traffic and road network data.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error. Route calculators that use Esri as a data source \n only calculate routes that are shorter than 400 km.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service Developer Guide.

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

Specifies the data provider of traffic and road network data.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example,\n entering HERE returns an error. Route calculators that use Esri as a\n data source only calculate routes that are shorter than 400 km.

\n \n

Valid values include:

\n \n

For additional information , see Data\n providers on the Amazon Location Service Developer Guide.

", "smithy.api#required": {} } }, @@ -1716,7 +1716,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" + "smithy.api#documentation": "

No longer used. If included, the only allowed value is\n RequestBasedUsage.

" } }, "Description": { @@ -1884,12 +1884,12 @@ "IntendedUse": { "target": "com.amazonaws.location#IntendedUse", "traits": { - "smithy.api#documentation": "

Specifies how the results of an operation will be stored by the caller.

\n

Valid values include:

\n \n

Default value: SingleUse\n

" + "smithy.api#documentation": "

Specifies how the results of an operation will be stored by the caller.

\n

Valid values include:

\n \n

Default value: SingleUse\n

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

Specifies the data storage option chosen for requesting Places.

\n \n

When using Amazon Location Places:

\n \n

For more information, see the AWS Service Terms for\n Amazon Location Service.

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

Specifies the data storage option chosen for requesting Places.

\n \n

When using Amazon Location Places:

\n \n

For more information, see the AWS Service Terms for Amazon Location Service.

\n " } }, "com.amazonaws.location#DeleteGeofenceCollection": { @@ -2027,7 +2027,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a place index resource from your AWS account.

\n \n

This operation deletes the resource permanently.

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

Deletes a place index resource from your AWS account.

\n \n

This operation deletes the resource permanently.

\n ", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -2082,7 +2082,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a route calculator resource from your AWS account.

\n \n

This operation deletes the resource permanently.

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

Deletes a route calculator resource from your AWS account.

\n \n

This operation deletes the resource permanently.

\n ", "smithy.api#endpoint": { "hostPrefix": "routes." }, @@ -2470,7 +2470,7 @@ "IndexArn": { "target": "com.amazonaws.location#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource\n across AWS.

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

The Amazon Resource Name (ARN) for the place index resource. Used to specify a\n resource across AWS.

\n ", "smithy.api#required": {} } }, @@ -2494,21 +2494,21 @@ "CreateTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp for when the place index resource was created in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.

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

The timestamp for when the place index resource was created in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.

", "smithy.api#required": {} } }, "UpdateTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp for when the place index resource was last updated in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.

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

The timestamp for when the place index resource was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.

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

The data provider of geospatial data. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

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

The data provider of geospatial data. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -3766,14 +3766,14 @@ "StartPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The starting position of the leg. Follows the format\n [longitude,latitude].

\n \n

If the StartPosition isn't located on a road, it's snapped to a nearby road.

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

The starting position of the leg. Follows the format\n [longitude,latitude].

\n \n

If the StartPosition isn't located on a road, it's snapped to a\n nearby road.

\n ", "smithy.api#required": {} } }, "EndPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The terminating position of the leg. Follows the format\n [longitude,latitude].

\n \n

If the EndPosition isn't located on a road, it's snapped to a nearby road.

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

The terminating position of the leg. Follows the format\n [longitude,latitude].

\n \n

If the EndPosition isn't located on a road, it's snapped to a nearby\n road.

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

Contains the calculated route's details for each path between a pair of positions. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.

\n

For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby road:

\n \n

A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:

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

Contains the calculated route's details for each path between a pair of positions. The\n number of legs returned corresponds to one fewer than the total number of positions in\n the request.

\n

For example, a route with a departure position and destination position returns one\n leg with the positions snapped to a nearby\n road:

\n \n

A route with a waypoint between the departure and destination position returns two\n legs with the positions snapped to a nearby road:

\n " } }, "com.amazonaws.location#LegGeometry": { @@ -4233,6 +4233,7 @@ "method": "POST" }, "smithy.api#paginated": { + "pageSize": "MaxResults", "inputToken": "NextToken", "outputToken": "NextToken", "items": "Entries" @@ -4256,6 +4257,16 @@ "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#documentation": "

An optional limit for the number of geofences returned in a single call.

\n

Default value: 100\n

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } } } }, @@ -4461,7 +4472,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

An optional limit for the maximum number of results returned in a single call.

\n

Default value: 100\n

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

An optional limit for the maximum number of results returned in a single call.

\n

Default value: 100\n

", "smithy.api#range": { "min": 1, "max": 100 @@ -4471,7 +4482,7 @@ "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

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

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

A pagination token indicating that there are additional pages available. You can use the\n token in a new request to fetch the next page of results.

" + "smithy.api#documentation": "

A pagination token indicating that there are additional pages available. You can use\n the token in a new request to fetch the next page of results.

" } } } @@ -4514,7 +4525,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of geospatial data. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

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

The data provider of geospatial data. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -4531,14 +4542,14 @@ "CreateTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp for when the place index resource was created in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.

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

The timestamp for when the place index resource was created in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.

", "smithy.api#required": {} } }, "UpdateTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp for when the place index resource was last updated in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.

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

The timestamp for when the place index resource was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.

", "smithy.api#required": {} } } @@ -5093,7 +5104,7 @@ "Label": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The full name and address of the point of interest such as a city,\n region, or country. For example, 123 Any Street, Any Town, USA.

" + "smithy.api#documentation": "

The full name and address of the point of interest such as a city, region, or country.\n For example, 123 Any Street, Any Town, USA.

" } }, "Geometry": { @@ -5111,7 +5122,7 @@ "Street": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name for a street or a road to identify a location. For example, Main\n Street.

" + "smithy.api#documentation": "

The name for a street or a road to identify a location. For example, Main\n Street.

" } }, "Neighborhood": { @@ -5123,48 +5134,48 @@ "Municipality": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A name for a local area, such as a city or town name. For example,\n Toronto.

" + "smithy.api#documentation": "

A name for a local area, such as a city or town name. For example,\n Toronto.

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

A country, or an area that's part of a larger region. For example, Metro\n Vancouver.

" + "smithy.api#documentation": "

A country, or an area that's part of a larger region. For example, Metro\n Vancouver.

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

A name for an area or geographical division, such as a province or state name. For\n example, British Columbia.

" + "smithy.api#documentation": "

A name for an area or geographical division, such as a province or state name. For\n example, British Columbia.

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

A country/region specified using ISO 3166 3-digit\n country/region code. For example, CAN.

" + "smithy.api#documentation": "

A country/region specified using ISO 3166 3-digit\n country/region code. For example, CAN.

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

A group of numbers and letters in a country-specific format, which accompanies the\n address for the purpose of identifying a location.

" + "smithy.api#documentation": "

A group of numbers and letters in a country-specific format, which accompanies the\n address for the purpose of identifying a location.

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

\n True if the result is interpolated from other known places.

\n

\n False if the Place is a known place.

\n

Not returned when the partner does not provide the information.

\n

For example, returns False for an address location that is found in the \n partner data, but returns True if an address does not exist in the partner\n data and its location is calculated by interpolating between other known addresses.\n

" + "smithy.api#documentation": "

\n True if the result is interpolated from other known places.

\n

\n False if the Place is a known place.

\n

Not returned when the partner does not provide the information.

\n

For example, returns False for an address location that is found in the\n partner data, but returns True if an address does not exist in the partner\n data and its location is calculated by interpolating between other known addresses.\n

" } }, "TimeZone": { "target": "com.amazonaws.location#TimeZone", "traits": { - "smithy.api#documentation": "

The time zone in which the Place is located. Returned only when using \n Here as the selected partner.

" + "smithy.api#documentation": "

The time zone in which the Place is located. Returned only when using\n Here as the selected partner.

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

Contains details about addresses or points of interest that match the search\n criteria.

" + "smithy.api#documentation": "

Contains details about addresses or points of interest that match the search\n criteria.

\n

Not all details are included with all responses. Some details may only be returned \n by specific data partners.

" } }, "com.amazonaws.location#PlaceGeometry": { @@ -5173,7 +5184,7 @@ "Point": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

A single point geometry specifies a location for a Place using WGS 84\n coordinates:

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

A single point geometry specifies a location for a Place using WGS 84\n coordinates:

\n " } } }, @@ -5533,12 +5544,12 @@ "Error": { "target": "com.amazonaws.location#RouteMatrixEntryError", "traits": { - "smithy.api#documentation": "

An error corresponding to the calculation of a route between the \n DeparturePosition and DestinationPosition.

" + "smithy.api#documentation": "

An error corresponding to the calculation of a route between the\n DeparturePosition and DestinationPosition.

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

The result for the calculated route of one DeparturePosition \n DestinationPosition pair.

" + "smithy.api#documentation": "

The result for the calculated route of one DeparturePosition\n DestinationPosition pair.

" } }, "com.amazonaws.location#RouteMatrixEntryError": { @@ -5559,7 +5570,7 @@ } }, "traits": { - "smithy.api#documentation": "

An error corresponding to the calculation of a route between the\n DeparturePosition and DestinationPosition.

\n

The error code can be one of the following:

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

An error corresponding to the calculation of a route between the\n DeparturePosition and DestinationPosition.

\n

The error code can be one of the following:

\n \n \n \n \n \n " } }, "com.amazonaws.location#RouteMatrixErrorCode": { @@ -5606,7 +5617,7 @@ "Distance": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The distance in meters of a great-circle arc between the query position and the \n result.

\n \n

A great-circle arc is the shortest path on a sphere, in this case the \n Earth. This returns the shortest distance between two locations.

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

The distance in meters of a great-circle arc between the query position and the\n result.

\n \n

A great-circle arc is the shortest path on a sphere, in this case the Earth. This\n returns the shortest distance between two locations.

\n ", "smithy.api#range": { "min": 0 }, @@ -5615,7 +5626,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains a search result from a position search query that is run on a place index resource.

" + "smithy.api#documentation": "

Contains a search result from a position search query that is run on a place index\n resource.

" } }, "com.amazonaws.location#SearchForPositionResultList": { @@ -5636,7 +5647,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains a place suggestion resulting from a place suggestion query that is run on a place index resource.

" + "smithy.api#documentation": "

Contains a place suggestion resulting from a place suggestion query that is run on a\n place index resource.

" } }, "com.amazonaws.location#SearchForSuggestionsResultList": { @@ -5658,7 +5669,7 @@ "Distance": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The distance in meters of a great-circle arc between the bias position specified \n and the result. Distance will be returned only if a bias position was \n specified in the query.

\n \n

A great-circle arc is the shortest path on a sphere, in this case the \n Earth. This returns the shortest distance between two locations.

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

The distance in meters of a great-circle arc between the bias position specified and\n the result. Distance will be returned only if a bias position was specified\n in the query.

\n \n

A great-circle arc is the shortest path on a sphere, in this case the Earth. This\n returns the shortest distance between two locations.

\n ", "smithy.api#range": { "min": 0 } @@ -5667,7 +5678,7 @@ "Relevance": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "

The relative confidence in the match for a result among the results returned. For \n example, if more fields for an address match (including house number, street, city, \n country/region, and postal code), the relevance score is closer to 1.

\n

Returned only when the partner selected is Esri.

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

The relative confidence in the match for a result among the results returned. For\n example, if more fields for an address match (including house number, street, city,\n country/region, and postal code), the relevance score is closer to 1.

\n

Returned only when the partner selected is Esri.

", "smithy.api#range": { "min": 0, "max": 1 @@ -5676,7 +5687,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains a search result from a text search query that is run on a place index resource.

" + "smithy.api#documentation": "

Contains a search result from a text search query that is run on a place index\n resource.

" } }, "com.amazonaws.location#SearchForTextResultList": { @@ -5711,7 +5722,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reverse geocodes a given coordinate and returns a legible address. Allows you to search\n for Places or points of interest near a given position.

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

Reverse geocodes a given coordinate and returns a legible address. Allows you to\n search for Places or points of interest near a given position.

", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -5736,20 +5747,20 @@ "Position": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

Specifies the longitude and latitude of the position to query.

\n

\n This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; \n the second number represents the Y coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents a position with\n longitude -123.1174 and\n latitude 49.2847.

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

Specifies the longitude and latitude of the position to query.

\n

This parameter must contain a pair of numbers. The first number represents the X\n coordinate, or longitude; the second number represents the Y coordinate, or\n latitude.

\n

For example, [-123.1174, 49.2847] represents a position with longitude\n -123.1174 and latitude 49.2847.

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

An optional parameter. The maximum number of results returned per request.

\n

Default value: 50\n

" + "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

Default value: 50\n

" } }, "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.

" + "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results, but not the results\n themselves. If no language is specified, or not supported for a particular result, the\n partner automatically chooses a language for the result.

\n

For an example, we'll use the Greek language. You search for a location around Athens,\n Greece, with the language parameter set to en. The\n city in the results will most likely be returned as\n Athens.

\n

If you set the language parameter to el, for Greek, then the\n city in the results will more likely be returned as\n Αθήνα.

\n

If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.

" } } } @@ -5760,14 +5771,14 @@ "Summary": { "target": "com.amazonaws.location#SearchPlaceIndexForPositionSummary", "traits": { - "smithy.api#documentation": "

Contains a summary of the request. Echoes the input values for Position,\n Language, MaxResults, and the DataSource of the place index.\n

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

Contains a summary of the request. Echoes the input values for Position,\n Language, MaxResults, and the DataSource of\n the place index.

", "smithy.api#required": {} } }, "Results": { "target": "com.amazonaws.location#SearchForPositionResultList", "traits": { - "smithy.api#documentation": "

Returns a list of Places closest to the specified position. Each result contains\n additional information about the Places returned.

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

Returns a list of Places closest to the specified position. Each result contains\n additional information about the Places returned.

", "smithy.api#required": {} } } @@ -5786,25 +5797,25 @@ "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#documentation": "

Contains the optional result count limit that is specified in the request.

\n

Default value: 50\n

" + "smithy.api#documentation": "

Contains the optional result count limit that is specified in the request.

\n

Default value: 50\n

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

The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

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

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.

" + "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.

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

A summary of the request sent by using SearchPlaceIndexForPosition.

" + "smithy.api#documentation": "

A summary of the request sent by using\n SearchPlaceIndexForPosition.

" } }, "com.amazonaws.location#SearchPlaceIndexForSuggestions": { @@ -5833,7 +5844,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates suggestions for addresses and points of interest based on partial or\n misspelled free-form text. This operation is also known as autocomplete, autosuggest,\n or fuzzy matching.

\n

Optional parameters let you narrow your search results by bounding box or\n country, or bias your search toward a specific position on the globe.

\n \n

You can search for suggested place names near a specified position by using BiasPosition, or\n filter results within a bounding box by using FilterBBox. These parameters are mutually exclusive; \n using both BiasPosition and FilterBBox in the same command returns an error.

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

Generates suggestions for addresses and points of interest based on partial or\n misspelled free-form text. This operation is also known as autocomplete, autosuggest, or\n fuzzy matching.

\n

Optional parameters let you narrow your search results by bounding box or country, or\n bias your search toward a specific position on the globe.

\n \n

You can search for suggested place names near a specified position by using\n BiasPosition, or filter results within a bounding box by using\n FilterBBox. These parameters are mutually exclusive; using both\n BiasPosition and FilterBBox in the same command\n returns an error.

\n ", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -5856,39 +5867,38 @@ } }, "Text": { - "target": "smithy.api#String", + "target": "com.amazonaws.location#SensitiveString", "traits": { - "smithy.api#documentation": "

The free-form partial text to use to generate place suggestions. For example,\n eiffel tow.

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

The free-form partial text to use to generate place suggestions. For example,\n eiffel tow.

", "smithy.api#length": { "min": 1, "max": 200 }, - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

An optional parameter that indicates a preference for place suggestions that are closer to a specified position.

\n

\n If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; \n the second number represents the Y coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and\n latitude 49.2847.

\n \n

\n BiasPosition and FilterBBox are mutually exclusive. Specifying both options results in an error.\n

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

An optional parameter that indicates a preference for place suggestions that are\n closer to a specified position.

\n

If provided, this parameter must contain a pair of numbers. The first number\n represents the X coordinate, or longitude; the second number represents the Y\n coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.

\n \n

\n BiasPosition and FilterBBox are mutually exclusive.\n Specifying both options results in an error.

\n " } }, "FilterBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "

An optional parameter that limits the search results by returning only suggestions within a specified bounding box.

\n

\n If provided, this parameter must contain a total of four consecutive numbers in two pairs.\n The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the northeast corner of the bounding box.

\n

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents\n a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, \n and the northeast corner has longitude -12.0684 and latitude -36.9542.

\n \n

\n FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.\n

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

An optional parameter that limits the search results by returning only suggestions\n within a specified bounding box.

\n

If provided, this parameter must contain a total of four consecutive numbers in two\n pairs. The first pair of numbers represents the X and Y coordinates (longitude and\n latitude, respectively) of the southwest corner of the bounding box; the second pair of\n numbers represents the X and Y coordinates (longitude and latitude, respectively) of the\n northeast corner of the bounding box.

\n

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a\n bounding box where the southwest corner has longitude -12.7935 and latitude\n -37.4835, and the northeast corner has longitude -12.0684\n and latitude -36.9542.

\n \n

\n FilterBBox and BiasPosition are mutually exclusive.\n Specifying both options results in an error.

\n " } }, "FilterCountries": { "target": "com.amazonaws.location#CountryCodeList", "traits": { - "smithy.api#documentation": "

An optional parameter that limits the search results by returning only suggestions within the provided list of countries.

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

An optional parameter that limits the search results by returning only suggestions\n within the provided list of countries.

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

An optional parameter. The maximum number of results returned per request.

\n

The default: 5\n

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

An optional parameter. The maximum number of results returned per request.

\n

The default: 5\n

", "smithy.api#range": { "min": 1, "max": 15 @@ -5898,7 +5908,7 @@ "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.

\n

Used only when the partner selected is Here.

" + "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results. If no language is specified,\n or not supported for a particular result, the partner automatically chooses a language\n for the result.

\n

For an example, we'll use the Greek language. You search for Athens, Gr\n to get suggestions with the language parameter set to en. The\n results found will most likely be returned as Athens, Greece.

\n

If you set the language parameter to el, for Greek, then the\n result found will more likely be returned as Αθήνα, Ελλάδα.

\n

If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.

" } } } @@ -5909,7 +5919,7 @@ "Summary": { "target": "com.amazonaws.location#SearchPlaceIndexForSuggestionsSummary", "traits": { - "smithy.api#documentation": "

Contains a summary of the request. Echoes the input values for BiasPosition,\n FilterBBox, FilterCountries, Language, MaxResults,\n and Text. Also includes the DataSource of the place index.\n

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

Contains a summary of the request. Echoes the input values for\n BiasPosition, FilterBBox, FilterCountries,\n Language, MaxResults, and Text. Also includes\n the DataSource of the place index.

", "smithy.api#required": {} } }, @@ -5926,23 +5936,22 @@ "type": "structure", "members": { "Text": { - "target": "smithy.api#String", + "target": "com.amazonaws.location#SensitiveString", "traits": { "smithy.api#documentation": "

The free-form partial text input specified in the request.

", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

Contains the coordinates for the optional bias position specified in the request.

\n

This parameter contains a pair of numbers. The first number represents the X \n coordinate, or longitude; the second number represents the Y coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and latitude 49.2847.

" + "smithy.api#documentation": "

Contains the coordinates for the optional bias position specified in the\n request.

\n

This parameter contains a pair of numbers. The first number represents the X\n coordinate, or longitude; the second number represents the Y coordinate, or\n latitude.

\n

For example, [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.

" } }, "FilterBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "

Contains the coordinates for the optional bounding box specified in the request.

" + "smithy.api#documentation": "

Contains the coordinates for the optional bounding box specified in the\n request.

" } }, "FilterCountries": { @@ -5960,19 +5969,19 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

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

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.

" + "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.

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

A summary of the request sent by using SearchPlaceIndexForSuggestions.

" + "smithy.api#documentation": "

A summary of the request sent by using\n SearchPlaceIndexForSuggestions.

" } }, "com.amazonaws.location#SearchPlaceIndexForText": { @@ -6001,7 +6010,7 @@ } ], "traits": { - "smithy.api#documentation": "

Geocodes free-form text, such as an address, name, city, or region to allow you to\n search for Places or points of interest.

\n

Optional parameters let you narrow your search results by bounding box or\n country, or bias your search toward a specific position on the globe.

\n \n

You can search for places near a given position using BiasPosition, or\n filter results within a bounding box using FilterBBox. Providing both\n parameters simultaneously returns an error.

\n \n

Search results are returned in order of highest to lowest relevance.

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

Geocodes free-form text, such as an address, name, city, or region to allow you to\n search for Places or points of interest.

\n

Optional parameters let you narrow your search results by bounding box or country, or\n bias your search toward a specific position on the globe.

\n \n

You can search for places near a given position using BiasPosition,\n or filter results within a bounding box using FilterBBox. Providing\n both parameters simultaneously returns an error.

\n \n

Search results are returned in order of highest to lowest relevance.

", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -6024,45 +6033,44 @@ } }, "Text": { - "target": "smithy.api#String", + "target": "com.amazonaws.location#SensitiveString", "traits": { - "smithy.api#documentation": "

The address, name,\n city, or region to be used in the search in free-form text format. For example, 123 Any\n Street.

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

The address, name, city, or region to be used in the search in free-form text format.\n For example, 123 Any Street.

", "smithy.api#length": { "min": 1, "max": 200 }, - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

An optional parameter that indicates a preference for places that are closer to a specified position.

\n

\n If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the \n second number represents the Y coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and\n latitude 49.2847.

\n \n

\n BiasPosition and FilterBBox are mutually exclusive. Specifying both options \n results in an error.\n

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

An optional parameter that indicates a preference for places that are closer to a\n specified position.

\n

If provided, this parameter must contain a pair of numbers. The first number\n represents the X coordinate, or longitude; the second number represents the Y\n coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.

\n \n

\n BiasPosition and FilterBBox are mutually exclusive.\n Specifying both options results in an error.

\n " } }, "FilterBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

\n

\n If provided, this parameter must contain a total of four consecutive numbers in two pairs.\n The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the northeast corner of the bounding box.

\n

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents\n a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, \n and the northeast corner has longitude -12.0684 and latitude -36.9542.

\n \n

\n FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.\n

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

An optional parameter that limits the search results by returning only places that are\n within the provided bounding box.

\n

If provided, this parameter must contain a total of four consecutive numbers in two\n pairs. The first pair of numbers represents the X and Y coordinates (longitude and\n latitude, respectively) of the southwest corner of the bounding box; the second pair of\n numbers represents the X and Y coordinates (longitude and latitude, respectively) of the\n northeast corner of the bounding box.

\n

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents a\n bounding box where the southwest corner has longitude -12.7935 and latitude\n -37.4835, and the northeast corner has longitude -12.0684\n and latitude -36.9542.

\n \n

\n FilterBBox and BiasPosition are mutually exclusive.\n Specifying both options results in an error.

\n " } }, "FilterCountries": { "target": "com.amazonaws.location#CountryCodeList", "traits": { - "smithy.api#documentation": "

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

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

An optional parameter that limits the search results by returning only places that are\n in a specified list of countries.

\n " } }, "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

The default: 50\n

" + "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

The default: 50\n

" } }, "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.

" + "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results, but not the results\n themselves. If no language is specified, or not supported for a particular result, the\n partner automatically chooses a language for the result.

\n

For an example, we'll use the Greek language. You search for Athens,\n Greece, with the language parameter set to en. The\n result found will most likely be returned as Athens.

\n

If you set the language parameter to el, for Greek, then the\n result found will more likely be returned as Αθήνα.

\n

If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.

" } } } @@ -6073,14 +6081,14 @@ "Summary": { "target": "com.amazonaws.location#SearchPlaceIndexForTextSummary", "traits": { - "smithy.api#documentation": "

Contains a summary of the request. Echoes the input values for BiasPosition,\n FilterBBox, FilterCountries, Language, MaxResults,\n and Text. Also includes the DataSource of the place index and\n the bounding box, ResultBBox, which surrounds the search results.\n

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

Contains a summary of the request. Echoes the input values for\n BiasPosition, FilterBBox, FilterCountries,\n Language, MaxResults, and Text. Also includes\n the DataSource of the place index and the bounding box,\n ResultBBox, which surrounds the search results.

", "smithy.api#required": {} } }, "Results": { "target": "com.amazonaws.location#SearchForTextResultList", "traits": { - "smithy.api#documentation": "

A list of Places matching the input text. Each result contains additional\n information about the specific point of interest.

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

A list of Places matching the input text. Each result contains additional information\n about the specific point of interest.

\n

Not all response properties are included with all responses. Some properties may \n only be returned by specific data partners.

", "smithy.api#required": {} } } @@ -6090,23 +6098,22 @@ "type": "structure", "members": { "Text": { - "target": "smithy.api#String", + "target": "com.amazonaws.location#SensitiveString", "traits": { "smithy.api#documentation": "

The search text specified in the request.

", - "smithy.api#required": {}, - "smithy.api#sensitive": {} + "smithy.api#required": {} } }, "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

Contains the coordinates for the optional bias position specified in the request.

\n

This parameter contains a pair of numbers. The first number represents the X \n coordinate, or longitude; the second number represents the Y coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and latitude 49.2847.

" + "smithy.api#documentation": "

Contains the coordinates for the optional bias position specified in the\n request.

\n

This parameter contains a pair of numbers. The first number represents the X\n coordinate, or longitude; the second number represents the Y coordinate, or\n latitude.

\n

For example, [-123.1174, 49.2847] represents the position with longitude\n -123.1174 and latitude 49.2847.

" } }, "FilterBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "

Contains the coordinates for the optional bounding box specified in the request.

" + "smithy.api#documentation": "

Contains the coordinates for the optional bounding box specified in the\n request.

" } }, "FilterCountries": { @@ -6124,20 +6131,20 @@ "ResultBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "

The bounding box that fully contains all search results.

\n \n

If you specified the optional FilterBBox parameter in the request, ResultBBox \n is contained within FilterBBox.

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

The bounding box that fully contains all search results.

\n \n

If you specified the optional FilterBBox parameter in the request,\n ResultBBox is contained within FilterBBox.

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

The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

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

The geospatial data provider attached to the place index resource specified in the\n request. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, "Language": { "target": "com.amazonaws.location#LanguageTag", "traits": { - "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.

" + "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.

" } } }, @@ -6145,6 +6152,12 @@ "smithy.api#documentation": "

A summary of the request sent by using SearchPlaceIndexForText.

" } }, + "com.amazonaws.location#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.location#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -6350,7 +6363,7 @@ "Name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the time zone, following the \n IANA time zone standard. For example, America/Los_Angeles.

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

The name of the time zone, following the \n IANA time zone standard. For example,\n America/Los_Angeles.

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

Information about a time zone. Includes the name of the time zone and the offset\n from UTC in seconds.

" + "smithy.api#documentation": "

Information about a time zone. Includes the name of the time zone and the offset from\n UTC in seconds.

" } }, "com.amazonaws.location#Timestamp": { @@ -6638,7 +6651,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" + "smithy.api#documentation": "

No longer used. If included, the only allowed value is\n RequestBasedUsage.

" } }, "PricingPlanDataSource": { @@ -6832,7 +6845,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" + "smithy.api#documentation": "

No longer used. If included, the only allowed value is\n RequestBasedUsage.

" } }, "Description": { @@ -6862,14 +6875,14 @@ "IndexArn": { "target": "com.amazonaws.location#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a\n resource across AWS.

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

The Amazon Resource Name (ARN) of the upated place index resource. Used to specify a\n resource across AWS.

\n ", "smithy.api#required": {} } }, "UpdateTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp for when the place index resource was last updated in ISO 8601 format:\n YYYY-MM-DDThh:mm:ss.sssZ.

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

The timestamp for when the place index resource was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ.

", "smithy.api#required": {} } } @@ -6930,7 +6943,7 @@ "message": "Deprecated. If included, the only allowed value is RequestBasedUsage.", "since": "2022-02-01" }, - "smithy.api#documentation": "

No longer used. If included, the only allowed value is \n RequestBasedUsage.

" + "smithy.api#documentation": "

No longer used. If included, the only allowed value is\n RequestBasedUsage.

" } }, "Description": { @@ -6954,7 +6967,7 @@ "CalculatorArn": { "target": "com.amazonaws.location#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated route calculator resource. Used to specify a resource\n across AWS.

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

The Amazon Resource Name (ARN) of the updated route calculator resource. Used to\n specify a resource across AWS.

\n ", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/mediaconvert.json b/aws/sdk/aws-models/mediaconvert.json index f343051a7..ff375cb30 100644 --- a/aws/sdk/aws-models/mediaconvert.json +++ b/aws/sdk/aws-models/mediaconvert.json @@ -5245,10 +5245,17 @@ "smithy.api#jsonName": "l6Mode" } }, + "Mapping": { + "target": "com.amazonaws.mediaconvert#DolbyVisionMapping", + "traits": { + "smithy.api#documentation": "Required when you set Dolby Vision Profile (Profile) to Profile 8.1 (PROFILE_8_1). When you set Content mapping (Mapping) to None (HDR10_NOMAP), content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to Static (HDR10_1000), the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims.", + "smithy.api#jsonName": "mapping" + } + }, "Profile": { "target": "com.amazonaws.mediaconvert#DolbyVisionProfile", "traits": { - "smithy.api#documentation": "In the current MediaConvert implementation, the Dolby Vision profile is always 5 (PROFILE_5). Therefore, all of your inputs must contain Dolby Vision frame interleaved data.", + "smithy.api#documentation": "Required when you use Dolby Vision (DolbyVision) processing. Set Profile (DolbyVisionProfile) to Profile 5 (Profile_5) to only include frame-interleaved Dolby Vision metadata in your output. Set Profile to Profile 8.1 (Profile_8_1) to include both frame-interleaved Dolby Vision metadata and HDR10 metadata in your output.", "smithy.api#jsonName": "profile" } } @@ -5299,14 +5306,34 @@ ] } }, + "com.amazonaws.mediaconvert#DolbyVisionMapping": { + "type": "string", + "traits": { + "smithy.api#documentation": "Required when you set Dolby Vision Profile (Profile) to Profile 8.1 (PROFILE_8_1). When you set Content mapping (Mapping) to None (HDR10_NOMAP), content mapping is not applied to the HDR10-compatible signal. Depending on the source peak nit level, clipping might occur on HDR devices without Dolby Vision. When you set Content mapping to Static (HDR10_1000), the transcoder creates a 1,000 nits peak HDR10-compatible signal by applying static content mapping to the source. This mode is speed-optimized for PQ10 sources with metadata that is created from analysis. For graded Dolby Vision content, be aware that creative intent might not be guaranteed with extreme 1,000 nits trims.", + "smithy.api#enum": [ + { + "value": "HDR10_NOMAP", + "name": "HDR10_NOMAP" + }, + { + "value": "HDR10_1000", + "name": "HDR10_1000" + } + ] + } + }, "com.amazonaws.mediaconvert#DolbyVisionProfile": { "type": "string", "traits": { - "smithy.api#documentation": "In the current MediaConvert implementation, the Dolby Vision profile is always 5 (PROFILE_5). Therefore, all of your inputs must contain Dolby Vision frame interleaved data.", + "smithy.api#documentation": "Required when you use Dolby Vision (DolbyVision) processing. Set Profile (DolbyVisionProfile) to Profile 5 (Profile_5) to only include frame-interleaved Dolby Vision metadata in your output. Set Profile to Profile 8.1 (Profile_8_1) to include both frame-interleaved Dolby Vision metadata and HDR10 metadata in your output.", "smithy.api#enum": [ { "value": "PROFILE_5", "name": "PROFILE_5" + }, + { + "value": "PROFILE_8_1", + "name": "PROFILE_8_1" } ] } @@ -10350,6 +10377,13 @@ "smithy.api#jsonName": "timecodeStart" } }, + "VideoGenerator": { + "target": "com.amazonaws.mediaconvert#InputVideoGenerator", + "traits": { + "smithy.api#documentation": "Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. When you include Video generator, MediaConvert creates a video input with black frames and without an audio track. You can specify a value for Video generator, or you can specify an Input file, but you cannot specify both.", + "smithy.api#jsonName": "videoGenerator" + } + }, "VideoSelector": { "target": "com.amazonaws.mediaconvert#VideoSelector", "traits": { @@ -10722,6 +10756,21 @@ ] } }, + "com.amazonaws.mediaconvert#InputVideoGenerator": { + "type": "structure", + "members": { + "Duration": { + "target": "com.amazonaws.mediaconvert#__integerMin50Max86400000", + "traits": { + "smithy.api#documentation": "Specify an integer value for Black video duration from 50 to 86400000 to generate a black video input for that many milliseconds. Required when you include Video generator.", + "smithy.api#jsonName": "duration" + } + } + }, + "traits": { + "smithy.api#documentation": "Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. When you include Video generator, MediaConvert creates a video input with black frames and without an audio track. You can specify a value for Video generator, or you can specify an Input file, but you cannot specify both." + } + }, "com.amazonaws.mediaconvert#InsertableImage": { "type": "structure", "members": { @@ -15789,6 +15838,22 @@ "smithy.api#documentation": "Specific settings for this type of output." } }, + "com.amazonaws.mediaconvert#PadVideo": { + "type": "string", + "traits": { + "smithy.api#documentation": "Use this setting if your input has video and audio durations that don't align, and your output or player has strict alignment requirements. Examples: Input audio track has a delayed start. Input video track ends before audio ends. When you set Pad video (padVideo) to Black (BLACK), MediaConvert generates black video frames so that output video and audio durations match. Black video frames are added at the beginning or end, depending on your input. To keep the default behavior and not generate black video, set Pad video to Disabled (DISABLED) or leave blank.", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "BLACK", + "name": "BLACK" + } + ] + } + }, "com.amazonaws.mediaconvert#PartnerWatermarking": { "type": "structure", "members": { @@ -18413,6 +18478,13 @@ "smithy.api#jsonName": "hdr10Metadata" } }, + "PadVideo": { + "target": "com.amazonaws.mediaconvert#PadVideo", + "traits": { + "smithy.api#documentation": "Use this setting if your input has video and audio durations that don't align, and your output or player has strict alignment requirements. Examples: Input audio track has a delayed start. Input video track ends before audio ends. When you set Pad video (padVideo) to Black (BLACK), MediaConvert generates black video frames so that output video and audio durations match. Black video frames are added at the beginning or end, depending on your input. To keep the default behavior and not generate black video, set Pad video to Disabled (DISABLED) or leave blank.", + "smithy.api#jsonName": "padVideo" + } + }, "Pid": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { @@ -20418,6 +20490,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin50Max86400000": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 50, + "max": 86400000 + } + } + }, "com.amazonaws.mediaconvert#__integerMin6000Max1024000": { "type": "integer", "traits": { diff --git a/aws/sdk/aws-models/mediapackage.json b/aws/sdk/aws-models/mediapackage.json index 47e766e66..10e3f4f10 100644 --- a/aws/sdk/aws-models/mediapackage.json +++ b/aws/sdk/aws-models/mediapackage.json @@ -986,7 +986,7 @@ "Profile": { "target": "com.amazonaws.mediapackage#Profile", "traits": { - "smithy.api#documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", + "smithy.api#documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled. When set to \"DVB-DASH_2014\", DVB-DASH 2014 compliant output is enabled.", "smithy.api#jsonName": "profile" } }, @@ -1027,7 +1027,7 @@ "UtcTimingUri": { "target": "com.amazonaws.mediapackage#__string", "traits": { - "smithy.api#documentation": "Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO or HTTP-HEAD", + "smithy.api#documentation": "Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE", "smithy.api#jsonName": "utcTimingUri" } } @@ -2665,6 +2665,10 @@ { "value": "HYBRIDCAST", "name": "HYBRIDCAST" + }, + { + "value": "DVB_DASH_2014", + "name": "DVB_DASH_2014" } ] } @@ -3543,6 +3547,10 @@ { "value": "HTTP-ISO", "name": "HTTP_ISO" + }, + { + "value": "HTTP-XSDATE", + "name": "HTTP_XSDATE" } ] } diff --git a/aws/sdk/aws-models/migration-hub-refactor-spaces.json b/aws/sdk/aws-models/migration-hub-refactor-spaces.json index 5a7bb3572..88b879e94 100644 --- a/aws/sdk/aws-models/migration-hub-refactor-spaces.json +++ b/aws/sdk/aws-models/migration-hub-refactor-spaces.json @@ -3450,7 +3450,7 @@ ], "origin": "*" }, - "smithy.api#documentation": "Amazon Web Services Migration Hub Refactor Spaces\n \n

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services SDKs.

\n \n

To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations\n and their OUs, use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the Amazon Web Services RAM API Reference.

", + "smithy.api#documentation": "Amazon Web Services Migration Hub Refactor Spaces\n \n

This API reference provides descriptions, syntax, and other details about each of the\n actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API\n request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services SDKs.

\n

To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations\n and their OUs, use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the Amazon Web Services RAM API Reference.

", "smithy.api#title": "AWS Migration Hub Refactor Spaces" }, "version": "2021-10-26", diff --git a/aws/sdk/aws-models/mobile.json b/aws/sdk/aws-models/mobile.json index 785148ffd..731bea560 100644 --- a/aws/sdk/aws-models/mobile.json +++ b/aws/sdk/aws-models/mobile.json @@ -70,7 +70,7 @@ "endpointPrefix": "mobile" }, "aws.auth#sigv4": { - "name": "awsmobilehubservice" + "name": "AWSMobileHubService" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

\n AWS Mobile Service provides mobile app and website developers with capabilities\n required to configure AWS resources and bootstrap their developer desktop projects\n with the necessary SDKs, constants, tools and samples to make use of those resources.\n

", diff --git a/aws/sdk/aws-models/organizations.json b/aws/sdk/aws-models/organizations.json index 58256a647..16da6e96a 100644 --- a/aws/sdk/aws-models/organizations.json +++ b/aws/sdk/aws-models/organizations.json @@ -555,6 +555,9 @@ "input": { "target": "com.amazonaws.organizations#AttachPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -752,6 +755,9 @@ "input": { "target": "com.amazonaws.organizations#CloseAccountRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -788,7 +794,7 @@ } ], "traits": { - "smithy.api#documentation": "

Closes an Amazon Web Services account that is now a part of an Organizations, either created within the organization, or invited to join the organization.

" + "smithy.api#documentation": "

Closes an Amazon Web Services member account within an organization. You can't close the management\n account with this API. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CloseAccount operates asynchronously, it can return a\n successful completion message even though account closure might still be in progress.\n You need to wait a few minutes before the account is fully closed. To check the status\n of the request, do one of the following:

\n \n \n \n \n

For more information about closing accounts, see Closing an\n Amazon Web Services account in the Organizations User Guide.\n

" } }, "com.amazonaws.organizations#CloseAccountRequest": { @@ -797,7 +803,7 @@ "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { - "smithy.api#documentation": "

Retrieves the Amazon Web Services account Id for the current CloseAccount API request.

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

Retrieves the Amazon Web Services account Id for the current CloseAccount API request.\n

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

The request failed because it conflicts with the current state of the specified resource.

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

The request failed because it conflicts with the current state of the specified\n resource.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -840,7 +846,7 @@ } }, "traits": { - "smithy.api#documentation": "

Performing this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation.

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

Performing this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation.

\n \n ", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -976,6 +982,10 @@ { "value": "SERVICE_ACCESS_NOT_ENABLED", "name": "SERVICE_ACCESS_NOT_ENABLED" + }, + { + "value": "INVALID_PAYMENT_INSTRUMENT", + "name": "INVALID_PAYMENT_INSTRUMENT" } ] } @@ -1076,6 +1086,10 @@ { "value": "MISSING_PAYMENT_INSTRUMENT", "name": "MISSING_PAYMENT_INSTRUMENT" + }, + { + "value": "INVALID_PAYMENT_INSTRUMENT", + "name": "INVALID_PAYMENT_INSTRUMENT" } ] } @@ -1222,7 +1236,7 @@ "FailureReason": { "target": "com.amazonaws.organizations#CreateAccountFailureReason", "traits": { - "smithy.api#documentation": "

If the request failed, a description of the reason for the failure.

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

If the request failed, a description of the reason for the failure.

\n " } } }, @@ -1303,7 +1317,7 @@ "AccountName": { "target": "com.amazonaws.organizations#CreateAccountName", "traits": { - "smithy.api#documentation": "

The friendly name of the member account.

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

The friendly name of the member account.

\n

The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or\n dot (.) You can't separate characters with a dash (–).

", "smithy.api#required": {} } }, @@ -1720,6 +1734,12 @@ }, "com.amazonaws.organizations#DeleteOrganization": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -1752,6 +1772,9 @@ "input": { "target": "com.amazonaws.organizations#DeleteOrganizationalUnitRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -1799,6 +1822,9 @@ "input": { "target": "com.amazonaws.organizations#DeletePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -1849,6 +1875,9 @@ "input": { "target": "com.amazonaws.organizations#DeregisterDelegatedAdministratorRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -2144,6 +2173,9 @@ }, "com.amazonaws.organizations#DescribeOrganization": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.organizations#DescribeOrganizationResponse" }, @@ -2310,6 +2342,9 @@ "input": { "target": "com.amazonaws.organizations#DetachPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -2376,6 +2411,9 @@ "input": { "target": "com.amazonaws.organizations#DisableAWSServiceAccessRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -2639,6 +2677,9 @@ "input": { "target": "com.amazonaws.organizations#EnableAWSServiceAccessRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -3457,6 +3498,12 @@ }, "com.amazonaws.organizations#LeaveOrganization": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -4776,6 +4823,9 @@ "input": { "target": "com.amazonaws.organizations#MoveAccountRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -5413,6 +5463,9 @@ "input": { "target": "com.amazonaws.organizations#RegisterDelegatedAdministratorRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -5473,6 +5526,9 @@ "input": { "target": "com.amazonaws.organizations#RemoveAccountFromOrganizationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -5683,6 +5739,9 @@ "input": { "target": "com.amazonaws.organizations#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" @@ -5836,6 +5895,9 @@ "input": { "target": "com.amazonaws.organizations#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" diff --git a/aws/sdk/aws-models/outposts.json b/aws/sdk/aws-models/outposts.json index 089898d64..0ae67eb74 100644 --- a/aws/sdk/aws-models/outposts.json +++ b/aws/sdk/aws-models/outposts.json @@ -187,6 +187,65 @@ "smithy.api#pattern": "^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:([a-z\\d-]+)/)[a-z]{2,8}-[a-f0-9]{17}$" } }, + "com.amazonaws.outposts#AssetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(\\w+)$" + } + }, + "com.amazonaws.outposts#AssetInfo": { + "type": "structure", + "members": { + "AssetId": { + "target": "com.amazonaws.outposts#AssetId", + "traits": { + "smithy.api#documentation": "

\n The ID of the asset.\n

" + } + }, + "RackId": { + "target": "com.amazonaws.outposts#RackId", + "traits": { + "smithy.api#documentation": "

\n The rack ID of the asset. \n

" + } + }, + "AssetType": { + "target": "com.amazonaws.outposts#AssetType", + "traits": { + "smithy.api#documentation": "

\n The type of the asset.\n

" + } + }, + "ComputeAttributes": { + "target": "com.amazonaws.outposts#ComputeAttributes", + "traits": { + "smithy.api#documentation": "

\n Information about compute hardware assets. \n

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

\n Information about hardware assets.\n

" + } + }, + "com.amazonaws.outposts#AssetListDefinition": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#AssetInfo" + } + }, + "com.amazonaws.outposts#AssetType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPUTE", + "name": "COMPUTE" + } + ] + } + }, "com.amazonaws.outposts#AvailabilityZone": { "type": "string", "traits": { @@ -404,6 +463,20 @@ "target": "com.amazonaws.outposts#City" } }, + "com.amazonaws.outposts#ComputeAttributes": { + "type": "structure", + "members": { + "HostId": { + "target": "com.amazonaws.outposts#HostId", + "traits": { + "smithy.api#documentation": "

\n The host ID of any Dedicated Hosts on the asset.\n

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

\n Information about compute hardware assets.\n

" + } + }, "com.amazonaws.outposts#ConflictException": { "type": "structure", "members": { @@ -1068,11 +1141,16 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the instance types for the specified Outpost.

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

Gets the instance types for the specified Outpost.

", "smithy.api#http": { "method": "GET", "uri": "/outposts/{OutpostId}/instanceTypes", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" } } }, @@ -1253,6 +1331,22 @@ } } }, + "com.amazonaws.outposts#HostId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]*$" + } + }, + "com.amazonaws.outposts#HostIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#HostId" + } + }, "com.amazonaws.outposts#ISO8601Timestamp": { "type": "timestamp" }, @@ -1451,6 +1545,88 @@ "target": "com.amazonaws.outposts#LineItemQuantity" } }, + "com.amazonaws.outposts#ListAssets": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#ListAssetsInput" + }, + "output": { + "target": "com.amazonaws.outposts#ListAssetsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Lists the hardware assets in an Outpost. If you are using Dedicated Hosts on \n Amazon Web Services Outposts, you can filter your request by host ID to return a list of hardware\n assets that allocate resources for Dedicated Hosts. \n

", + "smithy.api#http": { + "method": "GET", + "uri": "/outposts/{OutpostIdentifier}/assets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.outposts#ListAssetsInput": { + "type": "structure", + "members": { + "OutpostIdentifier": { + "target": "com.amazonaws.outposts#OutpostIdentifier", + "traits": { + "smithy.api#documentation": "

\n The ID or the Amazon Resource Name (ARN) of the Outpost.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HostIdFilter": { + "target": "com.amazonaws.outposts#HostIdList", + "traits": { + "smithy.api#documentation": "

\n A filter for the host ID of Dedicated Hosts on the Outpost.\n

\n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

", + "smithy.api#httpQuery": "HostIdFilter" + } + }, + "MaxResults": { + "target": "com.amazonaws.outposts#MaxResults1000", + "traits": { + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + } + } + }, + "com.amazonaws.outposts#ListAssetsOutput": { + "type": "structure", + "members": { + "Assets": { + "target": "com.amazonaws.outposts#AssetListDefinition", + "traits": { + "smithy.api#documentation": "

\n Information about hardware assets. \n

" + } + }, + "NextToken": { + "target": "com.amazonaws.outposts#Token" + } + } + }, "com.amazonaws.outposts#ListCatalogItems": { "type": "operation", "input": { @@ -1471,7 +1647,7 @@ } ], "traits": { - "smithy.api#documentation": "

Use to create a list of every item in the catalog. Add filters to your request to return a\n more specific list of results. Use filters to match an item class, storage\n option, or EC2 family.

\n

If you specify multiple filters, the filters are joined with an AND, and\n the request returns only results that match all of the specified filters.

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

Lists the items in the catalog. Add filters to your request to return a\n more specific list of results. Use filters to match an item class, storage\n option, or EC2 family.

\n

If you specify multiple filters, the filters are joined with an AND, and\n the request returns only results that match all of the specified filters.

", "smithy.api#http": { "method": "GET", "uri": "/catalog/items", @@ -1559,7 +1735,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a list of the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to \n return a more specific list of results.

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

Lists the Outpost orders for your Amazon Web Services account. You can filter your request by Outpost to \n return a more specific list of results.

", "smithy.api#http": { "method": "GET", "uri": "/list-orders", @@ -1630,7 +1806,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a list of the Outposts for your Amazon Web Services account. Add filters to your request to return\n a more specific list of results. Use filters to match an Outpost lifecycle status,\n Availability Zone (us-east-1a), and AZ ID (use1-az1).

\n \n

If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.

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

Lists the Outposts for your Amazon Web Services account. Add filters to your request to return\n a more specific list of results. Use filters to match an Outpost lifecycle status,\n Availability Zone (us-east-1a), and AZ ID (use1-az1).

\n \n

If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.

", "smithy.api#http": { "method": "GET", "uri": "/outposts", @@ -1712,7 +1888,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a list of the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to\n return a more specific list of results. Use filters to match site city, country code, or state/region of the \n operating address.

\n \n

If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.

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

Lists the Outpost sites for your Amazon Web Services account. Add operating address filters to your request to\n return a more specific list of results. Use filters to match site city, country code, or state/region of the \n operating address.

\n \n

If you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.

", "smithy.api#http": { "method": "GET", "uri": "/sites", @@ -2298,6 +2474,9 @@ { "target": "com.amazonaws.outposts#GetSiteAddress" }, + { + "target": "com.amazonaws.outposts#ListAssets" + }, { "target": "com.amazonaws.outposts#ListCatalogItems" }, @@ -2459,6 +2638,16 @@ "com.amazonaws.outposts#Quantity": { "type": "string" }, + "com.amazonaws.outposts#RackId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 20 + }, + "smithy.api#pattern": "^[\\S \\n]+$" + } + }, "com.amazonaws.outposts#RackPhysicalProperties": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/rds.json b/aws/sdk/aws-models/rds.json index 46309b798..9beaaa1ed 100644 --- a/aws/sdk/aws-models/rds.json +++ b/aws/sdk/aws-models/rds.json @@ -2496,6 +2496,9 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, @@ -2576,7 +2579,7 @@ "AvailabilityZone": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

\n \n

If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.

\n

For more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n

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

The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.

\n

\n Amazon Aurora\n

\n

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these \n Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

\n

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

\n

Example: us-east-1d\n

\n

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

" } }, "DBSubnetGroupName": { @@ -2624,7 +2627,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

" + "smithy.api#documentation": "

The version number of the database engine to use.

\n

For a list of valid engine versions, use the DescribeDBEngineVersions action.

\n

The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.

\n

\n Amazon Aurora\n

\n

Not applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.

\n

\n Amazon RDS Custom for Oracle\n

\n

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

\n

\n Amazon RDS Custom for SQL Server\n

\n

See RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.

\n

\n MariaDB\n

\n

For information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Microsoft SQL Server\n

\n

For information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.

\n

\n MySQL\n

\n

For information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.

\n

\n Oracle\n

\n

For information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.

\n

\n PostgreSQL\n

\n

For information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.

" } }, "AutoMinorVersionUpgrade": { @@ -2818,6 +2821,12 @@ "traits": { "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } } }, "traits": { @@ -2878,6 +2887,9 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, @@ -3094,6 +3106,12 @@ "traits": { "smithy.api#documentation": "

The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:

\n \n

For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon RDS User Guide.

\n

This setting is required for RDS Custom.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for read replica. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

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

Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide and \n \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

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

The Amazon Resource Name (ARN) for the DB subnet group.

" } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The network type of the DB subnet group.

\n

Valid values:

\n \n

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } } }, "traits": { @@ -13744,6 +13774,9 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, @@ -14046,6 +14079,12 @@ "traits": { "smithy.api#documentation": "

The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation. The minimum value is 60 (default). The maximum value is 1,440.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } } }, "traits": { @@ -14704,6 +14743,23 @@ } } }, + "com.amazonaws.rds#NetworkTypeNotSupported": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NetworkTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The network type is invalid for the DB instance. Valid nework type values are IPV4 and DUAL.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.rds#Option": { "type": "structure", "members": { @@ -15501,6 +15557,12 @@ "traits": { "smithy.api#documentation": "

Whether DB instances can be configured as a Multi-AZ DB cluster.

\n

For more information on Multi-AZ DB clusters, see \n \n Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.\n

" } + }, + "SupportedNetworkTypes": { + "target": "com.amazonaws.rds#StringList", + "traits": { + "smithy.api#documentation": "

The network types supported by the DB instance (IPV4 or DUAL).

\n

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } } }, "traits": { @@ -17830,6 +17892,9 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, @@ -18034,6 +18099,12 @@ "traits": { "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } } }, "traits": { @@ -18096,6 +18167,9 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, @@ -18386,6 +18460,12 @@ "traits": { "smithy.api#documentation": "

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

\n

For more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } } } }, @@ -18457,6 +18537,9 @@ { "target": "com.amazonaws.rds#KMSKeyNotAccessibleFault" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#OptionGroupNotFoundFault" }, @@ -18693,6 +18776,12 @@ "traits": { "smithy.api#documentation": "

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

\n

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

\n

For more information, see Working \n with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

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

The network type of the DB instance.

\n

Valid values:

\n \n

The network type is determined by the DBSubnetGroup specified for the DB instance. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon RDS User Guide.\n

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/redshift.json b/aws/sdk/aws-models/redshift.json index c9d6a84f6..d703091e6 100644 --- a/aws/sdk/aws-models/redshift.json +++ b/aws/sdk/aws-models/redshift.json @@ -622,7 +622,7 @@ } ], "traits": { - "smithy.api#documentation": "

From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account\n must have the correct access privileges.

" + "smithy.api#documentation": "

From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts or managing entities. To authorize a datashare for a data consumer,\n the producer account must have the correct access permissions.

" } }, "com.amazonaws.redshift#AuthorizeDataShareMessage": { @@ -1383,7 +1383,7 @@ "DbUser": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

A database user name that is authorized to log on to the database\n DbName using the password DbPassword. If the specified\n DbUser exists in the database, the new user name has the same database privileges as the\n the user named in DbUser. By default, the user is added to PUBLIC. If the\n DbGroups parameter is specifed, DbUser is added to the\n listed groups for any sessions created using these credentials.

" + "smithy.api#documentation": "

A database user name that is authorized to log on to the database DbName\n using the password DbPassword. If the specified DbUser exists in the\n database, the new user name has the same database permissions as the the user named in\n DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter\n is specifed, DbUser is added to the listed groups for any sessions created\n using these credentials.

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

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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

A flag that specifies whether to load sample data once the cluster is created.

" + } } }, "traits": { @@ -3724,7 +3730,7 @@ "DataShareAssociations": { "target": "com.amazonaws.redshift#DataShareAssociationList", "traits": { - "smithy.api#documentation": "

A value that specifies when the datashare has an association between a producer and data consumers.

" + "smithy.api#documentation": "

A value that specifies when the datashare has an association between producer and data\n consumers.

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

From the producer account, removes authorization from the specified datashare.

" + "smithy.api#documentation": "

From a datashare producer account, removes authorization from the specified datashare.

" } }, "com.amazonaws.redshift#DeauthorizeDataShareMessage": { @@ -7072,7 +7078,7 @@ } ], "traits": { - "smithy.api#documentation": "

From a consumer account, remove association for the specified datashare.\n

" + "smithy.api#documentation": "

From a datashare consumer account, remove association for the specified datashare.\n

" } }, "com.amazonaws.redshift#DisassociateDataShareConsumerMessage": { @@ -7980,7 +7986,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a database user name and temporary password with temporary authorization to\n log on to an Amazon Redshift database. The action returns the database user name\n prefixed with IAM: if AutoCreate is False or\n IAMA: if AutoCreate is True. You can\n optionally specify one or more database user groups that the user will join at log on.\n By default, the temporary credentials expire in 900 seconds. You can optionally specify\n a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more\n information, see Using IAM Authentication\n to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.

\n

The Identity and Access Management (IAM) user or role that runs\n GetClusterCredentials must have an IAM policy attached that allows access to all\n necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the\n Amazon Redshift Cluster Management Guide.

\n

If the DbGroups parameter is specified, the IAM policy must allow the\n redshift:JoinGroup action with access to the listed\n dbgroups.

\n

In addition, if the AutoCreate parameter is set to True,\n then the policy must include the redshift:CreateClusterUser\n privilege.

\n

If the DbName parameter is specified, the IAM policy must allow access\n to the resource dbname for the specified database name.

" + "smithy.api#documentation": "

Returns a database user name and temporary password with temporary authorization to\n log on to an Amazon Redshift database. The action returns the database user name\n prefixed with IAM: if AutoCreate is False or\n IAMA: if AutoCreate is True. You can\n optionally specify one or more database user groups that the user will join at log on.\n By default, the temporary credentials expire in 900 seconds. You can optionally specify\n a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more\n information, see Using IAM Authentication\n to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.

\n

The Identity and Access Management (IAM) user or role that runs\n GetClusterCredentials must have an IAM policy attached that allows access to all\n necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the\n Amazon Redshift Cluster Management Guide.

\n

If the DbGroups parameter is specified, the IAM policy must allow the\n redshift:JoinGroup action with access to the listed\n dbgroups.

\n

In addition, if the AutoCreate parameter is set to True,\n then the policy must include the redshift:CreateClusterUser\n permission.

\n

If the DbName parameter is specified, the IAM policy must allow access\n to the resource dbname for the specified database name.

" } }, "com.amazonaws.redshift#GetClusterCredentialsMessage": { @@ -11598,7 +11604,7 @@ } ], "traits": { - "smithy.api#documentation": "

From the consumer account, rejects the specified datashare.

" + "smithy.api#documentation": "

From a datashare consumer account, rejects the specified datashare.

" } }, "com.amazonaws.redshift#RejectDataShareMessage": { diff --git a/aws/sdk/aws-models/sagemaker.json b/aws/sdk/aws-models/sagemaker.json index 9c07492f0..ab53c7f48 100644 --- a/aws/sdk/aws-models/sagemaker.json +++ b/aws/sdk/aws-models/sagemaker.json @@ -2356,6 +2356,69 @@ ] } }, + "com.amazonaws.sagemaker#AutoMLMetricExtendedEnum": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Accuracy", + "name": "ACCURACY" + }, + { + "value": "MSE", + "name": "MSE" + }, + { + "value": "F1", + "name": "F1" + }, + { + "value": "F1macro", + "name": "F1_MACRO" + }, + { + "value": "AUC", + "name": "AUC" + }, + { + "value": "RMSE", + "name": "RMSE" + }, + { + "value": "MAE", + "name": "MAE" + }, + { + "value": "R2", + "name": "R2" + }, + { + "value": "BalancedAccuracy", + "name": "BALANCED_ACCURACY" + }, + { + "value": "Precision", + "name": "PRECISION" + }, + { + "value": "PrecisionMacro", + "name": "PRECISION_MACRO" + }, + { + "value": "Recall", + "name": "RECALL" + }, + { + "value": "RecallMacro", + "name": "RECALL_MACRO" + }, + { + "value": "LogLoss", + "name": "LogLoss" + } + ] + } + }, "com.amazonaws.sagemaker#AutoMLNameContains": { "type": "string", "traits": { @@ -27099,6 +27162,12 @@ "traits": { "smithy.api#documentation": "

The dataset split from which the AutoML job produced the metric.

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

The name of the standard metric.

" + } } }, "traits": { @@ -33769,7 +33838,17 @@ }, "com.amazonaws.sagemaker#RSessionAppSettings": { "type": "structure", - "members": {}, + "members": { + "DefaultResourceSpec": { + "target": "com.amazonaws.sagemaker#ResourceSpec" + }, + "CustomImages": { + "target": "com.amazonaws.sagemaker#CustomImages", + "traits": { + "smithy.api#documentation": "

A list of custom SageMaker images that are configured to run as a RSession app.

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

A collection of settings that apply to an RSessionGateway app.

" } diff --git a/aws/sdk/aws-models/secretsmanager.json b/aws/sdk/aws-models/secretsmanager.json index 3fc31db8b..1fd9745d4 100644 --- a/aws/sdk/aws-models/secretsmanager.json +++ b/aws/sdk/aws-models/secretsmanager.json @@ -75,7 +75,7 @@ } ], "traits": { - "smithy.api#documentation": "

Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.

\n

To turn on automatic rotation again, call RotateSecret.

\n \n

If you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label AWSPENDING from the partially created version, specified\n by the VersionId response value. We recommend you also evaluate the partially rotated\n new version to see if it should be deleted. You can delete a version by removing all staging labels\n from it.

\n \n

\n Required permissions: \n secretsmanager:CancelRotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Turns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.

\n

If you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. You might\n need to remove the staging label AWSPENDING from the partially created version. \n You also need to determine whether to roll back to the previous version of the secret \n by moving the staging label AWSCURRENT to the version that has AWSPENDING.\n To determine \n which version has a specific staging label, call ListSecretVersionIds. Then use \n UpdateSecretVersionStage to change staging labels. \n For more information, see How rotation works.

\n

To turn on automatic rotation again, call RotateSecret.

\n

\n Required permissions: \n secretsmanager:CancelRotateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#CancelRotateSecretRequest": { @@ -349,7 +349,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a secret and all of its versions. You can specify a recovery\n window during which you can restore the secret. The minimum recovery window is 7 days. \n The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.

\n

For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.

\n

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.

\n

At any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.

\n

In a secret scheduled for deletion, you cannot access the encrypted secret value.\n To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.

\n

\n Required permissions: \n secretsmanager:DeleteSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Deletes a secret and all of its versions. You can specify a recovery\n window during which you can restore the secret. The minimum recovery window is 7 days. \n The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.

\n

You can't delete a primary secret that is replicated to other Regions. You must first delete the \n replicas using RemoveRegionsFromReplication, and then delete the primary secret. \n When you delete a replica, it is deleted immediately.

\n

You can't directly delete a version of a secret. Instead, you remove all staging labels \n from the version using UpdateSecretVersionStage. This marks the version as deprecated, \n and then Secrets Manager can automatically delete the version in the background.

\n

To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm \n to alert you to any attempts to access a secret during the recovery window. For more information, \n see \n Monitor secrets scheduled for deletion.

\n

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.

\n

At any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.

\n

When a secret is scheduled for deletion, you cannot retrieve the secret value.\n You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.

\n

\n Required permissions: \n secretsmanager:DeleteSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#DeleteSecretRequest": { @@ -1055,7 +1055,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the versions for a secret.

\n

To list the secrets in the account, use ListSecrets.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

\n Required permissions: \n secretsmanager:ListSecretVersionIds. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions \n of a secret. For more information, see \n Secrets Manager concepts: Versions.

\n

To list the secrets in the account, use ListSecrets.

\n

\n Required permissions: \n secretsmanager:ListSecretVersionIds. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

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

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Find secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", diff --git a/aws/sdk/aws-models/securityhub.json b/aws/sdk/aws-models/securityhub.json index ca9f77320..7d9e12e38 100644 --- a/aws/sdk/aws-models/securityhub.json +++ b/aws/sdk/aws-models/securityhub.json @@ -13854,7 +13854,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.

\n

\n BatchImportFindings must be called by one of the following:

\n \n

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.

\n

After a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.

\n \n

Finding providers also should not use BatchImportFindings to update the following attributes.

\n \n

Instead, finding providers use FindingProviderFields to provide values for these attributes.

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

Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.

\n

\n BatchImportFindings must be called by one of the following:

\n \n

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.

\n

After a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.

\n \n

Finding providers also should not use BatchImportFindings to update the following attributes.

\n \n

Instead, finding providers use FindingProviderFields to provide values for these attributes.

", "smithy.api#http": { "method": "POST", "uri": "/findings/import", @@ -19886,7 +19886,7 @@ "name": "securityhub" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .

\n

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

\n

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

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

Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the \n Security HubUser\n Guide\n .

\n

When you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.

\n

For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.

\n

The following throttling limits apply to using Security Hub API operations.

\n ", "smithy.api#title": "AWS SecurityHub" }, "version": "2018-10-26", diff --git a/aws/sdk/aws-models/ssm-contacts.json b/aws/sdk/aws-models/ssm-contacts.json index 0279bc0cf..a097d2c3c 100644 --- a/aws/sdk/aws-models/ssm-contacts.json +++ b/aws/sdk/aws-models/ssm-contacts.json @@ -2099,7 +2099,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a resource to the specified contact or escalation plan.

" + "smithy.api#documentation": "

Adds a resource policy to the specified contact or escalation plan. The resource policy\n is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up\n cross-account functionality.

" } }, "com.amazonaws.ssmcontacts#PutContactPolicyRequest": { @@ -2247,6 +2247,21 @@ }, "com.amazonaws.ssmcontacts#SSMContacts": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "SSM Contacts", + "arnNamespace": "ssm-contacts", + "cloudFormationName": "SSMContacts", + "cloudTrailEventSource": "ssmcontacts.amazonaws.com", + "endpointPrefix": "ssm-contacts" + }, + "aws.auth#sigv4": { + "name": "ssm-contacts" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Systems Manager Incident Manager is an incident management console designed to help users\n mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.\n An incident is any unplanned interruption or reduction in quality of services.

\n

Incident Manager increases incident resolution by notifying responders of impact,\n highlighting relevant troubleshooting data, and providing collaboration tools to get\n services back up and running. To achieve the primary goal of reducing the\n time-to-resolution of critical incidents, Incident Manager automates response plans\n and enables responder team escalation.

", + "smithy.api#title": "AWS Systems Manager Incident Manager Contacts" + }, "version": "2021-05-03", "operations": [ { @@ -2330,22 +2345,7 @@ { "target": "com.amazonaws.ssmcontacts#UpdateContactChannel" } - ], - "traits": { - "aws.api#service": { - "sdkId": "SSM Contacts", - "arnNamespace": "ssm-contacts", - "cloudFormationName": "SSMContacts", - "cloudTrailEventSource": "ssmcontacts.amazonaws.com", - "endpointPrefix": "ssm-contacts" - }, - "aws.auth#sigv4": { - "name": "ssm-contacts" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Systems Manager Incident Manager is an incident management console designed to help users\n mitigate and recover from incidents affecting their Amazon Web Services-hosted applications.\n An incident is any unplanned interruption or reduction in quality of services.

\n

Incident Manager increases incident resolution by notifying responders of impact,\n highlighting relevant troubleshooting data, and providing collaboration tools to get\n services back up and running. To achieve the primary goal of reducing the\n time-to-resolution of critical incidents, Incident Manager automates response plans\n and enables responder team escalation.

", - "smithy.api#title": "AWS Systems Manager Incident Manager Contacts" - } + ] }, "com.amazonaws.ssmcontacts#SendActivationCode": { "type": "operation", diff --git a/aws/sdk/aws-models/ssm.json b/aws/sdk/aws-models/ssm.json index 68d0fd8d2..a5958e487 100644 --- a/aws/sdk/aws-models/ssm.json +++ b/aws/sdk/aws-models/ssm.json @@ -221,7 +221,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and\n patch baselines. Tags enable you to categorize your resources in different ways, for example, by\n purpose, owner, or environment. Each tag consists of a key and an optional value, both of which\n you define. For example, you could define a set of tags for your account's managed nodes that\n helps you track each node's owner and stack level. For example:

\n \n

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

\n

We recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.

\n

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you\n can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store\n parameters, and patch baselines. Tags enable you to categorize your resources in different ways,\n for example, by purpose, owner, or environment. Each tag consists of a key and an optional value,\n both of which you define. For example, you could define a set of tags for your account's managed\n nodes that helps you track each node's owner and stack level. For example:

\n \n

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5\n tags.

\n

We recommend that you devise a set of tag keys that meets your needs for each resource type.\n Using a consistent set of tag keys makes it easier for you to manage your resources. You can\n search and filter the resources based on the tags you add. Tags don't have any semantic meaning\n to and are interpreted strictly as a string of characters.

\n

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2\n resources in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ssm#AddTagsToResourceRequest": { @@ -886,6 +886,12 @@ "smithy.api#box": {}, "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" } + }, + "TargetMaps": { + "target": "com.amazonaws.ssm#TargetMaps", + "traits": { + "smithy.api#documentation": "

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.

" + } } }, "traits": { @@ -1084,6 +1090,12 @@ "smithy.api#box": {}, "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" } + }, + "TargetMaps": { + "target": "com.amazonaws.ssm#TargetMaps", + "traits": { + "smithy.api#documentation": "

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.

" + } } }, "traits": { @@ -1792,6 +1804,12 @@ "smithy.api#box": {}, "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" } + }, + "TargetMaps": { + "target": "com.amazonaws.ssm#TargetMaps", + "traits": { + "smithy.api#documentation": "

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.

" + } } }, "traits": { @@ -4286,6 +4304,9 @@ { "target": "com.amazonaws.ssm#InvalidTarget" }, + { + "target": "com.amazonaws.ssm#InvalidTargetMaps" + }, { "target": "com.amazonaws.ssm#UnsupportedPlatformType" } @@ -4333,6 +4354,9 @@ { "target": "com.amazonaws.ssm#InvalidTarget" }, + { + "target": "com.amazonaws.ssm#InvalidTargetMaps" + }, { "target": "com.amazonaws.ssm#UnsupportedPlatformType" } @@ -4473,6 +4497,12 @@ "smithy.api#box": {}, "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association.

" } + }, + "TargetMaps": { + "target": "com.amazonaws.ssm#TargetMaps", + "traits": { + "smithy.api#documentation": "

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.

" + } } }, "traits": { @@ -4600,7 +4630,13 @@ "target": "com.amazonaws.ssm#ScheduleOffset", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

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

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information\n about cron schedules for associations, see Reference: Cron\n and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

\n " + } + }, + "TargetMaps": { + "target": "com.amazonaws.ssm#TargetMaps", + "traits": { + "smithy.api#documentation": "

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.

" } } } @@ -10003,7 +10039,7 @@ "PluginName": { "target": "com.amazonaws.ssm#CommandPluginName", "traits": { - "smithy.api#documentation": "

The name of the plugin for which you want detailed results. If the document contains only\n one plugin, you can omit the name and details for that plugin. If the document contains more than\n one plugin, you must specify the name of the plugin for which you want to view details.

\n

Plugin names are also referred to as step names in Systems Manager documents (SSM\n documents). For example, aws:RunShellScript is a plugin.

\n

To find the PluginName, check the document content and find the name of the\n plugin. Alternatively, use ListCommandInvocations with the\n CommandId and Details parameters. The PluginName is the\n Name attribute of the CommandPlugin object in the\n CommandPlugins list.

" + "smithy.api#documentation": "

The name of the step for which you want detailed results. If the document contains only one\n step, you can omit the name and details for that step. If the document contains more than one\n step, you must specify the name of the step for which you want to view details. Be sure to\n specify the name of the step, not the name of a plugin like\n aws:RunShellScript.

\n

To find the PluginName, check the document content and find the name of the\n step you want details for. Alternatively, use ListCommandInvocations with the\n CommandId and Details parameters. The PluginName is the\n Name attribute of the CommandPlugin object in the\n CommandPlugins list.

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

Retrieves the details of a maintenance window task.

\n \t \n \t\t

For maintenance window tasks without a specified target, you can't supply values for\n \t\t\t--max-errors and --max-concurrency. Instead, the system inserts a\n \t\t\tplaceholder value of 1, which may be reported in the response to this command.\n \t\t\tThese values don't affect the running of your task and can be ignored.

\n \t \n \t

To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

" + "smithy.api#documentation": "

Retrieves the details of a maintenance window task.

\n \n

For maintenance window tasks without a specified target, you can't supply values for\n --max-errors and --max-concurrency. Instead, the system inserts a\n placeholder value of 1, which may be reported in the response to this command.\n These values don't affect the running of your task and can be ignored.

\n \n

To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

" } }, "com.amazonaws.ssm#GetMaintenanceWindowTaskRequest": { @@ -13547,6 +13583,22 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#InvalidTargetMaps": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssm#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidTargetMaps", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

TargetMap parameter isn't valid.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#InvalidTypeNameException": { "type": "structure", "members": { @@ -22480,6 +22532,12 @@ "smithy.api#documentation": "

A key-value mapping to target resources that the runbook operation performs tasks on.\n Required if you specify TargetParameterName.

" } }, + "TargetMaps": { + "target": "com.amazonaws.ssm#TargetMaps", + "traits": { + "smithy.api#documentation": "

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps\n can't be specified together.

" + } + }, "MaxConcurrency": { "target": "com.amazonaws.ssm#MaxConcurrency", "traits": { @@ -24734,6 +24792,9 @@ { "target": "com.amazonaws.ssm#InvalidTarget" }, + { + "target": "com.amazonaws.ssm#InvalidTargetMaps" + }, { "target": "com.amazonaws.ssm#InvalidUpdate" }, @@ -24855,7 +24916,13 @@ "target": "com.amazonaws.ssm#ScheduleOffset", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

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

Number of days to wait after the scheduled day to run an association. For example, if you\n specified a cron schedule of cron(0 0 ? * THU#2 *), you could specify an offset of 3\n to run the association each Sunday after the second Thursday of the month. For more information\n about cron schedules for associations, see Reference: Cron\n and rate expressions for Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n \n

To use offsets, you must specify the ApplyOnlyAtCronInterval parameter. This\n option tells the system not to run an association immediately after you create it.

\n " + } + }, + "TargetMaps": { + "target": "com.amazonaws.ssm#TargetMaps", + "traits": { + "smithy.api#documentation": "

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps\n can't be specified together.

" } } } diff --git a/aws/sdk/aws-models/synthetics.json b/aws/sdk/aws-models/synthetics.json index 9482d1469..880d0bf99 100644 --- a/aws/sdk/aws-models/synthetics.json +++ b/aws/sdk/aws-models/synthetics.json @@ -596,6 +596,50 @@ { "value": "INVALID_PERMISSIONS", "name": "INVALID_PERMISSIONS" + }, + { + "value": "CREATE_PENDING", + "name": "CREATE_PENDING" + }, + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "UPDATE_PENDING", + "name": "UPDATE_PENDING" + }, + { + "value": "UPDATE_IN_PROGRESS", + "name": "UPDATE_IN_PROGRESS" + }, + { + "value": "UPDATE_COMPLETE", + "name": "UPDATE_COMPLETE" + }, + { + "value": "ROLLBACK_COMPLETE", + "name": "ROLLBACK_COMPLETE" + }, + { + "value": "ROLLBACK_FAILED", + "name": "ROLLBACK_FAILED" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "SYNC_DELETE_IN_PROGRESS", + "name": "SYNC_DELETE_IN_PROGRESS" } ] } @@ -826,7 +870,7 @@ } ], "traits": { - "smithy.api#documentation": "

Permanently deletes the specified canary.

\n

When you delete a canary, resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to\n use again, you\n should also delete the following:

\n \n \n

Before you delete a canary, you might want to use GetCanary to display\n the information about this canary. Make\n note of the information returned by this operation so that you can delete these resources\n after you delete the canary.

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

Permanently deletes the specified canary.

\n

If you specify DeleteLambda to true, CloudWatch Synthetics also deletes\n the Lambda functions and layers that are used by the canary.

\n

Other esources used and created by the canary are not automatically deleted. \n After you delete a canary that you do not intend to\n use again, you\n should also delete the following:

\n \n \n

Before you delete a canary, you might want to use GetCanary to display\n the information about this canary. Make\n note of the information returned by this operation so that you can delete these resources\n after you delete the canary.

", "smithy.api#http": { "method": "DELETE", "uri": "/canary/{Name}", @@ -844,6 +888,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "DeleteLambda": { + "target": "com.amazonaws.synthetics#boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to also delete the Lambda functions and layers used by this canary. The default\n is false.

\n

Type: Boolean

", + "smithy.api#httpQuery": "deleteLambda" + } } } }, @@ -2067,6 +2118,9 @@ }, "com.amazonaws.synthetics#VpcId": { "type": "string" + }, + "com.amazonaws.synthetics#boolean": { + "type": "boolean" } } } diff --git a/aws/sdk/aws-models/wafv2.json b/aws/sdk/aws-models/wafv2.json index 3b2084ce6..dcfefb3f7 100644 --- a/aws/sdk/aws-models/wafv2.json +++ b/aws/sdk/aws-models/wafv2.json @@ -246,14 +246,14 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request\n JSON body that are within the JsonBody\n MatchScope. This is used with the FieldToMatch option\n JsonBody.\n \n

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

JSON specification: \"All\": {}\n

" + "smithy.api#documentation": "

Inspect all of the elements that WAF has parsed and extracted from the web request\n component that you've identified in your FieldToMatch specifications. \n

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"All\": {}\n

" } }, "com.amazonaws.wafv2#AllQueryArguments": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

All query arguments of a web request.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

JSON specification: \"AllQueryArguments\": {}\n

" + "smithy.api#documentation": "

Inspect all query arguments of the web request.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"AllQueryArguments\": {}\n

" } }, "com.amazonaws.wafv2#AllowAction": { @@ -311,7 +311,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.

" + "smithy.api#documentation": "

Associates a web ACL with a regional application resource, to protect the resource.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID\n to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution.

\n \n

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

" } }, "com.amazonaws.wafv2#AssociateWebACLRequest": { @@ -353,9 +353,16 @@ }, "com.amazonaws.wafv2#Body": { "type": "structure", - "members": {}, + "members": { + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the body of a web request\n when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to\n WAF by the underlying host service.

\n

The options for oversize handling are the following:

\n \n

You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

\n

Default: CONTINUE\n

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

The body of a web request. This immediately follows the request headers.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

JSON specification: \"Body\": {}\n

" + "smithy.api#documentation": "

Inspect the body of the web request. The body immediately follows the request headers.

\n

This is used to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

" } }, "com.amazonaws.wafv2#BodyParsingFallbackBehavior": { @@ -393,7 +400,7 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

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

The part of the web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, @@ -407,7 +414,7 @@ "PositionalConstraint": { "target": "com.amazonaws.wafv2#PositionalConstraint", "traits": { - "smithy.api#documentation": "

The area within the portion of a web request that you want WAF to search for\n SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of\n SearchString, but the location doesn't matter.

\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of\n SearchString, and SearchString must contain only alphanumeric\n characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must\n be a word, which means that both of the following are true:

\n \n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of\n SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified\n part of the web request.

\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of\n the web request.

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

The area within the portion of the web request that you want WAF to search for\n SearchString. Valid values include the following:

\n

\n CONTAINS\n

\n

The specified part of the web request must include the value of\n SearchString, but the location doesn't matter.

\n

\n CONTAINS_WORD\n

\n

The specified part of the web request must include the value of\n SearchString, and SearchString must contain only alphanumeric\n characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must\n be a word, which means that both of the following are true:

\n \n

\n EXACTLY\n

\n

The value of the specified part of the web request must exactly match the value of\n SearchString.

\n

\n STARTS_WITH\n

\n

The value of SearchString must appear at the beginning of the specified\n part of the web request.

\n

\n ENDS_WITH\n

\n

The value of SearchString must appear at the end of the specified part of\n the web request.

", "smithy.api#required": {} } } @@ -616,6 +623,73 @@ } } }, + "com.amazonaws.wafv2#CookieMatchPattern": { + "type": "structure", + "members": { + "All": { + "target": "com.amazonaws.wafv2#All", + "traits": { + "smithy.api#documentation": "

Inspect all cookies.

" + } + }, + "IncludedCookies": { + "target": "com.amazonaws.wafv2#CookieNames", + "traits": { + "smithy.api#documentation": "

Inspect only the cookies that have a key that matches one of the strings specified here.

" + } + }, + "ExcludedCookies": { + "target": "com.amazonaws.wafv2#CookieNames", + "traits": { + "smithy.api#documentation": "

Inspect only the cookies whose keys don't match any of the strings specified here.

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

The filter to use to identify the subset of cookies to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

\n

Example JSON: \"CookieMatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }\n

" + } + }, + "com.amazonaws.wafv2#CookieNames": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#SingleCookieName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 199 + } + } + }, + "com.amazonaws.wafv2#Cookies": { + "type": "structure", + "members": { + "MatchPattern": { + "target": "com.amazonaws.wafv2#CookieMatchPattern", + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of cookies to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

\n

Example JSON: \"CookieMatchPattern\": { \"IncludedCookies\": {\"KeyToInclude1\", \"KeyToInclude2\", \"KeyToInclude3\"} }\n

", + "smithy.api#required": {} + } + }, + "MatchScope": { + "target": "com.amazonaws.wafv2#MapMatchScope", + "traits": { + "smithy.api#documentation": "

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

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

What WAF should do if the cookies of the request are larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request cookies \n when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies\n and at most 8 KB of cookie contents to WAF.

\n

The options for oversize handling are the following:

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

Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow \n the set of cookies to inspect by including or excluding specific keys.

\n

This is used to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"Cookies\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\", \"OversizeHandling\": \"MATCH\" }\n

" + } + }, "com.amazonaws.wafv2#CountAction": { "type": "structure", "members": { @@ -1632,6 +1706,10 @@ { "value": "ZW", "name": "ZW" + }, + { + "value": "XK", + "name": "XK" } ] } @@ -1952,6 +2030,9 @@ "target": "com.amazonaws.wafv2#CreateWebACLResponse" }, "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, { "target": "com.amazonaws.wafv2#WAFDuplicateItemException" }, @@ -2621,7 +2702,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

" + "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

\n \n

Before deleting any web ACL, first disassociate it from all resources.

\n \n " } }, "com.amazonaws.wafv2#DeleteWebACLRequest": { @@ -2795,7 +2876,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n disassociate a web ACL, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution.

" + "smithy.api#documentation": "

Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one\n web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To\n disassociate a web ACL, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution.

" } }, "com.amazonaws.wafv2#DisassociateWebACLRequest": { @@ -2926,13 +3007,13 @@ "SingleHeader": { "target": "com.amazonaws.wafv2#SingleHeader", "traits": { - "smithy.api#documentation": "

Inspect a single header. Provide the name of the header to inspect, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" + "smithy.api#documentation": "

Inspect a single header. Provide the name of the header to inspect, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

\n

Alternately, you can filter and inspect all headers with the Headers \n FieldToMatch setting.

" } }, "SingleQueryArgument": { "target": "com.amazonaws.wafv2#SingleQueryArgument", "traits": { - "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such\n as UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + "smithy.api#documentation": "

Inspect a single query argument. Provide the name of the query argument to inspect, such\n as UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" } }, "AllQueryArguments": { @@ -2944,7 +3025,7 @@ "UriPath": { "target": "com.amazonaws.wafv2#UriPath", "traits": { - "smithy.api#documentation": "

Inspect the request URI path. This is the part of a web request that identifies a\n resource, for example, /images/daily-ad.jpg.

" + "smithy.api#documentation": "

Inspect the request URI path. This is the part of the web request that identifies a\n resource, for example, /images/daily-ad.jpg.

" } }, "QueryString": { @@ -2956,7 +3037,7 @@ "Body": { "target": "com.amazonaws.wafv2#Body", "traits": { - "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to\n WAF for inspection by the underlying host service. If you don't need to inspect more\n than 8 KB, you can guarantee that you don't allow additional bytes in by combining a\n statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement,\n with a SizeConstraintStatement that enforces an 8 KB size limit on the\n body of the request. WAF doesn't support inspecting the entire contents of web requests\n whose bodies exceed the 8 KB limit.

" + "smithy.api#documentation": "

Inspect the request body as plain text. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

Only the first 8 KB (8192 bytes) of the request body are forwarded to\n WAF for inspection by the underlying host service. For information about how to \n handle oversized request bodies, see the Body object configuration.

" } }, "Method": { @@ -2968,12 +3049,24 @@ "JsonBody": { "target": "com.amazonaws.wafv2#JsonBody", "traits": { - "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to\n WAF for inspection by the underlying host service. If you don't need to inspect more\n than 8 KB, you can guarantee that you don't allow additional bytes in by combining a\n statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement,\n with a SizeConstraintStatement that enforces an 8 KB size limit on the\n body of the request. WAF doesn't support inspecting the entire contents of web requests\n whose bodies exceed the 8 KB limit.

" + "smithy.api#documentation": "

Inspect the request body as JSON. The request body immediately follows the request\n headers. This is the part of a request that contains any additional data that you want to\n send to your web server as the HTTP request body, such as data from a form.

\n

Only the first 8 KB (8192 bytes) of the request body are forwarded to\n WAF for inspection by the underlying host service. For information about how to \n handle oversized request bodies, see the JsonBody object configuration.

" + } + }, + "Headers": { + "target": "com.amazonaws.wafv2#Headers", + "traits": { + "smithy.api#documentation": "

Inspect the request headers. You must configure scope and pattern matching filters \n in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

\n

Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to\n WAF for inspection by the underlying host service. You must configure \n how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters \n to the headers that it receives from the underlying host service.

" + } + }, + "Cookies": { + "target": "com.amazonaws.wafv2#Cookies", + "traits": { + "smithy.api#documentation": "

Inspect the request cookies. You must configure scope and pattern matching filters \n in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

\n

Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to\n WAF for inspection by the underlying host service. You must configure \n how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters \n to the cookies that it receives from the underlying host service.

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

The part of a web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.

\n

JSON specification for a QueryString field to match:

\n

\n \"FieldToMatch\": { \"QueryString\": {} }\n

\n

Example JSON for a Method field to match specification:

\n

\n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n

" + "smithy.api#documentation": "

The part of the web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.

\n

Example JSON for a QueryString field to match:

\n

\n \"FieldToMatch\": { \"QueryString\": {} }\n

\n

Example JSON for a Method field to match specification:

\n

\n \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }\n

" } }, "com.amazonaws.wafv2#FieldToMatchData": { @@ -4053,12 +4146,79 @@ "com.amazonaws.wafv2#HTTPVersion": { "type": "string" }, + "com.amazonaws.wafv2#HeaderMatchPattern": { + "type": "structure", + "members": { + "All": { + "target": "com.amazonaws.wafv2#All", + "traits": { + "smithy.api#documentation": "

Inspect all headers.

" + } + }, + "IncludedHeaders": { + "target": "com.amazonaws.wafv2#HeaderNames", + "traits": { + "smithy.api#documentation": "

Inspect only the headers that have a key that matches one of the strings specified here.

" + } + }, + "ExcludedHeaders": { + "target": "com.amazonaws.wafv2#HeaderNames", + "traits": { + "smithy.api#documentation": "

Inspect only the headers whose keys don't match any of the strings specified here.

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

The filter to use to identify the subset of headers to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

\n

Example JSON: \"HeaderMatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n

" + } + }, "com.amazonaws.wafv2#HeaderName": { "type": "string" }, + "com.amazonaws.wafv2#HeaderNames": { + "type": "list", + "member": { + "target": "com.amazonaws.wafv2#FieldToMatchData" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 199 + } + } + }, "com.amazonaws.wafv2#HeaderValue": { "type": "string" }, + "com.amazonaws.wafv2#Headers": { + "type": "structure", + "members": { + "MatchPattern": { + "target": "com.amazonaws.wafv2#HeaderMatchPattern", + "traits": { + "smithy.api#documentation": "

The filter to use to identify the subset of headers to inspect in a web request.

\n

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

\n

Example JSON: \"HeaderMatchPattern\": { \"ExcludedHeaders\": {\"KeyToExclude1\", \"KeyToExclude2\"} }\n

", + "smithy.api#required": {} + } + }, + "MatchScope": { + "target": "com.amazonaws.wafv2#MapMatchScope", + "traits": { + "smithy.api#documentation": "

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

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

What WAF should do if the headers of the request are larger than WAF can inspect. \n WAF does not support inspecting the entire contents of request headers \n when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers\n and at most 8 KB of header contents to WAF.

\n

The options for oversize handling are the following:

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

Inspect the headers in the web request. You can specify the parts of the headers to inspect and you can narrow \n the set of headers to inspect by including or excluding specific keys.

\n

This is used to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Alternately, you can use the SingleHeader \n FieldToMatch setting to inspect the value of a single header, identified by its key.

\n

Example JSON: \"Headers\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"KEY\", \"OversizeHandling\": \"MATCH\" }\n

" + } + }, "com.amazonaws.wafv2#IPAddress": { "type": "string", "traits": { @@ -4273,10 +4433,16 @@ "traits": { "smithy.api#documentation": "

What WAF should do if it fails to completely parse the JSON body. The options are\n the following:

\n \n

If you don't provide this setting, WAF parses and evaluates the content only up to the\n first parsing failure that it encounters.

\n

WAF does its best to parse the entire JSON body, but might be forced to stop for\n reasons such as invalid characters, duplicate keys, truncation, and any content whose root\n node isn't an object or an array.

\n

WAF parses the JSON in the following examples as two valid key, value pairs:

\n " } + }, + "OversizeHandling": { + "target": "com.amazonaws.wafv2#OversizeHandling", + "traits": { + "smithy.api#documentation": "

What WAF should do if the body is larger than WAF can inspect. \n WAF does not support inspecting the entire contents of the body of a web request\n when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to\n WAF by the underlying host service.

\n

The options for oversize handling are the following:

\n \n

You can combine the MATCH or NO_MATCH\n settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over 8 KB.

\n

Default: CONTINUE\n

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

The body of a web request, inspected as JSON. The body immediately follows the request\n headers. This is used in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you\n indicate.\n

\n

Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\" }\n

" + "smithy.api#documentation": "

Inspect the body of the web request as JSON. The body immediately follows the request\n headers.

\n

This is used to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Use the specifications in this object to indicate which parts of the JSON body to\n inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON\n that result from the matches that you\n indicate.\n

\n

Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\" }\n

" } }, "com.amazonaws.wafv2#JsonMatchPattern": { @@ -5588,11 +5754,30 @@ "smithy.api#documentation": "

Information for a single version of a managed rule set.

\n \n

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

\n

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

\n " } }, + "com.amazonaws.wafv2#MapMatchScope": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "KEY", + "name": "KEY" + }, + { + "value": "VALUE", + "name": "VALUE" + } + ] + } + }, "com.amazonaws.wafv2#Method": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

JSON specification: \"Method\": {}\n

" + "smithy.api#documentation": "

Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"Method\": {}\n

" } }, "com.amazonaws.wafv2#MetricName": { @@ -5707,6 +5892,25 @@ "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.

\n " } }, + "com.amazonaws.wafv2#OversizeHandling": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONTINUE", + "name": "CONTINUE" + }, + { + "value": "MATCH", + "name": "MATCH" + }, + { + "value": "NO_MATCH", + "name": "NO_MATCH" + } + ] + } + }, "com.amazonaws.wafv2#PaginationLimit": { "type": "integer", "traits": { @@ -5956,6 +6160,22 @@ { "value": "PAYLOAD_TYPE", "name": "PAYLOAD_TYPE" + }, + { + "value": "HEADER_MATCH_PATTERN", + "name": "HEADER_MATCH_PATTERN" + }, + { + "value": "COOKIE_MATCH_PATTERN", + "name": "COOKIE_MATCH_PATTERN" + }, + { + "value": "MAP_MATCH_SCOPE", + "name": "MAP_MATCH_SCOPE" + }, + { + "value": "OVERSIZE_HANDLING", + "name": "OVERSIZE_HANDLING" } ] } @@ -6261,7 +6481,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The query string of a web request. This is the part of a URL that appears after a ? character, if any.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

JSON specification: \"QueryString\": {}\n

" + "smithy.api#documentation": "

Inspect the query string of the web request. This is the part of a URL that appears after a ? character, if any.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"QueryString\": {}\n

" } }, "com.amazonaws.wafv2#RateBasedStatement": { @@ -6381,7 +6601,7 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

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

The part of the web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, @@ -6448,7 +6668,7 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

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

The part of the web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, @@ -7005,6 +7225,16 @@ "com.amazonaws.wafv2#SearchString": { "type": "blob" }, + "com.amazonaws.wafv2#SingleCookieName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "\\S" + } + }, "com.amazonaws.wafv2#SingleHeader": { "type": "structure", "members": { @@ -7017,7 +7247,7 @@ } }, "traits": { - "smithy.api#documentation": "

One of the headers in a web request, identified by name, for example,\n User-Agent or Referer. This setting isn't case\n sensitive.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" + "smithy.api#documentation": "

Inspect one of the headers in the web request, identified by name, for example,\n User-Agent or Referer. The name isn't case sensitive.

\n

You can filter and inspect all headers with the FieldToMatch setting Headers.

\n

This is used to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleHeader\": { \"Name\": \"haystack\" }\n

" } }, "com.amazonaws.wafv2#SingleQueryArgument": { @@ -7032,7 +7262,7 @@ } }, "traits": { - "smithy.api#documentation": "

One query argument in a web request, identified by name, for example\n UserName or SalesRegion. The name can be up to\n 30 characters long and isn't case sensitive.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" + "smithy.api#documentation": "

Inspect one query argument in the web request, identified by name, for example\n UserName or SalesRegion. The name isn't case sensitive.

\n

This is used to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

Example JSON: \"SingleQueryArgument\": { \"Name\": \"myArgument\" }\n

" } }, "com.amazonaws.wafv2#Size": { @@ -7050,7 +7280,7 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

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

The part of the web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, @@ -7092,7 +7322,7 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

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

The part of the web request that you want WAF to inspect. For more information, see FieldToMatch.

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

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.

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

Updates the specified IPSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.

\n \n \n

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

" } }, "com.amazonaws.wafv2#UpdateIPSetRequest": { @@ -7811,7 +8041,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.

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

Updates the specified RegexPatternSet.

\n \n

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.

\n \n \n

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

" } }, "com.amazonaws.wafv2#UpdateRegexPatternSetRequest": { @@ -7880,6 +8110,9 @@ "target": "com.amazonaws.wafv2#UpdateRuleGroupResponse" }, "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, { "target": "com.amazonaws.wafv2#WAFDuplicateItemException" }, @@ -7909,7 +8142,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.

\n \n

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

" + "smithy.api#documentation": "

Updates the specified RuleGroup.

\n \n

This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call.

\n \n \n

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

\n

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

" } }, "com.amazonaws.wafv2#UpdateRuleGroupRequest": { @@ -7990,6 +8223,9 @@ "target": "com.amazonaws.wafv2#UpdateWebACLResponse" }, "errors": [ + { + "target": "com.amazonaws.wafv2#WAFConfigurationWarningException" + }, { "target": "com.amazonaws.wafv2#WAFDuplicateItemException" }, @@ -8025,7 +8261,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified WebACL.

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.

\n \n

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

" + "smithy.api#documentation": "

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

\n \n

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

\n \n

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.

\n \n

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

" } }, "com.amazonaws.wafv2#UpdateWebACLRequest": { @@ -8114,7 +8350,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The path component of the URI of a web request. This is the part of a web request that identifies a resource. For example, /images/daily-ad.jpg.

\n

This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification.

\n

JSON specification: \"UriPath\": {}\n

" + "smithy.api#documentation": "

Inspect the path component of the URI of the web request. This is the part of the web request that identifies a resource. For example, /images/daily-ad.jpg.

\n

This is used only in the FieldToMatch specification for some web request component types.

\n

JSON specification: \"UriPath\": {}\n

" } }, "com.amazonaws.wafv2#UsernameField": { @@ -8218,7 +8454,19 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t perform the operation because your resource is being used by another\n resource or it’s associated with another resource.

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

WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.

\n

For DeleteWebACL, you will only get this exception if the web ACL is still associated with \n a regional resource. Deleting a web ACL that is still associated with an Amazon CloudFront distribution won't get this exception.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.wafv2#WAFConfigurationWarningException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. \n Rules that inspect the body must either provide an OversizeHandling configuration or they must \n be preceded by a SizeConstraintStatement that blocks the body content from being too large. \n Rules that inspect the headers or cookies must provide an OversizeHandling configuration.

\n

Provide the handling configuration and retry your operation.

\n

Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true).

", "smithy.api#error": "client" } }, @@ -8416,7 +8664,7 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t perform your tagging operation because of an internal error. Retry\n your request.

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

WAF couldn’t perform your tagging operation because of an internal error. Retry\n ybjectNoteWebRequestComponentour request.

", "smithy.api#error": "server" } }, @@ -8428,7 +8676,7 @@ } }, "traits": { - "smithy.api#documentation": "

WAF couldn’t retrieve the resource that you requested. Retry your request.

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

WAF couldn’t retrieve a resource that you specified for this operation. Verify the resources that you are specifying in your request parameters and then retry the operation.

", "smithy.api#error": "client" } }, @@ -8579,7 +8827,7 @@ "FieldToMatch": { "target": "com.amazonaws.wafv2#FieldToMatch", "traits": { - "smithy.api#documentation": "

The part of a web request that you want WAF to inspect. For more information, see FieldToMatch.

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

The part of the web request that you want WAF to inspect. For more information, see FieldToMatch.

", "smithy.api#required": {} } }, diff --git a/gradle.properties b/gradle.properties index a4b001e30..a71346f8b 100644 --- a/gradle.properties +++ b/gradle.properties @@ -8,10 +8,10 @@ rust.msrv=1.58.1 # Version number to use for the generated SDK # Note: these must always be full 3-segment semver versions -aws.sdk.version=0.11.0 +aws.sdk.version=0.12.0 # Version number to use for the generated runtime crates -smithy.rs.runtime.crate.version=0.41.0 +smithy.rs.runtime.crate.version=0.42.0 kotlin.code.style=official -- GitLab