Skip to content

BedrockClient#

Index > Bedrock > 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.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#

batch_delete_evaluation_job#

Creates a batch deletion job.

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)
    ...
  1. See BatchDeleteEvaluationJobResponseTypeDef 
# batch_delete_evaluation_job method usage example with argument unpacking

kwargs: BatchDeleteEvaluationJobRequestRequestTypeDef = {  # (1)
    "jobIdentifiers": ...,
}

parent.batch_delete_evaluation_job(**kwargs)
  1. See BatchDeleteEvaluationJobRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("bedrock").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_evaluation_job#

API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.

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: EvaluationConfigTypeDef,  # (1)
    inferenceConfig: EvaluationInferenceConfigTypeDef,  # (2)
    outputDataConfig: EvaluationOutputDataConfigTypeDef,  # (3)
    jobDescription: str = ...,
    clientRequestToken: str = ...,
    customerEncryptionKeyId: str = ...,
    jobTags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateEvaluationJobResponseTypeDef:  # (5)
    ...
  1. See EvaluationConfigTypeDef
  2. See EvaluationInferenceConfigTypeDef
  3. See EvaluationOutputDataConfigTypeDef
  4. See TagTypeDef
  5. See CreateEvaluationJobResponseTypeDef 
# create_evaluation_job method usage example with argument unpacking

kwargs: CreateEvaluationJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "roleArn": ...,
    "evaluationConfig": ...,
    "inferenceConfig": ...,
    "outputDataConfig": ...,
}

parent.create_evaluation_job(**kwargs)
  1. See CreateEvaluationJobRequestRequestTypeDef

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)
    ...
  1. See GuardrailTopicPolicyConfigTypeDef
  2. See GuardrailContentPolicyConfigTypeDef
  3. See GuardrailWordPolicyConfigTypeDef
  4. See GuardrailSensitiveInformationPolicyConfigTypeDef
  5. See GuardrailContextualGroundingPolicyConfigTypeDef
  6. See TagTypeDef
  7. See CreateGuardrailResponseTypeDef 
# create_guardrail method usage example with argument unpacking

kwargs: CreateGuardrailRequestRequestTypeDef = {  # (1)
    "name": ...,
    "blockedInputMessaging": ...,
    "blockedOutputsMessaging": ...,
}

parent.create_guardrail(**kwargs)
  1. See CreateGuardrailRequestRequestTypeDef

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)
    ...
  1. See CreateGuardrailVersionResponseTypeDef 
# create_guardrail_version method usage example with argument unpacking

kwargs: CreateGuardrailVersionRequestRequestTypeDef = {  # (1)
    "guardrailIdentifier": ...,
}

parent.create_guardrail_version(**kwargs)
  1. See CreateGuardrailVersionRequestRequestTypeDef

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)
    ...
  1. See InferenceProfileModelSourceTypeDef
  2. See TagTypeDef
  3. See CreateInferenceProfileResponseTypeDef 
# create_inference_profile method usage example with argument unpacking

kwargs: CreateInferenceProfileRequestRequestTypeDef = {  # (1)
    "inferenceProfileName": ...,
    "modelSource": ...,
}

parent.create_inference_profile(**kwargs)
  1. See CreateInferenceProfileRequestRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateModelCopyJobResponseTypeDef 
# create_model_copy_job method usage example with argument unpacking

kwargs: CreateModelCopyJobRequestRequestTypeDef = {  # (1)
    "sourceModelArn": ...,
    "targetModelName": ...,
}

parent.create_model_copy_job(**kwargs)
  1. See CreateModelCopyJobRequestRequestTypeDef

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: TrainingDataConfigTypeDef,  # (1)
    outputDataConfig: OutputDataConfigTypeDef,  # (2)
    hyperParameters: Mapping[str, str],
    clientRequestToken: str = ...,
    customizationType: CustomizationTypeType = ...,  # (3)
    customModelKmsKeyId: str = ...,
    jobTags: Sequence[TagTypeDef] = ...,  # (4)
    customModelTags: Sequence[TagTypeDef] = ...,  # (4)
    validationDataConfig: ValidationDataConfigTypeDef = ...,  # (6)
    vpcConfig: VpcConfigTypeDef = ...,  # (7)
) -> CreateModelCustomizationJobResponseTypeDef:  # (8)
    ...
  1. See TrainingDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See CustomizationTypeType
  4. See TagTypeDef
  5. See TagTypeDef
  6. See ValidationDataConfigTypeDef
  7. See VpcConfigTypeDef
  8. See CreateModelCustomizationJobResponseTypeDef 
# create_model_customization_job method usage example with argument unpacking

kwargs: CreateModelCustomizationJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "customModelName": ...,
    "roleArn": ...,
    "baseModelIdentifier": ...,
    "trainingDataConfig": ...,
    "outputDataConfig": ...,
    "hyperParameters": ...,
}

parent.create_model_customization_job(**kwargs)
  1. See CreateModelCustomizationJobRequestRequestTypeDef

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: VpcConfigTypeDef = ...,  # (4)
    importedModelKmsKeyId: str = ...,
) -> CreateModelImportJobResponseTypeDef:  # (5)
    ...
  1. See ModelDataSourceTypeDef
  2. See TagTypeDef
  3. See TagTypeDef
  4. See VpcConfigTypeDef
  5. See CreateModelImportJobResponseTypeDef 
# create_model_import_job method usage example with argument unpacking

kwargs: CreateModelImportJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "importedModelName": ...,
    "roleArn": ...,
    "modelDataSource": ...,
}

parent.create_model_import_job(**kwargs)
  1. See CreateModelImportJobRequestRequestTypeDef

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: VpcConfigTypeDef = ...,  # (3)
    timeoutDurationInHours: int = ...,
    tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateModelInvocationJobResponseTypeDef:  # (5)
    ...
  1. See ModelInvocationJobInputDataConfigTypeDef
  2. See ModelInvocationJobOutputDataConfigTypeDef
  3. See VpcConfigTypeDef
  4. See TagTypeDef
  5. See CreateModelInvocationJobResponseTypeDef 
# create_model_invocation_job method usage example with argument unpacking

kwargs: CreateModelInvocationJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "roleArn": ...,
    "modelId": ...,
    "inputDataConfig": ...,
    "outputDataConfig": ...,
}

parent.create_model_invocation_job(**kwargs)
  1. See CreateModelInvocationJobRequestRequestTypeDef

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)
    ...
  1. See CommitmentDurationType
  2. See TagTypeDef
  3. See CreateProvisionedModelThroughputResponseTypeDef 
# create_provisioned_model_throughput method usage example with argument unpacking

kwargs: CreateProvisionedModelThroughputRequestRequestTypeDef = {  # (1)
    "modelUnits": ...,
    "provisionedModelName": ...,
    "modelId": ...,
}

parent.create_provisioned_model_throughput(**kwargs)
  1. See CreateProvisionedModelThroughputRequestRequestTypeDef

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: DeleteCustomModelRequestRequestTypeDef = {  # (1)
    "modelIdentifier": ...,
}

parent.delete_custom_model(**kwargs)
  1. See DeleteCustomModelRequestRequestTypeDef

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: DeleteGuardrailRequestRequestTypeDef = {  # (1)
    "guardrailIdentifier": ...,
}

parent.delete_guardrail(**kwargs)
  1. See DeleteGuardrailRequestRequestTypeDef

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: DeleteImportedModelRequestRequestTypeDef = {  # (1)
    "modelIdentifier": ...,
}

parent.delete_imported_model(**kwargs)
  1. See DeleteImportedModelRequestRequestTypeDef

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: DeleteInferenceProfileRequestRequestTypeDef = {  # (1)
    "inferenceProfileIdentifier": ...,
}

parent.delete_inference_profile(**kwargs)
  1. See DeleteInferenceProfileRequestRequestTypeDef

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: DeleteProvisionedModelThroughputRequestRequestTypeDef = {  # (1)
    "provisionedModelId": ...,
}

parent.delete_provisioned_model_throughput(**kwargs)
  1. See DeleteProvisionedModelThroughputRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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:
    ...

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 Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/what....

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)
    ...
  1. See GetCustomModelResponseTypeDef 
# get_custom_model method usage example with argument unpacking

kwargs: GetCustomModelRequestRequestTypeDef = {  # (1)
    "modelIdentifier": ...,
}

parent.get_custom_model(**kwargs)
  1. See GetCustomModelRequestRequestTypeDef

get_evaluation_job#

Retrieves the properties associated with a model evaluation job, including 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)
    ...
  1. See GetEvaluationJobResponseTypeDef 
# get_evaluation_job method usage example with argument unpacking

kwargs: GetEvaluationJobRequestRequestTypeDef = {  # (1)
    "jobIdentifier": ...,
}

parent.get_evaluation_job(**kwargs)
  1. See GetEvaluationJobRequestRequestTypeDef

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)
    ...
  1. See GetFoundationModelResponseTypeDef 
# get_foundation_model method usage example with argument unpacking

kwargs: GetFoundationModelRequestRequestTypeDef = {  # (1)
    "modelIdentifier": ...,
}

parent.get_foundation_model(**kwargs)
  1. See GetFoundationModelRequestRequestTypeDef

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)
    ...
  1. See GetGuardrailResponseTypeDef 
# get_guardrail method usage example with argument unpacking

kwargs: GetGuardrailRequestRequestTypeDef = {  # (1)
    "guardrailIdentifier": ...,
}

parent.get_guardrail(**kwargs)
  1. See GetGuardrailRequestRequestTypeDef

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)
    ...
  1. See GetImportedModelResponseTypeDef 
# get_imported_model method usage example with argument unpacking

kwargs: GetImportedModelRequestRequestTypeDef = {  # (1)
    "modelIdentifier": ...,
}

parent.get_imported_model(**kwargs)
  1. See GetImportedModelRequestRequestTypeDef

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)
    ...
  1. See GetInferenceProfileResponseTypeDef 
# get_inference_profile method usage example with argument unpacking

kwargs: GetInferenceProfileRequestRequestTypeDef = {  # (1)
    "inferenceProfileIdentifier": ...,
}

parent.get_inference_profile(**kwargs)
  1. See GetInferenceProfileRequestRequestTypeDef

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)
    ...
  1. See GetModelCopyJobResponseTypeDef 
# get_model_copy_job method usage example with argument unpacking

kwargs: GetModelCopyJobRequestRequestTypeDef = {  # (1)
    "jobArn": ...,
}

parent.get_model_copy_job(**kwargs)
  1. See GetModelCopyJobRequestRequestTypeDef

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)
    ...
  1. See GetModelCustomizationJobResponseTypeDef 
# get_model_customization_job method usage example with argument unpacking

kwargs: GetModelCustomizationJobRequestRequestTypeDef = {  # (1)
    "jobIdentifier": ...,
}

parent.get_model_customization_job(**kwargs)
  1. See GetModelCustomizationJobRequestRequestTypeDef

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)
    ...
  1. See GetModelImportJobResponseTypeDef 
# get_model_import_job method usage example with argument unpacking

kwargs: GetModelImportJobRequestRequestTypeDef = {  # (1)
    "jobIdentifier": ...,
}

parent.get_model_import_job(**kwargs)
  1. See GetModelImportJobRequestRequestTypeDef

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)
    ...
  1. See GetModelInvocationJobResponseTypeDef 
# get_model_invocation_job method usage example with argument unpacking

kwargs: GetModelInvocationJobRequestRequestTypeDef = {  # (1)
    "jobIdentifier": ...,
}

parent.get_model_invocation_job(**kwargs)
  1. See GetModelInvocationJobRequestRequestTypeDef

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)
    ...
  1. See GetModelInvocationLoggingConfigurationResponseTypeDef

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)
    ...
  1. See GetProvisionedModelThroughputResponseTypeDef 
# get_provisioned_model_throughput method usage example with argument unpacking

kwargs: GetProvisionedModelThroughputRequestRequestTypeDef = {  # (1)
    "provisionedModelId": ...,
}

parent.get_provisioned_model_throughput(**kwargs)
  1. See GetProvisionedModelThroughputRequestRequestTypeDef

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)
    ...
  1. See SortModelsByType
  2. See SortOrderType
  3. See ListCustomModelsResponseTypeDef 
# list_custom_models method usage example with argument unpacking

kwargs: ListCustomModelsRequestRequestTypeDef = {  # (1)
    "creationTimeBefore": ...,
}

parent.list_custom_models(**kwargs)
  1. See ListCustomModelsRequestRequestTypeDef

list_evaluation_jobs#

Lists model 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)
    nameContains: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    sortBy: SortJobsByType = ...,  # (2)
    sortOrder: SortOrderType = ...,  # (3)
) -> ListEvaluationJobsResponseTypeDef:  # (4)
    ...
  1. See EvaluationJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See ListEvaluationJobsResponseTypeDef 
# list_evaluation_jobs method usage example with argument unpacking

kwargs: ListEvaluationJobsRequestRequestTypeDef = {  # (1)
    "creationTimeAfter": ...,
}

parent.list_evaluation_jobs(**kwargs)
  1. See ListEvaluationJobsRequestRequestTypeDef

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)
    ...
  1. See ModelCustomizationType
  2. See ModelModalityType
  3. See InferenceTypeType
  4. See ListFoundationModelsResponseTypeDef 
# list_foundation_models method usage example with argument unpacking

kwargs: ListFoundationModelsRequestRequestTypeDef = {  # (1)
    "byProvider": ...,
}

parent.list_foundation_models(**kwargs)
  1. See ListFoundationModelsRequestRequestTypeDef

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)
    ...
  1. See ListGuardrailsResponseTypeDef 
# list_guardrails method usage example with argument unpacking

kwargs: ListGuardrailsRequestRequestTypeDef = {  # (1)
    "guardrailIdentifier": ...,
}

parent.list_guardrails(**kwargs)
  1. See ListGuardrailsRequestRequestTypeDef

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)
    ...
  1. See SortModelsByType
  2. See SortOrderType
  3. See ListImportedModelsResponseTypeDef 
# list_imported_models method usage example with argument unpacking

kwargs: ListImportedModelsRequestRequestTypeDef = {  # (1)
    "creationTimeBefore": ...,
}

parent.list_imported_models(**kwargs)
  1. See ListImportedModelsRequestRequestTypeDef

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)
    ...
  1. See InferenceProfileTypeType
  2. See ListInferenceProfilesResponseTypeDef 
# list_inference_profiles method usage example with argument unpacking

kwargs: ListInferenceProfilesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_inference_profiles(**kwargs)
  1. See ListInferenceProfilesRequestRequestTypeDef

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)
    ...
  1. See ModelCopyJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See ListModelCopyJobsResponseTypeDef 
# list_model_copy_jobs method usage example with argument unpacking

kwargs: ListModelCopyJobsRequestRequestTypeDef = {  # (1)
    "creationTimeAfter": ...,
}

parent.list_model_copy_jobs(**kwargs)
  1. See ListModelCopyJobsRequestRequestTypeDef

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)
    ...
  1. See FineTuningJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See ListModelCustomizationJobsResponseTypeDef 
# list_model_customization_jobs method usage example with argument unpacking

kwargs: ListModelCustomizationJobsRequestRequestTypeDef = {  # (1)
    "creationTimeAfter": ...,
}

parent.list_model_customization_jobs(**kwargs)
  1. See ListModelCustomizationJobsRequestRequestTypeDef

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)
    ...
  1. See ModelImportJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See ListModelImportJobsResponseTypeDef 
# list_model_import_jobs method usage example with argument unpacking

kwargs: ListModelImportJobsRequestRequestTypeDef = {  # (1)
    "creationTimeAfter": ...,
}

parent.list_model_import_jobs(**kwargs)
  1. See ListModelImportJobsRequestRequestTypeDef

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)
    ...
  1. See ModelInvocationJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See ListModelInvocationJobsResponseTypeDef 
# list_model_invocation_jobs method usage example with argument unpacking

kwargs: ListModelInvocationJobsRequestRequestTypeDef = {  # (1)
    "submitTimeAfter": ...,
}

parent.list_model_invocation_jobs(**kwargs)
  1. See ListModelInvocationJobsRequestRequestTypeDef

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)
    ...
  1. See ProvisionedModelStatusType
  2. See SortByProvisionedModelsType
  3. See SortOrderType
  4. See ListProvisionedModelThroughputsResponseTypeDef 
# list_provisioned_model_throughputs method usage example with argument unpacking

kwargs: ListProvisionedModelThroughputsRequestRequestTypeDef = {  # (1)
    "creationTimeAfter": ...,
}

parent.list_provisioned_model_throughputs(**kwargs)
  1. See ListProvisionedModelThroughputsRequestRequestTypeDef

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)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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]:
    ...
  1. See LoggingConfigTypeDef 
# put_model_invocation_logging_configuration method usage example with argument unpacking

kwargs: PutModelInvocationLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "loggingConfig": ...,
}

parent.put_model_invocation_logging_configuration(**kwargs)
  1. See PutModelInvocationLoggingConfigurationRequestRequestTypeDef

stop_evaluation_job#

Stops an in progress model evaluation job.

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: StopEvaluationJobRequestRequestTypeDef = {  # (1)
    "jobIdentifier": ...,
}

parent.stop_evaluation_job(**kwargs)
  1. See StopEvaluationJobRequestRequestTypeDef

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: StopModelCustomizationJobRequestRequestTypeDef = {  # (1)
    "jobIdentifier": ...,
}

parent.stop_model_customization_job(**kwargs)
  1. See StopModelCustomizationJobRequestRequestTypeDef

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: StopModelInvocationJobRequestRequestTypeDef = {  # (1)
    "jobIdentifier": ...,
}

parent.stop_model_invocation_job(**kwargs)
  1. See StopModelInvocationJobRequestRequestTypeDef

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]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

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: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceARN": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

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)
    ...
  1. See GuardrailTopicPolicyConfigTypeDef
  2. See GuardrailContentPolicyConfigTypeDef
  3. See GuardrailWordPolicyConfigTypeDef
  4. See GuardrailSensitiveInformationPolicyConfigTypeDef
  5. See GuardrailContextualGroundingPolicyConfigTypeDef
  6. See UpdateGuardrailResponseTypeDef 
# update_guardrail method usage example with argument unpacking

kwargs: UpdateGuardrailRequestRequestTypeDef = {  # (1)
    "guardrailIdentifier": ...,
    "name": ...,
    "blockedInputMessaging": ...,
    "blockedOutputsMessaging": ...,
}

parent.update_guardrail(**kwargs)
  1. See UpdateGuardrailRequestRequestTypeDef

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: UpdateProvisionedModelThroughputRequestRequestTypeDef = {  # (1)
    "provisionedModelId": ...,
}

parent.update_provisioned_model_throughput(**kwargs)
  1. See UpdateProvisionedModelThroughputRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("bedrock").get_paginator method with overloads.