Skip to content

Paginators#

Index > Shield > Paginators

Auto-generated documentation for Shield type annotations stubs module mypy-boto3-shield.

ListAttacksPaginator#

Type annotations and code completion for boto3.client("shield").get_paginator("list_attacks"). boto3 documentation

# ListAttacksPaginator usage example

from boto3.session import Session

from mypy_boto3_shield.paginator import ListAttacksPaginator

def get_list_attacks_paginator() -> ListAttacksPaginator:
    return Session().client("shield").get_paginator("list_attacks")
# ListAttacksPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_shield.paginator import ListAttacksPaginator

session = Session()

client = Session().client("shield")  # (1)
paginator: ListAttacksPaginator = client.get_paginator("list_attacks")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ShieldClient
  2. paginator: ListAttacksPaginator
  3. item: ListAttacksResponseTypeDef

paginate#

Type annotations and code completion for ListAttacksPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ResourceArns: Sequence[str] = ...,
    StartTime: TimeRangeTypeDef = ...,  # (1)
    EndTime: TimeRangeTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> _PageIterator[ListAttacksResponseTypeDef]:  # (4)
    ...
  1. See TimeRangeTypeDef
  2. See TimeRangeTypeDef
  3. See PaginatorConfigTypeDef
  4. See ListAttacksResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: ListAttacksRequestListAttacksPaginateTypeDef = {  # (1)
    "ResourceArns": ...,
}

parent.paginate(**kwargs)
  1. See ListAttacksRequestListAttacksPaginateTypeDef

ListProtectionsPaginator#

Type annotations and code completion for boto3.client("shield").get_paginator("list_protections"). boto3 documentation

# ListProtectionsPaginator usage example

from boto3.session import Session

from mypy_boto3_shield.paginator import ListProtectionsPaginator

def get_list_protections_paginator() -> ListProtectionsPaginator:
    return Session().client("shield").get_paginator("list_protections")
# ListProtectionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_shield.paginator import ListProtectionsPaginator

session = Session()

client = Session().client("shield")  # (1)
paginator: ListProtectionsPaginator = client.get_paginator("list_protections")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ShieldClient
  2. paginator: ListProtectionsPaginator
  3. item: ListProtectionsResponseTypeDef

paginate#

Type annotations and code completion for ListProtectionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    InclusionFilters: InclusionProtectionFiltersTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListProtectionsResponseTypeDef]:  # (3)
    ...
  1. See InclusionProtectionFiltersTypeDef
  2. See PaginatorConfigTypeDef
  3. See ListProtectionsResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: ListProtectionsRequestListProtectionsPaginateTypeDef = {  # (1)
    "InclusionFilters": ...,
}

parent.paginate(**kwargs)
  1. See ListProtectionsRequestListProtectionsPaginateTypeDef