Paginators#
Index > AgentsforBedrockRuntime > Paginators
Auto-generated documentation for AgentsforBedrockRuntime type annotations stubs module mypy-boto3-bedrock-agent-runtime.
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)
- client: AgentsforBedrockRuntimeClient
- paginator: RetrievePaginator
- item: RetrieveResponseTypeDef
paginate#
Type annotations and code completion for RetrievePaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
knowledgeBaseId: str,
retrievalQuery: KnowledgeBaseQueryTypeDef, # (1)
retrievalConfiguration: KnowledgeBaseRetrievalConfigurationTypeDef = ..., # (2)
PaginationConfig: PaginatorConfigTypeDef = ..., # (3)
) -> _PageIterator[RetrieveResponseTypeDef]: # (4)
...
- See KnowledgeBaseQueryTypeDef
- See KnowledgeBaseRetrievalConfigurationTypeDef
- See PaginatorConfigTypeDef
- See RetrieveResponseTypeDef
# paginate method usage example with argument unpacking
kwargs: RetrieveRequestRetrievePaginateTypeDef = { # (1)
"knowledgeBaseId": ...,
"retrievalQuery": ...,
}
parent.paginate(**kwargs)