Class: Aws::IVSRealTime::Types::ListParticipantReplicasRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ivsrealtime/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

Maximum number of results to return. Default: 50.

Returns:

  • (Integer)


1734
1735
1736
1737
1738
1739
1740
1741
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1734

class ListParticipantReplicasRequest < Struct.new(
  :source_stage_arn,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The first participant to retrieve. This is used for pagination; see the ‘nextToken` response field.

Returns:

  • (String)


1734
1735
1736
1737
1738
1739
1740
1741
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1734

class ListParticipantReplicasRequest < Struct.new(
  :source_stage_arn,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#participant_idString

Participant ID of the publisher that has been replicated. This is assigned by IVS and returned by CreateParticipantToken or the ‘jti` (JWT ID) used to [create a self signed token].

[1]: docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html#getting-started-distribute-tokens-self-signed

Returns:

  • (String)


1734
1735
1736
1737
1738
1739
1740
1741
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1734

class ListParticipantReplicasRequest < Struct.new(
  :source_stage_arn,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#source_stage_arnString

ARN of the stage where the participant is publishing.

Returns:

  • (String)


1734
1735
1736
1737
1738
1739
1740
1741
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 1734

class ListParticipantReplicasRequest < Struct.new(
  :source_stage_arn,
  :participant_id,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end