ivsrealtime / Client / get_storage_configuration

get_storage_configuration

ivsrealtime.Client.get_storage_configuration(**kwargs)

Gets the storage configuration for the specified ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_storage_configuration(
    arn='string'
)

Parameters:

arn (string) –

[REQUIRED]

ARN of the storage configuration to be retrieved.

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

    • 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

• ivsrealtime.Client.exceptions.ResourceNotFoundException

• ivsrealtime.Client.exceptions.ValidationException

• ivsrealtime.Client.exceptions.AccessDeniedException

• ivsrealtime.Client.exceptions.InternalServerException

• ivsrealtime.Client.exceptions.ServiceQuotaExceededException

• ivsrealtime.Client.exceptions.ConflictException