IVS / Client / batch_start_viewer_session_revocation

batch_start_viewer_session_revocation#

IVS.Client.batch_start_viewer_session_revocation(**kwargs)#

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

See also: AWS API Documentation

Request Syntax

response = client.batch_start_viewer_session_revocation(
    viewerSessions=[
        {
            'channelArn': 'string',
            'viewerId': 'string',
            'viewerSessionVersionsLessThanOrEqualTo': 123
        },
    ]
)
Parameters:

viewerSessions (list) –

[REQUIRED]

Array of viewer sessions, one per channel-ARN and viewer-ID pair.

  • (dict) –

    A viewer session to revoke in the call to BatchStartViewerSessionRevocation.

    • channelArn (string) – [REQUIRED]

      The ARN of the channel associated with the viewer session to revoke.

    • viewerId (string) – [REQUIRED]

      The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.

    • viewerSessionVersionsLessThanOrEqualTo (integer) –

      An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.

Return type:

dict

Returns:

Response Syntax

{
    'errors': [
        {
            'channelArn': 'string',
            'code': 'string',
            'message': 'string',
            'viewerId': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • errors (list) –

      Each error object is related to a specific channelArn and viewerId pair in the request.

      • (dict) –

        Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.

        • channelArn (string) –

          Channel ARN.

        • code (string) –

          Error code.

        • message (string) –

          Error message, determined by the application.

        • viewerId (string) –

          The ID of the viewer session to revoke.

Exceptions