IVS / Client / create_recording_configuration

create_recording_configuration#

IVS.Client.create_recording_configuration(**kwargs)#

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

See also: AWS API Documentation

Request Syntax

response = client.create_recording_configuration(
    destinationConfiguration={
        's3': {
            'bucketName': 'string'
        }
    },
    name='string',
    recordingReconnectWindowSeconds=123,
    tags={
        'string': 'string'
    },
    thumbnailConfiguration={
        'recordingMode': 'DISABLED'|'INTERVAL',
        'targetIntervalSeconds': 123
    }
)
Parameters:

  • destinationConfiguration (dict) –

    [REQUIRED]

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

    • s3 (dict) –

      An S3 destination configuration where recorded videos will be stored.

      • bucketName (string) – [REQUIRED]

        Location (S3 bucket name) where recorded videos will be stored.

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

  • recordingReconnectWindowSeconds (integer) – If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

  • tags (dict) –

    Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

    • (string) –

      • (string) –

  • thumbnailConfiguration (dict) –

    A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

    • recordingMode (string) –

      Thumbnail recording mode. Default: INTERVAL.

    • targetIntervalSeconds (integer) –

      The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

      Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Return type:

dict

Returns:

Response Syntax

{
    'recordingConfiguration': {
        'arn': 'string',
        'destinationConfiguration': {
            's3': {
                'bucketName': 'string'
            }
        },
        'name': 'string',
        'recordingReconnectWindowSeconds': 123,
        'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
        'tags': {
            'string': 'string'
        },
        'thumbnailConfiguration': {
            'recordingMode': 'DISABLED'|'INTERVAL',
            'targetIntervalSeconds': 123
        }
    }
}

Response Structure

  • (dict) –

    • recordingConfiguration (dict) –

      • arn (string) –

        Recording-configuration ARN.

      • destinationConfiguration (dict) –

        A complex type that contains information about where recorded video will be stored.

        • s3 (dict) –

          An S3 destination configuration where recorded videos will be stored.

          • bucketName (string) –

            Location (S3 bucket name) where recorded videos will be stored.

      • name (string) –

        Recording-configuration name. The value does not need to be unique.

      • recordingReconnectWindowSeconds (integer) –

        If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

      • state (string) –

        Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

      • tags (dict) –

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

        • (string) –

          • (string) –

      • thumbnailConfiguration (dict) –

        A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

        • recordingMode (string) –

          Thumbnail recording mode. Default: INTERVAL.

        • targetIntervalSeconds (integer) –

          The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

          Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Exceptions

  • IVS.Client.exceptions.InternalServerException

  • IVS.Client.exceptions.AccessDeniedException

  • IVS.Client.exceptions.ValidationException

  • IVS.Client.exceptions.PendingVerification

  • IVS.Client.exceptions.ConflictException

  • IVS.Client.exceptions.ServiceQuotaExceededException