BedrockClient#
Auto-generated documentation for Bedrock type annotations stubs module mypy-boto3-bedrock.
BedrockClient#
Type annotations and code completion for boto3.client("bedrock")
.
boto3 documentation
# BedrockClient usage example
from boto3.session import Session
from mypy_boto3_bedrock.client import BedrockClient
def get_bedrock_client() -> BedrockClient:
return Session().client("bedrock")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("bedrock").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("bedrock")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ServiceUnavailableException,
client.exceptions.ThrottlingException,
client.exceptions.TooManyTagsException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_bedrock.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Type annotations and code completion for boto3.client("bedrock").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
generate_presigned_url#
Type annotations and code completion for boto3.client("bedrock").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
batch_delete_evaluation_job#
Deletes a batch of evaluation jobs.
Type annotations and code completion for boto3.client("bedrock").batch_delete_evaluation_job
method.
boto3 documentation
# batch_delete_evaluation_job method definition
def batch_delete_evaluation_job(
self,
*,
jobIdentifiers: Sequence[str],
) -> BatchDeleteEvaluationJobResponseTypeDef: # (1)
...
# batch_delete_evaluation_job method usage example with argument unpacking
kwargs: BatchDeleteEvaluationJobRequestTypeDef = { # (1)
"jobIdentifiers": ...,
}
parent.batch_delete_evaluation_job(**kwargs)
create_evaluation_job#
Creates an evaluation job.
Type annotations and code completion for boto3.client("bedrock").create_evaluation_job
method.
boto3 documentation
# create_evaluation_job method definition
def create_evaluation_job(
self,
*,
jobName: str,
roleArn: str,
evaluationConfig: EvaluationConfigUnionTypeDef, # (1)
inferenceConfig: EvaluationInferenceConfigUnionTypeDef, # (2)
outputDataConfig: EvaluationOutputDataConfigTypeDef, # (3)
jobDescription: str = ...,
clientRequestToken: str = ...,
customerEncryptionKeyId: str = ...,
jobTags: Sequence[TagTypeDef] = ..., # (4)
applicationType: ApplicationTypeType = ..., # (5)
) -> CreateEvaluationJobResponseTypeDef: # (6)
...
- See EvaluationConfigTypeDef EvaluationConfigOutputTypeDef
- See EvaluationInferenceConfigTypeDef EvaluationInferenceConfigOutputTypeDef
- See EvaluationOutputDataConfigTypeDef
- See TagTypeDef
- See ApplicationTypeType
- See CreateEvaluationJobResponseTypeDef
# create_evaluation_job method usage example with argument unpacking
kwargs: CreateEvaluationJobRequestTypeDef = { # (1)
"jobName": ...,
"roleArn": ...,
"evaluationConfig": ...,
"inferenceConfig": ...,
"outputDataConfig": ...,
}
parent.create_evaluation_job(**kwargs)
create_guardrail#
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
Type annotations and code completion for boto3.client("bedrock").create_guardrail
method.
boto3 documentation
# create_guardrail method definition
def create_guardrail(
self,
*,
name: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
description: str = ...,
topicPolicyConfig: GuardrailTopicPolicyConfigTypeDef = ..., # (1)
contentPolicyConfig: GuardrailContentPolicyConfigTypeDef = ..., # (2)
wordPolicyConfig: GuardrailWordPolicyConfigTypeDef = ..., # (3)
sensitiveInformationPolicyConfig: GuardrailSensitiveInformationPolicyConfigTypeDef = ..., # (4)
contextualGroundingPolicyConfig: GuardrailContextualGroundingPolicyConfigTypeDef = ..., # (5)
kmsKeyId: str = ...,
tags: Sequence[TagTypeDef] = ..., # (6)
clientRequestToken: str = ...,
) -> CreateGuardrailResponseTypeDef: # (7)
...
- See GuardrailTopicPolicyConfigTypeDef
- See GuardrailContentPolicyConfigTypeDef
- See GuardrailWordPolicyConfigTypeDef
- See GuardrailSensitiveInformationPolicyConfigTypeDef
- See GuardrailContextualGroundingPolicyConfigTypeDef
- See TagTypeDef
- See CreateGuardrailResponseTypeDef
# create_guardrail method usage example with argument unpacking
kwargs: CreateGuardrailRequestTypeDef = { # (1)
"name": ...,
"blockedInputMessaging": ...,
"blockedOutputsMessaging": ...,
}
parent.create_guardrail(**kwargs)
create_guardrail_version#
Creates a version of the guardrail.
Type annotations and code completion for boto3.client("bedrock").create_guardrail_version
method.
boto3 documentation
# create_guardrail_version method definition
def create_guardrail_version(
self,
*,
guardrailIdentifier: str,
description: str = ...,
clientRequestToken: str = ...,
) -> CreateGuardrailVersionResponseTypeDef: # (1)
...
# create_guardrail_version method usage example with argument unpacking
kwargs: CreateGuardrailVersionRequestTypeDef = { # (1)
"guardrailIdentifier": ...,
}
parent.create_guardrail_version(**kwargs)
create_inference_profile#
Creates an application inference profile to track metrics and costs when invoking a model.
Type annotations and code completion for boto3.client("bedrock").create_inference_profile
method.
boto3 documentation
# create_inference_profile method definition
def create_inference_profile(
self,
*,
inferenceProfileName: str,
modelSource: InferenceProfileModelSourceTypeDef, # (1)
description: str = ...,
clientRequestToken: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateInferenceProfileResponseTypeDef: # (3)
...
# create_inference_profile method usage example with argument unpacking
kwargs: CreateInferenceProfileRequestTypeDef = { # (1)
"inferenceProfileName": ...,
"modelSource": ...,
}
parent.create_inference_profile(**kwargs)
create_marketplace_model_endpoint#
Creates an endpoint for a model from Amazon Bedrock Marketplace.
Type annotations and code completion for boto3.client("bedrock").create_marketplace_model_endpoint
method.
boto3 documentation
# create_marketplace_model_endpoint method definition
def create_marketplace_model_endpoint(
self,
*,
modelSourceIdentifier: str,
endpointConfig: EndpointConfigUnionTypeDef, # (1)
endpointName: str,
acceptEula: bool = ...,
clientRequestToken: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateMarketplaceModelEndpointResponseTypeDef: # (3)
...
- See EndpointConfigTypeDef EndpointConfigOutputTypeDef
- See TagTypeDef
- See CreateMarketplaceModelEndpointResponseTypeDef
# create_marketplace_model_endpoint method usage example with argument unpacking
kwargs: CreateMarketplaceModelEndpointRequestTypeDef = { # (1)
"modelSourceIdentifier": ...,
"endpointConfig": ...,
"endpointName": ...,
}
parent.create_marketplace_model_endpoint(**kwargs)
create_model_copy_job#
Copies a model to another region so that it can be used there.
Type annotations and code completion for boto3.client("bedrock").create_model_copy_job
method.
boto3 documentation
# create_model_copy_job method definition
def create_model_copy_job(
self,
*,
sourceModelArn: str,
targetModelName: str,
modelKmsKeyId: str = ...,
targetModelTags: Sequence[TagTypeDef] = ..., # (1)
clientRequestToken: str = ...,
) -> CreateModelCopyJobResponseTypeDef: # (2)
...
# create_model_copy_job method usage example with argument unpacking
kwargs: CreateModelCopyJobRequestTypeDef = { # (1)
"sourceModelArn": ...,
"targetModelName": ...,
}
parent.create_model_copy_job(**kwargs)
create_model_customization_job#
Creates a fine-tuning job to customize a base model.
Type annotations and code completion for boto3.client("bedrock").create_model_customization_job
method.
boto3 documentation
# create_model_customization_job method definition
def create_model_customization_job(
self,
*,
jobName: str,
customModelName: str,
roleArn: str,
baseModelIdentifier: str,
trainingDataConfig: TrainingDataConfigUnionTypeDef, # (1)
outputDataConfig: OutputDataConfigTypeDef, # (2)
clientRequestToken: str = ...,
customizationType: CustomizationTypeType = ..., # (3)
customModelKmsKeyId: str = ...,
jobTags: Sequence[TagTypeDef] = ..., # (4)
customModelTags: Sequence[TagTypeDef] = ..., # (4)
validationDataConfig: ValidationDataConfigUnionTypeDef = ..., # (6)
hyperParameters: Mapping[str, str] = ...,
vpcConfig: VpcConfigUnionTypeDef = ..., # (7)
customizationConfig: CustomizationConfigTypeDef = ..., # (8)
) -> CreateModelCustomizationJobResponseTypeDef: # (9)
...
- See TrainingDataConfigTypeDef TrainingDataConfigOutputTypeDef
- See OutputDataConfigTypeDef
- See CustomizationTypeType
- See TagTypeDef
- See TagTypeDef
- See ValidationDataConfigTypeDef ValidationDataConfigOutputTypeDef
- See VpcConfigTypeDef VpcConfigOutputTypeDef
- See CustomizationConfigTypeDef
- See CreateModelCustomizationJobResponseTypeDef
# create_model_customization_job method usage example with argument unpacking
kwargs: CreateModelCustomizationJobRequestTypeDef = { # (1)
"jobName": ...,
"customModelName": ...,
"roleArn": ...,
"baseModelIdentifier": ...,
"trainingDataConfig": ...,
"outputDataConfig": ...,
}
parent.create_model_customization_job(**kwargs)
create_model_import_job#
Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker.
Type annotations and code completion for boto3.client("bedrock").create_model_import_job
method.
boto3 documentation
# create_model_import_job method definition
def create_model_import_job(
self,
*,
jobName: str,
importedModelName: str,
roleArn: str,
modelDataSource: ModelDataSourceTypeDef, # (1)
jobTags: Sequence[TagTypeDef] = ..., # (2)
importedModelTags: Sequence[TagTypeDef] = ..., # (2)
clientRequestToken: str = ...,
vpcConfig: VpcConfigUnionTypeDef = ..., # (4)
importedModelKmsKeyId: str = ...,
) -> CreateModelImportJobResponseTypeDef: # (5)
...
- See ModelDataSourceTypeDef
- See TagTypeDef
- See TagTypeDef
- See VpcConfigTypeDef VpcConfigOutputTypeDef
- See CreateModelImportJobResponseTypeDef
# create_model_import_job method usage example with argument unpacking
kwargs: CreateModelImportJobRequestTypeDef = { # (1)
"jobName": ...,
"importedModelName": ...,
"roleArn": ...,
"modelDataSource": ...,
}
parent.create_model_import_job(**kwargs)
create_model_invocation_job#
Creates a batch inference job to invoke a model on multiple prompts.
Type annotations and code completion for boto3.client("bedrock").create_model_invocation_job
method.
boto3 documentation
# create_model_invocation_job method definition
def create_model_invocation_job(
self,
*,
jobName: str,
roleArn: str,
modelId: str,
inputDataConfig: ModelInvocationJobInputDataConfigTypeDef, # (1)
outputDataConfig: ModelInvocationJobOutputDataConfigTypeDef, # (2)
clientRequestToken: str = ...,
vpcConfig: VpcConfigUnionTypeDef = ..., # (3)
timeoutDurationInHours: int = ...,
tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateModelInvocationJobResponseTypeDef: # (5)
...
- See ModelInvocationJobInputDataConfigTypeDef
- See ModelInvocationJobOutputDataConfigTypeDef
- See VpcConfigTypeDef VpcConfigOutputTypeDef
- See TagTypeDef
- See CreateModelInvocationJobResponseTypeDef
# create_model_invocation_job method usage example with argument unpacking
kwargs: CreateModelInvocationJobRequestTypeDef = { # (1)
"jobName": ...,
"roleArn": ...,
"modelId": ...,
"inputDataConfig": ...,
"outputDataConfig": ...,
}
parent.create_model_invocation_job(**kwargs)
create_provisioned_model_throughput#
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.
Type annotations and code completion for boto3.client("bedrock").create_provisioned_model_throughput
method.
boto3 documentation
# create_provisioned_model_throughput method definition
def create_provisioned_model_throughput(
self,
*,
modelUnits: int,
provisionedModelName: str,
modelId: str,
clientRequestToken: str = ...,
commitmentDuration: CommitmentDurationType = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateProvisionedModelThroughputResponseTypeDef: # (3)
...
# create_provisioned_model_throughput method usage example with argument unpacking
kwargs: CreateProvisionedModelThroughputRequestTypeDef = { # (1)
"modelUnits": ...,
"provisionedModelName": ...,
"modelId": ...,
}
parent.create_provisioned_model_throughput(**kwargs)
delete_custom_model#
Deletes a custom model that you created earlier.
Type annotations and code completion for boto3.client("bedrock").delete_custom_model
method.
boto3 documentation
# delete_custom_model method definition
def delete_custom_model(
self,
*,
modelIdentifier: str,
) -> Dict[str, Any]:
...
# delete_custom_model method usage example with argument unpacking
kwargs: DeleteCustomModelRequestTypeDef = { # (1)
"modelIdentifier": ...,
}
parent.delete_custom_model(**kwargs)
delete_guardrail#
Deletes a guardrail.
Type annotations and code completion for boto3.client("bedrock").delete_guardrail
method.
boto3 documentation
# delete_guardrail method definition
def delete_guardrail(
self,
*,
guardrailIdentifier: str,
guardrailVersion: str = ...,
) -> Dict[str, Any]:
...
# delete_guardrail method usage example with argument unpacking
kwargs: DeleteGuardrailRequestTypeDef = { # (1)
"guardrailIdentifier": ...,
}
parent.delete_guardrail(**kwargs)
delete_imported_model#
Deletes a custom model that you imported earlier.
Type annotations and code completion for boto3.client("bedrock").delete_imported_model
method.
boto3 documentation
# delete_imported_model method definition
def delete_imported_model(
self,
*,
modelIdentifier: str,
) -> Dict[str, Any]:
...
# delete_imported_model method usage example with argument unpacking
kwargs: DeleteImportedModelRequestTypeDef = { # (1)
"modelIdentifier": ...,
}
parent.delete_imported_model(**kwargs)
delete_inference_profile#
Deletes an application inference profile.
Type annotations and code completion for boto3.client("bedrock").delete_inference_profile
method.
boto3 documentation
# delete_inference_profile method definition
def delete_inference_profile(
self,
*,
inferenceProfileIdentifier: str,
) -> Dict[str, Any]:
...
# delete_inference_profile method usage example with argument unpacking
kwargs: DeleteInferenceProfileRequestTypeDef = { # (1)
"inferenceProfileIdentifier": ...,
}
parent.delete_inference_profile(**kwargs)
delete_marketplace_model_endpoint#
Deletes an endpoint for a model from Amazon Bedrock Marketplace.
Type annotations and code completion for boto3.client("bedrock").delete_marketplace_model_endpoint
method.
boto3 documentation
# delete_marketplace_model_endpoint method definition
def delete_marketplace_model_endpoint(
self,
*,
endpointArn: str,
) -> Dict[str, Any]:
...
# delete_marketplace_model_endpoint method usage example with argument unpacking
kwargs: DeleteMarketplaceModelEndpointRequestTypeDef = { # (1)
"endpointArn": ...,
}
parent.delete_marketplace_model_endpoint(**kwargs)
delete_model_invocation_logging_configuration#
Delete the invocation logging.
Type annotations and code completion for boto3.client("bedrock").delete_model_invocation_logging_configuration
method.
boto3 documentation
# delete_model_invocation_logging_configuration method definition
def delete_model_invocation_logging_configuration(
self,
) -> Dict[str, Any]:
...
delete_provisioned_model_throughput#
Deletes a Provisioned Throughput.
Type annotations and code completion for boto3.client("bedrock").delete_provisioned_model_throughput
method.
boto3 documentation
# delete_provisioned_model_throughput method definition
def delete_provisioned_model_throughput(
self,
*,
provisionedModelId: str,
) -> Dict[str, Any]:
...
# delete_provisioned_model_throughput method usage example with argument unpacking
kwargs: DeleteProvisionedModelThroughputRequestTypeDef = { # (1)
"provisionedModelId": ...,
}
parent.delete_provisioned_model_throughput(**kwargs)
deregister_marketplace_model_endpoint#
Deregisters an endpoint for a model from Amazon Bedrock Marketplace.
Type annotations and code completion for boto3.client("bedrock").deregister_marketplace_model_endpoint
method.
boto3 documentation
# deregister_marketplace_model_endpoint method definition
def deregister_marketplace_model_endpoint(
self,
*,
endpointArn: str,
) -> Dict[str, Any]:
...
# deregister_marketplace_model_endpoint method usage example with argument unpacking
kwargs: DeregisterMarketplaceModelEndpointRequestTypeDef = { # (1)
"endpointArn": ...,
}
parent.deregister_marketplace_model_endpoint(**kwargs)
get_custom_model#
Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service...
Type annotations and code completion for boto3.client("bedrock").get_custom_model
method.
boto3 documentation
# get_custom_model method definition
def get_custom_model(
self,
*,
modelIdentifier: str,
) -> GetCustomModelResponseTypeDef: # (1)
...
# get_custom_model method usage example with argument unpacking
kwargs: GetCustomModelRequestTypeDef = { # (1)
"modelIdentifier": ...,
}
parent.get_custom_model(**kwargs)
get_evaluation_job#
Gets information about an evaluation job, such as the status of the job.
Type annotations and code completion for boto3.client("bedrock").get_evaluation_job
method.
boto3 documentation
# get_evaluation_job method definition
def get_evaluation_job(
self,
*,
jobIdentifier: str,
) -> GetEvaluationJobResponseTypeDef: # (1)
...
# get_evaluation_job method usage example with argument unpacking
kwargs: GetEvaluationJobRequestTypeDef = { # (1)
"jobIdentifier": ...,
}
parent.get_evaluation_job(**kwargs)
get_foundation_model#
Get details about a Amazon Bedrock foundation model.
Type annotations and code completion for boto3.client("bedrock").get_foundation_model
method.
boto3 documentation
# get_foundation_model method definition
def get_foundation_model(
self,
*,
modelIdentifier: str,
) -> GetFoundationModelResponseTypeDef: # (1)
...
# get_foundation_model method usage example with argument unpacking
kwargs: GetFoundationModelRequestTypeDef = { # (1)
"modelIdentifier": ...,
}
parent.get_foundation_model(**kwargs)
get_guardrail#
Gets details about a guardrail.
Type annotations and code completion for boto3.client("bedrock").get_guardrail
method.
boto3 documentation
# get_guardrail method definition
def get_guardrail(
self,
*,
guardrailIdentifier: str,
guardrailVersion: str = ...,
) -> GetGuardrailResponseTypeDef: # (1)
...
# get_guardrail method usage example with argument unpacking
kwargs: GetGuardrailRequestTypeDef = { # (1)
"guardrailIdentifier": ...,
}
parent.get_guardrail(**kwargs)
get_imported_model#
Gets properties associated with a customized model you imported.
Type annotations and code completion for boto3.client("bedrock").get_imported_model
method.
boto3 documentation
# get_imported_model method definition
def get_imported_model(
self,
*,
modelIdentifier: str,
) -> GetImportedModelResponseTypeDef: # (1)
...
# get_imported_model method usage example with argument unpacking
kwargs: GetImportedModelRequestTypeDef = { # (1)
"modelIdentifier": ...,
}
parent.get_imported_model(**kwargs)
get_inference_profile#
Gets information about an inference profile.
Type annotations and code completion for boto3.client("bedrock").get_inference_profile
method.
boto3 documentation
# get_inference_profile method definition
def get_inference_profile(
self,
*,
inferenceProfileIdentifier: str,
) -> GetInferenceProfileResponseTypeDef: # (1)
...
# get_inference_profile method usage example with argument unpacking
kwargs: GetInferenceProfileRequestTypeDef = { # (1)
"inferenceProfileIdentifier": ...,
}
parent.get_inference_profile(**kwargs)
get_marketplace_model_endpoint#
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
Type annotations and code completion for boto3.client("bedrock").get_marketplace_model_endpoint
method.
boto3 documentation
# get_marketplace_model_endpoint method definition
def get_marketplace_model_endpoint(
self,
*,
endpointArn: str,
) -> GetMarketplaceModelEndpointResponseTypeDef: # (1)
...
# get_marketplace_model_endpoint method usage example with argument unpacking
kwargs: GetMarketplaceModelEndpointRequestTypeDef = { # (1)
"endpointArn": ...,
}
parent.get_marketplace_model_endpoint(**kwargs)
get_model_copy_job#
Retrieves information about a model copy job.
Type annotations and code completion for boto3.client("bedrock").get_model_copy_job
method.
boto3 documentation
# get_model_copy_job method definition
def get_model_copy_job(
self,
*,
jobArn: str,
) -> GetModelCopyJobResponseTypeDef: # (1)
...
# get_model_copy_job method usage example with argument unpacking
kwargs: GetModelCopyJobRequestTypeDef = { # (1)
"jobArn": ...,
}
parent.get_model_copy_job(**kwargs)
get_model_customization_job#
Retrieves the properties associated with a model-customization job, including the status of the job.
Type annotations and code completion for boto3.client("bedrock").get_model_customization_job
method.
boto3 documentation
# get_model_customization_job method definition
def get_model_customization_job(
self,
*,
jobIdentifier: str,
) -> GetModelCustomizationJobResponseTypeDef: # (1)
...
# get_model_customization_job method usage example with argument unpacking
kwargs: GetModelCustomizationJobRequestTypeDef = { # (1)
"jobIdentifier": ...,
}
parent.get_model_customization_job(**kwargs)
get_model_import_job#
Retrieves the properties associated with import model job, including the status of the job.
Type annotations and code completion for boto3.client("bedrock").get_model_import_job
method.
boto3 documentation
# get_model_import_job method definition
def get_model_import_job(
self,
*,
jobIdentifier: str,
) -> GetModelImportJobResponseTypeDef: # (1)
...
# get_model_import_job method usage example with argument unpacking
kwargs: GetModelImportJobRequestTypeDef = { # (1)
"jobIdentifier": ...,
}
parent.get_model_import_job(**kwargs)
get_model_invocation_job#
Gets details about a batch inference job.
Type annotations and code completion for boto3.client("bedrock").get_model_invocation_job
method.
boto3 documentation
# get_model_invocation_job method definition
def get_model_invocation_job(
self,
*,
jobIdentifier: str,
) -> GetModelInvocationJobResponseTypeDef: # (1)
...
# get_model_invocation_job method usage example with argument unpacking
kwargs: GetModelInvocationJobRequestTypeDef = { # (1)
"jobIdentifier": ...,
}
parent.get_model_invocation_job(**kwargs)
get_model_invocation_logging_configuration#
Get the current configuration values for model invocation logging.
Type annotations and code completion for boto3.client("bedrock").get_model_invocation_logging_configuration
method.
boto3 documentation
# get_model_invocation_logging_configuration method definition
def get_model_invocation_logging_configuration(
self,
) -> GetModelInvocationLoggingConfigurationResponseTypeDef: # (1)
...
get_prompt_router#
Retrieves details about a prompt router.
Type annotations and code completion for boto3.client("bedrock").get_prompt_router
method.
boto3 documentation
# get_prompt_router method definition
def get_prompt_router(
self,
*,
promptRouterArn: str,
) -> GetPromptRouterResponseTypeDef: # (1)
...
# get_prompt_router method usage example with argument unpacking
kwargs: GetPromptRouterRequestTypeDef = { # (1)
"promptRouterArn": ...,
}
parent.get_prompt_router(**kwargs)
get_provisioned_model_throughput#
Returns details for a Provisioned Throughput.
Type annotations and code completion for boto3.client("bedrock").get_provisioned_model_throughput
method.
boto3 documentation
# get_provisioned_model_throughput method definition
def get_provisioned_model_throughput(
self,
*,
provisionedModelId: str,
) -> GetProvisionedModelThroughputResponseTypeDef: # (1)
...
# get_provisioned_model_throughput method usage example with argument unpacking
kwargs: GetProvisionedModelThroughputRequestTypeDef = { # (1)
"provisionedModelId": ...,
}
parent.get_provisioned_model_throughput(**kwargs)
list_custom_models#
Returns a list of the custom models that you have created with the
CreateModelCustomizationJob
operation.
Type annotations and code completion for boto3.client("bedrock").list_custom_models
method.
boto3 documentation
# list_custom_models method definition
def list_custom_models(
self,
*,
creationTimeBefore: TimestampTypeDef = ...,
creationTimeAfter: TimestampTypeDef = ...,
nameContains: str = ...,
baseModelArnEquals: str = ...,
foundationModelArnEquals: str = ...,
maxResults: int = ...,
nextToken: str = ...,
sortBy: SortModelsByType = ..., # (1)
sortOrder: SortOrderType = ..., # (2)
isOwned: bool = ...,
) -> ListCustomModelsResponseTypeDef: # (3)
...
# list_custom_models method usage example with argument unpacking
kwargs: ListCustomModelsRequestTypeDef = { # (1)
"creationTimeBefore": ...,
}
parent.list_custom_models(**kwargs)
list_evaluation_jobs#
Lists all existing evaluation jobs.
Type annotations and code completion for boto3.client("bedrock").list_evaluation_jobs
method.
boto3 documentation
# list_evaluation_jobs method definition
def list_evaluation_jobs(
self,
*,
creationTimeAfter: TimestampTypeDef = ...,
creationTimeBefore: TimestampTypeDef = ...,
statusEquals: EvaluationJobStatusType = ..., # (1)
applicationTypeEquals: ApplicationTypeType = ..., # (2)
nameContains: str = ...,
maxResults: int = ...,
nextToken: str = ...,
sortBy: SortJobsByType = ..., # (3)
sortOrder: SortOrderType = ..., # (4)
) -> ListEvaluationJobsResponseTypeDef: # (5)
...
- See EvaluationJobStatusType
- See ApplicationTypeType
- See SortJobsByType
- See SortOrderType
- See ListEvaluationJobsResponseTypeDef
# list_evaluation_jobs method usage example with argument unpacking
kwargs: ListEvaluationJobsRequestTypeDef = { # (1)
"creationTimeAfter": ...,
}
parent.list_evaluation_jobs(**kwargs)
list_foundation_models#
Lists Amazon Bedrock foundation models that you can use.
Type annotations and code completion for boto3.client("bedrock").list_foundation_models
method.
boto3 documentation
# list_foundation_models method definition
def list_foundation_models(
self,
*,
byProvider: str = ...,
byCustomizationType: ModelCustomizationType = ..., # (1)
byOutputModality: ModelModalityType = ..., # (2)
byInferenceType: InferenceTypeType = ..., # (3)
) -> ListFoundationModelsResponseTypeDef: # (4)
...
- See ModelCustomizationType
- See ModelModalityType
- See InferenceTypeType
- See ListFoundationModelsResponseTypeDef
# list_foundation_models method usage example with argument unpacking
kwargs: ListFoundationModelsRequestTypeDef = { # (1)
"byProvider": ...,
}
parent.list_foundation_models(**kwargs)
list_guardrails#
Lists details about all the guardrails in an account.
Type annotations and code completion for boto3.client("bedrock").list_guardrails
method.
boto3 documentation
# list_guardrails method definition
def list_guardrails(
self,
*,
guardrailIdentifier: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListGuardrailsResponseTypeDef: # (1)
...
# list_guardrails method usage example with argument unpacking
kwargs: ListGuardrailsRequestTypeDef = { # (1)
"guardrailIdentifier": ...,
}
parent.list_guardrails(**kwargs)
list_imported_models#
Returns a list of models you've imported.
Type annotations and code completion for boto3.client("bedrock").list_imported_models
method.
boto3 documentation
# list_imported_models method definition
def list_imported_models(
self,
*,
creationTimeBefore: TimestampTypeDef = ...,
creationTimeAfter: TimestampTypeDef = ...,
nameContains: str = ...,
maxResults: int = ...,
nextToken: str = ...,
sortBy: SortModelsByType = ..., # (1)
sortOrder: SortOrderType = ..., # (2)
) -> ListImportedModelsResponseTypeDef: # (3)
...
# list_imported_models method usage example with argument unpacking
kwargs: ListImportedModelsRequestTypeDef = { # (1)
"creationTimeBefore": ...,
}
parent.list_imported_models(**kwargs)
list_inference_profiles#
Returns a list of inference profiles that you can use.
Type annotations and code completion for boto3.client("bedrock").list_inference_profiles
method.
boto3 documentation
# list_inference_profiles method definition
def list_inference_profiles(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
typeEquals: InferenceProfileTypeType = ..., # (1)
) -> ListInferenceProfilesResponseTypeDef: # (2)
...
# list_inference_profiles method usage example with argument unpacking
kwargs: ListInferenceProfilesRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_inference_profiles(**kwargs)
list_marketplace_model_endpoints#
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
Type annotations and code completion for boto3.client("bedrock").list_marketplace_model_endpoints
method.
boto3 documentation
# list_marketplace_model_endpoints method definition
def list_marketplace_model_endpoints(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
modelSourceEquals: str = ...,
) -> ListMarketplaceModelEndpointsResponseTypeDef: # (1)
...
# list_marketplace_model_endpoints method usage example with argument unpacking
kwargs: ListMarketplaceModelEndpointsRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_marketplace_model_endpoints(**kwargs)
list_model_copy_jobs#
Returns a list of model copy jobs that you have submitted.
Type annotations and code completion for boto3.client("bedrock").list_model_copy_jobs
method.
boto3 documentation
# list_model_copy_jobs method definition
def list_model_copy_jobs(
self,
*,
creationTimeAfter: TimestampTypeDef = ...,
creationTimeBefore: TimestampTypeDef = ...,
statusEquals: ModelCopyJobStatusType = ..., # (1)
sourceAccountEquals: str = ...,
sourceModelArnEquals: str = ...,
targetModelNameContains: str = ...,
maxResults: int = ...,
nextToken: str = ...,
sortBy: SortJobsByType = ..., # (2)
sortOrder: SortOrderType = ..., # (3)
) -> ListModelCopyJobsResponseTypeDef: # (4)
...
- See ModelCopyJobStatusType
- See SortJobsByType
- See SortOrderType
- See ListModelCopyJobsResponseTypeDef
# list_model_copy_jobs method usage example with argument unpacking
kwargs: ListModelCopyJobsRequestTypeDef = { # (1)
"creationTimeAfter": ...,
}
parent.list_model_copy_jobs(**kwargs)
list_model_customization_jobs#
Returns a list of model customization jobs that you have submitted.
Type annotations and code completion for boto3.client("bedrock").list_model_customization_jobs
method.
boto3 documentation
# list_model_customization_jobs method definition
def list_model_customization_jobs(
self,
*,
creationTimeAfter: TimestampTypeDef = ...,
creationTimeBefore: TimestampTypeDef = ...,
statusEquals: FineTuningJobStatusType = ..., # (1)
nameContains: str = ...,
maxResults: int = ...,
nextToken: str = ...,
sortBy: SortJobsByType = ..., # (2)
sortOrder: SortOrderType = ..., # (3)
) -> ListModelCustomizationJobsResponseTypeDef: # (4)
...
- See FineTuningJobStatusType
- See SortJobsByType
- See SortOrderType
- See ListModelCustomizationJobsResponseTypeDef
# list_model_customization_jobs method usage example with argument unpacking
kwargs: ListModelCustomizationJobsRequestTypeDef = { # (1)
"creationTimeAfter": ...,
}
parent.list_model_customization_jobs(**kwargs)
list_model_import_jobs#
Returns a list of import jobs you've submitted.
Type annotations and code completion for boto3.client("bedrock").list_model_import_jobs
method.
boto3 documentation
# list_model_import_jobs method definition
def list_model_import_jobs(
self,
*,
creationTimeAfter: TimestampTypeDef = ...,
creationTimeBefore: TimestampTypeDef = ...,
statusEquals: ModelImportJobStatusType = ..., # (1)
nameContains: str = ...,
maxResults: int = ...,
nextToken: str = ...,
sortBy: SortJobsByType = ..., # (2)
sortOrder: SortOrderType = ..., # (3)
) -> ListModelImportJobsResponseTypeDef: # (4)
...
- See ModelImportJobStatusType
- See SortJobsByType
- See SortOrderType
- See ListModelImportJobsResponseTypeDef
# list_model_import_jobs method usage example with argument unpacking
kwargs: ListModelImportJobsRequestTypeDef = { # (1)
"creationTimeAfter": ...,
}
parent.list_model_import_jobs(**kwargs)
list_model_invocation_jobs#
Lists all batch inference jobs in the account.
Type annotations and code completion for boto3.client("bedrock").list_model_invocation_jobs
method.
boto3 documentation
# list_model_invocation_jobs method definition
def list_model_invocation_jobs(
self,
*,
submitTimeAfter: TimestampTypeDef = ...,
submitTimeBefore: TimestampTypeDef = ...,
statusEquals: ModelInvocationJobStatusType = ..., # (1)
nameContains: str = ...,
maxResults: int = ...,
nextToken: str = ...,
sortBy: SortJobsByType = ..., # (2)
sortOrder: SortOrderType = ..., # (3)
) -> ListModelInvocationJobsResponseTypeDef: # (4)
...
- See ModelInvocationJobStatusType
- See SortJobsByType
- See SortOrderType
- See ListModelInvocationJobsResponseTypeDef
# list_model_invocation_jobs method usage example with argument unpacking
kwargs: ListModelInvocationJobsRequestTypeDef = { # (1)
"submitTimeAfter": ...,
}
parent.list_model_invocation_jobs(**kwargs)
list_prompt_routers#
Retrieves a list of prompt routers.
Type annotations and code completion for boto3.client("bedrock").list_prompt_routers
method.
boto3 documentation
# list_prompt_routers method definition
def list_prompt_routers(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListPromptRoutersResponseTypeDef: # (1)
...
# list_prompt_routers method usage example with argument unpacking
kwargs: ListPromptRoutersRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_prompt_routers(**kwargs)
list_provisioned_model_throughputs#
Lists the Provisioned Throughputs in the account.
Type annotations and code completion for boto3.client("bedrock").list_provisioned_model_throughputs
method.
boto3 documentation
# list_provisioned_model_throughputs method definition
def list_provisioned_model_throughputs(
self,
*,
creationTimeAfter: TimestampTypeDef = ...,
creationTimeBefore: TimestampTypeDef = ...,
statusEquals: ProvisionedModelStatusType = ..., # (1)
modelArnEquals: str = ...,
nameContains: str = ...,
maxResults: int = ...,
nextToken: str = ...,
sortBy: SortByProvisionedModelsType = ..., # (2)
sortOrder: SortOrderType = ..., # (3)
) -> ListProvisionedModelThroughputsResponseTypeDef: # (4)
...
- See ProvisionedModelStatusType
- See SortByProvisionedModelsType
- See SortOrderType
- See ListProvisionedModelThroughputsResponseTypeDef
# list_provisioned_model_throughputs method usage example with argument unpacking
kwargs: ListProvisionedModelThroughputsRequestTypeDef = { # (1)
"creationTimeAfter": ...,
}
parent.list_provisioned_model_throughputs(**kwargs)
list_tags_for_resource#
List the tags associated with the specified resource.
Type annotations and code completion for boto3.client("bedrock").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = { # (1)
"resourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
put_model_invocation_logging_configuration#
Set the configuration values for model invocation logging.
Type annotations and code completion for boto3.client("bedrock").put_model_invocation_logging_configuration
method.
boto3 documentation
# put_model_invocation_logging_configuration method definition
def put_model_invocation_logging_configuration(
self,
*,
loggingConfig: LoggingConfigTypeDef, # (1)
) -> Dict[str, Any]:
...
# put_model_invocation_logging_configuration method usage example with argument unpacking
kwargs: PutModelInvocationLoggingConfigurationRequestTypeDef = { # (1)
"loggingConfig": ...,
}
parent.put_model_invocation_logging_configuration(**kwargs)
register_marketplace_model_endpoint#
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
Type annotations and code completion for boto3.client("bedrock").register_marketplace_model_endpoint
method.
boto3 documentation
# register_marketplace_model_endpoint method definition
def register_marketplace_model_endpoint(
self,
*,
endpointIdentifier: str,
modelSourceIdentifier: str,
) -> RegisterMarketplaceModelEndpointResponseTypeDef: # (1)
...
# register_marketplace_model_endpoint method usage example with argument unpacking
kwargs: RegisterMarketplaceModelEndpointRequestTypeDef = { # (1)
"endpointIdentifier": ...,
"modelSourceIdentifier": ...,
}
parent.register_marketplace_model_endpoint(**kwargs)
stop_evaluation_job#
Stops an evaluation job that is current being created or running.
Type annotations and code completion for boto3.client("bedrock").stop_evaluation_job
method.
boto3 documentation
# stop_evaluation_job method definition
def stop_evaluation_job(
self,
*,
jobIdentifier: str,
) -> Dict[str, Any]:
...
# stop_evaluation_job method usage example with argument unpacking
kwargs: StopEvaluationJobRequestTypeDef = { # (1)
"jobIdentifier": ...,
}
parent.stop_evaluation_job(**kwargs)
stop_model_customization_job#
Stops an active model customization job.
Type annotations and code completion for boto3.client("bedrock").stop_model_customization_job
method.
boto3 documentation
# stop_model_customization_job method definition
def stop_model_customization_job(
self,
*,
jobIdentifier: str,
) -> Dict[str, Any]:
...
# stop_model_customization_job method usage example with argument unpacking
kwargs: StopModelCustomizationJobRequestTypeDef = { # (1)
"jobIdentifier": ...,
}
parent.stop_model_customization_job(**kwargs)
stop_model_invocation_job#
Stops a batch inference job.
Type annotations and code completion for boto3.client("bedrock").stop_model_invocation_job
method.
boto3 documentation
# stop_model_invocation_job method definition
def stop_model_invocation_job(
self,
*,
jobIdentifier: str,
) -> Dict[str, Any]:
...
# stop_model_invocation_job method usage example with argument unpacking
kwargs: StopModelInvocationJobRequestTypeDef = { # (1)
"jobIdentifier": ...,
}
parent.stop_model_invocation_job(**kwargs)
tag_resource#
Associate tags with a resource.
Type annotations and code completion for boto3.client("bedrock").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceARN: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = { # (1)
"resourceARN": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Remove one or more tags from a resource.
Type annotations and code completion for boto3.client("bedrock").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceARN: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = { # (1)
"resourceARN": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_guardrail#
Updates a guardrail with the values you specify.
Type annotations and code completion for boto3.client("bedrock").update_guardrail
method.
boto3 documentation
# update_guardrail method definition
def update_guardrail(
self,
*,
guardrailIdentifier: str,
name: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
description: str = ...,
topicPolicyConfig: GuardrailTopicPolicyConfigTypeDef = ..., # (1)
contentPolicyConfig: GuardrailContentPolicyConfigTypeDef = ..., # (2)
wordPolicyConfig: GuardrailWordPolicyConfigTypeDef = ..., # (3)
sensitiveInformationPolicyConfig: GuardrailSensitiveInformationPolicyConfigTypeDef = ..., # (4)
contextualGroundingPolicyConfig: GuardrailContextualGroundingPolicyConfigTypeDef = ..., # (5)
kmsKeyId: str = ...,
) -> UpdateGuardrailResponseTypeDef: # (6)
...
- See GuardrailTopicPolicyConfigTypeDef
- See GuardrailContentPolicyConfigTypeDef
- See GuardrailWordPolicyConfigTypeDef
- See GuardrailSensitiveInformationPolicyConfigTypeDef
- See GuardrailContextualGroundingPolicyConfigTypeDef
- See UpdateGuardrailResponseTypeDef
# update_guardrail method usage example with argument unpacking
kwargs: UpdateGuardrailRequestTypeDef = { # (1)
"guardrailIdentifier": ...,
"name": ...,
"blockedInputMessaging": ...,
"blockedOutputsMessaging": ...,
}
parent.update_guardrail(**kwargs)
update_marketplace_model_endpoint#
Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
Type annotations and code completion for boto3.client("bedrock").update_marketplace_model_endpoint
method.
boto3 documentation
# update_marketplace_model_endpoint method definition
def update_marketplace_model_endpoint(
self,
*,
endpointArn: str,
endpointConfig: EndpointConfigUnionTypeDef, # (1)
clientRequestToken: str = ...,
) -> UpdateMarketplaceModelEndpointResponseTypeDef: # (2)
...
- See EndpointConfigTypeDef EndpointConfigOutputTypeDef
- See UpdateMarketplaceModelEndpointResponseTypeDef
# update_marketplace_model_endpoint method usage example with argument unpacking
kwargs: UpdateMarketplaceModelEndpointRequestTypeDef = { # (1)
"endpointArn": ...,
"endpointConfig": ...,
}
parent.update_marketplace_model_endpoint(**kwargs)
update_provisioned_model_throughput#
Updates the name or associated model for a Provisioned Throughput.
Type annotations and code completion for boto3.client("bedrock").update_provisioned_model_throughput
method.
boto3 documentation
# update_provisioned_model_throughput method definition
def update_provisioned_model_throughput(
self,
*,
provisionedModelId: str,
desiredProvisionedModelName: str = ...,
desiredModelId: str = ...,
) -> Dict[str, Any]:
...
# update_provisioned_model_throughput method usage example with argument unpacking
kwargs: UpdateProvisionedModelThroughputRequestTypeDef = { # (1)
"provisionedModelId": ...,
}
parent.update_provisioned_model_throughput(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("bedrock").get_paginator
method with overloads.
client.get_paginator("list_custom_models")
-> ListCustomModelsPaginatorclient.get_paginator("list_evaluation_jobs")
-> ListEvaluationJobsPaginatorclient.get_paginator("list_guardrails")
-> ListGuardrailsPaginatorclient.get_paginator("list_imported_models")
-> ListImportedModelsPaginatorclient.get_paginator("list_inference_profiles")
-> ListInferenceProfilesPaginatorclient.get_paginator("list_marketplace_model_endpoints")
-> ListMarketplaceModelEndpointsPaginatorclient.get_paginator("list_model_copy_jobs")
-> ListModelCopyJobsPaginatorclient.get_paginator("list_model_customization_jobs")
-> ListModelCustomizationJobsPaginatorclient.get_paginator("list_model_import_jobs")
-> ListModelImportJobsPaginatorclient.get_paginator("list_model_invocation_jobs")
-> ListModelInvocationJobsPaginatorclient.get_paginator("list_prompt_routers")
-> ListPromptRoutersPaginatorclient.get_paginator("list_provisioned_model_throughputs")
-> ListProvisionedModelThroughputsPaginator