Skip to content

ListCompositionsRequest

Source code in docs_src/capo_ivs_realtime/types/list_compositions_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class ListCompositionsRequest(TypedDict, closed=True):
    filter_by_stage_arn: NotRequired["capo_ivs_realtime.types.stage_arn.StageArn"]
    """<p>Filters the Composition list to match the specified Stage ARN.</p>"""
    filter_by_encoder_configuration_arn: NotRequired[
        "capo_ivs_realtime.types.encoder_configuration_arn.EncoderConfigurationArn"
    ]
    """<p>Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.</p>"""
    next_token: NotRequired["capo_ivs_realtime.types.pagination_token.PaginationToken"]
    """<p>The first Composition to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>"""
    max_results: NotRequired[
        "capo_ivs_realtime.types.max_composition_results.MaxCompositionResults"
    ]
    """<p>Maximum number of results to return. Default: 100.</p>"""

filter_by_encoder_configuration_arn instance-attribute 

filter_by_encoder_configuration_arn: NotRequired[EncoderConfigurationArn]

Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

filter_by_stage_arn instance-attribute 

filter_by_stage_arn: NotRequired[StageArn]

Filters the Composition list to match the specified Stage ARN.

max_results instance-attribute 

max_results: NotRequired[MaxCompositionResults]

Maximum number of results to return. Default: 100.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

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