mediapackagev2 / Client / reset_channel_state

reset_channel_state#

mediapackagev2.Client.reset_channel_state(**kwargs)#

Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content.

Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder.

See also: AWS API Documentation

Request Syntax

response = client.reset_channel_state(
    ChannelGroupName='string',
    ChannelName='string'
)
Parameters:

  • ChannelGroupName (string) –

    [REQUIRED]

    The name of the channel group that contains the channel that you are resetting.

  • ChannelName (string) –

    [REQUIRED]

    The name of the channel that you are resetting.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelGroupName': 'string',
    'ChannelName': 'string',
    'Arn': 'string',
    'ResetAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • ChannelGroupName (string) –

      The name of the channel group that contains the channel that you just reset.

    • ChannelName (string) –

      The name of the channel that you just reset.

    • Arn (string) –

      The Amazon Resource Name (ARN) associated with the channel that you just reset.

    • ResetAt (datetime) –

      The time that the channel was last reset.

Exceptions