openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 197 kB
JSON
{"openapi":"3.0.0","info":{"version":"2018-04-23","x-release":"v4","title":"AWS MediaTailor","description":"<p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/\">AWS Elemental MediaTailor User Guide</a>.</p> <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</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":"mediatailor","x-aws-signingName":"mediatailor","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediatailor-2018-04-23.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/mediatailor/"},"servers":[{"url":"http://api.mediatailor.{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 MediaTailor multi-region endpoint"},{"url":"https://api.mediatailor.{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 MediaTailor multi-region endpoint"},{"url":"http://api.mediatailor.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The MediaTailor endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://api.mediatailor.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The MediaTailor endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/configureLogs/channel":{"put":{"operationId":"ConfigureLogsForChannel","description":"Configures Amazon CloudWatch log settings for a channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigureLogsForChannelResponse"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ChannelName","LogTypes"],"properties":{"ChannelName":{"description":"The name of the channel.","type":"string"},"LogTypes":{"description":"The types of logs to collect.","type":"array","items":{"$ref":"#/components/schemas/LogType"}}}}}}}},"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"}]},"/configureLogs/playbackConfiguration":{"put":{"operationId":"ConfigureLogsForPlaybackConfiguration","description":"Amazon CloudWatch log settings for a playback configuration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigureLogsForPlaybackConfigurationResponse"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PercentEnabled","PlaybackConfigurationName"],"properties":{"PercentEnabled":{"description":"<p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html\">debug log mode</a>.</p> <p>Valid values: <code>0</code> - <code>100</code> </p>","type":"integer"},"PlaybackConfigurationName":{"description":"The name of the playback configuration.","type":"string"}}}}}}},"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"}]},"/channel/{ChannelName}":{"post":{"operationId":"CreateChannel","description":"Creates a channel. For information about MediaTailor channels, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html\">Working with channels</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Outputs","PlaybackMode"],"properties":{"FillerSlate":{"description":"Slate VOD source configuration.","type":"object","properties":{"SourceLocationName":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The name of the source location where the slate VOD source is stored."}]},"VodSourceName":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate."}]}}},"Outputs":{"description":"An object that represents an object in the CreateChannel request.","type":"array","items":{"$ref":"#/components/schemas/RequestOutputItem"}},"PlaybackMode":{"description":"<p>The type of playback mode to use for this channel.</p> <p> <code>LINEAR</code> - The programs in the schedule play once back-to-back in the schedule.</p> <p> <code>LOOP</code> - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.</p>","type":"string","enum":["LOOP","LINEAR"]},"tags":{"description":"The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html\">Tagging AWS Elemental MediaTailor Resources</a>.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}},"Tier":{"description":"The tier of the channel.","type":"string","enum":["BASIC","STANDARD"]}}}}}}},"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":"DeleteChannel","description":"Deletes a channel. For information about MediaTailor channels, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html\">Working with channels</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel.","schema":{"type":"string"}}]},"get":{"operationId":"DescribeChannel","description":"Describes a channel. For information about MediaTailor channels, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html\">Working with channels</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeChannelResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel.","schema":{"type":"string"}}]},"put":{"operationId":"UpdateChannel","description":"Updates a channel. For information about MediaTailor channels, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html\">Working with channels</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Outputs"],"properties":{"FillerSlate":{"description":"Slate VOD source configuration.","type":"object","properties":{"SourceLocationName":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The name of the source location where the slate VOD source is stored."}]},"VodSourceName":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate."}]}}},"Outputs":{"description":"An object that represents an object in the CreateChannel request.","type":"array","items":{"$ref":"#/components/schemas/RequestOutputItem"}}}}}}}}},"/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}":{"post":{"operationId":"CreateLiveSource","description":"The live source configuration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLiveSourceResponse"}}}}},"parameters":[{"name":"LiveSourceName","in":"path","required":true,"description":"The name of the live source.","schema":{"type":"string"}},{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["HttpPackageConfigurations"],"properties":{"HttpPackageConfigurations":{"description":"The VOD source's HTTP package configuration settings.","type":"array","items":{"$ref":"#/components/schemas/HttpPackageConfiguration"}},"tags":{"description":"The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html\">Tagging AWS Elemental MediaTailor Resources</a>.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"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":"DeleteLiveSource","description":"The live source to delete.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLiveSourceResponse"}}}}},"parameters":[{"name":"LiveSourceName","in":"path","required":true,"description":"The name of the live source.","schema":{"type":"string"}},{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location associated with this Live Source.","schema":{"type":"string"}}]},"get":{"operationId":"DescribeLiveSource","description":"The live source to describe.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeLiveSourceResponse"}}}}},"parameters":[{"name":"LiveSourceName","in":"path","required":true,"description":"The name of the live source.","schema":{"type":"string"}},{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location associated with this Live Source.","schema":{"type":"string"}}]},"put":{"operationId":"UpdateLiveSource","description":"Updates a live source's configuration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveSourceResponse"}}}}},"parameters":[{"name":"LiveSourceName","in":"path","required":true,"description":"The name of the live source.","schema":{"type":"string"}},{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location associated with this Live Source.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["HttpPackageConfigurations"],"properties":{"HttpPackageConfigurations":{"description":"The VOD source's HTTP package configuration settings.","type":"array","items":{"$ref":"#/components/schemas/HttpPackageConfiguration"}}}}}}}}},"/prefetchSchedule/{PlaybackConfigurationName}/{Name}":{"post":{"operationId":"CreatePrefetchSchedule","description":"Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html\">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePrefetchScheduleResponse"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name to assign to the schedule request.","schema":{"type":"string"}},{"name":"PlaybackConfigurationName","in":"path","required":true,"description":"The name to assign to the playback configuration.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Consumption","Retrieval"],"properties":{"Consumption":{"description":"A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.","type":"object","properties":{"AvailMatchingCriteria":{"allOf":[{"$ref":"#/components/schemas/__listOfAvailMatchingCriteria"},{"description":"If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as <code>scte.event_id</code>, set the avail matching criteria."}]},"EndTime":{"allOf":[{"$ref":"#/components/schemas/__timestampUnix"},{"description":"The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call <code>DeletePrefetchSchedule</code>."}]},"StartTime":{"allOf":[{"$ref":"#/components/schemas/__timestampUnix"},{"description":"The time when prefetched ads are considered for use in an ad break. If you don't specify <code>StartTime</code>, the prefetched ads are available after MediaTailor retrives them from the ad decision server."}]}}},"Retrieval":{"description":"A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.","type":"object","properties":{"DynamicVariables":{"allOf":[{"$ref":"#/components/schemas/__mapOf__string"},{"description":"<p>The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).</p> <p>You initially configure <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html\">dynamic variables</a> for the ADS URL when you set up your playback configuration. When you specify <code>DynamicVariables</code> for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.</p>"}]},"EndTime":{"allOf":[{"$ref":"#/components/schemas/__timestampUnix"},{"description":"The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time."}]},"StartTime":{"allOf":[{"$ref":"#/components/schemas/__timestampUnix"},{"description":"The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible."}]}}},"StreamId":{"description":"An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.","type":"string"}}}}}}},"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":"DeletePrefetchSchedule","description":"Deletes a prefetch schedule for a specific playback configuration. If you call <code>DeletePrefetchSchedule</code> on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html\">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.","responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePrefetchScheduleResponse"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.","schema":{"type":"string"}},{"name":"PlaybackConfigurationName","in":"path","required":true,"description":"The name of the playback configuration for this prefetch schedule.","schema":{"type":"string"}}]},"get":{"operationId":"GetPrefetchSchedule","description":"Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html\">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPrefetchScheduleResponse"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.","schema":{"type":"string"}},{"name":"PlaybackConfigurationName","in":"path","required":true,"description":"Returns information about the prefetch schedule for a specific playback configuration. If you call <code>GetPrefetchSchedule</code> on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.","schema":{"type":"string"}}]}},"/channel/{ChannelName}/program/{ProgramName}":{"post":{"operationId":"CreateProgram","description":"Creates a program within a channel. For information about programs, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html\">Working with programs</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProgramResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel for this Program.","schema":{"type":"string"}},{"name":"ProgramName","in":"path","required":true,"description":"The name of the Program.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ScheduleConfiguration","SourceLocationName"],"properties":{"AdBreaks":{"description":"The ad break configuration settings.","type":"array","items":{"$ref":"#/components/schemas/AdBreak"}},"LiveSourceName":{"description":"The name of the LiveSource for this Program.","type":"string"},"ScheduleConfiguration":{"description":"Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.","type":"object","properties":{"ClipRange":{"allOf":[{"$ref":"#/components/schemas/ClipRange"},{"description":"Program clip range configuration."}]},"Transition":{"allOf":[{"$ref":"#/components/schemas/Transition"},{"description":"Program transition configurations."}]}}},"SourceLocationName":{"description":"The name of the source location.","type":"string"},"VodSourceName":{"description":"The name that's used to refer to a VOD source.","type":"string"}}}}}}},"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":"DeleteProgram","description":"Deletes a program within a channel. For information about programs, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html\">Working with programs</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProgramResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel.","schema":{"type":"string"}},{"name":"ProgramName","in":"path","required":true,"description":"The name of the program.","schema":{"type":"string"}}]},"get":{"operationId":"DescribeProgram","description":"Describes a program within a channel. For information about programs, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html\">Working with programs</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeProgramResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel associated with this Program.","schema":{"type":"string"}},{"name":"ProgramName","in":"path","required":true,"description":"The name of the program.","schema":{"type":"string"}}]},"put":{"operationId":"UpdateProgram","description":"Updates a program within a channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProgramResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel for this Program.","schema":{"type":"string"}},{"name":"ProgramName","in":"path","required":true,"description":"The name of the Program.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ScheduleConfiguration"],"properties":{"AdBreaks":{"description":"The ad break configuration settings.","type":"array","items":{"$ref":"#/components/schemas/AdBreak"}},"ScheduleConfiguration":{"description":"Schedule configuration parameters.","type":"object","properties":{"ClipRange":{"allOf":[{"$ref":"#/components/schemas/ClipRange"},{"description":"Program clip range configuration."}]},"Transition":{"allOf":[{"$ref":"#/components/schemas/UpdateProgramTransition"},{"description":"Program transition configuration."}]}}}}}}}}}},"/sourceLocation/{SourceLocationName}":{"post":{"operationId":"CreateSourceLocation","description":"Creates a source location. A source location is a container for sources. For more information about source locations, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html\">Working with source locations</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSourceLocationResponse"}}}}},"parameters":[{"name":"SourceLocationName","in":"path","required":true,"description":"The name associated with the source location.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["HttpConfiguration"],"properties":{"AccessConfiguration":{"description":"Access configuration parameters.","type":"object","properties":{"AccessType":{"allOf":[{"$ref":"#/components/schemas/AccessType"},{"description":"<p>The type of authentication used to access content from <code>HttpConfiguration::BaseUrl</code> on your source location. Accepted value: <code>S3_SIGV4</code>.</p> <p> <code>S3_SIGV4</code> - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.</p> <p>Before you can use <code>S3_SIGV4</code>, you must meet these requirements:</p> <p>• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.</p> <p>• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.</p> <p>• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.</p>"}]},"SecretsManagerAccessTokenConfiguration":{"allOf":[{"$ref":"#/components/schemas/SecretsManagerAccessTokenConfiguration"},{"description":"AWS Secrets Manager access token configuration parameters."}]}}},"DefaultSegmentDeliveryConfiguration":{"description":"The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.","type":"object","properties":{"BaseUrl":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The hostname of the server that will be used to serve segments. This string must include the protocol, such as <b>https://</b>."}]}}},"HttpConfiguration":{"description":"The HTTP configuration for the source location.","type":"object","properties":{"BaseUrl":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The base URL for the source location host server. This string must include the protocol, such as <b>https://</b>."}]}}},"SegmentDeliveryConfigurations":{"description":"A list of the segment delivery configurations associated with this resource.","type":"array","items":{"$ref":"#/components/schemas/SegmentDeliveryConfiguration"}},"tags":{"description":"The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html\">Tagging AWS Elemental MediaTailor Resources</a>.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"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":"DeleteSourceLocation","description":"Deletes a source location. A source location is a container for sources. For more information about source locations, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html\">Working with source locations</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSourceLocationResponse"}}}}},"parameters":[{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location.","schema":{"type":"string"}}]},"get":{"operationId":"DescribeSourceLocation","description":"Describes a source location. A source location is a container for sources. For more information about source locations, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html\">Working with source locations</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeSourceLocationResponse"}}}}},"parameters":[{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location.","schema":{"type":"string"}}]},"put":{"operationId":"UpdateSourceLocation","description":"Updates a source location. A source location is a container for sources. For more information about source locations, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html\">Working with source locations</a> in the <i>MediaTailor User Guide</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSourceLocationResponse"}}}}},"parameters":[{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["HttpConfiguration"],"properties":{"AccessConfiguration":{"description":"Access configuration parameters.","type":"object","properties":{"AccessType":{"allOf":[{"$ref":"#/components/schemas/AccessType"},{"description":"<p>The type of authentication used to access content from <code>HttpConfiguration::BaseUrl</code> on your source location. Accepted value: <code>S3_SIGV4</code>.</p> <p> <code>S3_SIGV4</code> - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.</p> <p>Before you can use <code>S3_SIGV4</code>, you must meet these requirements:</p> <p>• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.</p> <p>• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.</p> <p>• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.</p>"}]},"SecretsManagerAccessTokenConfiguration":{"allOf":[{"$ref":"#/components/schemas/SecretsManagerAccessTokenConfiguration"},{"description":"AWS Secrets Manager access token configuration parameters."}]}}},"DefaultSegmentDeliveryConfiguration":{"description":"The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.","type":"object","properties":{"BaseUrl":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The hostname of the server that will be used to serve segments. This string must include the protocol, such as <b>https://</b>."}]}}},"HttpConfiguration":{"description":"The HTTP configuration for the source location.","type":"object","properties":{"BaseUrl":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The base URL for the source location host server. This string must include the protocol, such as <b>https://</b>."}]}}},"SegmentDeliveryConfigurations":{"description":"A list of the segment delivery configurations associated with this resource.","type":"array","items":{"$ref":"#/components/schemas/SegmentDeliveryConfiguration"}}}}}}}}},"/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}":{"post":{"operationId":"CreateVodSource","description":"The VOD source configuration parameters.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVodSourceResponse"}}}}},"parameters":[{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location for this VOD source.","schema":{"type":"string"}},{"name":"VodSourceName","in":"path","required":true,"description":"The name associated with the VOD source.>","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["HttpPackageConfigurations"],"properties":{"HttpPackageConfigurations":{"description":"The VOD source's HTTP package configuration settings.","type":"array","items":{"$ref":"#/components/schemas/HttpPackageConfiguration"}},"tags":{"description":"The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html\">Tagging AWS Elemental MediaTailor Resources</a>.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"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":"DeleteVodSource","description":"The video on demand (VOD) source to delete.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteVodSourceResponse"}}}}},"parameters":[{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location associated with this VOD Source.","schema":{"type":"string"}},{"name":"VodSourceName","in":"path","required":true,"description":"The name of the VOD source.","schema":{"type":"string"}}]},"get":{"operationId":"DescribeVodSource","description":"Provides details about a specific video on demand (VOD) source in a specific source location.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeVodSourceResponse"}}}}},"parameters":[{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location associated with this VOD Source.","schema":{"type":"string"}},{"name":"VodSourceName","in":"path","required":true,"description":"The name of the VOD Source.","schema":{"type":"string"}}]},"put":{"operationId":"UpdateVodSource","description":"Updates a VOD source's configuration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVodSourceResponse"}}}}},"parameters":[{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location associated with this VOD Source.","schema":{"type":"string"}},{"name":"VodSourceName","in":"path","required":true,"description":"The name of the VOD source.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["HttpPackageConfigurations"],"properties":{"HttpPackageConfigurations":{"description":"The VOD source's HTTP package configuration settings.","type":"array","items":{"$ref":"#/components/schemas/HttpPackageConfiguration"}}}}}}}}},"/channel/{ChannelName}/policy":{"delete":{"operationId":"DeleteChannelPolicy","description":"The channel policy to delete.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelPolicyResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel associated with this channel policy.","schema":{"type":"string"}}]},"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":"Returns the channel's IAM policy. IAM policies are used to control access to your channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelPolicyResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel associated with this Channel Policy.","schema":{"type":"string"}}]},"put":{"operationId":"PutChannelPolicy","description":"Creates an IAM policy for the channel. IAM policies are used to control access to your channel.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutChannelPolicyResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The channel name associated with this Channel Policy.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Policy"],"properties":{"Policy":{"description":"Adds an IAM role that determines the permissions of your channel.","type":"string"}}}}}}}},"/playbackConfiguration/{Name}":{"delete":{"operationId":"DeletePlaybackConfiguration","description":"Deletes a playback configuration. For information about MediaTailor configurations, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html\">Working with configurations in AWS Elemental MediaTailor</a>.","responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePlaybackConfigurationResponse"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The name of the playback configuration.","schema":{"type":"string"}}]},"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":"GetPlaybackConfiguration","description":"Retrieves a playback configuration. For information about MediaTailor configurations, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html\">Working with configurations in AWS Elemental MediaTailor</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPlaybackConfigurationResponse"}}}}},"parameters":[{"name":"Name","in":"path","required":true,"description":"The identifier for the playback configuration.","schema":{"type":"string"}}]}},"/channel/{ChannelName}/schedule":{"get":{"operationId":"GetChannelSchedule","description":"Retrieves information about your channel's schedule.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelScheduleResponse"}}}}},"parameters":[{"name":"ChannelName","in":"path","required":true,"description":"The name of the channel associated with this Channel Schedule.","schema":{"type":"string"}},{"name":"durationMinutes","in":"query","required":false,"description":"The duration in minutes of the channel schedule.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> channel schedules, use the value of <code>NextToken</code> in the response to get the next page of results.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"<p>(Optional) If the playback configuration has more than <code>MaxResults</code> channel schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p> <p>For the first <code>GetChannelScheduleRequest</code> request, omit this value.</p> <p>For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p> <p>If the previous response didn't include a <code>NextToken</code> element, there are no more channel schedules to get.</p>","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}]},"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"}]},"/alerts#resourceArn":{"get":{"operationId":"ListAlerts","description":"Lists the alerts that are associated with a MediaTailor channel assembly resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAlertsResponse"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> alerts, use the value of <code>NextToken</code> in the response to get the next page of results.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.","schema":{"type":"string"}},{"name":"resourceArn","in":"query","required":true,"description":"The Amazon Resource Name (ARN) of the resource.","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}]},"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"}]},"/channels":{"get":{"operationId":"ListChannels","description":"Retrieves information about the channels that are associated with the current AWS account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelsResponse"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> channels, use the value of <code>NextToken</code> in the response to get the next page of results.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"Pagination token returned by the list request when results exceed the maximum allowed. 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}]},"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"}]},"/sourceLocation/{SourceLocationName}/liveSources":{"get":{"operationId":"ListLiveSources","description":"Lists the live sources contained in a source location. A source represents a piece of content.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLiveSourcesResponse"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> live sources, use the value of <code>NextToken</code> in the response to get the next page of results.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.","schema":{"type":"string"}},{"name":"SourceLocationName","in":"path","required":true,"description":"The name of the source location associated with this Live Sources list.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","sche