Start Viewer Session Revocation

ivs_start_viewer_session_revocation

R Documentation

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID¶

Description¶

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.

Usage¶

ivs_start_viewer_session_revocation(channelArn, viewerId,
  viewerSessionVersionsLessThanOrEqualTo)

Arguments¶

channelArn

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

viewerId

[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

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.

Value¶

An empty list.

Request syntax¶

svc$start_viewer_session_revocation(
  channelArn = "string",
  viewerId = "string",
  viewerSessionVersionsLessThanOrEqualTo = 123
)