From f322198c047da98d4adc5d828c23044708683bfe Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Mon, 28 Oct 2024 18:06:16 +0000 Subject: [PATCH] Update API model --- .../aws-models/mediapackagev2.json | 2183 ++++++++++++++--- .../sdk-codegen/aws-models/opensearch.json | 69 + codegen/sdk-codegen/aws-models/rds.json | 68 +- .../aws-models/storage-gateway.json | 28 +- 4 files changed, 2024 insertions(+), 324 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/mediapackagev2.json b/codegen/sdk-codegen/aws-models/mediapackagev2.json index 01de86232e9..430f33117da 100644 --- a/codegen/sdk-codegen/aws-models/mediapackagev2.json +++ b/codegen/sdk-codegen/aws-models/mediapackagev2.json @@ -42,6 +42,112 @@ } } }, + "com.amazonaws.mediapackagev2#CancelHarvestJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediapackagev2#CancelHarvestJobRequest" + }, + "output": { + "target": "com.amazonaws.mediapackagev2#CancelHarvestJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediapackagev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.mediapackagev2#ConflictException" + }, + { + "target": "com.amazonaws.mediapackagev2#InternalServerException" + }, + { + "target": "com.amazonaws.mediapackagev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mediapackagev2#ThrottlingException" + }, + { + "target": "com.amazonaws.mediapackagev2#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to cancel a harvest job on an endpoint", + "smithy.api#documentation": "

Cancels an in-progress harvest job.

", + "smithy.api#examples": [ + { + "title": "Cancel a Harvest Job", + "input": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "HarvestJobName": "HarvestJobName" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/harvestJob/{HarvestJobName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediapackagev2#CancelHarvestJobRequest": { + "type": "structure", + "members": { + "ChannelGroupName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel group containing the channel from which the harvest job is running.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel from which the harvest job is running.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HarvestJobName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.

", + "smithy.api#httpHeader": "x-amzn-update-if-match" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mediapackagev2#CancelHarvestJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.mediapackagev2#ChannelGroupListConfiguration": { "type": "structure", "members": { @@ -109,6 +215,9 @@ "resources": [ { "target": "com.amazonaws.mediapackagev2#ChannelResource" + }, + { + "target": "com.amazonaws.mediapackagev2#HarvestJobResource" } ], "traits": { @@ -821,123 +930,13 @@ "target": "com.amazonaws.mediapackagev2#CreateDashManifestConfiguration" } }, - "com.amazonaws.mediapackagev2#CreateHlsManifestConfiguration": { - "type": "structure", - "members": { - "ManifestName": { - "target": "com.amazonaws.mediapackagev2#ManifestName", - "traits": { - "smithy.api#documentation": "

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", - "smithy.api#required": {} - } - }, - "ChildManifestName": { - "target": "com.amazonaws.mediapackagev2#ManifestName", - "traits": { - "smithy.api#documentation": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

" - } - }, - "ScteHls": { - "target": "com.amazonaws.mediapackagev2#ScteHls" - }, - "StartTag": { - "target": "com.amazonaws.mediapackagev2#StartTag" - }, - "ManifestWindowSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The total duration (in seconds) of the manifest's content.

", - "smithy.api#range": { - "min": 30 - } - } - }, - "ProgramDateTimeIntervalSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", - "smithy.api#range": { - "min": 1, - "max": 1209600 - } - } - }, - "FilterConfiguration": { - "target": "com.amazonaws.mediapackagev2#FilterConfiguration" - } - }, - "traits": { - "smithy.api#documentation": "

Create an HTTP live streaming (HLS) manifest configuration.

" - } - }, - "com.amazonaws.mediapackagev2#CreateHlsManifests": { - "type": "list", - "member": { - "target": "com.amazonaws.mediapackagev2#CreateHlsManifestConfiguration" - } - }, - "com.amazonaws.mediapackagev2#CreateLowLatencyHlsManifestConfiguration": { - "type": "structure", - "members": { - "ManifestName": { - "target": "com.amazonaws.mediapackagev2#ManifestName", - "traits": { - "smithy.api#documentation": "

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", - "smithy.api#required": {} - } - }, - "ChildManifestName": { - "target": "com.amazonaws.mediapackagev2#ManifestName", - "traits": { - "smithy.api#documentation": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

" - } - }, - "ScteHls": { - "target": "com.amazonaws.mediapackagev2#ScteHls" - }, - "StartTag": { - "target": "com.amazonaws.mediapackagev2#StartTag" - }, - "ManifestWindowSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The total duration (in seconds) of the manifest's content.

", - "smithy.api#range": { - "min": 30 - } - } - }, - "ProgramDateTimeIntervalSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", - "smithy.api#range": { - "min": 1, - "max": 1209600 - } - } - }, - "FilterConfiguration": { - "target": "com.amazonaws.mediapackagev2#FilterConfiguration" - } - }, - "traits": { - "smithy.api#documentation": "

Create a low-latency HTTP live streaming (HLS) manifest configuration.

" - } - }, - "com.amazonaws.mediapackagev2#CreateLowLatencyHlsManifests": { - "type": "list", - "member": { - "target": "com.amazonaws.mediapackagev2#CreateLowLatencyHlsManifestConfiguration" - } - }, - "com.amazonaws.mediapackagev2#CreateOriginEndpoint": { + "com.amazonaws.mediapackagev2#CreateHarvestJob": { "type": "operation", "input": { - "target": "com.amazonaws.mediapackagev2#CreateOriginEndpointRequest" + "target": "com.amazonaws.mediapackagev2#CreateHarvestJobRequest" }, "output": { - "target": "com.amazonaws.mediapackagev2#CreateOriginEndpointResponse" + "target": "com.amazonaws.mediapackagev2#CreateHarvestJobResponse" }, "errors": [ { @@ -963,64 +962,492 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to create an origin endpoint for a channel", + "aws.iam#actionPermissionDescription": "Grants permission to create a HarvestJob", "aws.iam#conditionKeys": [ - "aws:TagKeys", - "aws:RequestTag/${TagKey}" + "aws:ResourceTag/${TagKey}" ], - "smithy.api#documentation": "

The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.

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

Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.

", "smithy.api#examples": [ { - "title": "Creating an OriginEndpoint with container type TS, and encryption enabled", + "title": "Creating a Harvest Job", "input": { "ChannelGroupName": "exampleChannelGroup", - "ChannelName": "exampleChannel", - "OriginEndpointName": "exampleOriginEndpointTS", - "ContainerType": "TS", - "Description": "Description for exampleOriginEndpointTS", - "StartoverWindowSeconds": 300, - "ForceEndpointErrorConfiguration": { - "EndpointErrorConditions": [ - "STALE_MANIFEST", - "INCOMPLETE_MANIFEST", - "MISSING_DRM_KEY", - "SLATE_INPUT" + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "Description": "Example HarvestJob description", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } ] }, - "Segment": { - "SegmentDurationSeconds": 6, - "SegmentName": "segmentName", - "TsUseAudioRenditionGroup": true, - "IncludeIframeOnlyStreams": true, - "TsIncludeDvbSubtitles": true, - "Scte": { - "ScteFilter": [ - "SPLICE_INSERT", - "BREAK" - ] - }, - "Encryption": { - "ConstantInitializationVector": "A382A901F3C1F7718512266CFFBB0B7E", - "EncryptionMethod": { - "TsEncryptionMethod": "AES_128" - }, - "KeyRotationIntervalSeconds": 300, - "SpekeKeyProvider": { - "EncryptionContractConfiguration": { - "PresetSpeke20Audio": "SHARED", - "PresetSpeke20Video": "SHARED" - }, - "ResourceId": "ResourceId", - "DrmSystems": [ - "CLEAR_KEY_AES_128" - ], - "RoleArn": "arn:aws:iam::123456789012:role/empRole", - "Url": "https://foo.com" - } - } + "ScheduleConfiguration": { + "StartTime": "2024-05-28T06:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" }, - "HlsManifests": [ - { + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + } + }, + "output": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + }, + "HarvestJobName": "HarvestJobName", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } + ] + }, + "Description": "Example HarvestJob description", + "ScheduleConfiguration": { + "StartTime": "2024-05-28T06:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" + }, + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName", + "CreatedAt": "2024-05-28T09:36:00.00Z", + "ModifiedAt": "2024-05-28T09:36:00.00Z", + "Status": "QUEUED", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", + "Tags": { + "key1": "value1", + "key2": "value2" + } + } + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/harvestJob" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediapackagev2#CreateHarvestJobRequest": { + "type": "structure", + "members": { + "ChannelGroupName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel group containing the channel from which to harvest content.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel from which to harvest content.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin endpoint from which to harvest content.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.mediapackagev2#ResourceDescription", + "traits": { + "smithy.api#documentation": "

An optional description for the harvest job.

" + } + }, + "HarvestedManifests": { + "target": "com.amazonaws.mediapackagev2#HarvestedManifests", + "traits": { + "smithy.api#documentation": "

A list of manifests to be harvested.

", + "smithy.api#required": {} + } + }, + "ScheduleConfiguration": { + "target": "com.amazonaws.mediapackagev2#HarvesterScheduleConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for when the harvest job should run, including start and end times.

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

The S3 destination where the harvested content will be placed.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.mediapackagev2#IdempotencyToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "smithy.api#httpHeader": "x-amzn-client-token", + "smithy.api#idempotencyToken": {} + } + }, + "HarvestJobName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

A name for the harvest job. This name must be unique within the channel.

" + } + }, + "Tags": { + "target": "com.amazonaws.mediapackagev2#TagMap", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

A collection of tags associated with the harvest job.

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

The request object for creating a new harvest job.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mediapackagev2#CreateHarvestJobResponse": { + "type": "structure", + "members": { + "ChannelGroupName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel group containing the channel from which content is being harvested.

", + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel from which content is being harvested.

", + "smithy.api#required": {} + } + }, + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin endpoint from which content is being harvested.

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

The S3 destination where the harvested content will be placed.

", + "smithy.api#required": {} + } + }, + "HarvestJobName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the created harvest job.

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

A list of manifests that will be harvested.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.mediapackagev2#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the harvest job, if provided.

" + } + }, + "ScheduleConfiguration": { + "target": "com.amazonaws.mediapackagev2#HarvesterScheduleConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for when the harvest job will run, including start and end times.

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

The Amazon Resource Name (ARN) of the created harvest job.

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

The date and time the harvest job was created.

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

The date and time the harvest job was last modified.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.mediapackagev2#HarvestJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).

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

An error message if the harvest job creation failed.

" + } + }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The current version of the harvest job. Used for concurrency control.

" + } + }, + "Tags": { + "target": "com.amazonaws.mediapackagev2#TagMap", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

A collection of tags associated with the harvest job.

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

The response object returned after creating a harvest job.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.mediapackagev2#CreateHlsManifestConfiguration": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ManifestName", + "traits": { + "smithy.api#documentation": "

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", + "smithy.api#required": {} + } + }, + "ChildManifestName": { + "target": "com.amazonaws.mediapackagev2#ManifestName", + "traits": { + "smithy.api#documentation": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

" + } + }, + "ScteHls": { + "target": "com.amazonaws.mediapackagev2#ScteHls" + }, + "StartTag": { + "target": "com.amazonaws.mediapackagev2#StartTag" + }, + "ManifestWindowSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total duration (in seconds) of the manifest's content.

", + "smithy.api#range": { + "min": 30 + } + } + }, + "ProgramDateTimeIntervalSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", + "smithy.api#range": { + "min": 1, + "max": 1209600 + } + } + }, + "FilterConfiguration": { + "target": "com.amazonaws.mediapackagev2#FilterConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Create an HTTP live streaming (HLS) manifest configuration.

" + } + }, + "com.amazonaws.mediapackagev2#CreateHlsManifests": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#CreateHlsManifestConfiguration" + } + }, + "com.amazonaws.mediapackagev2#CreateLowLatencyHlsManifestConfiguration": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ManifestName", + "traits": { + "smithy.api#documentation": "

A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

", + "smithy.api#required": {} + } + }, + "ChildManifestName": { + "target": "com.amazonaws.mediapackagev2#ManifestName", + "traits": { + "smithy.api#documentation": "

A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

" + } + }, + "ScteHls": { + "target": "com.amazonaws.mediapackagev2#ScteHls" + }, + "StartTag": { + "target": "com.amazonaws.mediapackagev2#StartTag" + }, + "ManifestWindowSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total duration (in seconds) of the manifest's content.

", + "smithy.api#range": { + "min": 30 + } + } + }, + "ProgramDateTimeIntervalSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", + "smithy.api#range": { + "min": 1, + "max": 1209600 + } + } + }, + "FilterConfiguration": { + "target": "com.amazonaws.mediapackagev2#FilterConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Create a low-latency HTTP live streaming (HLS) manifest configuration.

" + } + }, + "com.amazonaws.mediapackagev2#CreateLowLatencyHlsManifests": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#CreateLowLatencyHlsManifestConfiguration" + } + }, + "com.amazonaws.mediapackagev2#CreateOriginEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediapackagev2#CreateOriginEndpointRequest" + }, + "output": { + "target": "com.amazonaws.mediapackagev2#CreateOriginEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediapackagev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.mediapackagev2#ConflictException" + }, + { + "target": "com.amazonaws.mediapackagev2#InternalServerException" + }, + { + "target": "com.amazonaws.mediapackagev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mediapackagev2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.mediapackagev2#ThrottlingException" + }, + { + "target": "com.amazonaws.mediapackagev2#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create an origin endpoint for a channel", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], + "smithy.api#documentation": "

The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.

", + "smithy.api#examples": [ + { + "title": "Creating an OriginEndpoint with container type TS, and encryption enabled", + "input": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannel", + "OriginEndpointName": "exampleOriginEndpointTS", + "ContainerType": "TS", + "Description": "Description for exampleOriginEndpointTS", + "StartoverWindowSeconds": 300, + "ForceEndpointErrorConfiguration": { + "EndpointErrorConditions": [ + "STALE_MANIFEST", + "INCOMPLETE_MANIFEST", + "MISSING_DRM_KEY", + "SLATE_INPUT" + ] + }, + "Segment": { + "SegmentDurationSeconds": 6, + "SegmentName": "segmentName", + "TsUseAudioRenditionGroup": true, + "IncludeIframeOnlyStreams": true, + "TsIncludeDvbSubtitles": true, + "Scte": { + "ScteFilter": [ + "SPLICE_INSERT", + "BREAK" + ] + }, + "Encryption": { + "ConstantInitializationVector": "A382A901F3C1F7718512266CFFBB0B7E", + "EncryptionMethod": { + "TsEncryptionMethod": "AES_128" + }, + "KeyRotationIntervalSeconds": 300, + "SpekeKeyProvider": { + "EncryptionContractConfiguration": { + "PresetSpeke20Audio": "SHARED", + "PresetSpeke20Video": "SHARED" + }, + "ResourceId": "ResourceId", + "DrmSystems": [ + "CLEAR_KEY_AES_128" + ], + "RoleArn": "arn:aws:iam::123456789012:role/empRole", + "Url": "https://foo.com" + } + } + }, + "HlsManifests": [ + { "ManifestName": "exampleManifest1", "ChildManifestName": "exampleChildManifest1", "ScteHls": { @@ -2171,6 +2598,21 @@ "smithy.api#output": {} } }, + "com.amazonaws.mediapackagev2#Destination": { + "type": "structure", + "members": { + "S3Destination": { + "target": "com.amazonaws.mediapackagev2#S3DestinationConfig", + "traits": { + "smithy.api#documentation": "

The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket.

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

The configuration for the destination where the harvested content will be exported.

" + } + }, "com.amazonaws.mediapackagev2#DrmSystem": { "type": "enum", "members": { @@ -2827,66 +3269,365 @@ "smithy.api#documentation": "

The total duration (in seconds) of the manifest's content.

" } }, - "FilterConfiguration": { - "target": "com.amazonaws.mediapackagev2#FilterConfiguration" - }, - "MinUpdatePeriodSeconds": { - "target": "smithy.api#Integer", + "FilterConfiguration": { + "target": "com.amazonaws.mediapackagev2#FilterConfiguration" + }, + "MinUpdatePeriodSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

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

Minimum amount of content (in seconds) that a player must keep available in the buffer.

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

The amount of time (in seconds) that the player should be from the end of the manifest.

" + } + }, + "SegmentTemplateFormat": { + "target": "com.amazonaws.mediapackagev2#DashSegmentTemplateFormat", + "traits": { + "smithy.api#documentation": "

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

\n

Value description:

\n " + } + }, + "PeriodTriggers": { + "target": "com.amazonaws.mediapackagev2#DashPeriodTriggers", + "traits": { + "smithy.api#documentation": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

" + } + }, + "ScteDash": { + "target": "com.amazonaws.mediapackagev2#ScteDash", + "traits": { + "smithy.api#documentation": "

The SCTE configuration.

" + } + }, + "DrmSignaling": { + "target": "com.amazonaws.mediapackagev2#DashDrmSignaling", + "traits": { + "smithy.api#documentation": "

Determines how the DASH manifest signals the DRM content.

" + } + }, + "UtcTiming": { + "target": "com.amazonaws.mediapackagev2#DashUtcTiming", + "traits": { + "smithy.api#documentation": "

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

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

Retrieve the DASH manifest configuration.

" + } + }, + "com.amazonaws.mediapackagev2#GetDashManifests": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#GetDashManifestConfiguration" + } + }, + "com.amazonaws.mediapackagev2#GetHarvestJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediapackagev2#GetHarvestJobRequest" + }, + "output": { + "target": "com.amazonaws.mediapackagev2#GetHarvestJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediapackagev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.mediapackagev2#InternalServerException" + }, + { + "target": "com.amazonaws.mediapackagev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mediapackagev2#ThrottlingException" + }, + { + "target": "com.amazonaws.mediapackagev2#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve a HarvestJob", + "smithy.api#documentation": "

Retrieves the details of a specific harvest job.

", + "smithy.api#examples": [ + { + "title": "Getting a Harvest Job", + "input": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "HarvestJobName": "HarvestJobName" + }, + "output": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + }, + "HarvestJobName": "HarvestJobName", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } + ] + }, + "Description": "Example HarvestJob description", + "ScheduleConfiguration": { + "StartTime": "2024-05-28T06:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" + }, + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName", + "CreatedAt": "2024-05-28T09:36:00.00Z", + "ModifiedAt": "2024-05-28T09:36:00.00Z", + "Status": "QUEUED", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", + "Tags": { + "key1": "value1", + "key2": "value2" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/harvestJob/{HarvestJobName}" + }, + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "HarvestJobFinished": { + "description": "Waits for the HarvestJob to conclude to return", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Status", + "expected": "COMPLETED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "Status", + "expected": "CANCELLED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Status", + "expected": "QUEUED", + "comparator": "stringEquals" + } + } + }, + { + "state": "retry", + "matcher": { + "output": { + "path": "Status", + "expected": "IN_PROGRESS", + "comparator": "stringEquals" + } + } + } + ] + } + } + } + }, + "com.amazonaws.mediapackagev2#GetHarvestJobRequest": { + "type": "structure", + "members": { + "ChannelGroupName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel group containing the channel associated with the harvest job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel associated with the harvest job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin endpoint associated with the harvest job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "HarvestJobName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the harvest job to retrieve.

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

The request object for retrieving a specific harvest job.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.mediapackagev2#GetHarvestJobResponse": { + "type": "structure", + "members": { + "ChannelGroupName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel group containing the channel associated with the harvest job.

", + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel associated with the harvest job.

", + "smithy.api#required": {} + } + }, + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin endpoint associated with the harvest job.

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

The S3 destination where the harvested content is being placed.

", + "smithy.api#required": {} + } + }, + "HarvestJobName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the harvest job.

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

A list of manifests that are being or have been harvested.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.mediapackagev2#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description of the harvest job, if provided.

" + } + }, + "ScheduleConfiguration": { + "target": "com.amazonaws.mediapackagev2#HarvesterScheduleConfiguration", "traits": { - "smithy.api#documentation": "

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

" + "smithy.api#documentation": "

The configuration for when the harvest job is scheduled to run, including start and end times.

", + "smithy.api#required": {} } }, - "MinBufferTimeSeconds": { - "target": "smithy.api#Integer", + "Arn": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Minimum amount of content (in seconds) that a player must keep available in the buffer.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the harvest job.

", + "smithy.api#required": {} } }, - "SuggestedPresentationDelaySeconds": { - "target": "smithy.api#Integer", + "CreatedAt": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The amount of time (in seconds) that the player should be from the end of the manifest.

" + "smithy.api#documentation": "

The date and time when the harvest job was created.

", + "smithy.api#required": {} } }, - "SegmentTemplateFormat": { - "target": "com.amazonaws.mediapackagev2#DashSegmentTemplateFormat", + "ModifiedAt": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

\n

Value description:

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

The date and time when the harvest job was last modified.

", + "smithy.api#required": {} } }, - "PeriodTriggers": { - "target": "com.amazonaws.mediapackagev2#DashPeriodTriggers", + "Status": { + "target": "com.amazonaws.mediapackagev2#HarvestJobStatus", "traits": { - "smithy.api#documentation": "

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period.\n For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

" + "smithy.api#documentation": "

The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).

", + "smithy.api#required": {} } }, - "ScteDash": { - "target": "com.amazonaws.mediapackagev2#ScteDash", + "ErrorMessage": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The SCTE configuration.

" + "smithy.api#documentation": "

An error message if the harvest job encountered any issues.

" } }, - "DrmSignaling": { - "target": "com.amazonaws.mediapackagev2#DashDrmSignaling", + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", "traits": { - "smithy.api#documentation": "

Determines how the DASH manifest signals the DRM content.

" + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The current version of the harvest job. Used for concurrency control.

" } }, - "UtcTiming": { - "target": "com.amazonaws.mediapackagev2#DashUtcTiming", + "Tags": { + "target": "com.amazonaws.mediapackagev2#TagMap", "traits": { - "smithy.api#documentation": "

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

" + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

A collection of tags associated with the harvest job.

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

Retrieve the DASH manifest configuration.

" - } - }, - "com.amazonaws.mediapackagev2#GetDashManifests": { - "type": "list", - "member": { - "target": "com.amazonaws.mediapackagev2#GetDashManifestConfiguration" + "smithy.api#documentation": "

The response object containing the details of the requested harvest job.

", + "smithy.api#output": {} } }, "com.amazonaws.mediapackagev2#GetHlsManifestConfiguration": { @@ -3319,93 +4060,388 @@ "smithy.api#required": {} } }, - "OriginEndpointName": { - "target": "com.amazonaws.mediapackagev2#ResourceName", + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

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

The type of container attached to this origin endpoint.

", + "smithy.api#required": {} + } + }, + "Segment": { + "target": "com.amazonaws.mediapackagev2#Segment", + "traits": { + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the origin endpoint was created.

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

The date and time the origin endpoint was modified.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.mediapackagev2#ResourceDescription", + "traits": { + "smithy.api#documentation": "

The description for your origin endpoint.

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

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

" + } + }, + "HlsManifests": { + "target": "com.amazonaws.mediapackagev2#GetHlsManifests", + "traits": { + "smithy.api#documentation": "

An HTTP live streaming (HLS) manifest configuration.

" + } + }, + "LowLatencyHlsManifests": { + "target": "com.amazonaws.mediapackagev2#GetLowLatencyHlsManifests", + "traits": { + "smithy.api#documentation": "

A low-latency HLS manifest configuration.

" + } + }, + "DashManifests": { + "target": "com.amazonaws.mediapackagev2#GetDashManifests", + "traits": { + "smithy.api#documentation": "

A DASH manifest configuration.

" + } + }, + "ForceEndpointErrorConfiguration": { + "target": "com.amazonaws.mediapackagev2#ForceEndpointErrorConfiguration", + "traits": { + "smithy.api#documentation": "

The failover settings for the endpoint.

" + } + }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

" + } + }, + "Tags": { + "target": "com.amazonaws.mediapackagev2#TagMap", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The comma-separated list of tag key:value pairs assigned to the origin endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mediapackagev2#HarvestJob": { + "type": "structure", + "members": { + "ChannelGroupName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel group containing the channel associated with this harvest job.

", + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel associated with this harvest job.

", + "smithy.api#required": {} + } + }, + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin endpoint associated with this harvest job.

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

The S3 destination where the harvested content will be placed.

", + "smithy.api#required": {} + } + }, + "HarvestJobName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the harvest job.

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

A list of manifests that are being or have been harvested.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.mediapackagev2#ResourceDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the harvest job.

" + } + }, + "ScheduleConfiguration": { + "target": "com.amazonaws.mediapackagev2#HarvesterScheduleConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for when the harvest job is scheduled to run.

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

The Amazon Resource Name (ARN) of the harvest job.

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

The date and time when the harvest job was created.

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

The date and time when the harvest job was last modified.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.mediapackagev2#HarvestJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).

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

An error message if the harvest job encountered any issues.

" + } + }, + "ETag": { + "target": "com.amazonaws.mediapackagev2#EntityTag", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The current version of the harvest job. Used for concurrency control.

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

Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket.

" + } + }, + "com.amazonaws.mediapackagev2#HarvestJobResource": { + "type": "resource", + "identifiers": { + "ChannelGroupName": { + "target": "com.amazonaws.mediapackagev2#ResourceName" + }, + "ChannelName": { + "target": "com.amazonaws.mediapackagev2#ResourceName" + }, + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName" + }, + "HarvestJobName": { + "target": "com.amazonaws.mediapackagev2#ResourceName" + } + }, + "create": { + "target": "com.amazonaws.mediapackagev2#CreateHarvestJob" + }, + "read": { + "target": "com.amazonaws.mediapackagev2#GetHarvestJob" + }, + "update": { + "target": "com.amazonaws.mediapackagev2#CancelHarvestJob" + }, + "list": { + "target": "com.amazonaws.mediapackagev2#ListHarvestJobs" + }, + "traits": { + "aws.api#arn": { + "template": "channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/harvestJob/{HarvestJobName}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "

A HarvestJob resource represents a request to export content from a MediaPackage v2 channel to an S3 bucket.

" + } + }, + "com.amazonaws.mediapackagev2#HarvestJobStatus": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

", - "smithy.api#required": {} + "smithy.api#enumValue": "IN_PROGRESS" } }, - "ContainerType": { - "target": "com.amazonaws.mediapackagev2#ContainerType", + "CANCELLED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The type of container attached to this origin endpoint.

", - "smithy.api#required": {} + "smithy.api#enumValue": "CANCELLED" } }, - "Segment": { - "target": "com.amazonaws.mediapackagev2#Segment", + "COMPLETED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#required": {} + "smithy.api#enumValue": "COMPLETED" } }, - "CreatedAt": { - "target": "smithy.api#Timestamp", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The date and time the origin endpoint was created.

", - "smithy.api#required": {} + "smithy.api#enumValue": "FAILED" } - }, - "ModifiedAt": { - "target": "smithy.api#Timestamp", + } + } + }, + "com.amazonaws.mediapackagev2#HarvestJobsList": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#HarvestJob" + } + }, + "com.amazonaws.mediapackagev2#HarvestedDashManifest": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", "traits": { - "smithy.api#documentation": "

The date and time the origin endpoint was modified.

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

The name of the harvested DASH manifest.

", "smithy.api#required": {} } - }, - "Description": { - "target": "com.amazonaws.mediapackagev2#ResourceDescription", + } + }, + "traits": { + "smithy.api#documentation": "

Information about a harvested DASH manifest.

" + } + }, + "com.amazonaws.mediapackagev2#HarvestedDashManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#HarvestedDashManifest" + } + }, + "com.amazonaws.mediapackagev2#HarvestedHlsManifest": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", "traits": { - "smithy.api#documentation": "

The description for your origin endpoint.

" + "smithy.api#documentation": "

The name of the harvested HLS manifest.

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

Information about a harvested HLS manifest.

" + } + }, + "com.amazonaws.mediapackagev2#HarvestedHlsManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#HarvestedHlsManifest" + } + }, + "com.amazonaws.mediapackagev2#HarvestedLowLatencyHlsManifest": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", "traits": { - "smithy.api#documentation": "

The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

" + "smithy.api#documentation": "

The name of the harvested Low-Latency HLS manifest.

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

Information about a harvested Low-Latency HLS manifest.

" + } + }, + "com.amazonaws.mediapackagev2#HarvestedLowLatencyHlsManifestsList": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#HarvestedLowLatencyHlsManifest" + } + }, + "com.amazonaws.mediapackagev2#HarvestedManifests": { + "type": "structure", + "members": { "HlsManifests": { - "target": "com.amazonaws.mediapackagev2#GetHlsManifests", - "traits": { - "smithy.api#documentation": "

An HTTP live streaming (HLS) manifest configuration.

" - } - }, - "LowLatencyHlsManifests": { - "target": "com.amazonaws.mediapackagev2#GetLowLatencyHlsManifests", + "target": "com.amazonaws.mediapackagev2#HarvestedHlsManifestsList", "traits": { - "smithy.api#documentation": "

A low-latency HLS manifest configuration.

" + "smithy.api#documentation": "

A list of harvested HLS manifests.

" } }, "DashManifests": { - "target": "com.amazonaws.mediapackagev2#GetDashManifests", + "target": "com.amazonaws.mediapackagev2#HarvestedDashManifestsList", "traits": { - "smithy.api#documentation": "

A DASH manifest configuration.

" + "smithy.api#documentation": "

A list of harvested DASH manifests.

" } }, - "ForceEndpointErrorConfiguration": { - "target": "com.amazonaws.mediapackagev2#ForceEndpointErrorConfiguration", + "LowLatencyHlsManifests": { + "target": "com.amazonaws.mediapackagev2#HarvestedLowLatencyHlsManifestsList", "traits": { - "smithy.api#documentation": "

The failover settings for the endpoint.

" + "smithy.api#documentation": "

A list of harvested Low-Latency HLS manifests.

" } - }, - "ETag": { - "target": "com.amazonaws.mediapackagev2#EntityTag", + } + }, + "traits": { + "smithy.api#documentation": "

A collection of harvested manifests of different types.

" + } + }, + "com.amazonaws.mediapackagev2#HarvesterScheduleConfiguration": { + "type": "structure", + "members": { + "StartTime": { + "target": "smithy.api#Timestamp", "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

" + "smithy.api#documentation": "

The start time for the harvest job.

", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.mediapackagev2#TagMap", + "EndTime": { + "target": "smithy.api#Timestamp", "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The comma-separated list of tag key:value pairs assigned to the origin endpoint.

" + "smithy.api#documentation": "

The end time for the harvest job.

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

Defines the schedule configuration for a harvest job.

" } }, "com.amazonaws.mediapackagev2#IdempotencyToken": { @@ -3565,30 +4601,177 @@ "com.amazonaws.mediapackagev2#ListChannelGroupsResponse": { "type": "structure", "members": { - "Items": { - "target": "com.amazonaws.mediapackagev2#ChannelGroupsList", + "Items": { + "target": "com.amazonaws.mediapackagev2#ChannelGroupsList", + "traits": { + "smithy.api#documentation": "

The objects being returned.

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

The pagination token from the GET list request. Use the token to fetch the next page of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mediapackagev2#ListChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediapackagev2#ListChannelsRequest" + }, + "output": { + "target": "com.amazonaws.mediapackagev2#ListChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediapackagev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.mediapackagev2#InternalServerException" + }, + { + "target": "com.amazonaws.mediapackagev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.mediapackagev2#ThrottlingException" + }, + { + "target": "com.amazonaws.mediapackagev2#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to list all channels in a channel group", + "smithy.api#documentation": "

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

", + "smithy.api#examples": [ + { + "title": "Listing all Channels", + "input": { + "ChannelGroupName": "exampleChannelGroup" + }, + "output": { + "Items": [ + { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannel", + "Description": "Description for exampleChannel", + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel", + "CreatedAt": "2022-10-18T09:36:00.00Z", + "ModifiedAt": "2022-10-18T09:36:00.00Z" + }, + { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "anotherExampleChannel", + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/anotherExampleChannel", + "CreatedAt": "2022-10-18T10:36:00.00Z", + "ModifiedAt": "2022-10-18T10:36:00.00Z" + } + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/channelGroup/{ChannelGroupName}/channel", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediapackagev2#ListChannelsRequest": { + "type": "structure", + "members": { + "ChannelGroupName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.mediapackagev2#ListResourceMaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "

The maximum number of results to return in the response.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The pagination token from the GET list request. Use the token to fetch the next page of results.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.mediapackagev2#ListChannelsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediapackagev2#ChannelList", + "traits": { + "smithy.api#documentation": "

The objects being returned.

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

The pagination token from the GET list request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.mediapackagev2#ListDashManifestConfiguration": { + "type": "structure", + "members": { + "ManifestName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", "traits": { - "smithy.api#documentation": "

The objects being returned.

" + "smithy.api#documentation": "

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

", + "smithy.api#required": {} } }, - "NextToken": { + "Url": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The pagination token from the GET list request. Use the token to fetch the next page of results.

" + "smithy.api#documentation": "

The egress domain URL for stream delivery from MediaPackage.

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

List the DASH manifest configuration.

" } }, - "com.amazonaws.mediapackagev2#ListChannels": { + "com.amazonaws.mediapackagev2#ListDashManifests": { + "type": "list", + "member": { + "target": "com.amazonaws.mediapackagev2#ListDashManifestConfiguration" + } + }, + "com.amazonaws.mediapackagev2#ListHarvestJobs": { "type": "operation", "input": { - "target": "com.amazonaws.mediapackagev2#ListChannelsRequest" + "target": "com.amazonaws.mediapackagev2#ListHarvestJobsRequest" }, "output": { - "target": "com.amazonaws.mediapackagev2#ListChannelsResponse" + "target": "com.amazonaws.mediapackagev2#ListHarvestJobsResponse" }, "errors": [ { @@ -3608,11 +4791,11 @@ } ], "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to list all channels in a channel group", - "smithy.api#documentation": "

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

", + "aws.iam#actionPermissionDescription": "Grants permission to list all harvest jobs of a ChannelGroup, Channel, or OriginEndpoint", + "smithy.api#documentation": "

Retrieves a list of harvest jobs that match the specified criteria.

", "smithy.api#examples": [ { - "title": "Listing all Channels", + "title": "ListHarvestJobs: Specify ChannelGroup only", "input": { "ChannelGroupName": "exampleChannelGroup" }, @@ -3620,26 +4803,309 @@ "Items": [ { "ChannelGroupName": "exampleChannelGroup", - "ChannelName": "exampleChannel", - "Description": "Description for exampleChannel", - "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel", - "CreatedAt": "2022-10-18T09:36:00.00Z", - "ModifiedAt": "2022-10-18T09:36:00.00Z" + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + }, + "HarvestJobName": "HarvestJobName", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } + ] + }, + "Description": "Example HarvestJob description", + "ScheduleConfiguration": { + "StartTime": "2024-05-28T06:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" + }, + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName", + "CreatedAt": "2024-05-28T09:36:00.00Z", + "ModifiedAt": "2024-05-28T09:36:00.00Z", + "Status": "QUEUED", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", + "Tags": { + "key1": "value1", + "key2": "value2" + } }, { "ChannelGroupName": "exampleChannelGroup", - "ChannelName": "anotherExampleChannel", - "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/anotherExampleChannel", - "CreatedAt": "2022-10-18T10:36:00.00Z", - "ModifiedAt": "2022-10-18T10:36:00.00Z" + "ChannelName": "exampleChannelName2", + "OriginEndpointName": "exampleOriginEndpointName2", + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + }, + "HarvestJobName": "HarvestJobName2", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } + ] + }, + "Description": "Example HarvestJob2 description", + "ScheduleConfiguration": { + "StartTime": "2024-05-28T02:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" + }, + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName2/originEndpoint/exampleOriginEndpointName2/harvestJob/HarvestJobName2", + "CreatedAt": "2024-05-28T15:30:00.00Z", + "ModifiedAt": "2024-05-28T15:30:00.00Z", + "Status": "IN_PROGRESS", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", + "Tags": { + "key1": "value1", + "key2": "value2" + } } - ] + ], + "NextToken": "someTokenValue" + } + }, + { + "title": "ListHarvestJobs: Specify ChannelGroup, Channel only", + "input": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName" + }, + "output": { + "Items": [ + { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + }, + "HarvestJobName": "HarvestJobName", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } + ] + }, + "Description": "Example HarvestJob description", + "ScheduleConfiguration": { + "StartTime": "2024-05-28T06:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" + }, + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName", + "CreatedAt": "2024-05-28T09:36:00.00Z", + "ModifiedAt": "2024-05-28T09:36:00.00Z", + "Status": "QUEUED", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", + "Tags": { + "key1": "value1", + "key2": "value2" + } + }, + { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName2", + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + }, + "HarvestJobName": "HarvestJobName2", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } + ] + }, + "Description": "Example HarvestJob2 description", + "ScheduleConfiguration": { + "StartTime": "2024-05-28T02:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" + }, + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName2/harvestJob/HarvestJobName2", + "CreatedAt": "2024-05-28T15:30:00.00Z", + "ModifiedAt": "2024-05-28T15:30:00.00Z", + "Status": "IN_PROGRESS", + "Tags": { + "key1": "value1", + "key2": "value2" + } + } + ], + "NextToken": "someTokenValue" + } + }, + { + "title": "ListHarvestJobs: Specify ChannelGroup, Channel, OriginEndpoint", + "input": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName" + }, + "output": { + "Items": [ + { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + }, + "HarvestJobName": "HarvestJobName", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } + ] + }, + "Description": "Example HarvestJob description", + "ScheduleConfiguration": { + "StartTime": "2024-05-28T06:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" + }, + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName", + "CreatedAt": "2024-05-28T09:36:00.00Z", + "ModifiedAt": "2024-05-28T09:36:00.00Z", + "Status": "QUEUED", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=" + } + ], + "NextToken": "someTokenValue" + } + }, + { + "title": "ListHarvestJobs: Specify ChannelGroup, Channel, OriginEndpoint + Status filter", + "input": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "Status": "QUEUED" + }, + "output": { + "Items": [ + { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName", + "Destination": { + "S3Destination": { + "BucketName": "harvestJobS3DestinationBucket", + "DestinationPath": "manifests" + } + }, + "HarvestJobName": "HarvestJobName", + "HarvestedManifests": { + "HlsManifests": [ + { + "ManifestName": "HlsManifest" + } + ], + "DashManifests": [ + { + "ManifestName": "DashManifest" + } + ], + "LowLatencyHlsManifests": [ + { + "ManifestName": "LowLatencyHlsManifest" + } + ] + }, + "Description": "Example HarvestJob description", + "ScheduleConfiguration": { + "StartTime": "2024-05-28T06:00:00.00Z", + "EndTime": "2024-05-28T12:00:00.00Z" + }, + "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannelName/originEndpoint/exampleOriginEndpointName/harvestJob/HarvestJobName", + "CreatedAt": "2024-05-28T09:36:00.00Z", + "ModifiedAt": "2024-05-28T09:36:00.00Z", + "Status": "QUEUED", + "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=" + } + ], + "NextToken": "someTokenValue" } + }, + { + "title": "ListHarvestJobs: Empty response", + "input": { + "ChannelGroupName": "exampleChannelGroup", + "ChannelName": "exampleChannelName", + "OriginEndpointName": "exampleOriginEndpointName" + }, + "output": {} } ], "smithy.api#http": { "method": "GET", - "uri": "/channelGroup/{ChannelGroupName}/channel", + "uri": "/channelGroup/{ChannelGroupName}/harvestJob", "code": 200 }, "smithy.api#paginated": { @@ -3651,84 +5117,94 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.mediapackagev2#ListChannelsRequest": { + "com.amazonaws.mediapackagev2#ListHarvestJobsRequest": { "type": "structure", "members": { "ChannelGroupName": { "target": "com.amazonaws.mediapackagev2#ResourceName", "traits": { - "smithy.api#documentation": "

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

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

The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "ChannelName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.

", + "smithy.api#httpQuery": "channelName", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "OriginEndpointName": { + "target": "com.amazonaws.mediapackagev2#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.

", + "smithy.api#httpQuery": "originEndpointName", + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "Status": { + "target": "com.amazonaws.mediapackagev2#HarvestJobStatus", + "traits": { + "smithy.api#documentation": "

The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.

", + "smithy.api#httpQuery": "includeStatus" + } + }, "MaxResults": { "target": "com.amazonaws.mediapackagev2#ListResourceMaxResults", "traits": { "smithy.api#default": 10, - "smithy.api#documentation": "

The maximum number of results to return in the response.

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The pagination token from the GET list request. Use the token to fetch the next page of results.

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

A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.

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

The request object for listing harvest jobs.

", "smithy.api#input": {} } }, - "com.amazonaws.mediapackagev2#ListChannelsResponse": { + "com.amazonaws.mediapackagev2#ListHarvestJobsResponse": { "type": "structure", "members": { "Items": { - "target": "com.amazonaws.mediapackagev2#ChannelList", + "target": "com.amazonaws.mediapackagev2#HarvestJobsList", "traits": { - "smithy.api#documentation": "

The objects being returned.

" + "smithy.api#documentation": "

An array of harvest job objects that match the specified criteria.

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

The pagination token from the GET list request.

" + "smithy.api#documentation": "

A token used for pagination. Include this value in subsequent requests to retrieve the next set of results. If null, there are no more results to retrieve.

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

The response object containing the list of harvest jobs that match the specified criteria.

", "smithy.api#output": {} } }, - "com.amazonaws.mediapackagev2#ListDashManifestConfiguration": { - "type": "structure", - "members": { - "ManifestName": { - "target": "com.amazonaws.mediapackagev2#ResourceName", - "traits": { - "smithy.api#documentation": "

A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

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

The egress domain URL for stream delivery from MediaPackage.

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

List the DASH manifest configuration.

" - } - }, - "com.amazonaws.mediapackagev2#ListDashManifests": { - "type": "list", - "member": { - "target": "com.amazonaws.mediapackagev2#ListDashManifestConfiguration" - } - }, "com.amazonaws.mediapackagev2#ListHlsManifestConfiguration": { "type": "structure", "members": { @@ -4609,7 +6085,54 @@ "traits": { "smithy.api#enumValue": "ORIGIN_ENDPOINT" } + }, + "HARVEST_JOB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARVEST_JOB" + } + } + } + }, + "com.amazonaws.mediapackagev2#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.mediapackagev2#S3DestinationConfig": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.mediapackagev2#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of an S3 bucket within which harvested content will be exported.

", + "smithy.api#required": {} + } + }, + "DestinationPath": { + "target": "com.amazonaws.mediapackagev2#S3DestinationPath", + "traits": { + "smithy.api#documentation": "

The path within the specified S3 bucket where the harvested content will be placed.

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

Configuration parameters for where in an S3 bucket to place the harvested content.

" + } + }, + "com.amazonaws.mediapackagev2#S3DestinationPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S]+$" } }, "com.amazonaws.mediapackagev2#Scte": { @@ -6143,6 +7666,54 @@ "smithy.api#enumValue": "SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY" } }, + "HARVESTED_MANIFEST_HAS_START_END_FILTER_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARVESTED_MANIFEST_HAS_START_END_FILTER_CONFIGURATION" + } + }, + "HARVESTED_MANIFEST_NOT_FOUND_ON_ENDPOINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARVESTED_MANIFEST_NOT_FOUND_ON_ENDPOINT" + } + }, + "TOO_MANY_IN_PROGRESS_HARVEST_JOBS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOO_MANY_IN_PROGRESS_HARVEST_JOBS" + } + }, + "HARVEST_JOB_INELIGIBLE_FOR_CANCELLATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARVEST_JOB_INELIGIBLE_FOR_CANCELLATION" + } + }, + "INVALID_HARVEST_JOB_DURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_HARVEST_JOB_DURATION" + } + }, + "HARVEST_JOB_S3_DESTINATION_MISSING_OR_INCOMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARVEST_JOB_S3_DESTINATION_MISSING_OR_INCOMPLETE" + } + }, + "HARVEST_JOB_UNABLE_TO_WRITE_TO_S3_DESTINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARVEST_JOB_UNABLE_TO_WRITE_TO_S3_DESTINATION" + } + }, + "HARVEST_JOB_CUSTOMER_ENDPOINT_READ_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HARVEST_JOB_CUSTOMER_ENDPOINT_READ_ACCESS_DENIED" + } + }, "CLIP_START_TIME_WITH_START_OR_END": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json index a04daec6154..7996aef72ae 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.json +++ b/codegen/sdk-codegen/aws-models/opensearch.json @@ -2942,6 +2942,12 @@ "traits": { "smithy.api#documentation": "

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

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

List of node options for the domain.

" + } } }, "traits": { @@ -9203,6 +9209,32 @@ "smithy.api#documentation": "

When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.

" } }, + "com.amazonaws.opensearch#NodeConfig": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "

A boolean that indicates whether a particular node type is enabled or not.

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

The instance type of a particular node type in the cluster.

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

The number of nodes of a particular node type in the cluster.

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

Container for specifying configuration of any node type.

" + } + }, "com.amazonaws.opensearch#NodeId": { "type": "string", "traits": { @@ -9212,6 +9244,43 @@ } } }, + "com.amazonaws.opensearch#NodeOption": { + "type": "structure", + "members": { + "NodeType": { + "target": "com.amazonaws.opensearch#NodeOptionsNodeType", + "traits": { + "smithy.api#documentation": "

Container for node type like coordinating.

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

Container for specifying configuration of any node type.

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

Container for specifying node type.

" + } + }, + "com.amazonaws.opensearch#NodeOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#NodeOption" + } + }, + "com.amazonaws.opensearch#NodeOptionsNodeType": { + "type": "enum", + "members": { + "COORDINATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "coordinator" + } + } + } + }, "com.amazonaws.opensearch#NodeStatus": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index a8ec1970d95..9b3af7257ed 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -2081,7 +2081,7 @@ "target": "com.amazonaws.rds#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The pending maintenance action to apply to this resource.

\n

Valid Values: system-update, db-upgrade, \n hardware-maintenance, ca-certificate-rotation\n

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

The pending maintenance action to apply to this resource.

\n

Valid Values:

\n \n

For more information about these actions, see \n Maintenance actions for Amazon Aurora or \n Maintenance actions for Amazon RDS.

", "smithy.api#required": {} } }, @@ -4468,7 +4468,7 @@ "EnableLimitlessDatabase": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

\n

Valid for: Aurora DB clusters only

\n \n

This setting is no longer used. Instead use the ClusterScalabilityType setting.

\n " } }, "ServerlessV2ScalingConfiguration": { @@ -21849,7 +21849,7 @@ "EnableLimitlessDatabase": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

\n

Valid for: Aurora DB clusters only

\n \n

This setting is no longer used. Instead use the ClusterScalabilityType setting when you create your Aurora Limitless Database DB cluster.

\n " } }, "CACertificateIdentifier": { @@ -24779,7 +24779,7 @@ "Action": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource.

\n

For more information about maintenance actions, see Maintaining a DB instance.

\n

Valid Values: system-update | db-upgrade | hardware-maintenance | ca-certificate-rotation\n

" + "smithy.api#documentation": "

The type of pending maintenance action that is available for the resource.

\n

For more information about maintenance actions, see Maintaining a DB instance.

\n

Valid Values:

\n \n

For more information about these actions, see \n Maintenance actions for Amazon Aurora or \n Maintenance actions for Amazon RDS.

" } }, "AutoAppliedAfterDate": { @@ -27406,6 +27406,36 @@ "smithy.api#documentation": "

Reserved for future use.

" } }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

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

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. \n There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid Values:

\n \n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" + } + }, "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { @@ -27735,6 +27765,36 @@ "smithy.api#documentation": "

Reserved for future use.

" } }, + "MonitoringInterval": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off \n collecting Enhanced Monitoring metrics, specify 0.

\n

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

\n

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60\n

\n

Default: 0\n

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

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. \n An example is arn:aws:iam:123456789012:role/emaccess.

\n

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

" + } + }, + "EnablePerformanceInsights": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

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

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

\n

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. \n There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

" + } + }, + "PerformanceInsightsRetentionPeriod": { + "target": "com.amazonaws.rds#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days to retain Performance Insights data.

\n

Valid Values:

\n \n

Default: 7 days

\n

If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

" + } + }, "EngineLifecycleSupport": { "target": "com.amazonaws.rds#String", "traits": { diff --git a/codegen/sdk-codegen/aws-models/storage-gateway.json b/codegen/sdk-codegen/aws-models/storage-gateway.json index 29b9abdd1b0..24ed5063499 100644 --- a/codegen/sdk-codegen/aws-models/storage-gateway.json +++ b/codegen/sdk-codegen/aws-models/storage-gateway.json @@ -101,7 +101,7 @@ "GatewayType": { "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "

A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.

\n

Valid Values: STORED | CACHED | VTL\n | FILE_S3 |\n FILE_FSX_SMB\n

" + "smithy.api#documentation": "

A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.

\n \n

Amazon FSx File Gateway is no longer available to new customers. Existing\n customers of FSx File Gateway can continue to use the service normally. For\n capabilities similar to FSx File Gateway, visit this blog post.

\n \n

Valid Values: STORED | CACHED | VTL\n | FILE_S3 |\n FILE_FSX_SMB\n

" } }, "TapeDriveType": { @@ -907,18 +907,18 @@ "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", "traits": { - "smithy.api#documentation": "

The average upload rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the upload rate limit is not set.

\n \n

For Tape Gateway and Volume Gateway, the minimum value is 51200.

\n

For S3 File Gateway and FSx File Gateway, the minimum value is\n 104857600.

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

The average upload rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the upload rate limit is not set.

\n \n

For Tape Gateway and Volume Gateway, the minimum value is 51200.

\n

This field is required for S3 File Gateway, and the minimum value is\n 104857600.

\n " } }, "AverageDownloadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", "traits": { - "smithy.api#documentation": "

The average download rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the download rate limit is not\n set.

" + "smithy.api#documentation": "

The average download rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the download rate limit is not\n set.

\n \n

S3 File Gateway does not support this feature.

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

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit\n schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit\n interval defines a period of time on one or more days of the week, during which bandwidth\n rate limits are specified for uploading, downloading, or both.

" + "smithy.api#documentation": "

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule\n consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval\n defines a period of time on one or more days of the week, during which bandwidth rate\n limits are specified for uploading, downloading, or both.

\n \n

FSx File Gateway does not support this feature.

\n " } }, "com.amazonaws.storagegateway#BandwidthRateLimitIntervals": { @@ -1494,7 +1494,7 @@ "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { - "smithy.api#documentation": "

A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).

\n \n

You can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.

\n

Bucket ARN:

\n

\n arn:aws:s3:::my-bucket/prefix/\n

\n

Access point ARN:

\n

\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n

\n

If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

\n

Access point alias:

\n

\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n

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

A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).

\n \n

You can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.

\n

Bucket ARN:

\n

\n arn:aws:s3:::amzn-s3-demo-bucket/prefix/\n

\n

Access point ARN:

\n

\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n

\n

If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

\n

Access point alias:

\n

\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n

\n ", "smithy.api#required": {} } }, @@ -1549,7 +1549,7 @@ "FileShareName": { "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "

The name of the file share. Optional.

\n \n

\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.

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

The name of the file share. Optional.

\n \n

\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.

\n

A valid NFS file share name can only contain the following characters:\n a-z, A-Z,\n 0-9, -, ., and\n _.

\n " } }, "CacheAttributes": { @@ -1671,7 +1671,7 @@ "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { - "smithy.api#documentation": "

A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).

\n \n

You can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.

\n

Bucket ARN:

\n

\n arn:aws:s3:::my-bucket/prefix/\n

\n

Access point ARN:

\n

\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n

\n

If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

\n

Access point alias:

\n

\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n

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

A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).

\n \n

You can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.

\n

Bucket ARN:

\n

\n arn:aws:s3:::amzn-s3-demo-bucket/prefix/\n

\n

Access point ARN:

\n

\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n

\n

If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

\n

Access point alias:

\n

\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n

\n ", "smithy.api#required": {} } }, @@ -1762,7 +1762,7 @@ "FileShareName": { "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "

The name of the file share. Optional.

\n \n

\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.

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

The name of the file share. Optional.

\n \n

\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.

\n

A valid SMB file share name cannot contain the following characters:\n [,],#,;,<,>,:,\",\\,/,|,?,*,+,\n or ASCII control characters 1-31.

\n " } }, "CacheAttributes": { @@ -3708,7 +3708,7 @@ "GatewayType": { "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "

The type of the gateway.

" + "smithy.api#documentation": "

The type of the gateway.

\n \n

Amazon FSx File Gateway is no longer available to new customers. Existing\n customers of FSx File Gateway can continue to use the service normally. For\n capabilities similar to FSx File Gateway, visit this blog post.

\n " } }, "NextUpdateAvailabilityDate": { @@ -6005,7 +6005,7 @@ "GatewayType": { "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "

The type of the gateway.

" + "smithy.api#documentation": "

The type of the gateway.

\n \n

Amazon FSx File Gateway is no longer available to new customers. Existing\n customers of FSx File Gateway can continue to use the service normally. For\n capabilities similar to FSx File Gateway, visit this blog post.

\n " } }, "GatewayOperationalState": { @@ -7263,7 +7263,7 @@ "com.amazonaws.storagegateway#LocationARN": { "type": "string", "traits": { - "smithy.api#documentation": "

A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).

\n \n

You can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.

\n

Bucket ARN:

\n

\n arn:aws:s3:::my-bucket/prefix/\n

\n

Access point ARN:

\n

\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n

\n

If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

\n

Access point alias:

\n

\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n

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

A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).

\n \n

You can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.

\n

Bucket ARN:

\n

\n arn:aws:s3:::amzn-s3-demo-bucket/prefix/\n

\n

Access point ARN:

\n

\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n

\n

If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

\n

Access point alias:

\n

\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n

\n ", "smithy.api#length": { "min": 16, "max": 1400 @@ -9086,7 +9086,7 @@ "name": "storagegateway" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Storage Gateway Service\n

Storage Gateway is the service that connects an on-premises software appliance\n with cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the Amazon Web Services storage\n infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.

\n

Use the following links to get started using the Storage Gateway\n Service API Reference:

\n \n \n

Storage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change\n your resource ID to lowercase to use it with the EC2 API. For example, in Storage\n Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use\n this ID with the EC2 API, you must change it to vol-aa22bb012345daf670.\n Otherwise, the EC2 API might not behave as expected.

\n \n \n

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway\n volumes are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.

\n

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:

\n

\n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

\n

A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.

\n

For more information, see Announcement:\n Heads-up – Longer Storage Gateway volume and snapshot IDs coming in\n 2016.

\n ", + "smithy.api#documentation": "Storage Gateway Service\n \n

Amazon FSx File Gateway is no longer available to new customers. Existing\n customers of FSx File Gateway can continue to use the service normally. For\n capabilities similar to FSx File Gateway, visit this blog post.

\n \n

Storage Gateway is the service that connects an on-premises software appliance\n with cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the Amazon Web Services storage\n infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.

\n

Use the following links to get started using the Storage Gateway\n Service API Reference:

\n \n \n

Storage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change\n your resource ID to lowercase to use it with the EC2 API. For example, in Storage\n Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use\n this ID with the EC2 API, you must change it to vol-aa22bb012345daf670.\n Otherwise, the EC2 API might not behave as expected.

\n \n \n

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway\n volumes are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.

\n

For example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:

\n

\n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

\n

A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.

\n

For more information, see Announcement:\n Heads-up – Longer Storage Gateway volume and snapshot IDs coming in\n 2016.

\n ", "smithy.api#title": "AWS Storage Gateway", "smithy.api#xmlNamespace": { "uri": "http://storagegateway.amazonaws.com/doc/2013-06-30" @@ -11322,7 +11322,7 @@ "FileShareName": { "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "

The name of the file share. Optional.

\n \n

\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.

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

The name of the file share. Optional.

\n \n

\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.

\n

A valid NFS file share name can only contain the following characters:\n a-z, A-Z,\n 0-9, -, ., and\n _.

\n " } }, "CacheAttributes": { @@ -11490,7 +11490,7 @@ "FileShareName": { "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "

The name of the file share. Optional.

\n \n

\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.

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

The name of the file share. Optional.

\n \n

\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.

\n

A valid SMB file share name cannot contain the following characters:\n [,],#,;,<,>,:,\",\\,/,|,?,*,+,\n or ASCII control characters 1-31.

\n " } }, "CacheAttributes": {