ivsrealtime / Client / create_storage_configuration

create_storage_configuration#

ivsrealtime.Client.create_storage_configuration(**kwargs)#

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

See also: AWS API Documentation

Request Syntax

response = client.create_storage_configuration(
    name='string',
    s3={
        'bucketName': 'string'
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) – Storage configuration name. The value does not need to be unique.

  • s3 (dict) –

    [REQUIRED]

    A complex type that contains a storage configuration for where recorded video will be stored.

    • bucketName (string) – [REQUIRED]

      Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

  • tags (dict) –

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'storageConfiguration': {
        'arn': 'string',
        'name': 'string',
        's3': {
            'bucketName': 'string'
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • storageConfiguration (dict) –

      The StorageConfiguration that was created.

      • arn (string) –

        ARN of the storage configuration.

      • name (string) –

        Name of the storage configuration.

      • s3 (dict) –

        An S3 destination configuration where recorded videos will be stored.

        • bucketName (string) –

          Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

      • tags (dict) –

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

        • (string) –

          • (string) –

Exceptions