ListSourceLocations - AWS Elemental MediaTailor

ListSourceLocations

Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.

URI

/v1/sourceLocations

HTTP methods

GET

Operation ID: ListSourceLocations

Retrieves a list of source locations.

Query parameters
Name Type Required Description
nextToken String False

Pagination token from the GET list request. Use the token to fetch the next page of results.

maxResults String False

Upper bound on number of records to return. The maximum number of results is 100.

Responses
Status code Response model Description
200 ListSourceLocationsResponse

Success.

Schemas

Response bodies

{ "NextToken": "string", "Items": [ { "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
AccessType

string

Values: S3_SIGV4 | SECRETS_MANAGER_ACCESS_TOKEN

False

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.

SecretsManagerAccessTokenConfiguration

SecretsManagerAccessTokenConfiguration

False

AWS Secrets Manager access token configuration parameters.

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://.

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://.

ListSourceLocationsResponse

Lists the source locations.

Property Type Required Description
Items

Array of type SourceLocation

False

An array of source locations.

NextToken

string

False

Pagination token from the list request. Use the token to fetch the next page of results.

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
HeaderName

string

False

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

SecretArn

string

False

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

SecretStringKey

string

False

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.

SourceLocation

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

Property Type Required Description
AccessConfiguration

AccessConfiguration

False

The access configuration for the source location.

Arn

string

True

The ARN of the SourceLocation.

CreationTime

integer

Format: date-time

False

The timestamp that indicates when the source location was created.

DefaultSegmentDeliveryConfiguration

DefaultSegmentDeliveryConfiguration

False

The default segment delivery configuration.

HttpConfiguration

HttpConfiguration

True

The HTTP configuration for the source location.

LastModifiedTime

integer

Format: date-time

False

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

SourceLocationName

string

True

The name of the source location.

tags

object

False

The tags assigned to the source location.

See also

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

ListSourceLocations