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: 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)
) -> PageIterator[GetAgentMemoryResponseTypeDef]:  # (3)
    ...

1. See MemoryTypeType
2. See PaginatorConfigTypeDef
3. See GetAgentMemoryResponseTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See GetAgentMemoryRequestPaginateTypeDef

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: 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)
) -> PageIterator[RerankResponseTypeDef]:  # (5)
    ...

1. See RerankQueryTypeDef
2. See RerankingConfigurationTypeDef
3. See RerankSourceTypeDef
4. See PaginatorConfigTypeDef
5. See 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: 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)
) -> PageIterator[RetrieveResponseTypeDef]:  # (5)
    ...

1. See KnowledgeBaseQueryTypeDef
2. See GuardrailConfigurationTypeDef
3. See KnowledgeBaseRetrievalConfigurationPaginatorTypeDef
4. See PaginatorConfigTypeDef
5. See RetrieveResponseTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See RetrieveRequestPaginateTypeDef