ivsrealtime / Client / list_ingest_configurations

list_ingest_configurations#

ivsrealtime.Client.list_ingest_configurations(**kwargs)#

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

See also: AWS API Documentation

Request Syntax

response = client.list_ingest_configurations(
    filterByStageArn='string',
    filterByState='ACTIVE'|'INACTIVE',
    nextToken='string',
    maxResults=123
)
Parameters:

  • filterByStageArn (string) – Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.

  • filterByState (string) – Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.

  • nextToken (string) – The first IngestConfiguration to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults (integer) – Maximum number of results to return. Default: 50.

Return type:

dict

Returns:

Response Syntax

{
    'ingestConfigurations': [
        {
            'name': 'string',
            'arn': 'string',
            'ingestProtocol': 'RTMP'|'RTMPS',
            'stageArn': 'string',
            'participantId': 'string',
            'state': 'ACTIVE'|'INACTIVE',
            'userId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • ingestConfigurations (list) –

      List of the matching ingest configurations (summary information only).

      • (dict) –

        Summary information about an IngestConfiguration.

        • name (string) –

          Ingest name.

        • arn (string) –

          Ingest configuration ARN.

        • ingestProtocol (string) –

          Type of ingest protocol that the user employs for broadcasting.

        • stageArn (string) –

          ARN of the stage with which the IngestConfiguration is associated.

        • participantId (string) –

          ID of the participant within the stage.

        • state (string) –

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

        • userId (string) –

          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.

    • nextToken (string) –

      If there are more IngestConfigurations than maxResults, use nextToken in the request to get the next set.

Exceptions

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException