SourceLocation - AWS Elemental MediaTailor

SourceLocation

Describes, creates, updates, and deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.

URI

/v1/sourceLocation/sourceLocationName

HTTP methods

GET

Operation ID: DescribeSourceLocation

Retrieves the properties of the requested source location.

Path parameters
Name Type Required Description
sourceLocationName String True

The identifier for the source location you are working on.

Responses
Status code Response model Description
200 DescribeSourceLocationResponse

Success.

POST

Operation ID: CreateSourceLocation

Creates a source location on a specific channel.

Path parameters
Name Type Required Description
sourceLocationName String True

The identifier for the source location you are working on.

Responses
Status code Response model Description
200 DescribeSourceLocationResponse

Success.

PUT

Operation ID: UpdateSourceLocation

Updates a source location on a specific channel.

Path parameters
Name Type Required Description
sourceLocationName String True

The identifier for the source location you are working on.

Responses
Status code Response model Description
200 DescribeSourceLocationResponse

Success.

DELETE

Operation ID: DeleteSourceLocation

Deletes a source location on a specific channel.

Path parameters
Name Type Required Description
sourceLocationName String True

The identifier for the source location you are working on.

Responses
Status code Response model Description
200 DeleteSourceLocationResponse

Success.

Schemas

Request bodies

{ "DefaultSegmentDeliveryConfiguration": { "BaseUrl": "string" }, "HttpConfiguration": { "BaseUrl": "string" }, "AccessConfiguration": { "SecretsManagerAccessTokenConfiguration": { "SecretArn": "string", "HeaderName": "string", "SecretStringKey": "string" }, "AccessType": enum }, "tags": { } }
{ "DefaultSegmentDeliveryConfiguration": { "BaseUrl": "string" }, "HttpConfiguration": { "BaseUrl": "string" }, "AccessConfiguration": { "SecretsManagerAccessTokenConfiguration": { "SecretArn": "string", "HeaderName": "string", "SecretStringKey": "string" }, "AccessType": enum } }

Response bodies

{ "SourceLocationName": "string", "DefaultSegmentDeliveryConfiguration": { "BaseUrl": "string" }, "CreationTime": integer, "LastModifiedTime": integer, "HttpConfiguration": { "BaseUrl": "string" }, "Arn": "string", "AccessConfiguration": { "SecretsManagerAccessTokenConfiguration": { "SecretArn": "string", "HeaderName": "string", "SecretStringKey": "string" }, "AccessType": enum }, "tags": { } }
{ }

Properties

AccessConfiguration

Access configuration parameters.

Property Type Required Description
SecretsManagerAccessTokenConfiguration

SecretsManagerAccessTokenConfiguration

False

AWS Secrets Manager access token configuration parameters.

AccessType

string

Values: S3_SIGV4

True

The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

S3_SIGV4 - 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.

Before you can use S3_SIGV4, you must meet these requirements:

• 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.

• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

CreateSourceLocationRequest

Source location configuration parameters.

Property Type Required Description
DefaultSegmentDeliveryConfiguration

DefaultSegmentDeliveryConfiguration

False

The optional configuration for the server that serves segments.

HttpConfiguration

HttpConfiguration

True

The source's HTTP package configurations.

AccessConfiguration

AccessConfiguration

False

Access configuration parameters. Configures the type of authentication used to access content from your source location.

tags

object

False

The tags to assign to the source location.

DefaultSegmentDeliveryConfiguration

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.

Property Type Required Description
BaseUrl

string

False

The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

DeleteSourceLocationResponse

This response includes only the "type" : "object" property.

DescribeSourceLocationResponse

This response includes only the "type" : "object" property.

Property Type Required Description
SourceLocationName

string

True

The name of the source location.

DefaultSegmentDeliveryConfiguration

DefaultSegmentDeliveryConfiguration

False

The default segment delivery configuration settings.

CreationTime

integer

Format: date-time

False

The timestamp that indicates when the source location was created.

LastModifiedTime

integer

Format: date-time

False

The timestamp that indicates when the source location was last modified.

HttpConfiguration

HttpConfiguration

True

The HTTP package configuration settings for the source location.

Arn

string

True

The ARN of the source location.

AccessConfiguration

AccessConfiguration

False

The access configuration for the source location.

tags

object

False

The tags assigned to the source location.

HttpConfiguration

The HTTP configuration for the source location.

Property Type Required Description
BaseUrl

string

True

The base URL for the source location host server. This string must include the protocol, such as https://.

SecretsManagerAccessTokenConfiguration

AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.

Property Type Required Description
SecretArn

string

True

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

HeaderName

string

True

The name of the HTTP header used to supply the access token in requests to the source location.

SecretStringKey

string

True

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

UpdateSourceLocationRequest

Source location configuration parameters.

Property Type Required Description
DefaultSegmentDeliveryConfiguration

DefaultSegmentDeliveryConfiguration

False

The optional configuration for the host server that serves segments.

HttpConfiguration

HttpConfiguration

True

The HTTP configuration for the source location.

AccessConfiguration

AccessConfiguration

False

Access configuration parameters. Configures the type of authentication used to access content from your source location.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeSourceLocation

CreateSourceLocation

UpdateSourceLocation

DeleteSourceLocation