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
- ListModelCustomizationJobsPaginator
- 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
- GuardrailFilterStrengthType
- GuardrailManagedWordsTypeType
- GuardrailPiiEntityTypeType
- GuardrailSensitiveInformationActionType
- GuardrailStatusType
- GuardrailTopicTypeType
- InferenceTypeType
- ListCustomModelsPaginatorName
- ListEvaluationJobsPaginatorName
- ListGuardrailsPaginatorName
- ListModelCustomizationJobsPaginatorName
- ListProvisionedModelThroughputsPaginatorName
- ModelCustomizationJobStatusType
- ModelCustomizationType
- ModelModalityType
- ProvisionedModelStatusType
- SortByProvisionedModelsType
- SortJobsByType
- SortModelsByType
- SortOrderType
- BedrockServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- S3ConfigTypeDef
- EvaluationOutputDataConfigTypeDef
- TagTypeDef
- ResponseMetadataTypeDef
- CreateGuardrailVersionRequestRequestTypeDef
- OutputDataConfigTypeDef
- TrainingDataConfigTypeDef
- VpcConfigTypeDef
- CustomModelSummaryTypeDef
- DeleteCustomModelRequestRequestTypeDef
- DeleteGuardrailRequestRequestTypeDef
- DeleteProvisionedModelThroughputRequestRequestTypeDef
- EvaluationBedrockModelTypeDef
- EvaluationDatasetLocationTypeDef
- EvaluationSummaryTypeDef
- FoundationModelLifecycleTypeDef
- GetCustomModelRequestRequestTypeDef
- TrainingMetricsTypeDef
- ValidatorMetricTypeDef
- GetEvaluationJobRequestRequestTypeDef
- GetFoundationModelRequestRequestTypeDef
- GetGuardrailRequestRequestTypeDef
- GetModelCustomizationJobRequestRequestTypeDef
- VpcConfigOutputTypeDef
- GetProvisionedModelThroughputRequestRequestTypeDef
- GuardrailContentFilterConfigTypeDef
- GuardrailContentFilterTypeDef
- GuardrailManagedWordsConfigTypeDef
- GuardrailManagedWordsTypeDef
- GuardrailPiiEntityConfigTypeDef
- GuardrailPiiEntityTypeDef
- GuardrailRegexConfigTypeDef
- GuardrailRegexTypeDef
- GuardrailSummaryTypeDef
- GuardrailTopicConfigTypeDef
- GuardrailTopicTypeDef
- GuardrailWordConfigTypeDef
- GuardrailWordTypeDef
- HumanEvaluationCustomMetricTypeDef
- HumanWorkflowConfigTypeDef
- PaginatorConfigTypeDef
- TimestampTypeDef
- ListFoundationModelsRequestRequestTypeDef
- ListGuardrailsRequestRequestTypeDef
- ModelCustomizationJobSummaryTypeDef
- ProvisionedModelSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- StopEvaluationJobRequestRequestTypeDef
- StopModelCustomizationJobRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateProvisionedModelThroughputRequestRequestTypeDef
- ValidatorTypeDef
- CloudWatchConfigTypeDef
- CreateProvisionedModelThroughputRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- CreateEvaluationJobResponseTypeDef
- CreateGuardrailResponseTypeDef
- CreateGuardrailVersionResponseTypeDef
- CreateModelCustomizationJobResponseTypeDef
- CreateProvisionedModelThroughputResponseTypeDef
- GetProvisionedModelThroughputResponseTypeDef
- ListTagsForResourceResponseTypeDef
- UpdateGuardrailResponseTypeDef
- ListCustomModelsResponseTypeDef
- EvaluationModelConfigTypeDef
- EvaluationDatasetTypeDef
- ListEvaluationJobsResponseTypeDef
- FoundationModelDetailsTypeDef
- FoundationModelSummaryTypeDef
- VpcConfigUnionTypeDef
- GuardrailContentPolicyConfigTypeDef
- GuardrailContentPolicyTypeDef
- GuardrailSensitiveInformationPolicyConfigTypeDef
- GuardrailSensitiveInformationPolicyTypeDef
- ListGuardrailsResponseTypeDef
- GuardrailTopicPolicyConfigTypeDef
- GuardrailTopicPolicyTypeDef
- GuardrailWordPolicyConfigTypeDef
- GuardrailWordPolicyTypeDef
- ListGuardrailsRequestListGuardrailsPaginateTypeDef
- ListCustomModelsRequestListCustomModelsPaginateTypeDef
- ListCustomModelsRequestRequestTypeDef
- ListEvaluationJobsRequestListEvaluationJobsPaginateTypeDef
- ListEvaluationJobsRequestRequestTypeDef
- ListModelCustomizationJobsRequestListModelCustomizationJobsPaginateTypeDef
- ListModelCustomizationJobsRequestRequestTypeDef
- ListProvisionedModelThroughputsRequestListProvisionedModelThroughputsPaginateTypeDef
- ListProvisionedModelThroughputsRequestRequestTypeDef
- ListModelCustomizationJobsResponseTypeDef
- ListProvisionedModelThroughputsResponseTypeDef
- ValidationDataConfigOutputTypeDef
- ValidationDataConfigTypeDef
- LoggingConfigTypeDef
- EvaluationInferenceConfigOutputTypeDef
- EvaluationInferenceConfigTypeDef
- EvaluationDatasetMetricConfigOutputTypeDef
- EvaluationDatasetMetricConfigTypeDef
- GetFoundationModelResponseTypeDef
- ListFoundationModelsResponseTypeDef
- CreateGuardrailRequestRequestTypeDef
- UpdateGuardrailRequestRequestTypeDef
- GetGuardrailResponseTypeDef
- GetCustomModelResponseTypeDef
- GetModelCustomizationJobResponseTypeDef
- CreateModelCustomizationJobRequestRequestTypeDef
- ValidationDataConfigUnionTypeDef
- GetModelInvocationLoggingConfigurationResponseTypeDef
- PutModelInvocationLoggingConfigurationRequestRequestTypeDef
- EvaluationInferenceConfigUnionTypeDef
- AutomatedEvaluationConfigOutputTypeDef
- HumanEvaluationConfigOutputTypeDef
- AutomatedEvaluationConfigTypeDef
- HumanEvaluationConfigTypeDef
- EvaluationConfigOutputTypeDef
- EvaluationConfigTypeDef
- GetEvaluationJobResponseTypeDef
- CreateEvaluationJobRequestRequestTypeDef
- EvaluationConfigUnionTypeDef