MediaTailor / Client / list_source_locations

list_source_locations#

MediaTailor.Client.list_source_locations(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_source_locations(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than MaxResults source locations, use the value of NextToken in the response to get the next page of results.

  • NextToken (string) – Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'AccessConfiguration': {
                'AccessType': 'S3_SIGV4'|'SECRETS_MANAGER_ACCESS_TOKEN'|'AUTODETECT_SIGV4',
                'SecretsManagerAccessTokenConfiguration': {
                    'HeaderName': 'string',
                    'SecretArn': 'string',
                    'SecretStringKey': 'string'
                }
            },
            'Arn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'DefaultSegmentDeliveryConfiguration': {
                'BaseUrl': 'string'
            },
            'HttpConfiguration': {
                'BaseUrl': 'string'
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'SegmentDeliveryConfigurations': [
                {
                    'BaseUrl': 'string',
                    'Name': 'string'
                },
            ],
            'SourceLocationName': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      A list of source locations.

      • (dict) –

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

        • AccessConfiguration (dict) –

          The access configuration for the source location.

          • AccessType (string) –

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

            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.

            AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.

            Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you must meet these requirements:

            • You must grant MediaTailor access to your MediaPackage endpoint by granting mediatailor.amazonaws.com principal access in an Origin Access policy on the endpoint.

            • Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.

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

            Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet these requirements:

            • You must grant MediaTailor access to your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For more 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 (dict) –

            AWS Secrets Manager access token configuration parameters.

            • HeaderName (string) –

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

            • SecretArn (string) –

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

            • SecretStringKey (string) –

              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.

        • Arn (string) –

          The ARN of the SourceLocation.

        • CreationTime (datetime) –

          The timestamp that indicates when the source location was created.

        • DefaultSegmentDeliveryConfiguration (dict) –

          The default segment delivery configuration.

          • BaseUrl (string) –

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

        • HttpConfiguration (dict) –

          The HTTP configuration for the source location.

          • BaseUrl (string) –

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

        • LastModifiedTime (datetime) –

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

        • SegmentDeliveryConfigurations (list) –

          The segment delivery configurations for the source location.

          • (dict) –

            The segment delivery configuration settings.

            • BaseUrl (string) –

              The base URL of the host or path of the segment delivery server that you’re using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.

            • Name (string) –

              A unique identifier used to distinguish between multiple segment delivery configurations in a source location.

        • SourceLocationName (string) –

          The name of the source location.

        • Tags (dict) –

          The tags assigned 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 Tagging AWS Elemental MediaTailor Resources.

          • (string) –

            • (string) –

    • NextToken (string) –

      Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.