Skip to content

Type definitions#

Index > AgentsforBedrock > Type definitions

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

S3IdentifierTypeDef#

# S3IdentifierTypeDef definition

class S3IdentifierTypeDef(TypedDict):
    s3BucketName: NotRequired[str],
    s3ObjectKey: NotRequired[str],

ActionGroupExecutorTypeDef#

# ActionGroupExecutorTypeDef definition

class ActionGroupExecutorTypeDef(TypedDict):
    lambda: NotRequired[str],

ActionGroupSummaryTypeDef#

# ActionGroupSummaryTypeDef definition

class ActionGroupSummaryTypeDef(TypedDict):
    actionGroupId: str,
    actionGroupName: str,
    actionGroupState: ActionGroupStateType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
  1. See ActionGroupStateType

AgentAliasRoutingConfigurationListItemTypeDef#

# AgentAliasRoutingConfigurationListItemTypeDef definition

class AgentAliasRoutingConfigurationListItemTypeDef(TypedDict):
    agentVersion: str,

AgentKnowledgeBaseSummaryTypeDef#

# AgentKnowledgeBaseSummaryTypeDef definition

class AgentKnowledgeBaseSummaryTypeDef(TypedDict):
    knowledgeBaseId: str,
    knowledgeBaseState: KnowledgeBaseStateType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
  1. See KnowledgeBaseStateType

AgentKnowledgeBaseTypeDef#

# AgentKnowledgeBaseTypeDef definition

class AgentKnowledgeBaseTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,
    description: str,
    createdAt: datetime,
    updatedAt: datetime,
    knowledgeBaseState: KnowledgeBaseStateType,  # (1)
  1. See KnowledgeBaseStateType

AgentSummaryTypeDef#

# AgentSummaryTypeDef definition

class AgentSummaryTypeDef(TypedDict):
    agentId: str,
    agentName: str,
    agentStatus: AgentStatusType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
    latestAgentVersion: NotRequired[str],
  1. See AgentStatusType

AgentVersionSummaryTypeDef#

# AgentVersionSummaryTypeDef definition

class AgentVersionSummaryTypeDef(TypedDict):
    agentName: str,
    agentStatus: AgentStatusType,  # (1)
    agentVersion: str,
    createdAt: datetime,
    updatedAt: datetime,
    description: NotRequired[str],
  1. See AgentStatusType

AssociateAgentKnowledgeBaseRequestRequestTypeDef#

# AssociateAgentKnowledgeBaseRequestRequestTypeDef definition

class AssociateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,
    description: str,
    knowledgeBaseState: NotRequired[KnowledgeBaseStateType],  # (1)
  1. See KnowledgeBaseStateType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

FixedSizeChunkingConfigurationTypeDef#

# FixedSizeChunkingConfigurationTypeDef definition

class FixedSizeChunkingConfigurationTypeDef(TypedDict):
    maxTokens: int,
    overlapPercentage: int,

ServerSideEncryptionConfigurationTypeDef#

# ServerSideEncryptionConfigurationTypeDef definition

class ServerSideEncryptionConfigurationTypeDef(TypedDict):
    kmsKeyArn: NotRequired[str],

S3DataSourceConfigurationTypeDef#

# S3DataSourceConfigurationTypeDef definition

class S3DataSourceConfigurationTypeDef(TypedDict):
    bucketArn: str,
    inclusionPrefixes: NotRequired[Sequence[str]],

DataSourceSummaryTypeDef#

# DataSourceSummaryTypeDef definition

class DataSourceSummaryTypeDef(TypedDict):
    knowledgeBaseId: str,
    dataSourceId: str,
    name: str,
    status: DataSourceStatusType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
  1. See DataSourceStatusType

DeleteAgentActionGroupRequestRequestTypeDef#

# DeleteAgentActionGroupRequestRequestTypeDef definition

class DeleteAgentActionGroupRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    actionGroupId: str,
    skipResourceInUseCheck: NotRequired[bool],

DeleteAgentAliasRequestRequestTypeDef#

# DeleteAgentAliasRequestRequestTypeDef definition

class DeleteAgentAliasRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentAliasId: str,

DeleteAgentRequestRequestTypeDef#

# DeleteAgentRequestRequestTypeDef definition

class DeleteAgentRequestRequestTypeDef(TypedDict):
    agentId: str,
    skipResourceInUseCheck: NotRequired[bool],

DeleteAgentVersionRequestRequestTypeDef#

# DeleteAgentVersionRequestRequestTypeDef definition

class DeleteAgentVersionRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    skipResourceInUseCheck: NotRequired[bool],

DeleteDataSourceRequestRequestTypeDef#

# DeleteDataSourceRequestRequestTypeDef definition

class DeleteDataSourceRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    dataSourceId: str,

DeleteKnowledgeBaseRequestRequestTypeDef#

# DeleteKnowledgeBaseRequestRequestTypeDef definition

class DeleteKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

DisassociateAgentKnowledgeBaseRequestRequestTypeDef#

# DisassociateAgentKnowledgeBaseRequestRequestTypeDef definition

class DisassociateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,

GetAgentActionGroupRequestRequestTypeDef#

# GetAgentActionGroupRequestRequestTypeDef definition

class GetAgentActionGroupRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    actionGroupId: str,

GetAgentAliasRequestRequestTypeDef#

# GetAgentAliasRequestRequestTypeDef definition

class GetAgentAliasRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentAliasId: str,

GetAgentKnowledgeBaseRequestRequestTypeDef#

# GetAgentKnowledgeBaseRequestRequestTypeDef definition

class GetAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,

GetAgentRequestRequestTypeDef#

# GetAgentRequestRequestTypeDef definition

class GetAgentRequestRequestTypeDef(TypedDict):
    agentId: str,

GetAgentVersionRequestRequestTypeDef#

# GetAgentVersionRequestRequestTypeDef definition

class GetAgentVersionRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,

GetDataSourceRequestRequestTypeDef#

# GetDataSourceRequestRequestTypeDef definition

class GetDataSourceRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    dataSourceId: str,

GetIngestionJobRequestRequestTypeDef#

# GetIngestionJobRequestRequestTypeDef definition

class GetIngestionJobRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    dataSourceId: str,
    ingestionJobId: str,

GetKnowledgeBaseRequestRequestTypeDef#

# GetKnowledgeBaseRequestRequestTypeDef definition

class GetKnowledgeBaseRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,

InferenceConfigurationTypeDef#

# InferenceConfigurationTypeDef definition

class InferenceConfigurationTypeDef(TypedDict):
    temperature: NotRequired[float],
    topP: NotRequired[float],
    topK: NotRequired[int],
    maximumLength: NotRequired[int],
    stopSequences: NotRequired[Sequence[str]],

IngestionJobFilterTypeDef#

# IngestionJobFilterTypeDef definition

class IngestionJobFilterTypeDef(TypedDict):
    attribute: IngestionJobFilterAttributeType,  # (1)
    operator: IngestionJobFilterOperatorType,  # (2)
    values: Sequence[str],
  1. See IngestionJobFilterAttributeType
  2. See IngestionJobFilterOperatorType

IngestionJobSortByTypeDef#

# IngestionJobSortByTypeDef definition

class IngestionJobSortByTypeDef(TypedDict):
    attribute: IngestionJobSortByAttributeType,  # (1)
    order: SortOrderType,  # (2)
  1. See IngestionJobSortByAttributeType
  2. See SortOrderType

IngestionJobStatisticsTypeDef#

# IngestionJobStatisticsTypeDef definition

class IngestionJobStatisticsTypeDef(TypedDict):
    numberOfDocumentsScanned: NotRequired[int],
    numberOfNewDocumentsIndexed: NotRequired[int],
    numberOfModifiedDocumentsIndexed: NotRequired[int],
    numberOfDocumentsDeleted: NotRequired[int],
    numberOfDocumentsFailed: NotRequired[int],

VectorKnowledgeBaseConfigurationTypeDef#

# VectorKnowledgeBaseConfigurationTypeDef definition

class VectorKnowledgeBaseConfigurationTypeDef(TypedDict):
    embeddingModelArn: str,

KnowledgeBaseSummaryTypeDef#

# KnowledgeBaseSummaryTypeDef definition

class KnowledgeBaseSummaryTypeDef(TypedDict):
    knowledgeBaseId: str,
    name: str,
    status: KnowledgeBaseStatusType,  # (1)
    updatedAt: datetime,
    description: NotRequired[str],
  1. See KnowledgeBaseStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAgentActionGroupsRequestRequestTypeDef#

# ListAgentActionGroupsRequestRequestTypeDef definition

class ListAgentActionGroupsRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAgentAliasesRequestRequestTypeDef#

# ListAgentAliasesRequestRequestTypeDef definition

class ListAgentAliasesRequestRequestTypeDef(TypedDict):
    agentId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAgentKnowledgeBasesRequestRequestTypeDef#

# ListAgentKnowledgeBasesRequestRequestTypeDef definition

class ListAgentKnowledgeBasesRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAgentVersionsRequestRequestTypeDef#

# ListAgentVersionsRequestRequestTypeDef definition

class ListAgentVersionsRequestRequestTypeDef(TypedDict):
    agentId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAgentsRequestRequestTypeDef#

# ListAgentsRequestRequestTypeDef definition

class ListAgentsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListDataSourcesRequestRequestTypeDef#

# ListDataSourcesRequestRequestTypeDef definition

class ListDataSourcesRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListKnowledgeBasesRequestRequestTypeDef#

# ListKnowledgeBasesRequestRequestTypeDef definition

class ListKnowledgeBasesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

OpenSearchServerlessFieldMappingTypeDef#

# OpenSearchServerlessFieldMappingTypeDef definition

class OpenSearchServerlessFieldMappingTypeDef(TypedDict):
    vectorField: str,
    textField: str,
    metadataField: str,

PineconeFieldMappingTypeDef#

# PineconeFieldMappingTypeDef definition

class PineconeFieldMappingTypeDef(TypedDict):
    textField: str,
    metadataField: str,

PrepareAgentRequestRequestTypeDef#

# PrepareAgentRequestRequestTypeDef definition

class PrepareAgentRequestRequestTypeDef(TypedDict):
    agentId: str,

RdsFieldMappingTypeDef#

# RdsFieldMappingTypeDef definition

class RdsFieldMappingTypeDef(TypedDict):
    primaryKeyField: str,
    vectorField: str,
    textField: str,
    metadataField: str,

RedisEnterpriseCloudFieldMappingTypeDef#

# RedisEnterpriseCloudFieldMappingTypeDef definition

class RedisEnterpriseCloudFieldMappingTypeDef(TypedDict):
    vectorField: str,
    textField: str,
    metadataField: str,

StartIngestionJobRequestRequestTypeDef#

# StartIngestionJobRequestRequestTypeDef definition

class StartIngestionJobRequestRequestTypeDef(TypedDict):
    knowledgeBaseId: str,
    dataSourceId: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateAgentKnowledgeBaseRequestRequestTypeDef#

# UpdateAgentKnowledgeBaseRequestRequestTypeDef definition

class UpdateAgentKnowledgeBaseRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentVersion: str,
    knowledgeBaseId: str,
    description: NotRequired[str],
    knowledgeBaseState: NotRequired[KnowledgeBaseStateType],  # (1)
  1. See KnowledgeBaseStateType

APISchemaTypeDef#

# APISchemaTypeDef definition

class APISchemaTypeDef(TypedDict):
    s3: NotRequired[S3IdentifierTypeDef],  # (1)
    payload: NotRequired[str],
  1. See S3IdentifierTypeDef

AgentAliasHistoryEventTypeDef#

# AgentAliasHistoryEventTypeDef definition

class AgentAliasHistoryEventTypeDef(TypedDict):
    routingConfiguration: NotRequired[List[AgentAliasRoutingConfigurationListItemTypeDef]],  # (1)
    endDate: NotRequired[datetime],
    startDate: NotRequired[datetime],
  1. See AgentAliasRoutingConfigurationListItemTypeDef

AgentAliasSummaryTypeDef#

# AgentAliasSummaryTypeDef definition

class AgentAliasSummaryTypeDef(TypedDict):
    agentAliasId: str,
    agentAliasName: str,
    agentAliasStatus: AgentAliasStatusType,  # (2)
    createdAt: datetime,
    updatedAt: datetime,
    description: NotRequired[str],
    routingConfiguration: NotRequired[List[AgentAliasRoutingConfigurationListItemTypeDef]],  # (1)
  1. See AgentAliasRoutingConfigurationListItemTypeDef
  2. See AgentAliasStatusType

CreateAgentAliasRequestRequestTypeDef#

# CreateAgentAliasRequestRequestTypeDef definition

class CreateAgentAliasRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentAliasName: str,
    clientToken: NotRequired[str],
    description: NotRequired[str],
    routingConfiguration: NotRequired[Sequence[AgentAliasRoutingConfigurationListItemTypeDef]],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See AgentAliasRoutingConfigurationListItemTypeDef

UpdateAgentAliasRequestRequestTypeDef#

# UpdateAgentAliasRequestRequestTypeDef definition

class UpdateAgentAliasRequestRequestTypeDef(TypedDict):
    agentId: str,
    agentAliasId: str,
    agentAliasName: str,
    description: NotRequired[str],
    routingConfiguration: NotRequired[Sequence[Age