Bedrock module#
Index > Bedrock
Auto-generated documentation for Bedrock type annotations stubs module mypy-boto3-bedrock.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.23' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
Bedrock
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Bedrock
.
From PyPI with pip#
Install boto3-stubs
for Bedrock
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[bedrock]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[bedrock]'
# standalone installation
python -m pip install mypy-boto3-bedrock
How to uninstall#
python -m pip uninstall -y mypy-boto3-bedrock
Usage#
Code samples can be found in Examples.
BedrockClient#
Type annotations and code completion for boto3.client("bedrock")
as BedrockClient
boto3 documentation
# BedrockClient usage example
from boto3.session import Session
from mypy_boto3_bedrock.client import BedrockClient
def get_client() -> BedrockClient:
return Session().client("bedrock")
Paginators#
Type annotations and code completion for paginators
from boto3.client("bedrock").get_paginator("...")
.
# ListCustomModelsPaginator usage example
from boto3.session import Session
from mypy_boto3_bedrock.paginator import ListCustomModelsPaginator
def get_list_custom_models_paginator() -> ListCustomModelsPaginator:
return Session().client("bedrock").get_paginator("list_custom_models"))
- ListCustomModelsPaginator
- ListEvaluationJobsPaginator
- ListGuardrailsPaginator
- ListImportedModelsPaginator
- ListInferenceProfilesPaginator
- ListMarketplaceModelEndpointsPaginator
- ListModelCopyJobsPaginator
- ListModelCustomizationJobsPaginator
- ListModelImportJobsPaginator
- ListModelInvocationJobsPaginator
- ListPromptRoutersPaginator
- ListProvisionedModelThroughputsPaginator
Literals#
Type annotations for literals used in methods and schema.
# ApplicationTypeType usage example
from mypy_boto3_bedrock.literals import ApplicationTypeType
def get_value() -> ApplicationTypeType:
return "ModelEvaluation"
- ApplicationTypeType
- CommitmentDurationType
- CustomizationTypeType
- EvaluationJobStatusType
- EvaluationJobTypeType
- EvaluationTaskTypeType
- ExternalSourceTypeType
- FineTuningJobStatusType
- FoundationModelLifecycleStatusType
- GuardrailContentFilterTypeType
- GuardrailContextualGroundingFilterTypeType
- GuardrailFilterStrengthType
- GuardrailManagedWordsTypeType
- GuardrailModalityType
- GuardrailPiiEntityTypeType
- GuardrailSensitiveInformationActionType
- GuardrailStatusType
- GuardrailTopicTypeType
- InferenceProfileStatusType
- InferenceProfileTypeType
- InferenceTypeType
- ListCustomModelsPaginatorName
- ListEvaluationJobsPaginatorName
- ListGuardrailsPaginatorName
- ListImportedModelsPaginatorName
- ListInferenceProfilesPaginatorName
- ListMarketplaceModelEndpointsPaginatorName
- ListModelCopyJobsPaginatorName
- ListModelCustomizationJobsPaginatorName
- ListModelImportJobsPaginatorName
- ListModelInvocationJobsPaginatorName
- ListPromptRoutersPaginatorName
- ListProvisionedModelThroughputsPaginatorName
- ModelCopyJobStatusType
- ModelCustomizationJobStatusType
- ModelCustomizationType
- ModelImportJobStatusType
- ModelInvocationJobStatusType
- ModelModalityType
- PerformanceConfigLatencyType
- PromptRouterStatusType
- PromptRouterTypeType
- ProvisionedModelStatusType
- QueryTransformationTypeType
- RetrieveAndGenerateTypeType
- S3InputFormatType
- SearchTypeType
- SortByProvisionedModelsType
- SortJobsByType
- SortModelsByType
- SortOrderType
- StatusType
- BedrockServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BatchDeleteEvaluationJobErrorTypeDef
- BatchDeleteEvaluationJobItemTypeDef
- BatchDeleteEvaluationJobRequestTypeDef
- ResponseMetadataTypeDef
- BedrockEvaluatorModelTypeDef
- BlobTypeDef
- ByteContentDocOutputTypeDef
- S3ConfigTypeDef
- EvaluationOutputDataConfigTypeDef
- TagTypeDef
- CreateGuardrailVersionRequestTypeDef
- InferenceProfileModelSourceTypeDef
- OutputDataConfigTypeDef
- CustomModelSummaryTypeDef
- DeleteCustomModelRequestTypeDef
- DeleteGuardrailRequestTypeDef
- DeleteImportedModelRequestTypeDef
- DeleteInferenceProfileRequestTypeDef
- DeleteMarketplaceModelEndpointRequestTypeDef
- DeleteProvisionedModelThroughputRequestTypeDef
- DeregisterMarketplaceModelEndpointRequestTypeDef
- TeacherModelConfigTypeDef
- PerformanceConfigurationTypeDef
- EvaluationDatasetLocationTypeDef
- EvaluationSummaryTypeDef
- S3ObjectDocTypeDef
- GuardrailConfigurationTypeDef
- PromptTemplateTypeDef
- FilterAttributeOutputTypeDef
- FilterAttributeTypeDef
- FoundationModelLifecycleTypeDef
- GetCustomModelRequestTypeDef
- TrainingMetricsTypeDef
- ValidatorMetricTypeDef
- GetEvaluationJobRequestTypeDef
- GetFoundationModelRequestTypeDef
- GetGuardrailRequestTypeDef
- GetImportedModelRequestTypeDef
- GetInferenceProfileRequestTypeDef
- InferenceProfileModelTypeDef
- GetMarketplaceModelEndpointRequestTypeDef
- GetModelCopyJobRequestTypeDef
- GetModelCustomizationJobRequestTypeDef
- VpcConfigOutputTypeDef
- GetModelImportJobRequestTypeDef
- GetModelInvocationJobRequestTypeDef
- GetPromptRouterRequestTypeDef
- PromptRouterTargetModelTypeDef
- RoutingCriteriaTypeDef
- GetProvisionedModelThroughputRequestTypeDef
- GuardrailContentFilterConfigTypeDef
- GuardrailContentFilterTypeDef
- GuardrailContextualGroundingFilterConfigTypeDef
- GuardrailContextualGroundingFilterTypeDef
- GuardrailManagedWordsConfigTypeDef
- GuardrailManagedWordsTypeDef
- GuardrailPiiEntityConfigTypeDef
- GuardrailPiiEntityTypeDef
- GuardrailRegexConfigTypeDef
- GuardrailRegexTypeDef
- GuardrailSummaryTypeDef
- GuardrailTopicConfigTypeDef
- GuardrailTopicTypeDef
- GuardrailWordConfigTypeDef
- GuardrailWordTypeDef
- HumanEvaluationCustomMetricTypeDef
- HumanWorkflowConfigTypeDef
- ImportedModelSummaryTypeDef
- InvocationLogSourceTypeDef
- TextInferenceConfigOutputTypeDef
- TextInferenceConfigTypeDef
- PaginatorConfigTypeDef
- TimestampTypeDef
- ListFoundationModelsRequestTypeDef
- ListGuardrailsRequestTypeDef
- ListInferenceProfilesRequestTypeDef
- ListMarketplaceModelEndpointsRequestTypeDef
- MarketplaceModelEndpointSummaryTypeDef
- ModelCustomizationJobSummaryTypeDef
- ModelImportJobSummaryTypeDef
- ListPromptRoutersRequestTypeDef
- ProvisionedModelSummaryTypeDef
- ListTagsForResourceRequestTypeDef
- S3DataSourceTypeDef
- ModelInvocationJobS3InputDataConfigTypeDef
- ModelInvocationJobS3OutputDataConfigTypeDef
- QueryTransformationConfigurationTypeDef
- RegisterMarketplaceModelEndpointRequestTypeDef
- RequestMetadataBaseFiltersOutputTypeDef
- RequestMetadataBaseFiltersTypeDef
- VpcConfigTypeDef
- StopEvaluationJobRequestTypeDef
- StopModelCustomizationJobRequestTypeDef
- StopModelInvocationJobRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateProvisionedModelThroughputRequestTypeDef
- ValidatorTypeDef
- BatchDeleteEvaluationJobResponseTypeDef
- CreateEvaluationJobResponseTypeDef
- CreateGuardrailResponseTypeDef
- CreateGuardrailVersionResponseTypeDef
- CreateInferenceProfileResponseTypeDef
- CreateModelCopyJobResponseTypeDef
- CreateModelCustomizationJobResponseTypeDef
- CreateModelImportJobResponseTypeDef
- CreateModelInvocationJobResponseTypeDef
- CreateProvisionedModelThroughputResponseTypeDef
- GetProvisionedModelThroughputResponseTypeDef
- UpdateGuardrailResponseTypeDef
- EvaluatorModelConfigOutputTypeDef
- EvaluatorModelConfigTypeDef
- ByteContentDocTypeDef
- CloudWatchConfigTypeDef
- CreateModelCopyJobRequestTypeDef
- CreateProvisionedModelThroughputRequestTypeDef
- GetModelCopyJobResponseTypeDef
- ListTagsForResourceResponseTypeDef
- ModelCopyJobSummaryTypeDef
- TagResourceRequestTypeDef
- CreateInferenceProfileRequestTypeDef
- ListCustomModelsResponseTypeDef
- DistillationConfigTypeDef
- EvaluationBedrockModelTypeDef
- EvaluationDatasetTypeDef
- ListEvaluationJobsResponseTypeDef
- ExternalSourceOutputTypeDef
- RetrievalFilterOutputTypeDef
- RetrievalFilterTypeDef
- FoundationModelDetailsTypeDef
- FoundationModelSummaryTypeDef
- GetInferenceProfileResponseTypeDef
- InferenceProfileSummaryTypeDef
- SageMakerEndpointOutputTypeDef
- GetPromptRouterResponseTypeDef
- PromptRouterSummaryTypeDef
- GuardrailContentPolicyConfigTypeDef
- GuardrailContentPolicyTypeDef
- GuardrailContextualGroundingPolicyConfigTypeDef
- GuardrailContextualGroundingPolicyTypeDef
- GuardrailSensitiveInformationPolicyConfigTypeDef
- GuardrailSensitiveInformationPolicyTypeDef
- ListGuardrailsResponseTypeDef
- GuardrailTopicPolicyConfigTypeDef
- GuardrailTopicPolicyTypeDef
- GuardrailWordPolicyConfigTypeDef
- GuardrailWordPolicyTypeDef
- ListImportedModelsResponseTypeDef
- KbInferenceConfigOutputTypeDef
- KbInferenceConfigTypeDef
- ListGuardrailsRequestPaginateTypeDef
- ListInferenceProfilesRequestPaginateTypeDef
- ListMarketplaceModelEndpointsRequestPaginateTypeDef
- ListPromptRoutersRequestPaginateTypeDef
- ListCustomModelsRequestPaginateTypeDef
- ListCustomModelsRequestTypeDef
- ListEvaluationJobsRequestPaginateTypeDef
- ListEvaluationJobsRequestTypeDef
- ListImportedModelsRequestPaginateTypeDef
- ListImportedModelsRequestTypeDef
- ListModelCopyJobsRequestPaginateTypeDef
- ListModelCopyJobsRequestTypeDef
- ListModelCustomizationJobsRequestPaginateTypeDef
- ListModelCustomizationJobsRequestTypeDef
- ListModelImportJobsRequestPaginateTypeDef
- ListModelImportJobsRequestTypeDef
- ListModelInvocationJobsRequestPaginateTypeDef
- ListModelInvocationJobsRequestTypeDef
- ListProvisionedModelThroughputsRequestPaginateTypeDef
- ListProvisionedModelThroughputsRequestTypeDef
- ListMarketplaceModelEndpointsResponseTypeDef
- ListModelCustomizationJobsResponseTypeDef
- ListModelImportJobsResponseTypeDef
- ListProvisionedModelThroughputsResponseTypeDef
- ModelDataSourceTypeDef
- ModelInvocationJobInputDataConfigTypeDef
- ModelInvocationJobOutputDataConfigTypeDef
- OrchestrationConfigurationTypeDef
- RequestMetadataFiltersOutputTypeDef
- RequestMetadataFiltersTypeDef
- SageMakerEndpointTypeDef
- VpcConfigUnionTypeDef
- ValidationDataConfigOutputTypeDef
- ValidationDataConfigTypeDef
- ExternalSourceTypeDef
- LoggingConfigTypeDef
- ListModelCopyJobsResponseTypeDef
- CustomizationConfigTypeDef
- EvaluationModelConfigTypeDef
- EvaluationDatasetMetricConfigOutputTypeDef
- EvaluationDatasetMetricConfigTypeDef
- KnowledgeBaseVectorSearchConfigurationOutputTypeDef
- KnowledgeBaseVectorSearchConfigurationTypeDef
- GetFoundationModelResponseTypeDef
- ListFoundationModelsResponseTypeDef
- ListInferenceProfilesResponseTypeDef
- EndpointConfigOutputTypeDef
- ListPromptRoutersResponseTypeDef
- CreateGuardrailRequestTypeDef
- UpdateGuardrailRequestTypeDef
- GetGuardrailResponseTypeDef
- ExternalSourcesGenerationConfigurationOutputTypeDef
- GenerationConfigurationOutputTypeDef
- ExternalSourcesGenerationConfigurationTypeDef
- GenerationConfigurationTypeDef
- GetImportedModelResponseTypeDef
- GetModelImportJobResponseTypeDef
- GetModelInvocationJobResponseTypeDef
- ModelInvocationJobSummaryTypeDef
- InvocationLogsConfigOutputTypeDef
- InvocationLogsConfigTypeDef
- EndpointConfigTypeDef
- CreateModelImportJobRequestTypeDef
- CreateModelInvocationJobRequestTypeDef
- ValidationDataConfigUnionTypeDef
- GetModelInvocationLoggingConfigurationResponseTypeDef
- PutModelInvocationLoggingConfigurationRequestTypeDef
- AutomatedEvaluationConfigOutputTypeDef
- HumanEvaluationConfigOutputTypeDef
- AutomatedEvaluationConfigTypeDef
- HumanEvaluationConfigTypeDef
- KnowledgeBaseRetrievalConfigurationOutputTypeDef
- KnowledgeBaseRetrievalConfigurationTypeDef
- MarketplaceModelEndpointTypeDef
- ExternalSourcesRetrieveAndGenerateConfigurationOutputTypeDef
- ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
- ListModelInvocationJobsResponseTypeDef
- TrainingDataConfigOutputTypeDef
- TrainingDataConfigTypeDef
- EndpointConfigUnionTypeDef
- EvaluationConfigOutputTypeDef
- EvaluationConfigTypeDef
- KnowledgeBaseRetrieveAndGenerateConfigurationOutputTypeDef
- RetrieveConfigOutputTypeDef
- KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
- RetrieveConfigTypeDef
- CreateMarketplaceModelEndpointResponseTypeDef
- GetMarketplaceModelEndpointResponseTypeDef
- RegisterMarketplaceModelEndpointResponseTypeDef
- UpdateMarketplaceModelEndpointResponseTypeDef
- GetCustomModelResponseTypeDef
- GetModelCustomizationJobResponseTypeDef
- TrainingDataConfigUnionTypeDef
- CreateMarketplaceModelEndpointRequestTypeDef
- UpdateMarketplaceModelEndpointRequestTypeDef
- EvaluationConfigUnionTypeDef
- RetrieveAndGenerateConfigurationOutputTypeDef
- RetrieveAndGenerateConfigurationTypeDef
- CreateModelCustomizationJobRequestTypeDef
- KnowledgeBaseConfigOutputTypeDef
- KnowledgeBaseConfigTypeDef
- RAGConfigOutputTypeDef
- RAGConfigTypeDef
- EvaluationInferenceConfigOutputTypeDef
- EvaluationInferenceConfigTypeDef
- GetEvaluationJobResponseTypeDef
- EvaluationInferenceConfigUnionTypeDef
- CreateEvaluationJobRequestTypeDef