Skip to content

create_model_copy_job

Operation

create_model_copy_job

create_model_copy_job(request: CreateModelCopyJobInput | CreateModelCopyJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateModelCopyJobInputDict]) -> CreateModelCopyJobOutput

Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request CreateModelCopyJobInput | CreateModelCopyJobInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateModelCopyJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateModelCopyJobOutput

An instance of CreateModelCopyJobOutput.

create_model_copy_job async

create_model_copy_job(request: CreateModelCopyJobInput | CreateModelCopyJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateModelCopyJobInputDict]) -> CreateModelCopyJobOutput

Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.

Parameters:

Name Type Description Default
request CreateModelCopyJobInput | CreateModelCopyJobInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateModelCopyJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateModelCopyJobOutput

An instance of CreateModelCopyJobOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateModelCopyJobInputDict

Bases: TypedDict

Dictionary form of CreateModelCopyJobInput.

Attributes

client_request_token instance-attribute
client_request_token: str | None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

model_kms_key_id instance-attribute
model_kms_key_id: str | None

The ARN of the KMS key that you use to encrypt the model copy.

source_model_arn instance-attribute
source_model_arn: Required[str]

The Amazon Resource Name (ARN) of the model to be copied.

target_model_name instance-attribute
target_model_name: Required[str]

A name for the copied model.

target_model_tags instance-attribute
target_model_tags: Sequence[Tag | TagDict] | None

Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.

CreateModelCopyJobInput dataclass

Bases: _SerdeShape

Dataclass for CreateModelCopyJobInput structure.

Attributes

client_request_token class-attribute instance-attribute
client_request_token: str | None = ...

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

model_kms_key_id class-attribute instance-attribute
model_kms_key_id: str | None = ...

The ARN of the KMS key that you use to encrypt the model copy.

source_model_arn class-attribute instance-attribute
source_model_arn: str | None = ...

The Amazon Resource Name (ARN) of the model to be copied.

target_model_name class-attribute instance-attribute
target_model_name: str | None = ...

A name for the copied model.

target_model_tags class-attribute instance-attribute
target_model_tags: list[Tag] | None = ...

Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.

Output

CreateModelCopyJobOutput dataclass

Bases: _SerdeShape

Dataclass for CreateModelCopyJobOutput structure.

Attributes

job_arn instance-attribute
job_arn: str

The Amazon Resource Name (ARN) of the model copy job.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.