AWS API Changes

2022/01/20 - AWS MediaTailor - 4 updated api methods

Changes This release adds support for multiple Segment Delivery Configurations. Users can provide a list of names and URLs when creating or editing a source location. When retrieving content, users can send a header to choose which URL should be used to serve content.

CreateSourceLocation (updated)

Link ¶
Changes (both)

{'SegmentDeliveryConfigurations': [{'BaseUrl': 'string', 'Name': 'string'}]}

Creates a source location on a specific channel.

See also: AWS API Documentation

Request Syntax

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'
    }
)

type AccessConfiguration

dict

param AccessConfiguration

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.

type DefaultSegmentDeliveryConfiguration

dict

param DefaultSegmentDeliveryConfiguration

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

type HttpConfiguration

dict

param HttpConfiguration

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

type SegmentDeliveryConfigurations

list

param SegmentDeliveryConfigurations

(dict) --
- BaseUrl (string) --
- Name (string) --

type SourceLocationName

string

param SourceLocationName

[REQUIRED]

The identifier for the source location you are working on.

type Tags

dict

param Tags

The tags to assign to the source location.

(string) --
- (string) --

rtype

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) --

Success.
- 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. 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 of the source location.
- CreationTime (datetime) --
  
  The timestamp that indicates when the source location was created.
- DefaultSegmentDeliveryConfiguration (dict) --
  
  The default segment delivery configuration settings.
  - 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 package configuration settings 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) --
  - (dict) --
    - BaseUrl (string) --
    - Name (string) --
- SourceLocationName (string) --
  
  The name of the source location.
- Tags (dict) --
  
  The tags assigned to the source location.
  - (string) --
    - (string) --

DescribeSourceLocation (updated)

Link ¶
Changes (response)

{'SegmentDeliveryConfigurations': [{'BaseUrl': 'string', 'Name': 'string'}]}

Retrieves the properties of the requested source location.

See also: AWS API Documentation

Request Syntax

client.describe_source_location(
    SourceLocationName='string'
)

type SourceLocationName

string

param SourceLocationName

[REQUIRED]

The identifier for the source location you are working on.

rtype

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) --

Success.
- 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. 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 of the source location.
- CreationTime (datetime) --
  
  The timestamp that indicates when the source location was created.
- DefaultSegmentDeliveryConfiguration (dict) --
  
  The default segment delivery configuration settings.
  - 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 package configuration settings 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) --
  - (dict) --
    - BaseUrl (string) --
    - Name (string) --
- SourceLocationName (string) --
  
  The name of the source location.
- Tags (dict) --
  
  The tags assigned to the source location.
  - (string) --
    - (string) --

ListSourceLocations (updated)

Link ¶
Changes (response)

{'Items': {'SegmentDeliveryConfigurations': [{'BaseUrl': 'string',
                                              'Name': 'string'}]}}

Retrieves a list of source locations.

See also: AWS API Documentation

Request Syntax

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

type MaxResults

integer

param MaxResults

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

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'Items': [
        {
            '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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Success.
- Items (list) --
  
  An array of source locations.
  - (dict) --
    
    This response includes only the "type" : "object" property.
    - 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. 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 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) --
      - (dict) --
        
        BaseUrl (string) --
        
        Name (string) --
    - SourceLocationName (string) --
      
      The name of the source location.
    - Tags (dict) --
      
      The tags assigned to the source location.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  Pagination token from the list request. Use the token to fetch the next page of results.

UpdateSourceLocation (updated)

Link ¶
Changes (both)

{'SegmentDeliveryConfigurations': [{'BaseUrl': 'string', 'Name': 'string'}]}

Updates a source location on a specific channel.

See also: AWS API Documentation

Request Syntax

client.update_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'
)

type AccessConfiguration

dict

param AccessConfiguration

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.

type DefaultSegmentDeliveryConfiguration

dict

param DefaultSegmentDeliveryConfiguration

The optional configuration for the host 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:// .

type HttpConfiguration

dict

param HttpConfiguration

[REQUIRED]

The HTTP configuration for the source location.

BaseUrl (string) -- [REQUIRED]

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

type SegmentDeliveryConfigurations

list

param SegmentDeliveryConfigurations

(dict) --
- BaseUrl (string) --
- Name (string) --

type SourceLocationName

string

param SourceLocationName

[REQUIRED]

The identifier for the source location you are working on.

rtype

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) --

Success.
- 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. 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 of the source location.
- CreationTime (datetime) --
  
  The timestamp that indicates when the source location was created.
- DefaultSegmentDeliveryConfiguration (dict) --
  
  The default segment delivery configuration settings.
  - 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 package configuration settings 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) --
  - (dict) --
    - BaseUrl (string) --
    - Name (string) --
- SourceLocationName (string) --
  
  The name of the source location.
- Tags (dict) --
  
  The tags assigned to the source location.
  - (string) --
    - (string) --