Paginators

Index > IVS > Paginators

Auto-generated documentation for IVS type annotations stubs module types-boto3-ivs.

ListChannelsPaginator

Type annotations and code completion for boto3.client("ivs").get_paginator("list_channels"). boto3 documentation

# ListChannelsPaginator usage example

from boto3.session import Session

from types_boto3_ivs.paginator import ListChannelsPaginator

def get_list_channels_paginator() -> ListChannelsPaginator:
    return Session().client("ivs").get_paginator("list_channels")

# ListChannelsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_ivs.paginator import ListChannelsPaginator

session = Session()

client = Session().client("ivs")  # (1)
paginator: ListChannelsPaginator = client.get_paginator("list_channels")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: IVSClient
2. paginator: ListChannelsPaginator
3. item: PageIterator[ListChannelsResponseTypeDef]

paginate

Type annotations and code completion for ListChannelsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    filterByName: str = ...,
    filterByPlaybackRestrictionPolicyArn: str = ...,
    filterByRecordingConfigurationArn: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListChannelsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListChannelsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListChannelsRequestPaginateTypeDef = {  # (1)
    "filterByName": ...,
}

parent.paginate(**kwargs)

1. See ListChannelsRequestPaginateTypeDef

ListPlaybackKeyPairsPaginator

Type annotations and code completion for boto3.client("ivs").get_paginator("list_playback_key_pairs"). boto3 documentation

# ListPlaybackKeyPairsPaginator usage example

from boto3.session import Session

from types_boto3_ivs.paginator import ListPlaybackKeyPairsPaginator

def get_list_playback_key_pairs_paginator() -> ListPlaybackKeyPairsPaginator:
    return Session().client("ivs").get_paginator("list_playback_key_pairs")

# ListPlaybackKeyPairsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_ivs.paginator import ListPlaybackKeyPairsPaginator

session = Session()

client = Session().client("ivs")  # (1)
paginator: ListPlaybackKeyPairsPaginator = client.get_paginator("list_playback_key_pairs")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: IVSClient
2. paginator: ListPlaybackKeyPairsPaginator
3. item: PageIterator[ListPlaybackKeyPairsResponseTypeDef]

paginate

Type annotations and code completion for ListPlaybackKeyPairsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListPlaybackKeyPairsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListPlaybackKeyPairsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListPlaybackKeyPairsRequestPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See ListPlaybackKeyPairsRequestPaginateTypeDef

ListRecordingConfigurationsPaginator

Type annotations and code completion for boto3.client("ivs").get_paginator("list_recording_configurations"). boto3 documentation

# ListRecordingConfigurationsPaginator usage example

from boto3.session import Session

from types_boto3_ivs.paginator import ListRecordingConfigurationsPaginator

def get_list_recording_configurations_paginator() -> ListRecordingConfigurationsPaginator:
    return Session().client("ivs").get_paginator("list_recording_configurations")

# ListRecordingConfigurationsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_ivs.paginator import ListRecordingConfigurationsPaginator

session = Session()

client = Session().client("ivs")  # (1)
paginator: ListRecordingConfigurationsPaginator = client.get_paginator("list_recording_configurations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: IVSClient
2. paginator: ListRecordingConfigurationsPaginator
3. item: PageIterator[ListRecordingConfigurationsResponseTypeDef]

paginate

Type annotations and code completion for ListRecordingConfigurationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListRecordingConfigurationsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListRecordingConfigurationsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListRecordingConfigurationsRequestPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See ListRecordingConfigurationsRequestPaginateTypeDef

ListStreamKeysPaginator

Type annotations and code completion for boto3.client("ivs").get_paginator("list_stream_keys"). boto3 documentation

# ListStreamKeysPaginator usage example

from boto3.session import Session

from types_boto3_ivs.paginator import ListStreamKeysPaginator

def get_list_stream_keys_paginator() -> ListStreamKeysPaginator:
    return Session().client("ivs").get_paginator("list_stream_keys")

# ListStreamKeysPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_ivs.paginator import ListStreamKeysPaginator

session = Session()

client = Session().client("ivs")  # (1)
paginator: ListStreamKeysPaginator = client.get_paginator("list_stream_keys")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: IVSClient
2. paginator: ListStreamKeysPaginator
3. item: PageIterator[ListStreamKeysResponseTypeDef]

paginate

Type annotations and code completion for ListStreamKeysPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    channelArn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListStreamKeysResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListStreamKeysResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListStreamKeysRequestPaginateTypeDef = {  # (1)
    "channelArn": ...,
}

parent.paginate(**kwargs)

1. See ListStreamKeysRequestPaginateTypeDef

ListStreamsPaginator

Type annotations and code completion for boto3.client("ivs").get_paginator("list_streams"). boto3 documentation

# ListStreamsPaginator usage example

from boto3.session import Session

from types_boto3_ivs.paginator import ListStreamsPaginator

def get_list_streams_paginator() -> ListStreamsPaginator:
    return Session().client("ivs").get_paginator("list_streams")

# ListStreamsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_ivs.paginator import ListStreamsPaginator

session = Session()

client = Session().client("ivs")  # (1)
paginator: ListStreamsPaginator = client.get_paginator("list_streams")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: IVSClient
2. paginator: ListStreamsPaginator
3. item: PageIterator[ListStreamsResponseTypeDef]

paginate

Type annotations and code completion for ListStreamsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    filterBy: StreamFiltersTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListStreamsResponseTypeDef]:  # (3)
    ...

1. See StreamFiltersTypeDef
2. See PaginatorConfigTypeDef
3. See PageIterator[ListStreamsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListStreamsRequestPaginateTypeDef = {  # (1)
    "filterBy": ...,
}

parent.paginate(**kwargs)

1. See ListStreamsRequestPaginateTypeDef