Skip to content

Paginators#

Index > AgentsforBedrock > Paginators

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

ListAgentActionGroupsPaginator#

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

# ListAgentActionGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentActionGroupsPaginator

def get_list_agent_action_groups_paginator() -> ListAgentActionGroupsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_agent_action_groups")
# ListAgentActionGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentActionGroupsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListAgentActionGroupsPaginator = client.get_paginator("list_agent_action_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListAgentActionGroupsPaginator
  3. item: ListAgentActionGroupsResponseTypeDef

paginate#

Type annotations and code completion for ListAgentActionGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: ListAgentActionGroupsRequestPaginateTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
}

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

ListAgentAliasesPaginator#

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

# ListAgentAliasesPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentAliasesPaginator

def get_list_agent_aliases_paginator() -> ListAgentAliasesPaginator:
    return Session().client("bedrock-agent").get_paginator("list_agent_aliases")
# ListAgentAliasesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentAliasesPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListAgentAliasesPaginator = client.get_paginator("list_agent_aliases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListAgentAliasesPaginator
  3. item: ListAgentAliasesResponseTypeDef

paginate#

Type annotations and code completion for ListAgentAliasesPaginator.paginate method.

# paginate method definition

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

kwargs: ListAgentAliasesRequestPaginateTypeDef = {  # (1)
    "agentId": ...,
}

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

ListAgentCollaboratorsPaginator#

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

# ListAgentCollaboratorsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentCollaboratorsPaginator

def get_list_agent_collaborators_paginator() -> ListAgentCollaboratorsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_agent_collaborators")
# ListAgentCollaboratorsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentCollaboratorsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListAgentCollaboratorsPaginator = client.get_paginator("list_agent_collaborators")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListAgentCollaboratorsPaginator
  3. item: ListAgentCollaboratorsResponseTypeDef

paginate#

Type annotations and code completion for ListAgentCollaboratorsPaginator.paginate method.

# paginate method definition

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

kwargs: ListAgentCollaboratorsRequestPaginateTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
}

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

ListAgentKnowledgeBasesPaginator#

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

# ListAgentKnowledgeBasesPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentKnowledgeBasesPaginator

def get_list_agent_knowledge_bases_paginator() -> ListAgentKnowledgeBasesPaginator:
    return Session().client("bedrock-agent").get_paginator("list_agent_knowledge_bases")
# ListAgentKnowledgeBasesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentKnowledgeBasesPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListAgentKnowledgeBasesPaginator = client.get_paginator("list_agent_knowledge_bases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListAgentKnowledgeBasesPaginator
  3. item: ListAgentKnowledgeBasesResponseTypeDef

paginate#

Type annotations and code completion for ListAgentKnowledgeBasesPaginator.paginate method.

# paginate method definition

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

kwargs: ListAgentKnowledgeBasesRequestPaginateTypeDef = {  # (1)
    "agentId": ...,
    "agentVersion": ...,
}

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

ListAgentVersionsPaginator#

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

# ListAgentVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentVersionsPaginator

def get_list_agent_versions_paginator() -> ListAgentVersionsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_agent_versions")
# ListAgentVersionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentVersionsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListAgentVersionsPaginator = client.get_paginator("list_agent_versions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListAgentVersionsPaginator
  3. item: ListAgentVersionsResponseTypeDef

paginate#

Type annotations and code completion for ListAgentVersionsPaginator.paginate method.

# paginate method definition

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

kwargs: ListAgentVersionsRequestPaginateTypeDef = {  # (1)
    "agentId": ...,
}

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

ListAgentsPaginator#

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

# ListAgentsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentsPaginator

def get_list_agents_paginator() -> ListAgentsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_agents")
# ListAgentsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListAgentsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListAgentsPaginator = client.get_paginator("list_agents")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListAgentsPaginator
  3. item: ListAgentsResponseTypeDef

paginate#

Type annotations and code completion for ListAgentsPaginator.paginate method.

# paginate method definition

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

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

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

ListDataSourcesPaginator#

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

# ListDataSourcesPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListDataSourcesPaginator

def get_list_data_sources_paginator() -> ListDataSourcesPaginator:
    return Session().client("bedrock-agent").get_paginator("list_data_sources")
# ListDataSourcesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListDataSourcesPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListDataSourcesPaginator = client.get_paginator("list_data_sources")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListDataSourcesPaginator
  3. item: ListDataSourcesResponseTypeDef

paginate#

Type annotations and code completion for ListDataSourcesPaginator.paginate method.

# paginate method definition

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

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

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

ListFlowAliasesPaginator#

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

# ListFlowAliasesPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListFlowAliasesPaginator

def get_list_flow_aliases_paginator() -> ListFlowAliasesPaginator:
    return Session().client("bedrock-agent").get_paginator("list_flow_aliases")
# ListFlowAliasesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListFlowAliasesPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListFlowAliasesPaginator = client.get_paginator("list_flow_aliases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListFlowAliasesPaginator
  3. item: ListFlowAliasesResponseTypeDef

paginate#

Type annotations and code completion for ListFlowAliasesPaginator.paginate method.

# paginate method definition

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

kwargs: ListFlowAliasesRequestPaginateTypeDef = {  # (1)
    "flowIdentifier": ...,
}

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

ListFlowVersionsPaginator#

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

# ListFlowVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListFlowVersionsPaginator

def get_list_flow_versions_paginator() -> ListFlowVersionsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_flow_versions")
# ListFlowVersionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListFlowVersionsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListFlowVersionsPaginator = client.get_paginator("list_flow_versions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListFlowVersionsPaginator
  3. item: ListFlowVersionsResponseTypeDef

paginate#

Type annotations and code completion for ListFlowVersionsPaginator.paginate method.

# paginate method definition

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

kwargs: ListFlowVersionsRequestPaginateTypeDef = {  # (1)
    "flowIdentifier": ...,
}

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

ListFlowsPaginator#

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

# ListFlowsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListFlowsPaginator

def get_list_flows_paginator() -> ListFlowsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_flows")
# ListFlowsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListFlowsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListFlowsPaginator = client.get_paginator("list_flows")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListFlowsPaginator
  3. item: ListFlowsResponseTypeDef

paginate#

Type annotations and code completion for ListFlowsPaginator.paginate method.

# paginate method definition

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

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

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

ListIngestionJobsPaginator#

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

# ListIngestionJobsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListIngestionJobsPaginator

def get_list_ingestion_jobs_paginator() -> ListIngestionJobsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_ingestion_jobs")
# ListIngestionJobsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListIngestionJobsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListIngestionJobsPaginator = client.get_paginator("list_ingestion_jobs")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListIngestionJobsPaginator
  3. item: ListIngestionJobsResponseTypeDef

paginate#

Type annotations and code completion for ListIngestionJobsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    dataSourceId: str,
    knowledgeBaseId: str,
    filters: Sequence[IngestionJobFilterTypeDef] = ...,  # (1)
    sortBy: IngestionJobSortByTypeDef = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> PageIterator[ListIngestionJobsResponseTypeDef]:  # (4)
    ...
  1. See IngestionJobFilterTypeDef
  2. See IngestionJobSortByTypeDef
  3. See PaginatorConfigTypeDef
  4. See ListIngestionJobsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListIngestionJobsRequestPaginateTypeDef = {  # (1)
    "dataSourceId": ...,
    "knowledgeBaseId": ...,
}

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

ListKnowledgeBaseDocumentsPaginator#

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

# ListKnowledgeBaseDocumentsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListKnowledgeBaseDocumentsPaginator

def get_list_knowledge_base_documents_paginator() -> ListKnowledgeBaseDocumentsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_knowledge_base_documents")
# ListKnowledgeBaseDocumentsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListKnowledgeBaseDocumentsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListKnowledgeBaseDocumentsPaginator = client.get_paginator("list_knowledge_base_documents")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListKnowledgeBaseDocumentsPaginator
  3. item: ListKnowledgeBaseDocumentsResponseTypeDef

paginate#

Type annotations and code completion for ListKnowledgeBaseDocumentsPaginator.paginate method.

# paginate method definition

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

kwargs: ListKnowledgeBaseDocumentsRequestPaginateTypeDef = {  # (1)
    "dataSourceId": ...,
    "knowledgeBaseId": ...,
}

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

ListKnowledgeBasesPaginator#

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

# ListKnowledgeBasesPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListKnowledgeBasesPaginator

def get_list_knowledge_bases_paginator() -> ListKnowledgeBasesPaginator:
    return Session().client("bedrock-agent").get_paginator("list_knowledge_bases")
# ListKnowledgeBasesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListKnowledgeBasesPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListKnowledgeBasesPaginator = client.get_paginator("list_knowledge_bases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListKnowledgeBasesPaginator
  3. item: ListKnowledgeBasesResponseTypeDef

paginate#

Type annotations and code completion for ListKnowledgeBasesPaginator.paginate method.

# paginate method definition

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

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

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

ListPromptsPaginator#

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

# ListPromptsPaginator usage example

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListPromptsPaginator

def get_list_prompts_paginator() -> ListPromptsPaginator:
    return Session().client("bedrock-agent").get_paginator("list_prompts")
# ListPromptsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_bedrock_agent.paginator import ListPromptsPaginator

session = Session()

client = Session().client("bedrock-agent")  # (1)
paginator: ListPromptsPaginator = client.get_paginator("list_prompts")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: AgentsforBedrockClient
  2. paginator: ListPromptsPaginator
  3. item: ListPromptsResponseTypeDef

paginate#

Type annotations and code completion for ListPromptsPaginator.paginate method.

# paginate method definition

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

kwargs: ListPromptsRequestPaginateTypeDef = {  # (1)
    "promptIdentifier": ...,
}

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