Skip to content

Paginators#

Index > CodeCommit > Paginators

Auto-generated documentation for CodeCommit type annotations stubs module types-boto3-codecommit.

DescribePullRequestEventsPaginator#

Type annotations and code completion for boto3.client("codecommit").get_paginator("describe_pull_request_events"). boto3 documentation

# DescribePullRequestEventsPaginator usage example

from boto3.session import Session

from types_boto3_codecommit.paginator import DescribePullRequestEventsPaginator

def get_describe_pull_request_events_paginator() -> DescribePullRequestEventsPaginator:
    return Session().client("codecommit").get_paginator("describe_pull_request_events")
# DescribePullRequestEventsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_codecommit.paginator import DescribePullRequestEventsPaginator

session = Session()

client = Session().client("codecommit")  # (1)
paginator: DescribePullRequestEventsPaginator = client.get_paginator("describe_pull_request_events")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: DescribePullRequestEventsPaginator
  3. item: DescribePullRequestEventsOutputTypeDef

paginate#

Type annotations and code completion for DescribePullRequestEventsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    pullRequestId: str,
    pullRequestEventType: PullRequestEventTypeType = ...,  # (1)
    actorArn: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[DescribePullRequestEventsOutputTypeDef]:  # (3)
    ...
  1. See PullRequestEventTypeType
  2. See PaginatorConfigTypeDef
  3. See DescribePullRequestEventsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribePullRequestEventsInputPaginateTypeDef = {  # (1)
    "pullRequestId": ...,
}

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

GetCommentsForComparedCommitPaginator#

Type annotations and code completion for boto3.client("codecommit").get_paginator("get_comments_for_compared_commit"). boto3 documentation

# GetCommentsForComparedCommitPaginator usage example

from boto3.session import Session

from types_boto3_codecommit.paginator import GetCommentsForComparedCommitPaginator

def get_get_comments_for_compared_commit_paginator() -> GetCommentsForComparedCommitPaginator:
    return Session().client("codecommit").get_paginator("get_comments_for_compared_commit")
# GetCommentsForComparedCommitPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_codecommit.paginator import GetCommentsForComparedCommitPaginator

session = Session()

client = Session().client("codecommit")  # (1)
paginator: GetCommentsForComparedCommitPaginator = client.get_paginator("get_comments_for_compared_commit")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: GetCommentsForComparedCommitPaginator
  3. item: GetCommentsForComparedCommitOutputTypeDef

paginate#

Type annotations and code completion for GetCommentsForComparedCommitPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    repositoryName: str,
    afterCommitId: str,
    beforeCommitId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[GetCommentsForComparedCommitOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See GetCommentsForComparedCommitOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: GetCommentsForComparedCommitInputPaginateTypeDef = {  # (1)
    "repositoryName": ...,
    "afterCommitId": ...,
}

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

GetCommentsForPullRequestPaginator#

Type annotations and code completion for boto3.client("codecommit").get_paginator("get_comments_for_pull_request"). boto3 documentation

# GetCommentsForPullRequestPaginator usage example

from boto3.session import Session

from types_boto3_codecommit.paginator import GetCommentsForPullRequestPaginator

def get_get_comments_for_pull_request_paginator() -> GetCommentsForPullRequestPaginator:
    return Session().client("codecommit").get_paginator("get_comments_for_pull_request")
# GetCommentsForPullRequestPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_codecommit.paginator import GetCommentsForPullRequestPaginator

session = Session()

client = Session().client("codecommit")  # (1)
paginator: GetCommentsForPullRequestPaginator = client.get_paginator("get_comments_for_pull_request")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: GetCommentsForPullRequestPaginator
  3. item: GetCommentsForPullRequestOutputTypeDef

paginate#

Type annotations and code completion for GetCommentsForPullRequestPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    pullRequestId: str,
    repositoryName: str = ...,
    beforeCommitId: str = ...,
    afterCommitId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[GetCommentsForPullRequestOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See GetCommentsForPullRequestOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: GetCommentsForPullRequestInputPaginateTypeDef = {  # (1)
    "pullRequestId": ...,
}

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

GetDifferencesPaginator#

Type annotations and code completion for boto3.client("codecommit").get_paginator("get_differences"). boto3 documentation

# GetDifferencesPaginator usage example

from boto3.session import Session

from types_boto3_codecommit.paginator import GetDifferencesPaginator

def get_get_differences_paginator() -> GetDifferencesPaginator:
    return Session().client("codecommit").get_paginator("get_differences")
# GetDifferencesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_codecommit.paginator import GetDifferencesPaginator

session = Session()

client = Session().client("codecommit")  # (1)
paginator: GetDifferencesPaginator = client.get_paginator("get_differences")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: GetDifferencesPaginator
  3. item: GetDifferencesOutputTypeDef

paginate#

Type annotations and code completion for GetDifferencesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    repositoryName: str,
    afterCommitSpecifier: str,
    beforeCommitSpecifier: str = ...,
    beforePath: str = ...,
    afterPath: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[GetDifferencesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See GetDifferencesOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: GetDifferencesInputPaginateTypeDef = {  # (1)
    "repositoryName": ...,
    "afterCommitSpecifier": ...,
}

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

ListBranchesPaginator#

Type annotations and code completion for boto3.client("codecommit").get_paginator("list_branches"). boto3 documentation

# ListBranchesPaginator usage example

from boto3.session import Session

from types_boto3_codecommit.paginator import ListBranchesPaginator

def get_list_branches_paginator() -> ListBranchesPaginator:
    return Session().client("codecommit").get_paginator("list_branches")
# ListBranchesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_codecommit.paginator import ListBranchesPaginator

session = Session()

client = Session().client("codecommit")  # (1)
paginator: ListBranchesPaginator = client.get_paginator("list_branches")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: ListBranchesPaginator
  3. item: ListBranchesOutputTypeDef

paginate#

Type annotations and code completion for ListBranchesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    repositoryName: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListBranchesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListBranchesOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListBranchesInputPaginateTypeDef = {  # (1)
    "repositoryName": ...,
}

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

ListPullRequestsPaginator#

Type annotations and code completion for boto3.client("codecommit").get_paginator("list_pull_requests"). boto3 documentation

# ListPullRequestsPaginator usage example

from boto3.session import Session

from types_boto3_codecommit.paginator import ListPullRequestsPaginator

def get_list_pull_requests_paginator() -> ListPullRequestsPaginator:
    return Session().client("codecommit").get_paginator("list_pull_requests")
# ListPullRequestsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_codecommit.paginator import ListPullRequestsPaginator

session = Session()

client = Session().client("codecommit")  # (1)
paginator: ListPullRequestsPaginator = client.get_paginator("list_pull_requests")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: ListPullRequestsPaginator
  3. item: ListPullRequestsOutputTypeDef

paginate#

Type annotations and code completion for ListPullRequestsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    repositoryName: str,
    authorArn: str = ...,
    pullRequestStatus: PullRequestStatusEnumType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[ListPullRequestsOutputTypeDef]:  # (3)
    ...
  1. See PullRequestStatusEnumType
  2. See PaginatorConfigTypeDef
  3. See ListPullRequestsOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListPullRequestsInputPaginateTypeDef = {  # (1)
    "repositoryName": ...,
}

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

ListRepositoriesPaginator#

Type annotations and code completion for boto3.client("codecommit").get_paginator("list_repositories"). boto3 documentation

# ListRepositoriesPaginator usage example

from boto3.session import Session

from types_boto3_codecommit.paginator import ListRepositoriesPaginator

def get_list_repositories_paginator() -> ListRepositoriesPaginator:
    return Session().client("codecommit").get_paginator("list_repositories")
# ListRepositoriesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_codecommit.paginator import ListRepositoriesPaginator

session = Session()

client = Session().client("codecommit")  # (1)
paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: ListRepositoriesPaginator
  3. item: ListRepositoriesOutputTypeDef

paginate#

Type annotations and code completion for ListRepositoriesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    sortBy: SortByEnumType = ...,  # (1)
    order: OrderEnumType = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> PageIterator[ListRepositoriesOutputTypeDef]:  # (4)
    ...
  1. See SortByEnumType
  2. See OrderEnumType
  3. See PaginatorConfigTypeDef
  4. See ListRepositoriesOutputTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListRepositoriesInputPaginateTypeDef = {  # (1)
    "sortBy": ...,
}

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