The SourceLocation API from Amazon MediaTailor — 5 operation(s) for sourcelocation.
openapi: 3.0.0
info:
version: 2018-04-23
x-release: v4
title: AWS MediaTailor Alerts#resourceArn SourceLocation API
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://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: 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
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)
security:
- hmac: []
tags:
- name: SourceLocation
paths:
/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}:
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: CreateLiveSource
description: The live source configuration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLiveSourceResponse'
examples:
CreateLiveSource200Example:
summary: Default CreateLiveSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
LiveSourceName: example-resource
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'
summary: Amazon MediaTailor Create Live Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
delete:
operationId: DeleteLiveSource
description: The live source to delete.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteLiveSourceResponse'
examples:
DeleteLiveSource200Example:
summary: Default DeleteLiveSource 200 response
x-microcks-default: true
value: {}
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
summary: Amazon MediaTailor Delete Live Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
get:
operationId: DescribeLiveSource
description: The live source to describe.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeLiveSourceResponse'
examples:
DescribeLiveSource200Example:
summary: Default DescribeLiveSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
LiveSourceName: example-resource
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
summary: Amazon MediaTailor Describe Live Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
put:
operationId: UpdateLiveSource
description: Updates a live source's configuration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateLiveSourceResponse'
examples:
UpdateLiveSource200Example:
summary: Default UpdateLiveSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
LiveSourceName: example-resource
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'
summary: Amazon MediaTailor Update Live Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
/sourceLocation/{SourceLocationName}:
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: 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'
examples:
CreateSourceLocation200Example:
summary: Default CreateSourceLocation 200 response
x-microcks-default: true
value:
AccessConfiguration: example-value
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
DefaultSegmentDeliveryConfiguration: example-value
HttpConfiguration: example-value
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'
summary: Amazon MediaTailor Create Source Location
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
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'
examples:
DeleteSourceLocation200Example:
summary: Default DeleteSourceLocation 200 response
x-microcks-default: true
value: {}
parameters:
- name: SourceLocationName
in: path
required: true
description: The name of the source location.
schema:
type: string
summary: Amazon MediaTailor Delete Source Location
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
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'
examples:
DescribeSourceLocation200Example:
summary: Default DescribeSourceLocation 200 response
x-microcks-default: true
value:
AccessConfiguration: example-value
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
DefaultSegmentDeliveryConfiguration: example-value
HttpConfiguration: example-value
parameters:
- name: SourceLocationName
in: path
required: true
description: The name of the source location.
schema:
type: string
summary: Amazon MediaTailor Describe Source Location
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
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'
examples:
UpdateSourceLocation200Example:
summary: Default UpdateSourceLocation 200 response
x-microcks-default: true
value:
AccessConfiguration: example-value
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
DefaultSegmentDeliveryConfiguration: example-value
HttpConfiguration: example-value
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'
summary: Amazon MediaTailor Update Source Location
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}:
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: CreateVodSource
description: The VOD source configuration parameters.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVodSourceResponse'
examples:
CreateVodSource200Example:
summary: Default CreateVodSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
SourceLocationName: example-resource
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'
summary: Amazon MediaTailor Create Vod Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
delete:
operationId: DeleteVodSource
description: The video on demand (VOD) source to delete.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteVodSourceResponse'
examples:
DeleteVodSource200Example:
summary: Default DeleteVodSource 200 response
x-microcks-default: true
value: {}
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
summary: Amazon MediaTailor Delete Vod Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
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'
examples:
DescribeVodSource200Example:
summary: Default DescribeVodSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
SourceLocationName: example-resource
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
summary: Amazon MediaTailor Describe Vod Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
put:
operationId: UpdateVodSource
description: Updates a VOD source's configuration.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVodSourceResponse'
examples:
UpdateVodSource200Example:
summary: Default UpdateVodSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
SourceLocationName: example-resource
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'
summary: Amazon MediaTailor Update Vod Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- SourceLocation
/sourceLocation/{SourceLocationName}/liveSources:
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: 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'
examples:
ListLiveSources200Example:
summary: Default ListLiveSources 200 response
x-microcks-default: true
value:
Items: example-value
NextToken: example-value
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediatailor/refs/heads/main/openapi/amazon-mediatailor-sourcelocation-api-openapi.yml