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#

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_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_provisioned_model_throughput#

Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.

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_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 Bedrock User Guide.

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_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_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_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#

Get 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: Union[datetime, str] = ...,
    creationTimeAfter: Union[datetime, str] = ...,
    nameContains: str = ...,
    baseModelArnEquals: str = ...,
    foundationModelArnEquals: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    sortBy: SortModelsByType = ...,  # (1)
    sortOrder: SortOrderType = ...,  # (2)
) -> 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_foundation_models#

List of 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_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.