Skip to content

ListChannelsRequest

Source code in docs_src/capo_ivs/types/list_channels_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class ListChannelsRequest(TypedDict, closed=True):
    filter_by_name: NotRequired["capo_ivs.types.channel_name.ChannelName"]
    """<p>Filters the channel list to match the specified name.</p>"""
    filter_by_recording_configuration_arn: NotRequired[
        "capo_ivs.types.channel_recording_configuration_arn.ChannelRecordingConfigurationArn"
    ]
    """<p>Filters the channel list to match the specified recording-configuration ARN.</p>"""
    filter_by_playback_restriction_policy_arn: NotRequired[
        "capo_ivs.types.channel_playback_restriction_policy_arn.ChannelPlaybackRestrictionPolicyArn"
    ]
    """<p>Filters the channel list to match the specified policy.</p>"""
    filter_by_ad_configuration_arn: NotRequired[
        "capo_ivs.types.channel_ad_configuration_arn.ChannelAdConfigurationArn"
    ]
    """<p>Filters the channel list to match the specified ad configuration ARN.</p>"""
    next_token: NotRequired["capo_ivs.types.pagination_token.PaginationToken"]
    """<p>The first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>"""
    max_results: NotRequired["capo_ivs.types.max_channel_results.MaxChannelResults"]
    """<p>Maximum number of channels to return. Default: 100.</p>"""

filter_by_ad_configuration_arn instance-attribute 

filter_by_ad_configuration_arn: NotRequired[ChannelAdConfigurationArn]

Filters the channel list to match the specified ad configuration ARN.

filter_by_name instance-attribute 

filter_by_name: NotRequired[ChannelName]

Filters the channel list to match the specified name.

filter_by_playback_restriction_policy_arn instance-attribute 

filter_by_playback_restriction_policy_arn: NotRequired[
    ChannelPlaybackRestrictionPolicyArn
]

Filters the channel list to match the specified policy.

filter_by_recording_configuration_arn instance-attribute 

filter_by_recording_configuration_arn: NotRequired[ChannelRecordingConfigurationArn]

Filters the channel list to match the specified recording-configuration ARN.

max_results instance-attribute 

max_results: NotRequired[MaxChannelResults]

Maximum number of channels to return. Default: 100.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

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