UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 121 kB
{"openapi":"3.0.0","info":{"version":"2022-12-25","x-release":"v4","title":"AWS Elemental MediaPackage v2","description":"<note> <p>This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2. </p> <p>The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like \"v2\", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.</p> <p>If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the <a href=\"https://docs.aws.amazon.com/mediapackage/latest/apireference/what-is.html\">MediaPackage v1 Live API Reference</a>.</p> </note> <p>This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.</p> <p>We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.</p>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"mediapackagev2","x-aws-signingName":"mediapackagev2","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediapackagev2-2022-12-25.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/mediapackagev2/"},"servers":[{"url":"http://mediapackagev2.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The mediapackagev2 multi-region endpoint"},{"url":"https://mediapackagev2.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The mediapackagev2 multi-region endpoint"},{"url":"http://mediapackagev2.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The mediapackagev2 endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://mediapackagev2.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The mediapackagev2 endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/channelGroup/{ChannelGroupName}/channel":{"post":{"operationId":"CreateChannel","description":"Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"x-amzn-client-token","in":"header","required":false,"description":"A unique, case-sensitive token that you provide to ensure the idempotency of the request.","schema":{"type":"string","pattern":"[\\S]+","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ChannelName"],"properties":{"ChannelName":{"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.","type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256},"Description":{"description":"Enter any descriptive text that helps you to identify the channel.","type":"string","minLength":0,"maxLength":1024},"tags":{"description":"<p>A comma-separated list of tag key:value pairs that you define. For example:</p> <p> <code>\"Key1\": \"Value1\",</code> </p> <p> <code>\"Key2\": \"Value2\"</code> </p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListChannels","description":"Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelsResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in the response.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The pagination token from the GET list request. Use the token to fetch the next page of results.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/channelGroup":{"post":{"operationId":"CreateChannelGroup","description":"Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelGroupResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"x-amzn-client-token","in":"header","required":false,"description":"A unique, case-sensitive token that you provide to ensure the idempotency of the request.","schema":{"type":"string","pattern":"[\\S]+","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ChannelGroupName"],"properties":{"ChannelGroupName":{"description":"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. You can't use spaces in the name. You can't change the name after you create the channel group.","type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256},"Description":{"description":"Enter any descriptive text that helps you to identify the channel group.","type":"string","minLength":0,"maxLength":1024},"tags":{"description":"<p>A comma-separated list of tag key:value pairs that you define. For example:</p> <p> <code>\"Key1\": \"Value1\",</code> </p> <p> <code>\"Key2\": \"Value2\"</code> </p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListChannelGroups","description":"Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelGroupsResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in the response.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The pagination token from the GET list request. Use the token to fetch the next page of results.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint":{"post":{"operationId":"CreateOriginEndpoint","description":"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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOriginEndpointResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"x-amzn-client-token","in":"header","required":false,"description":"A unique, case-sensitive token that you provide to ensure the idempotency of the request.","schema":{"type":"string","pattern":"[\\S]+","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OriginEndpointName","ContainerType"],"properties":{"OriginEndpointName":{"description":"The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.","type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256},"ContainerType":{"description":"The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint.","type":"string","enum":["TS","CMAF"]},"Segment":{"description":"The segment configuration, including the segment name, duration, and other configuration values.","type":"object","properties":{"SegmentDurationSeconds":{"allOf":[{"$ref":"#/components/schemas/SegmentSegmentDurationSecondsInteger"},{"description":"The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration."}]},"SegmentName":{"allOf":[{"$ref":"#/components/schemas/SegmentSegmentNameString"},{"description":"The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name."}]},"TsUseAudioRenditionGroup":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group."}]},"IncludeIframeOnlyStreams":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind."}]},"TsIncludeDvbSubtitles":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output."}]},"Scte":{"allOf":[{"$ref":"#/components/schemas/Scte"},{"description":"The SCTE configuration options in the segment settings."}]},"Encryption":{"$ref":"#/components/schemas/Encryption"}}},"Description":{"description":"Enter any descriptive text that helps you to identify the origin endpoint.","type":"string","minLength":0,"maxLength":1024},"StartoverWindowSeconds":{"description":"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. The maximum startover window is 1,209,600 seconds (14 days).","type":"integer","minimum":60,"maximum":1209600},"HlsManifests":{"description":"An HTTP live streaming (HLS) manifest configuration.","type":"array","items":{"$ref":"#/components/schemas/CreateHlsManifestConfiguration"}},"LowLatencyHlsManifests":{"description":"A low-latency HLS manifest configuration.","type":"array","items":{"$ref":"#/components/schemas/CreateLowLatencyHlsManifestConfiguration"}},"Tags":{"description":"<p>A comma-separated list of tag key:value pairs that you define. For example:</p> <p> <code>\"Key1\": \"Value1\",</code> </p> <p> <code>\"Key2\": \"Value2\"</code> </p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListOriginEndpoints","description":"Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOriginEndpointsResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return in the response.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The pagination token from the GET list request. Use the token to fetch the next page of results.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/":{"delete":{"operationId":"DeleteChannel","description":"Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetChannel","description":"Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}]},"put":{"operationId":"UpdateChannel","description":"<p>Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.</p> <p>Any edits you make that impact the video output may not be reflected for a few minutes.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Description":{"description":"Any descriptive information that you want to add to the channel for future identification purposes.","type":"string","minLength":0,"maxLength":1024}}}}}}}},"/channelGroup/{ChannelGroupName}":{"delete":{"operationId":"DeleteChannelGroup","description":"Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelGroupResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetChannelGroup","description":"Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelGroupResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}]},"put":{"operationId":"UpdateChannelGroup","description":"<p>Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.</p> <p>Any edits you make that impact the video output may not be reflected for a few minutes.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelGroupResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Description":{"description":"Any descriptive information that you want to add to the channel group for future identification purposes.","type":"string","minLength":0,"maxLength":1024}}}}}}}},"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/policy":{"delete":{"operationId":"DeleteChannelPolicy","description":"Delete a channel policy.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelPolicyResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetChannelPolicy","description":"Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelPolicyResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}]},"put":{"operationId":"PutChannelPolicy","description":"Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutChannelPolicyResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Policy"],"properties":{"Policy":{"description":"The policy to attach to the specified channel.","type":"string","minLength":0,"maxLength":6144}}}}}}}},"/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}":{"delete":{"operationId":"DeleteOriginEndpoint","description":"Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteOriginEndpointResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"OriginEndpointName","in":"path","required":true,"description":"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. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetOriginEndpoint","description":"Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOriginEndpointResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"OriginEndpointName","in":"path","required":true,"description":"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. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}]},"put":{"operationId":"UpdateOriginEndpoint","description":"<p>Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.</p> <p>Any edits you make that impact the video output may not be reflected for a few minutes.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOriginEndpointResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"ChannelGroupName","in":"path","required":true,"description":"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.","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"ChannelName","in":"path","required":true,"description":"The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}},{"name":"OriginEndpointName","in":"path","required":true,"description":"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. ","schema":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":256}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ContainerType"],"properties":{"ContainerType":{"description":"The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. ","type":"string","enum":["TS","CMAF"]},"Segment":{"description":"The segment configuration, including the segment name, duration, and other configuration values.","type":"object","properties":{"SegmentDurationSeconds":{"allOf":[{"$ref":"#/components/schemas/SegmentSegmentDurationSecondsInteger"},{"description":"The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration."}]},"SegmentName":{"allOf":[{"$ref":"#/components/schemas/SegmentSegmentNameString"},{"description":"The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name."}]},"TsUseAudioRenditionGroup":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group."}]},"IncludeIframeOnlyStreams":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionalit