Skip to content

IngestConfigurationSummary

Source code in docs_src/capo_ivs_realtime/types/ingest_configuration_summary.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class IngestConfigurationSummary(TypedDict, closed=True):
    name: NotRequired[
        "capo_ivs_realtime.types.ingest_configuration_name.IngestConfigurationName"
    ]
    """<p>Ingest name.</p>"""
    arn: "capo_ivs_realtime.types.ingest_configuration_arn.IngestConfigurationArn"
    """<p>Ingest configuration ARN.</p>"""
    ingest_protocol: "capo_ivs_realtime.types.ingest_protocol.IngestProtocol"
    """<p>Type of ingest protocol that the user employs for broadcasting.</p>"""
    stage_arn: "capo_ivs_realtime.types.ingest_configuration_stage_arn.IngestConfigurationStageArn"
    """<p>ARN of the stage with which the IngestConfiguration is associated.</p>"""
    participant_id: "capo_ivs_realtime.types.participant_id.ParticipantId"
    """<p>ID of the participant within the stage.</p>"""
    state: "capo_ivs_realtime.types.ingest_configuration_state.IngestConfigurationState"
    """<p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is publishing to the stage associated with the ingest configuration.</p>"""
    user_id: NotRequired["capo_ivs_realtime.types.user_id.UserId"]
    """<p>Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i> </p>"""
    redundant_ingest: "capo_ivs_realtime.types.redundant_ingest.RedundantIngest"
    """<p>Indicates whether redundant ingest is enabled for the ingest configuration.</p>"""

arn instance-attribute 

arn: IngestConfigurationArn

Ingest configuration ARN.

ingest_protocol instance-attribute 

ingest_protocol: IngestProtocol

Type of ingest protocol that the user employs for broadcasting.

name instance-attribute 

name: NotRequired[IngestConfigurationName]

Ingest name.

participant_id instance-attribute 

participant_id: ParticipantId

ID of the participant within the stage.

redundant_ingest instance-attribute 

redundant_ingest: RedundantIngest

Indicates whether redundant ingest is enabled for the ingest configuration.

stage_arn instance-attribute 

stage_arn: IngestConfigurationStageArn

ARN of the stage with which the IngestConfiguration is associated.

state instance-attribute 

state: IngestConfigurationState

State of the ingest configuration. It is ACTIVE if a publisher currently is publishing to the stage associated with the ingest configuration.

user_id instance-attribute 

user_id: NotRequired[UserId]

Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.