Bedrock module#
Index > Bedrock
Auto-generated documentation for Bedrock type annotations stubs module mypy-boto3-bedrock.
How to install#
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
- ListModelCopyJobsPaginator
- ListModelCustomizationJobsPaginator
- ListModelImportJobsPaginator
- ListModelInvocationJobsPaginator
- ListProvisionedModelThroughputsPaginator
Literals#
Type annotations for literals used in methods and schema.
# CommitmentDurationType usage example
from mypy_boto3_bedrock.literals import CommitmentDurationType
def get_value() -> CommitmentDurationType:
return "OneMonth"
- CommitmentDurationType
- CustomizationTypeType
- EvaluationJobStatusType
- EvaluationJobTypeType
- EvaluationTaskTypeType
- FineTuningJobStatusType
- FoundationModelLifecycleStatusType
- GuardrailContentFilterTypeType
- GuardrailContextualGroundingFilterTypeType
- GuardrailFilterStrengthType
- GuardrailManagedWordsTypeType
- GuardrailPiiEntityTypeType
- GuardrailSensitiveInformationActionType
- GuardrailStatusType
- GuardrailTopicTypeType
- InferenceProfileStatusType
- InferenceProfileTypeType
- InferenceTypeType
- ListCustomModelsPaginatorName
- ListEvaluationJobsPaginatorName
- ListGuardrailsPaginatorName
- ListImportedModelsPaginatorName
- ListInferenceProfilesPaginatorName
- ListModelCopyJobsPaginatorName
- ListModelCustomizationJobsPaginatorName
- ListModelImportJobsPaginatorName
- ListModelInvocationJobsPaginatorName
- ListProvisionedModelThroughputsPaginatorName
- ModelCopyJobStatusType
- ModelCustomizationJobStatusType
- ModelCustomizationType
- ModelImportJobStatusType
- ModelInvocationJobStatusType
- ModelModalityType
- ProvisionedModelStatusType
- S3InputFormatType
- SortByProvisionedModelsType
- SortJobsByType
- SortModelsByType
- SortOrderType
- BedrockServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BatchDeleteEvaluationJobErrorTypeDef
- BatchDeleteEvaluationJobItemTypeDef
- BatchDeleteEvaluationJobRequestRequestTypeDef
- ResponseMetadataTypeDef
- S3ConfigTypeDef
- EvaluationOutputDataConfigTypeDef
- TagTypeDef
- CreateGuardrailVersionRequestRequestTypeDef
- InferenceProfileModelSourceTypeDef
- OutputDataConfigTypeDef
- TrainingDataConfigTypeDef
- VpcConfigTypeDef
- CustomModelSummaryTypeDef
- DeleteCustomModelRequestRequestTypeDef
- DeleteGuardrailRequestRequestTypeDef
- DeleteImportedModelRequestRequestTypeDef
- DeleteInferenceProfileRequestRequestTypeDef
- DeleteProvisionedModelThroughputRequestRequestTypeDef
- EvaluationBedrockModelTypeDef
- EvaluationDatasetLocationTypeDef
- EvaluationSummaryTypeDef
- FoundationModelLifecycleTypeDef
- GetCustomModelRequestRequestTypeDef
- TrainingMetricsTypeDef
- ValidatorMetricTypeDef
- GetEvaluationJobRequestRequestTypeDef
- GetFoundationModelRequestRequestTypeDef
- GetGuardrailRequestRequestTypeDef
- GetImportedModelRequestRequestTypeDef
- GetInferenceProfileRequestRequestTypeDef
- InferenceProfileModelTypeDef
- GetModelCopyJobRequestRequestTypeDef
- GetModelCustomizationJobRequestRequestTypeDef
- VpcConfigOutputTypeDef
- GetModelImportJobRequestRequestTypeDef
- GetModelInvocationJobRequestRequestTypeDef
- GetProvisionedModelThroughputRequestRequestTypeDef
- GuardrailContentFilterConfigTypeDef
- GuardrailContentFilterTypeDef
- GuardrailContextualGroundingFilterConfigTypeDef
- GuardrailContextualGroundingFilterTypeDef
- GuardrailManagedWordsConfigTypeDef
- GuardrailManagedWordsTypeDef
- GuardrailPiiEntityConfigTypeDef
- GuardrailPiiEntityTypeDef
- GuardrailRegexConfigTypeDef
- GuardrailRegexTypeDef
- GuardrailSummaryTypeDef
- GuardrailTopicConfigTypeDef
- GuardrailTopicTypeDef
- GuardrailWordConfigTypeDef
- GuardrailWordTypeDef
- HumanEvaluationCustomMetricTypeDef
- HumanWorkflowConfigTypeDef
- ImportedModelSummaryTypeDef
- PaginatorConfigTypeDef
- TimestampTypeDef
- ListFoundationModelsRequestRequestTypeDef
- ListGuardrailsRequestRequestTypeDef
- ListInferenceProfilesRequestRequestTypeDef
- ModelCustomizationJobSummaryTypeDef
- ModelImportJobSummaryTypeDef
- ProvisionedModelSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- S3DataSourceTypeDef
- ModelInvocationJobS3InputDataConfigTypeDef
- ModelInvocationJobS3OutputDataConfigTypeDef
- StopEvaluationJobRequestRequestTypeDef
- StopModelCustomizationJobRequestRequestTypeDef
- StopModelInvocationJobRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateProvisionedModelThroughputRequestRequestTypeDef
- ValidatorTypeDef
- BatchDeleteEvaluationJobResponseTypeDef
- CreateEvaluationJobResponseTypeDef
- CreateGuardrailResponseTypeDef
- CreateGuardrailVersionResponseTypeDef
- CreateInferenceProfileResponseTypeDef
- CreateModelCopyJobResponseTypeDef
- CreateModelCustomizationJobResponseTypeDef
- CreateModelImportJobResponseTypeDef
- CreateModelInvocationJobResponseTypeDef
- CreateProvisionedModelThroughputResponseTypeDef
- GetProvisionedModelThroughputResponseTypeDef
- UpdateGuardrailResponseTypeDef
- CloudWatchConfigTypeDef
- CreateModelCopyJobRequestRequestTypeDef
- CreateProvisionedModelThroughputRequestRequestTypeDef
- GetModelCopyJobResponseTypeDef
- ListTagsForResourceResponseTypeDef
- ModelCopyJobSummaryTypeDef
- TagResourceRequestRequestTypeDef
- CreateInferenceProfileRequestRequestTypeDef
- ListCustomModelsResponseTypeDef
- EvaluationModelConfigTypeDef
- EvaluationDatasetTypeDef
- ListEvaluationJobsResponseTypeDef
- FoundationModelDetailsTypeDef
- FoundationModelSummaryTypeDef
- GetInferenceProfileResponseTypeDef
- InferenceProfileSummaryTypeDef
- GuardrailContentPolicyConfigTypeDef
- GuardrailContentPolicyTypeDef
- GuardrailContextualGroundingPolicyConfigTypeDef
- GuardrailContextualGroundingPolicyTypeDef
- GuardrailSensitiveInformationPolicyConfigTypeDef
- GuardrailSensitiveInformationPolicyTypeDef
- ListGuardrailsResponseTypeDef
- GuardrailTopicPolicyConfigTypeDef
- GuardrailTopicPolicyTypeDef
- GuardrailWordPolicyConfigTypeDef
- GuardrailWordPolicyTypeDef
- ListImportedModelsResponseTypeDef
- ListGuardrailsRequestListGuardrailsPaginateTypeDef
- ListInferenceProfilesRequestListInferenceProfilesPaginateTypeDef
- ListCustomModelsRequestListCustomModelsPaginateTypeDef
- ListCustomModelsRequestRequestTypeDef
- ListEvaluationJobsRequestListEvaluationJobsPaginateTypeDef
- ListEvaluationJobsRequestRequestTypeDef
- ListImportedModelsRequestListImportedModelsPaginateTypeDef
- ListImportedModelsRequestRequestTypeDef
- ListModelCopyJobsRequestListModelCopyJobsPaginateTypeDef
- ListModelCopyJobsRequestRequestTypeDef
- ListModelCustomizationJobsRequestListModelCustomizationJobsPaginateTypeDef
- ListModelCustomizationJobsRequestRequestTypeDef
- ListModelImportJobsRequestListModelImportJobsPaginateTypeDef
- ListModelImportJobsRequestRequestTypeDef
- ListModelInvocationJobsRequestListModelInvocationJobsPaginateTypeDef
- ListModelInvocationJobsRequestRequestTypeDef
- ListProvisionedModelThroughputsRequestListProvisionedModelThroughputsPaginateTypeDef
- ListProvisionedModelThroughputsRequestRequestTypeDef
- ListModelCustomizationJobsResponseTypeDef
- ListModelImportJobsResponseTypeDef
- ListProvisionedModelThroughputsResponseTypeDef
- ModelDataSourceTypeDef
- ModelInvocationJobInputDataConfigTypeDef
- ModelInvocationJobOutputDataConfigTypeDef
- ValidationDataConfigOutputTypeDef
- ValidationDataConfigTypeDef
- LoggingConfigTypeDef
- ListModelCopyJobsResponseTypeDef
- EvaluationInferenceConfigOutputTypeDef
- EvaluationInferenceConfigTypeDef
- EvaluationDatasetMetricConfigOutputTypeDef
- EvaluationDatasetMetricConfigTypeDef
- GetFoundationModelResponseTypeDef
- ListFoundationModelsResponseTypeDef
- ListInferenceProfilesResponseTypeDef
- CreateGuardrailRequestRequestTypeDef
- UpdateGuardrailRequestRequestTypeDef
- GetGuardrailResponseTypeDef
- CreateModelImportJobRequestRequestTypeDef
- GetImportedModelResponseTypeDef
- GetModelImportJobResponseTypeDef
- CreateModelInvocationJobRequestRequestTypeDef
- GetModelInvocationJobResponseTypeDef
- ModelInvocationJobSummaryTypeDef
- GetCustomModelResponseTypeDef
- GetModelCustomizationJobResponseTypeDef
- CreateModelCustomizationJobRequestRequestTypeDef
- GetModelInvocationLoggingConfigurationResponseTypeDef
- PutModelInvocationLoggingConfigurationRequestRequestTypeDef
- AutomatedEvaluationConfigOutputTypeDef
- HumanEvaluationConfigOutputTypeDef
- EvaluationDatasetMetricConfigUnionTypeDef
- HumanEvaluationConfigTypeDef
- ListModelInvocationJobsResponseTypeDef
- EvaluationConfigOutputTypeDef
- AutomatedEvaluationConfigTypeDef
- HumanEvaluationConfigUnionTypeDef
- GetEvaluationJobResponseTypeDef
- AutomatedEvaluationConfigUnionTypeDef
- EvaluationConfigTypeDef
- CreateEvaluationJobRequestRequestTypeDef