Skip to content

iter_list_channels

iter_list_channels(
    *,
    config_overrides: Optional[ivsClientConfig] = None,
    filter_by_name: Optional[ChannelName] = None,
    filter_by_recording_configuration_arn: Optional[
        ChannelRecordingConfigurationArn
    ] = None,
    filter_by_playback_restriction_policy_arn: Optional[
        ChannelPlaybackRestrictionPolicyArn
    ] = None,
    filter_by_ad_configuration_arn: Optional[ChannelAdConfigurationArn] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxChannelResults] = None,
) -> Iterator[ListChannelsResponse]
Source code in docs_src/capo_ivs/_services/ivs.py
def iter_list_channels(
    self,
    *,
    config_overrides: Optional[ivsClientConfig] = None,
    filter_by_name: Optional["capo_ivs.types.channel_name.ChannelName"] = None,
    filter_by_recording_configuration_arn: Optional[
        "capo_ivs.types.channel_recording_configuration_arn.ChannelRecordingConfigurationArn"
    ] = None,
    filter_by_playback_restriction_policy_arn: Optional[
        "capo_ivs.types.channel_playback_restriction_policy_arn.ChannelPlaybackRestrictionPolicyArn"
    ] = None,
    filter_by_ad_configuration_arn: Optional[
        "capo_ivs.types.channel_ad_configuration_arn.ChannelAdConfigurationArn"
    ] = None,
    next_token: Optional["capo_ivs.types.pagination_token.PaginationToken"] = None,
    max_results: Optional[
        "capo_ivs.types.max_channel_results.MaxChannelResults"
    ] = None,
) -> "Iterator[capo_ivs.types.list_channels_response.ListChannelsResponse]":
    _token = next_token
    while True:
        _response = self.list_channels(
            config_overrides=config_overrides,
            filter_by_name=filter_by_name,
            filter_by_recording_configuration_arn=filter_by_recording_configuration_arn,
            filter_by_playback_restriction_policy_arn=filter_by_playback_restriction_policy_arn,
            filter_by_ad_configuration_arn=filter_by_ad_configuration_arn,
            next_token=_token,
            max_results=max_results,
        )
        yield _response
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break