Skip to content

Paginators#

Index > XRay > Paginators

Auto-generated documentation for XRay type annotations stubs module mypy-boto3-xray.

BatchGetTracesPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("batch_get_traces"). boto3 documentation

# BatchGetTracesPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import BatchGetTracesPaginator

def get_batch_get_traces_paginator() -> BatchGetTracesPaginator:
    return Session().client("xray").get_paginator("batch_get_traces")
# BatchGetTracesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import BatchGetTracesPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: BatchGetTracesPaginator = client.get_paginator("batch_get_traces")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: BatchGetTracesPaginator
  3. item: BatchGetTracesResultTypeDef

paginate#

Type annotations and code completion for BatchGetTracesPaginator.paginate method.

# paginate method definition

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

kwargs: BatchGetTracesRequestPaginateTypeDef = {  # (1)
    "TraceIds": ...,
}

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

GetGroupsPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("get_groups"). boto3 documentation

# GetGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import GetGroupsPaginator

def get_get_groups_paginator() -> GetGroupsPaginator:
    return Session().client("xray").get_paginator("get_groups")
# GetGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import GetGroupsPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: GetGroupsPaginator = client.get_paginator("get_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: GetGroupsPaginator
  3. item: GetGroupsResultTypeDef

paginate#

Type annotations and code completion for GetGroupsPaginator.paginate method.

# paginate method definition

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

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

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

GetSamplingRulesPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("get_sampling_rules"). boto3 documentation

# GetSamplingRulesPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import GetSamplingRulesPaginator

def get_get_sampling_rules_paginator() -> GetSamplingRulesPaginator:
    return Session().client("xray").get_paginator("get_sampling_rules")
# GetSamplingRulesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import GetSamplingRulesPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: GetSamplingRulesPaginator = client.get_paginator("get_sampling_rules")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: GetSamplingRulesPaginator
  3. item: GetSamplingRulesResultTypeDef

paginate#

Type annotations and code completion for GetSamplingRulesPaginator.paginate method.

# paginate method definition

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

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

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

GetSamplingStatisticSummariesPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("get_sampling_statistic_summaries"). boto3 documentation

# GetSamplingStatisticSummariesPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import GetSamplingStatisticSummariesPaginator

def get_get_sampling_statistic_summaries_paginator() -> GetSamplingStatisticSummariesPaginator:
    return Session().client("xray").get_paginator("get_sampling_statistic_summaries")
# GetSamplingStatisticSummariesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import GetSamplingStatisticSummariesPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: GetSamplingStatisticSummariesPaginator = client.get_paginator("get_sampling_statistic_summaries")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: GetSamplingStatisticSummariesPaginator
  3. item: GetSamplingStatisticSummariesResultTypeDef

paginate#

Type annotations and code completion for GetSamplingStatisticSummariesPaginator.paginate method.

# paginate method definition

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

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

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

GetServiceGraphPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("get_service_graph"). boto3 documentation

# GetServiceGraphPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import GetServiceGraphPaginator

def get_get_service_graph_paginator() -> GetServiceGraphPaginator:
    return Session().client("xray").get_paginator("get_service_graph")
# GetServiceGraphPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import GetServiceGraphPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: GetServiceGraphPaginator = client.get_paginator("get_service_graph")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: GetServiceGraphPaginator
  3. item: GetServiceGraphResultTypeDef

paginate#

Type annotations and code completion for GetServiceGraphPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    GroupName: str = ...,
    GroupARN: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[GetServiceGraphResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See GetServiceGraphResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: GetServiceGraphRequestPaginateTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
}

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

GetTimeSeriesServiceStatisticsPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("get_time_series_service_statistics"). boto3 documentation

# GetTimeSeriesServiceStatisticsPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import GetTimeSeriesServiceStatisticsPaginator

def get_get_time_series_service_statistics_paginator() -> GetTimeSeriesServiceStatisticsPaginator:
    return Session().client("xray").get_paginator("get_time_series_service_statistics")
# GetTimeSeriesServiceStatisticsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import GetTimeSeriesServiceStatisticsPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: GetTimeSeriesServiceStatisticsPaginator = client.get_paginator("get_time_series_service_statistics")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: GetTimeSeriesServiceStatisticsPaginator
  3. item: GetTimeSeriesServiceStatisticsResultTypeDef

paginate#

Type annotations and code completion for GetTimeSeriesServiceStatisticsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    GroupName: str = ...,
    GroupARN: str = ...,
    EntitySelectorExpression: str = ...,
    Period: int = ...,
    ForecastStatistics: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[GetTimeSeriesServiceStatisticsResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See GetTimeSeriesServiceStatisticsResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: GetTimeSeriesServiceStatisticsRequestPaginateTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
}

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

GetTraceGraphPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("get_trace_graph"). boto3 documentation

# GetTraceGraphPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import GetTraceGraphPaginator

def get_get_trace_graph_paginator() -> GetTraceGraphPaginator:
    return Session().client("xray").get_paginator("get_trace_graph")
# GetTraceGraphPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import GetTraceGraphPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: GetTraceGraphPaginator = client.get_paginator("get_trace_graph")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: GetTraceGraphPaginator
  3. item: GetTraceGraphResultTypeDef

paginate#

Type annotations and code completion for GetTraceGraphPaginator.paginate method.

# paginate method definition

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

kwargs: GetTraceGraphRequestPaginateTypeDef = {  # (1)
    "TraceIds": ...,
}

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

GetTraceSummariesPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("get_trace_summaries"). boto3 documentation

# GetTraceSummariesPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import GetTraceSummariesPaginator

def get_get_trace_summaries_paginator() -> GetTraceSummariesPaginator:
    return Session().client("xray").get_paginator("get_trace_summaries")
# GetTraceSummariesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import GetTraceSummariesPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: GetTraceSummariesPaginator = client.get_paginator("get_trace_summaries")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: GetTraceSummariesPaginator
  3. item: GetTraceSummariesResultTypeDef

paginate#

Type annotations and code completion for GetTraceSummariesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    TimeRangeType: TimeRangeTypeType = ...,  # (1)
    Sampling: bool = ...,
    SamplingStrategy: SamplingStrategyTypeDef = ...,  # (2)
    FilterExpression: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> PageIterator[GetTraceSummariesResultTypeDef]:  # (4)
    ...
  1. See TimeRangeTypeType
  2. See SamplingStrategyTypeDef
  3. See PaginatorConfigTypeDef
  4. See GetTraceSummariesResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: GetTraceSummariesRequestPaginateTypeDef = {  # (1)
    "StartTime": ...,
    "EndTime": ...,
}

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

ListResourcePoliciesPaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("list_resource_policies"). boto3 documentation

# ListResourcePoliciesPaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import ListResourcePoliciesPaginator

def get_list_resource_policies_paginator() -> ListResourcePoliciesPaginator:
    return Session().client("xray").get_paginator("list_resource_policies")
# ListResourcePoliciesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import ListResourcePoliciesPaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: ListResourcePoliciesPaginator = client.get_paginator("list_resource_policies")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: ListResourcePoliciesPaginator
  3. item: ListResourcePoliciesResultTypeDef

paginate#

Type annotations and code completion for ListResourcePoliciesPaginator.paginate method.

# paginate method definition

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

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

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

ListTagsForResourcePaginator#

Type annotations and code completion for boto3.client("xray").get_paginator("list_tags_for_resource"). boto3 documentation

# ListTagsForResourcePaginator usage example

from boto3.session import Session

from mypy_boto3_xray.paginator import ListTagsForResourcePaginator

def get_list_tags_for_resource_paginator() -> ListTagsForResourcePaginator:
    return Session().client("xray").get_paginator("list_tags_for_resource")
# ListTagsForResourcePaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_xray.paginator import ListTagsForResourcePaginator

session = Session()

client = Session().client("xray")  # (1)
paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: XRayClient
  2. paginator: ListTagsForResourcePaginator
  3. item: ListTagsForResourceResponseTypeDef

paginate#

Type annotations and code completion for ListTagsForResourcePaginator.paginate method.

# paginate method definition

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

kwargs: ListTagsForResourceRequestPaginateTypeDef = {  # (1)
    "ResourceARN": ...,
}

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