openapi: 3.0.0 info: version: 2017-10-12 x-release: v4 title: AWS Elemental MediaPackage Channels Origin Endpoints API description: AWS Elemental MediaPackage x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png 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: mediapackage x-aws-signingName: mediapackage x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediapackage-2017-10-12.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 servers: - url: http://mediapackage.{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 MediaPackage multi-region endpoint - url: https://mediapackage.{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 MediaPackage multi-region endpoint - url: http://mediapackage.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The MediaPackage endpoint for China (Beijing) and China (Ningxia) - url: https://mediapackage.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The MediaPackage endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Origin Endpoints paths: /origin_endpoints: 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' post: operationId: CreateOriginEndpoint description: Creates a new OriginEndpoint record. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateOriginEndpointResponse' examples: CreateOriginEndpoint200Example: summary: Default CreateOriginEndpoint 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example Authorization: example-value ChannelId: id-abc123 CmafPackage: example-value CreatedAt: example-value '480': description: UnprocessableEntityException content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityException' examples: CreateOriginEndpoint480Example: summary: Default CreateOriginEndpoint 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateOriginEndpoint481Example: summary: Default CreateOriginEndpoint 481 response x-microcks-default: true value: {} '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateOriginEndpoint482Example: summary: Default CreateOriginEndpoint 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: CreateOriginEndpoint483Example: summary: Default CreateOriginEndpoint 483 response x-microcks-default: true value: {} '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateOriginEndpoint484Example: summary: Default CreateOriginEndpoint 484 response x-microcks-default: true value: {} '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateOriginEndpoint485Example: summary: Default CreateOriginEndpoint 485 response x-microcks-default: true value: {} parameters: [] requestBody: required: true content: application/json: schema: type: object required: - channelId - id properties: authorization: description: CDN Authorization credentials type: object properties: CdnIdentifierSecret: allOf: - $ref: '#/components/schemas/__string' - xml: name: cdnIdentifierSecret description: 'The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint. ' SecretsRoleArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: secretsRoleArn description: 'The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. ' channelId: description: 'The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the OriginEndpoint is created. ' type: string cmafPackage: description: A Common Media Application Format (CMAF) packaging configuration. type: object properties: Encryption: allOf: - $ref: '#/components/schemas/CmafEncryption' - xml: name: encryption HlsManifests: allOf: - $ref: '#/components/schemas/__listOfHlsManifestCreateOrUpdateParameters' - xml: name: hlsManifests description: A list of HLS manifest configurations SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration. ' SegmentPrefix: allOf: - $ref: '#/components/schemas/__string' - xml: name: segmentPrefix description: An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection dashPackage: description: A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. type: object properties: AdTriggers: allOf: - $ref: '#/components/schemas/AdTriggers' - xml: name: adTriggers AdsOnDeliveryRestrictions: allOf: - $ref: '#/components/schemas/AdsOnDeliveryRestrictions' - xml: name: adsOnDeliveryRestrictions Encryption: allOf: - $ref: '#/components/schemas/DashEncryption' - xml: name: encryption IncludeIframeOnlyStream: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeIframeOnlyStream description: When enabled, an I-Frame only stream will be included in the output. ManifestLayout: allOf: - $ref: '#/components/schemas/ManifestLayout' - xml: name: manifestLayout description: Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. ManifestWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: manifestWindowSeconds description: Time window (in seconds) contained in each manifest. MinBufferTimeSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: minBufferTimeSeconds description: Minimum duration (in seconds) that a player will buffer media before starting the presentation. MinUpdatePeriodSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: minUpdatePeriodSeconds description: Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD). PeriodTriggers: allOf: - $ref: '#/components/schemas/__listOf__PeriodTriggersElement' - xml: name: periodTriggers description: 'A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers. ' Profile: allOf: - $ref: '#/components/schemas/Profile' - xml: name: profile description: The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled. SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration. ' SegmentTemplateFormat: allOf: - $ref: '#/components/schemas/SegmentTemplateFormat' - xml: name: segmentTemplateFormat description: Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection SuggestedPresentationDelaySeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: suggestedPresentationDelaySeconds description: Duration (in seconds) to delay live content before presentation. UtcTiming: allOf: - $ref: '#/components/schemas/UtcTiming' - xml: name: utcTiming description: Determines the type of UTCTiming included in the Media Presentation Description (MPD) UtcTimingUri: allOf: - $ref: '#/components/schemas/__string' - xml: name: utcTimingUri description: Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE description: description: A short text description of the OriginEndpoint. type: string hlsPackage: description: An HTTP Live Streaming (HLS) packaging configuration. type: object properties: AdMarkers: allOf: - $ref: '#/components/schemas/AdMarkers' - xml: name: adMarkers description: "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n\"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events \nin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value \nthat is greater than 0.\n" AdTriggers: allOf: - $ref: '#/components/schemas/AdTriggers' - xml: name: adTriggers AdsOnDeliveryRestrictions: allOf: - $ref: '#/components/schemas/AdsOnDeliveryRestrictions' - xml: name: adsOnDeliveryRestrictions Encryption: allOf: - $ref: '#/components/schemas/HlsEncryption' - xml: name: encryption IncludeDvbSubtitles: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeDvbSubtitles description: When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output. IncludeIframeOnlyStream: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeIframeOnlyStream description: When enabled, an I-Frame only stream will be included in the output. PlaylistType: allOf: - $ref: '#/components/schemas/PlaylistType' - xml: name: playlistType description: 'The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist. ' PlaylistWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: playlistWindowSeconds description: Time window (in seconds) contained in each parent manifest. ProgramDateTimeIntervalSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: programDateTimeIntervalSeconds description: 'The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output. ' SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration. ' StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection UseAudioRenditionGroup: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: useAudioRenditionGroup description: When enabled, audio streams will be placed in rendition groups in the output. id: description: 'The ID of the OriginEndpoint. The ID must be unique within the region and it cannot be changed after the OriginEndpoint is created. ' type: string manifestName: description: A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index"). type: string mssPackage: description: A Microsoft Smooth Streaming (MSS) packaging configuration. type: object properties: Encryption: allOf: - $ref: '#/components/schemas/MssEncryption' - xml: name: encryption ManifestWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: manifestWindowSeconds description: The time window (in seconds) contained in each manifest. SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: The duration (in seconds) of each segment. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection origination: description: 'Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination ' enum: - ALLOW - DENY type: string startoverWindowSeconds: description: 'Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint. ' type: integer tags: description: A collection of tags associated with a resource type: object additionalProperties: $ref: '#/components/schemas/__string' timeDelaySeconds: description: 'Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint. ' type: integer whitelist: description: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. type: array items: $ref: '#/components/schemas/__string' summary: Amazon MediaPackage Create Origin Endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Origin Endpoints get: operationId: ListOriginEndpoints description: Returns a collection of OriginEndpoint records. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListOriginEndpointsResponse' examples: ListOriginEndpoints200Example: summary: Default ListOriginEndpoints 200 response x-microcks-default: true value: NextToken: example-value OriginEndpoints: example-value '480': description: UnprocessableEntityException content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityException' examples: ListOriginEndpoints480Example: summary: Default ListOriginEndpoints 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListOriginEndpoints481Example: summary: Default ListOriginEndpoints 481 response x-microcks-default: true value: {} '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListOriginEndpoints482Example: summary: Default ListOriginEndpoints 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListOriginEndpoints483Example: summary: Default ListOriginEndpoints 483 response x-microcks-default: true value: {} '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListOriginEndpoints484Example: summary: Default ListOriginEndpoints 484 response x-microcks-default: true value: {} '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListOriginEndpoints485Example: summary: Default ListOriginEndpoints 485 response x-microcks-default: true value: {} parameters: - name: channelId in: query required: false description: When specified, the request will return only OriginEndpoints associated with the given Channel ID. schema: type: string - name: maxResults in: query required: false description: The upper bound on the number of records to return. schema: type: integer minimum: 1 maximum: 1000 - name: nextToken in: query required: false description: A token used to resume pagination from the end of a previous request. 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 summary: Amazon MediaPackage List Origin Endpoints x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Origin Endpoints /origin_endpoints/{id}: 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' delete: operationId: DeleteOriginEndpoint description: Deletes an existing OriginEndpoint. responses: '202': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteOriginEndpointResponse' examples: DeleteOriginEndpoint202Example: summary: Default DeleteOriginEndpoint 202 response x-microcks-default: true value: {} '480': description: UnprocessableEntityException content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityException' examples: DeleteOriginEndpoint480Example: summary: Default DeleteOriginEndpoint 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteOriginEndpoint481Example: summary: Default DeleteOriginEndpoint 481 response x-microcks-default: true value: {} '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteOriginEndpoint482Example: summary: Default DeleteOriginEndpoint 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteOriginEndpoint483Example: summary: Default DeleteOriginEndpoint 483 response x-microcks-default: true value: {} '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DeleteOriginEndpoint484Example: summary: Default DeleteOriginEndpoint 484 response x-microcks-default: true value: {} '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DeleteOriginEndpoint485Example: summary: Default DeleteOriginEndpoint 485 response x-microcks-default: true value: {} parameters: - name: id in: path required: true description: The ID of the OriginEndpoint to delete. schema: type: string summary: Amazon MediaPackage Delete Origin Endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Origin Endpoints get: operationId: DescribeOriginEndpoint description: Gets details about an existing OriginEndpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeOriginEndpointResponse' examples: DescribeOriginEndpoint200Example: summary: Default DescribeOriginEndpoint 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example Authorization: example-value ChannelId: id-abc123 CmafPackage: example-value CreatedAt: example-value '480': description: UnprocessableEntityException content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityException' examples: DescribeOriginEndpoint480Example: summary: Default DescribeOriginEndpoint 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeOriginEndpoint481Example: summary: Default DescribeOriginEndpoint 481 response x-microcks-default: true value: {} '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeOriginEndpoint482Example: summary: Default DescribeOriginEndpoint 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeOriginEndpoint483Example: summary: Default DescribeOriginEndpoint 483 response x-microcks-default: true value: {} '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: DescribeOriginEndpoint484Example: summary: Default DescribeOriginEndpoint 484 response x-microcks-default: true value: {} '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: DescribeOriginEndpoint485Example: summary: Default DescribeOriginEndpoint 485 response x-microcks-default: true value: {} parameters: - name: id in: path required: true description: The ID of the OriginEndpoint. schema: type: string summary: Amazon MediaPackage Describe Origin Endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Origin Endpoints put: operationId: UpdateOriginEndpoint description: Updates an existing OriginEndpoint. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateOriginEndpointResponse' examples: UpdateOriginEndpoint200Example: summary: Default UpdateOriginEndpoint 200 response x-microcks-default: true value: Arn: arn:aws:service:us-east-1:123456789012:resource/example Authorization: example-value ChannelId: id-abc123 CmafPackage: example-value CreatedAt: example-value '480': description: UnprocessableEntityException content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityException' examples: UpdateOriginEndpoint480Example: summary: Default UpdateOriginEndpoint 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateOriginEndpoint481Example: summary: Default UpdateOriginEndpoint 481 response x-microcks-default: true value: {} '482': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateOriginEndpoint482Example: summary: Default UpdateOriginEndpoint 482 response x-microcks-default: true value: {} '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateOriginEndpoint483Example: summary: Default UpdateOriginEndpoint 483 response x-microcks-default: true value: {} '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateOriginEndpoint484Example: summary: Default UpdateOriginEndpoint 484 response x-microcks-default: true value: {} '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateOriginEndpoint485Example: summary: Default UpdateOriginEndpoint 485 response x-microcks-default: true value: {} parameters: - name: id in: path required: true description: The ID of the OriginEndpoint to update. schema: type: string requestBody: required: true content: application/json: schema: type: object properties: authorization: description: CDN Authorization credentials type: object properties: CdnIdentifierSecret: allOf: - $ref: '#/components/schemas/__string' - xml: name: cdnIdentifierSecret description: 'The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint. ' SecretsRoleArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: secretsRoleArn description: 'The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. ' cmafPackage: description: A Common Media Application Format (CMAF) packaging configuration. type: object properties: Encryption: allOf: - $ref: '#/components/schemas/CmafEncryption' - xml: name: encryption HlsManifests: allOf: - $ref: '#/components/schemas/__listOfHlsManifestCreateOrUpdateParameters' - xml: name: hlsManifests description: A list of HLS manifest configurations SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration. ' SegmentPrefix: allOf: - $ref: '#/components/schemas/__string' - xml: name: segmentPrefix description: An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection dashPackage: description: A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. type: object properties: AdTriggers: allOf: - $ref: '#/components/schemas/AdTriggers' - xml: name: adTriggers AdsOnDeliveryRestrictions: allOf: - $ref: '#/components/schemas/AdsOnDeliveryRestrictions' - xml: name: adsOnDeliveryRestrictions Encryption: allOf: - $ref: '#/components/schemas/DashEncryption' - xml: name: encryption IncludeIframeOnlyStream: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeIframeOnlyStream description: When enabled, an I-Frame only stream will be included in the output. ManifestLayout: allOf: - $ref: '#/components/schemas/ManifestLayout' - xml: name: manifestLayout description: Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. ManifestWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: manifestWindowSeconds description: Time window (in seconds) contained in each manifest. MinBufferTimeSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: minBufferTimeSeconds description: Minimum duration (in seconds) that a player will buffer media before starting the presentation. MinUpdatePeriodSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: minUpdatePeriodSeconds description: Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD). PeriodTriggers: allOf: - $ref: '#/components/schemas/__listOf__PeriodTriggersElement' - xml: name: periodTriggers description: 'A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers. ' Profile: allOf: - $ref: '#/components/schemas/Profile' - xml: name: profile description: The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled. SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration. ' SegmentTemplateFormat: allOf: - $ref: '#/components/schemas/SegmentTemplateFormat' - xml: name: segmentTemplateFormat description: Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection SuggestedPresentationDelaySeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: suggestedPresentationDelaySeconds description: Duration (in seconds) to delay live content before presentation. UtcTiming: allOf: - $ref: '#/components/schemas/UtcTiming' - xml: name: utcTiming description: Determines the type of UTCTiming included in the Media Presentation Description (MPD) UtcTimingUri: allOf: - $ref: '#/components/schemas/__string' - xml: name: utcTimingUri description: Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE description: description: A short text description of the OriginEndpoint. type: string hlsPackage: description: An HTTP Live Streaming (HLS) packaging configuration. type: object properties: AdMarkers: allOf: - $ref: '#/components/schemas/AdMarkers' - xml: name: adMarkers description: "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n\"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events \nin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value \nthat is greater than 0.\n" AdTriggers: allOf: - $ref: '#/components/schemas/AdTriggers' - xml: name: adTriggers AdsOnDeliveryRestrictions: allOf: - $ref: '#/components/schemas/AdsOnDeliveryRestrictions' - xml: name: adsOnDeliveryRestrictions Encryption: allOf: - $ref: '#/components/schemas/HlsEncryption' - xml: name: encryption IncludeDvbSubtitles: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeDvbSubtitles description: When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output. IncludeIframeOnlyStream: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeIframeOnlyStream description: When enabled, an I-Frame only stream will be included in the output. PlaylistType: allOf: - $ref: '#/components/schemas/PlaylistType' - xml: name: playlistType description: 'The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist. ' PlaylistWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: playlistWindowSeconds description: Time window (in seconds) contained in each parent manifest. ProgramDateTimeIntervalSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: programDateTimeIntervalSeconds description: 'The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output. ' SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration. ' StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection UseAudioRenditionGroup: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: useAudioRenditionGroup description: When enabled, audio streams will be placed in rendition groups in the output. manifestName: description: A short string that will be appended to the end of the Endpoint URL. type: string mssPackage: description: A Microsoft Smooth Streaming (MSS) packaging configuration. type: object properties: Encryption: allOf: - $ref: '#/components/schemas/MssEncryption' - xml: name: encryption ManifestWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: manifestWindowSeconds description: The time window (in seconds) contained in each manifest. SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: The duration (in seconds) of each segment. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection origination: description: 'Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination ' enum: - ALLOW - DENY type: string startoverWindowSeconds: description: 'Maximum duration (in seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint. ' type: integer timeDelaySeconds: description: 'Amount of delay (in seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint. ' type: integer whitelist: description: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. type: array items: $ref: '#/components/schemas/__string' summary: Amazon MediaPackage Update Origin Endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Origin Endpoints components: schemas: CmafEncryption: required: - SpekeKeyProvider type: object properties: ConstantInitializationVector: allOf: - $ref: '#/components/schemas/__string' - xml: name: constantInitializationVector description: An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). EncryptionMethod: allOf: - $ref: '#/components/schemas/CmafEncryptionMethod' - xml: name: encryptionMethod KeyRotationIntervalSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: keyRotationIntervalSeconds description: Time (in seconds) between each encryption key rotation. SpekeKeyProvider: allOf: - $ref: '#/components/schemas/SpekeKeyProvider' - xml: name: spekeKeyProvider description: A Common Media Application Format (CMAF) encryption configuration. AdTriggers: type: array description: 'A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types. ' items: $ref: '#/components/schemas/__AdTriggersElement' __AdTriggersElement: enum: - SPLICE_INSERT - BREAK - PROVIDER_ADVERTISEMENT - DISTRIBUTOR_ADVERTISEMENT - PROVIDER_PLACEMENT_OPPORTUNITY - DISTRIBUTOR_PLACEMENT_OPPORTUNITY - PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY - DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY type: string HlsManifest: required: - Id type: object properties: AdMarkers: allOf: - $ref: '#/components/schemas/AdMarkers' - xml: name: adMarkers description: "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n\"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events \nin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value \nthat is greater than 0.\n" Id: allOf: - $ref: '#/components/schemas/__string' - xml: name: id description: The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created. IncludeIframeOnlyStream: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeIframeOnlyStream description: When enabled, an I-Frame only stream will be included in the output. ManifestName: allOf: - $ref: '#/components/schemas/__string' - xml: name: manifestName description: An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint. PlaylistType: allOf: - $ref: '#/components/schemas/PlaylistType' - xml: name: playlistType description: 'The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist. ' PlaylistWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: playlistWindowSeconds description: Time window (in seconds) contained in each parent manifest. ProgramDateTimeIntervalSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: programDateTimeIntervalSeconds description: 'The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output. ' Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: The URL of the packaged OriginEndpoint for consumption. AdTriggers: allOf: - $ref: '#/components/schemas/AdTriggers' - xml: name: adTriggers AdsOnDeliveryRestrictions: allOf: - $ref: '#/components/schemas/AdsOnDeliveryRestrictions' - xml: name: adsOnDeliveryRestrictions description: A HTTP Live Streaming (HLS) manifest configuration. __listOfHlsManifestCreateOrUpdateParameters: type: array items: $ref: '#/components/schemas/HlsManifestCreateOrUpdateParameters' InternalServerErrorException: {} UtcTiming: enum: - NONE - HTTP-HEAD - HTTP-ISO - HTTP-XSDATE type: string OriginEndpoint: type: object properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: The Amazon Resource Name (ARN) assigned to the OriginEndpoint. Authorization: allOf: - $ref: '#/components/schemas/Authorization' - xml: name: authorization ChannelId: allOf: - $ref: '#/components/schemas/__string' - xml: name: channelId description: The ID of the Channel the OriginEndpoint is associated with. CmafPackage: allOf: - $ref: '#/components/schemas/CmafPackage' - xml: name: cmafPackage CreatedAt: allOf: - $ref: '#/components/schemas/__string' - xml: name: createdAt description: The date and time the OriginEndpoint was created. DashPackage: allOf: - $ref: '#/components/schemas/DashPackage' - xml: name: dashPackage Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A short text description of the OriginEndpoint. HlsPackage: allOf: - $ref: '#/components/schemas/HlsPackage' - xml: name: hlsPackage Id: allOf: - $ref: '#/components/schemas/__string' - xml: name: id description: The ID of the OriginEndpoint. ManifestName: allOf: - $ref: '#/components/schemas/__string' - xml: name: manifestName description: A short string appended to the end of the OriginEndpoint URL. MssPackage: allOf: - $ref: '#/components/schemas/MssPackage' - xml: name: mssPackage Origination: allOf: - $ref: '#/components/schemas/Origination' - xml: name: origination description: 'Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination ' StartoverWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: startoverWindowSeconds description: 'Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint. ' Tags: allOf: - $ref: '#/components/schemas/Tags' - xml: name: tags TimeDelaySeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: timeDelaySeconds description: 'Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint. ' Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: The URL of the packaged OriginEndpoint for consumption. Whitelist: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: whitelist description: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. description: An OriginEndpoint resource configuration. EncryptionMethod: enum: - AES_128 - SAMPLE_AES type: string AdsOnDeliveryRestrictions: enum: - NONE - RESTRICTED - UNRESTRICTED - BOTH type: string description: 'This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers. ' MssPackage: type: object properties: Encryption: allOf: - $ref: '#/components/schemas/MssEncryption' - xml: name: encryption ManifestWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: manifestWindowSeconds description: The time window (in seconds) contained in each manifest. SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: The duration (in seconds) of each segment. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection description: A Microsoft Smooth Streaming (MSS) packaging configuration. Profile: enum: - NONE - HBBTV_1_5 - HYBRIDCAST - DVB_DASH_2014 type: string ManifestLayout: enum: - FULL - COMPACT type: string PresetSpeke20Audio: enum: - PRESET-AUDIO-1 - PRESET-AUDIO-2 - PRESET-AUDIO-3 - SHARED - UNENCRYPTED type: string DashEncryption: required: - SpekeKeyProvider type: object properties: KeyRotationIntervalSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: keyRotationIntervalSeconds description: Time (in seconds) between each encryption key rotation. SpekeKeyProvider: allOf: - $ref: '#/components/schemas/SpekeKeyProvider' - xml: name: spekeKeyProvider description: A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration. __integer: type: integer TooManyRequestsException: {} CmafPackage: type: object properties: Encryption: allOf: - $ref: '#/components/schemas/CmafEncryption' - xml: name: encryption HlsManifests: allOf: - $ref: '#/components/schemas/__listOfHlsManifest' - xml: name: hlsManifests description: A list of HLS manifest configurations SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration. ' SegmentPrefix: allOf: - $ref: '#/components/schemas/__string' - xml: name: segmentPrefix description: An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection description: A Common Media Application Format (CMAF) packaging configuration. __listOfHlsManifest: type: array items: $ref: '#/components/schemas/HlsManifest' PlaylistType: enum: - NONE - EVENT - VOD type: string __listOf__PeriodTriggersElement: type: array items: $ref: '#/components/schemas/__PeriodTriggersElement' DeleteOriginEndpointResponse: type: object properties: {} PresetSpeke20Video: enum: - PRESET-VIDEO-1 - PRESET-VIDEO-2 - PRESET-VIDEO-3 - PRESET-VIDEO-4 - PRESET-VIDEO-5 - PRESET-VIDEO-6 - PRESET-VIDEO-7 - PRESET-VIDEO-8 - SHARED - UNENCRYPTED type: string ListOriginEndpointsResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/__string' - xml: name: nextToken description: A token that can be used to resume pagination from the end of the collection. OriginEndpoints: allOf: - $ref: '#/components/schemas/__listOfOriginEndpoint' - xml: name: originEndpoints description: A list of OriginEndpoint records. Authorization: required: - SecretsRoleArn - CdnIdentifierSecret type: object properties: CdnIdentifierSecret: allOf: - $ref: '#/components/schemas/__string' - xml: name: cdnIdentifierSecret description: 'The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint. ' SecretsRoleArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: secretsRoleArn description: 'The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. ' description: CDN Authorization credentials StreamOrder: enum: - ORIGINAL - VIDEO_BITRATE_ASCENDING - VIDEO_BITRATE_DESCENDING type: string StreamSelection: type: object properties: MaxVideoBitsPerSecond: allOf: - $ref: '#/components/schemas/__integer' - xml: name: maxVideoBitsPerSecond description: The maximum video bitrate (bps) to include in output. MinVideoBitsPerSecond: allOf: - $ref: '#/components/schemas/__integer' - xml: name: minVideoBitsPerSecond description: The minimum video bitrate (bps) to include in output. StreamOrder: allOf: - $ref: '#/components/schemas/StreamOrder' - xml: name: streamOrder description: A directive that determines the order of streams in the output. description: A StreamSelection configuration. __boolean: type: boolean HlsPackage: type: object properties: AdMarkers: allOf: - $ref: '#/components/schemas/AdMarkers' - xml: name: adMarkers description: "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n\"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events \nin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value \nthat is greater than 0.\n" AdTriggers: allOf: - $ref: '#/components/schemas/AdTriggers' - xml: name: adTriggers AdsOnDeliveryRestrictions: allOf: - $ref: '#/components/schemas/AdsOnDeliveryRestrictions' - xml: name: adsOnDeliveryRestrictions Encryption: allOf: - $ref: '#/components/schemas/HlsEncryption' - xml: name: encryption IncludeDvbSubtitles: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeDvbSubtitles description: When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output. IncludeIframeOnlyStream: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeIframeOnlyStream description: When enabled, an I-Frame only stream will be included in the output. PlaylistType: allOf: - $ref: '#/components/schemas/PlaylistType' - xml: name: playlistType description: 'The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist. ' PlaylistWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: playlistWindowSeconds description: Time window (in seconds) contained in each parent manifest. ProgramDateTimeIntervalSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: programDateTimeIntervalSeconds description: 'The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output. ' SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration. ' StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection UseAudioRenditionGroup: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: useAudioRenditionGroup description: When enabled, audio streams will be placed in rendition groups in the output. description: An HTTP Live Streaming (HLS) packaging configuration. CmafEncryptionMethod: enum: - SAMPLE_AES - AES_CTR type: string description: The encryption method to use. DescribeOriginEndpointResponse: type: object properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: The Amazon Resource Name (ARN) assigned to the OriginEndpoint. Authorization: allOf: - $ref: '#/components/schemas/Authorization' - xml: name: authorization ChannelId: allOf: - $ref: '#/components/schemas/__string' - xml: name: channelId description: The ID of the Channel the OriginEndpoint is associated with. CmafPackage: allOf: - $ref: '#/components/schemas/CmafPackage' - xml: name: cmafPackage CreatedAt: allOf: - $ref: '#/components/schemas/__string' - xml: name: createdAt description: The date and time the OriginEndpoint was created. DashPackage: allOf: - $ref: '#/components/schemas/DashPackage' - xml: name: dashPackage Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A short text description of the OriginEndpoint. HlsPackage: allOf: - $ref: '#/components/schemas/HlsPackage' - xml: name: hlsPackage Id: allOf: - $ref: '#/components/schemas/__string' - xml: name: id description: The ID of the OriginEndpoint. ManifestName: allOf: - $ref: '#/components/schemas/__string' - xml: name: manifestName description: A short string appended to the end of the OriginEndpoint URL. MssPackage: allOf: - $ref: '#/components/schemas/MssPackage' - xml: name: mssPackage Origination: allOf: - $ref: '#/components/schemas/Origination' - xml: name: origination description: 'Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination ' StartoverWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: startoverWindowSeconds description: 'Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint. ' Tags: allOf: - $ref: '#/components/schemas/Tags' - xml: name: tags TimeDelaySeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: timeDelaySeconds description: 'Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint. ' Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: The URL of the packaged OriginEndpoint for consumption. Whitelist: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: whitelist description: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. DashPackage: type: object properties: AdTriggers: allOf: - $ref: '#/components/schemas/AdTriggers' - xml: name: adTriggers AdsOnDeliveryRestrictions: allOf: - $ref: '#/components/schemas/AdsOnDeliveryRestrictions' - xml: name: adsOnDeliveryRestrictions Encryption: allOf: - $ref: '#/components/schemas/DashEncryption' - xml: name: encryption IncludeIframeOnlyStream: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeIframeOnlyStream description: When enabled, an I-Frame only stream will be included in the output. ManifestLayout: allOf: - $ref: '#/components/schemas/ManifestLayout' - xml: name: manifestLayout description: Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. ManifestWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: manifestWindowSeconds description: Time window (in seconds) contained in each manifest. MinBufferTimeSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: minBufferTimeSeconds description: Minimum duration (in seconds) that a player will buffer media before starting the presentation. MinUpdatePeriodSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: minUpdatePeriodSeconds description: Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD). PeriodTriggers: allOf: - $ref: '#/components/schemas/__listOf__PeriodTriggersElement' - xml: name: periodTriggers description: 'A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers. ' Profile: allOf: - $ref: '#/components/schemas/Profile' - xml: name: profile description: The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. When set to "DVB-DASH_2014", DVB-DASH 2014 compliant output is enabled. SegmentDurationSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: segmentDurationSeconds description: 'Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration. ' SegmentTemplateFormat: allOf: - $ref: '#/components/schemas/SegmentTemplateFormat' - xml: name: segmentTemplateFormat description: Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs. StreamSelection: allOf: - $ref: '#/components/schemas/StreamSelection' - xml: name: streamSelection SuggestedPresentationDelaySeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: suggestedPresentationDelaySeconds description: Duration (in seconds) to delay live content before presentation. UtcTiming: allOf: - $ref: '#/components/schemas/UtcTiming' - xml: name: utcTiming description: Determines the type of UTCTiming included in the Media Presentation Description (MPD) UtcTimingUri: allOf: - $ref: '#/components/schemas/__string' - xml: name: utcTimingUri description: Specifies the value attribute of the UTCTiming field when utcTiming is set to HTTP-ISO, HTTP-HEAD or HTTP-XSDATE description: A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration. UnprocessableEntityException: {} Origination: enum: - ALLOW - DENY type: string __listOfOriginEndpoint: type: array items: $ref: '#/components/schemas/OriginEndpoint' Tags: type: object description: A collection of tags associated with a resource additionalProperties: $ref: '#/components/schemas/__string' HlsManifestCreateOrUpdateParameters: required: - Id type: object properties: AdMarkers: allOf: - $ref: '#/components/schemas/AdMarkers' - xml: name: adMarkers description: "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n\"DATERANGE\" inserts EXT-X-DATERANGE tags to signal ad and program transition events \nin HLS and CMAF manifests. For this option, you must set a programDateTimeIntervalSeconds value \nthat is greater than 0.\n" AdTriggers: allOf: - $ref: '#/components/schemas/AdTriggers' - xml: name: adTriggers AdsOnDeliveryRestrictions: allOf: - $ref: '#/components/schemas/AdsOnDeliveryRestrictions' - xml: name: adsOnDeliveryRestrictions Id: allOf: - $ref: '#/components/schemas/__string' - xml: name: id description: The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created. IncludeIframeOnlyStream: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: includeIframeOnlyStream description: When enabled, an I-Frame only stream will be included in the output. ManifestName: allOf: - $ref: '#/components/schemas/__string' - xml: name: manifestName description: An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint. PlaylistType: allOf: - $ref: '#/components/schemas/PlaylistType' - xml: name: playlistType description: 'The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist. ' PlaylistWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: playlistWindowSeconds description: Time window (in seconds) contained in each parent manifest. ProgramDateTimeIntervalSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: programDateTimeIntervalSeconds description: 'The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output. ' description: A HTTP Live Streaming (HLS) manifest configuration. __listOf__string: type: array items: $ref: '#/components/schemas/__string' SegmentTemplateFormat: enum: - NUMBER_WITH_TIMELINE - TIME_WITH_TIMELINE - NUMBER_WITH_DURATION type: string UpdateOriginEndpointResponse: type: object properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: The Amazon Resource Name (ARN) assigned to the OriginEndpoint. Authorization: allOf: - $ref: '#/components/schemas/Authorization' - xml: name: authorization ChannelId: allOf: - $ref: '#/components/schemas/__string' - xml: name: channelId description: The ID of the Channel the OriginEndpoint is associated with. CmafPackage: allOf: - $ref: '#/components/schemas/CmafPackage' - xml: name: cmafPackage CreatedAt: allOf: - $ref: '#/components/schemas/__string' - xml: name: createdAt description: The date and time the OriginEndpoint was created. DashPackage: allOf: - $ref: '#/components/schemas/DashPackage' - xml: name: dashPackage Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A short text description of the OriginEndpoint. HlsPackage: allOf: - $ref: '#/components/schemas/HlsPackage' - xml: name: hlsPackage Id: allOf: - $ref: '#/components/schemas/__string' - xml: name: id description: The ID of the OriginEndpoint. ManifestName: allOf: - $ref: '#/components/schemas/__string' - xml: name: manifestName description: A short string appended to the end of the OriginEndpoint URL. MssPackage: allOf: - $ref: '#/components/schemas/MssPackage' - xml: name: mssPackage Origination: allOf: - $ref: '#/components/schemas/Origination' - xml: name: origination description: 'Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination ' StartoverWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: startoverWindowSeconds description: 'Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint. ' Tags: allOf: - $ref: '#/components/schemas/Tags' - xml: name: tags TimeDelaySeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: timeDelaySeconds description: 'Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint. ' Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: The URL of the packaged OriginEndpoint for consumption. Whitelist: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: whitelist description: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. SpekeKeyProvider: required: - ResourceId - SystemIds - Url - RoleArn type: object properties: CertificateArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: certificateArn description: 'An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service. ' EncryptionContractConfiguration: allOf: - $ref: '#/components/schemas/EncryptionContractConfiguration' - xml: name: encryptionContractConfiguration ResourceId: allOf: - $ref: '#/components/schemas/__string' - xml: name: resourceId description: The resource ID to include in key requests. RoleArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: roleArn description: 'An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service. ' SystemIds: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: systemIds description: The system IDs to include in key requests. Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: The URL of the external key provider service. description: A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys. MssEncryption: required: - SpekeKeyProvider type: object properties: SpekeKeyProvider: allOf: - $ref: '#/components/schemas/SpekeKeyProvider' - xml: name: spekeKeyProvider description: A Microsoft Smooth Streaming (MSS) encryption configuration. AdMarkers: enum: - NONE - SCTE35_ENHANCED - PASSTHROUGH - DATERANGE type: string CreateOriginEndpointResponse: type: object properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: The Amazon Resource Name (ARN) assigned to the OriginEndpoint. Authorization: allOf: - $ref: '#/components/schemas/Authorization' - xml: name: authorization ChannelId: allOf: - $ref: '#/components/schemas/__string' - xml: name: channelId description: The ID of the Channel the OriginEndpoint is associated with. CmafPackage: allOf: - $ref: '#/components/schemas/CmafPackage' - xml: name: cmafPackage CreatedAt: allOf: - $ref: '#/components/schemas/__string' - xml: name: createdAt description: The date and time the OriginEndpoint was created. DashPackage: allOf: - $ref: '#/components/schemas/DashPackage' - xml: name: dashPackage Description: allOf: - $ref: '#/components/schemas/__string' - xml: name: description description: A short text description of the OriginEndpoint. HlsPackage: allOf: - $ref: '#/components/schemas/HlsPackage' - xml: name: hlsPackage Id: allOf: - $ref: '#/components/schemas/__string' - xml: name: id description: The ID of the OriginEndpoint. ManifestName: allOf: - $ref: '#/components/schemas/__string' - xml: name: manifestName description: A short string appended to the end of the OriginEndpoint URL. MssPackage: allOf: - $ref: '#/components/schemas/MssPackage' - xml: name: mssPackage Origination: allOf: - $ref: '#/components/schemas/Origination' - xml: name: origination description: 'Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination ' StartoverWindowSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: startoverWindowSeconds description: 'Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint. ' Tags: allOf: - $ref: '#/components/schemas/Tags' - xml: name: tags TimeDelaySeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: timeDelaySeconds description: 'Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint. ' Url: allOf: - $ref: '#/components/schemas/__string' - xml: name: url description: The URL of the packaged OriginEndpoint for consumption. Whitelist: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: whitelist description: A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint. ForbiddenException: {} NotFoundException: {} __PeriodTriggersElement: enum: - ADS type: string ServiceUnavailableException: {} HlsEncryption: required: - SpekeKeyProvider type: object properties: ConstantInitializationVector: allOf: - $ref: '#/components/schemas/__string' - xml: name: constantInitializationVector description: 'A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated. ' EncryptionMethod: allOf: - $ref: '#/components/schemas/EncryptionMethod' - xml: name: encryptionMethod description: The encryption method to use. KeyRotationIntervalSeconds: allOf: - $ref: '#/components/schemas/__integer' - xml: name: keyRotationIntervalSeconds description: Interval (in seconds) between each encryption key rotation. RepeatExtXKey: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: repeatExtXKey description: When enabled, the EXT-X-KEY tag will be repeated in output manifests. SpekeKeyProvider: allOf: - $ref: '#/components/schemas/SpekeKeyProvider' - xml: name: spekeKeyProvider description: An HTTP Live Streaming (HLS) encryption configuration. __string: type: string EncryptionContractConfiguration: required: - PresetSpeke20Audio - PresetSpeke20Video type: object properties: PresetSpeke20Audio: allOf: - $ref: '#/components/schemas/PresetSpeke20Audio' - xml: name: presetSpeke20Audio description: A collection of audio encryption presets. PresetSpeke20Video: allOf: - $ref: '#/components/schemas/PresetSpeke20Video' - xml: name: presetSpeke20Video description: A collection of video encryption presets. description: "Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 2.0. \nThe encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. \nTo configure the encryption contract, specify which audio and video encryption presets to use.\nNote the following considerations when using encryptionContractConfiguration:\nencryptionContractConfiguration can be used for DASH or CMAF endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification.\nYou must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.\n" parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/mediapackage/ x-hasEquivalentPaths: true