MediaTailor / Client / create_source_location

create_source_location#

MediaTailor.Client.create_source_location(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_source_location(
    AccessConfiguration={
        'AccessType': 'S3_SIGV4'|'SECRETS_MANAGER_ACCESS_TOKEN',
        'SecretsManagerAccessTokenConfiguration': {
            'HeaderName': 'string',
            'SecretArn': 'string',
            'SecretStringKey': 'string'
        }
    },
    DefaultSegmentDeliveryConfiguration={
        'BaseUrl': 'string'
    },
    HttpConfiguration={
        'BaseUrl': 'string'
    },
    SegmentDeliveryConfigurations=[
        {
            'BaseUrl': 'string',
            'Name': 'string'
        },
    ],
    SourceLocationName='string',
    Tags={
        'string': 'string'
    }
)

Parameters:

AccessConfiguration (dict) –
Access configuration parameters. Configures the type of authentication used to access content from your source location.
- AccessType (string) –
  
  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 (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.
DefaultSegmentDeliveryConfiguration (dict) –
The optional configuration for the server that serves segments.
- 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) –
[REQUIRED]

The source’s HTTP package configurations.
- BaseUrl (string) – [REQUIRED]
  
  The base URL for the source location host server. This string must include the protocol, such as https://.
SegmentDeliveryConfigurations (list) –
A list of the segment delivery configurations associated with this resource.
- (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) –
[REQUIRED]

The name associated with the source location.
Tags (dict) –
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 Tagging AWS Elemental MediaTailor Resources.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AccessConfiguration': {
        'AccessType': 'S3_SIGV4'|'SECRETS_MANAGER_ACCESS_TOKEN',
        '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'
    }
}

Response Structure

(dict) –
- AccessConfiguration (dict) –
  
  Access configuration parameters. Configures the type of authentication used to access content from your source location.
  - AccessType (string) –
    
    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 (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 to assign to the source location.
- CreationTime (datetime) –
  
  The time the source location was created.
- DefaultSegmentDeliveryConfiguration (dict) –
  
  The optional configuration for the server that serves segments.
  - 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 source’s HTTP package configurations.
  - BaseUrl (string) –
    
    The base URL for the source location host server. This string must include the protocol, such as https://.
- LastModifiedTime (datetime) –
  
  The time the source location was last modified.
- SegmentDeliveryConfigurations (list) –
  
  The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
  - (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 to assign to the source location.
- Tags (dict) –
  
  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 Tagging AWS Elemental MediaTailor Resources.
  - (string) –
    - (string) –