Skip to content

Paginators#

Index > AgentsforBedrockRuntime > Paginators

Auto-generated documentation for AgentsforBedrockRuntime type annotations stubs module mypy-boto3-bedrock-agent-runtime.

GetAgentMemoryPaginator#

Type annotations and code completion for boto3.client("bedrock-agent-runtime").get_paginator("get_agent_memory"). boto3 documentation

# GetAgentMemoryPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import GetAgentMemoryPaginator

def get_get_agent_memory_paginator() -> GetAgentMemoryPaginator:
    return Session().client("bedrock-agent-runtime").get_paginator("get_agent_memory")
# GetAgentMemoryPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import GetAgentMemoryPaginator

session = Session()

client = Session().client("bedrock-agent-runtime")  # (1)
paginator: GetAgentMemoryPaginator = client.get_paginator("get_agent_memory")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockRuntimeClient
  2. paginator: GetAgentMemoryPaginator
  3. item: PageIterator[GetAgentMemoryResponseTypeDef]

paginate#

Type annotations and code completion for GetAgentMemoryPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    agentAliasId: str,
    agentId: str,
    memoryId: str,
    memoryType: MemoryTypeType,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[GetAgentMemoryResponseTypeDef]:  # (3)
    ...
  1. See MemoryTypeType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[GetAgentMemoryResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetAgentMemoryRequestPaginateTypeDef = {  # (1)
    "agentAliasId": ...,
    "agentId": ...,
    "memoryId": ...,
    "memoryType": ...,
}

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

ListInvocationStepsPaginator#

Type annotations and code completion for boto3.client("bedrock-agent-runtime").get_paginator("list_invocation_steps"). boto3 documentation

# ListInvocationStepsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import ListInvocationStepsPaginator

def get_list_invocation_steps_paginator() -> ListInvocationStepsPaginator:
    return Session().client("bedrock-agent-runtime").get_paginator("list_invocation_steps")
# ListInvocationStepsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import ListInvocationStepsPaginator

session = Session()

client = Session().client("bedrock-agent-runtime")  # (1)
paginator: ListInvocationStepsPaginator = client.get_paginator("list_invocation_steps")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockRuntimeClient
  2. paginator: ListInvocationStepsPaginator
  3. item: PageIterator[ListInvocationStepsResponseTypeDef]

paginate#

Type annotations and code completion for ListInvocationStepsPaginator.paginate method.

# paginate method definition

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

kwargs: ListInvocationStepsRequestPaginateTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

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

ListInvocationsPaginator#

Type annotations and code completion for boto3.client("bedrock-agent-runtime").get_paginator("list_invocations"). boto3 documentation

# ListInvocationsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import ListInvocationsPaginator

def get_list_invocations_paginator() -> ListInvocationsPaginator:
    return Session().client("bedrock-agent-runtime").get_paginator("list_invocations")
# ListInvocationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import ListInvocationsPaginator

session = Session()

client = Session().client("bedrock-agent-runtime")  # (1)
paginator: ListInvocationsPaginator = client.get_paginator("list_invocations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockRuntimeClient
  2. paginator: ListInvocationsPaginator
  3. item: PageIterator[ListInvocationsResponseTypeDef]

paginate#

Type annotations and code completion for ListInvocationsPaginator.paginate method.

# paginate method definition

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

kwargs: ListInvocationsRequestPaginateTypeDef = {  # (1)
    "sessionIdentifier": ...,
}

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

ListSessionsPaginator#

Type annotations and code completion for boto3.client("bedrock-agent-runtime").get_paginator("list_sessions"). boto3 documentation

# ListSessionsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import ListSessionsPaginator

def get_list_sessions_paginator() -> ListSessionsPaginator:
    return Session().client("bedrock-agent-runtime").get_paginator("list_sessions")
# ListSessionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import ListSessionsPaginator

session = Session()

client = Session().client("bedrock-agent-runtime")  # (1)
paginator: ListSessionsPaginator = client.get_paginator("list_sessions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockRuntimeClient
  2. paginator: ListSessionsPaginator
  3. item: PageIterator[ListSessionsResponseTypeDef]

paginate#

Type annotations and code completion for ListSessionsPaginator.paginate method.

# paginate method definition

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

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

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

RerankPaginator#

Type annotations and code completion for boto3.client("bedrock-agent-runtime").get_paginator("rerank"). boto3 documentation

# RerankPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import RerankPaginator

def get_rerank_paginator() -> RerankPaginator:
    return Session().client("bedrock-agent-runtime").get_paginator("rerank")
# RerankPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import RerankPaginator

session = Session()

client = Session().client("bedrock-agent-runtime")  # (1)
paginator: RerankPaginator = client.get_paginator("rerank")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockRuntimeClient
  2. paginator: RerankPaginator
  3. item: PageIterator[RerankResponseTypeDef]

paginate#

Type annotations and code completion for RerankPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    queries: Sequence[RerankQueryTypeDef],  # (1)
    rerankingConfiguration: RerankingConfigurationTypeDef,  # (2)
    sources: Sequence[RerankSourceTypeDef],  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> botocore.paginate.PageIterator[RerankResponseTypeDef]:  # (5)
    ...
  1. See Sequence[RerankQueryTypeDef]
  2. See RerankingConfigurationTypeDef
  3. See Sequence[RerankSourceTypeDef]
  4. See PaginatorConfigTypeDef
  5. See PageIterator[RerankResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: RerankRequestPaginateTypeDef = {  # (1)
    "queries": ...,
    "rerankingConfiguration": ...,
    "sources": ...,
}

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

RetrievePaginator#

Type annotations and code completion for boto3.client("bedrock-agent-runtime").get_paginator("retrieve"). boto3 documentation

# RetrievePaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import RetrievePaginator

def get_retrieve_paginator() -> RetrievePaginator:
    return Session().client("bedrock-agent-runtime").get_paginator("retrieve")
# RetrievePaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent_runtime.paginator import RetrievePaginator

session = Session()

client = Session().client("bedrock-agent-runtime")  # (1)
paginator: RetrievePaginator = client.get_paginator("retrieve")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockRuntimeClient
  2. paginator: RetrievePaginator
  3. item: PageIterator[RetrieveResponseTypeDef]

paginate#

Type annotations and code completion for RetrievePaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    knowledgeBaseId: str,
    retrievalQuery: KnowledgeBaseQueryTypeDef,  # (1)
    guardrailConfiguration: GuardrailConfigurationTypeDef = ...,  # (2)
    retrievalConfiguration: KnowledgeBaseRetrievalConfigurationPaginatorTypeDef = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> botocore.paginate.PageIterator[RetrieveResponseTypeDef]:  # (5)
    ...
  1. See KnowledgeBaseQueryTypeDef
  2. See GuardrailConfigurationTypeDef
  3. See KnowledgeBaseRetrievalConfigurationPaginatorTypeDef
  4. See PaginatorConfigTypeDef
  5. See PageIterator[RetrieveResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: RetrieveRequestPaginateTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "retrievalQuery": ...,
}

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