get_custom_model¶
Operation¶
get_custom_model
¶
get_custom_model(request: GetCustomModelInput | GetCustomModelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCustomModelInputDict]) -> GetCustomModelOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetCustomModelInput | GetCustomModelInputDict | 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[GetCustomModelInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetCustomModelOutput
|
An instance of |
get_custom_model
async
¶
get_custom_model(request: GetCustomModelInput | GetCustomModelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCustomModelInputDict]) -> GetCustomModelOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetCustomModelInput | GetCustomModelInputDict | 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[GetCustomModelInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetCustomModelOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetCustomModelOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetCustomModelOutput structure.
Attributes¶
base_model_arn
class-attribute
instance-attribute
¶
base_model_arn: str | None = ...
Amazon Resource Name (ARN) of the base model.
customization_config
class-attribute
instance-attribute
¶
customization_config: CustomizationConfig | None = ...
The customization configuration for the custom model.
customization_type
class-attribute
instance-attribute
¶
customization_type: str | None = ...
The type of model customization.
failure_message
class-attribute
instance-attribute
¶
failure_message: str | None = ...
A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.
hyper_parameters
class-attribute
instance-attribute
¶
Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.
job_arn
class-attribute
instance-attribute
¶
job_arn: str | None = ...
Job Amazon Resource Name (ARN) associated with this model. For models
that you create with the
CreateCustomModel
API operation, this is NULL.
job_name
class-attribute
instance-attribute
¶
job_name: str | None = ...
Job name associated with this model.
model_arn
instance-attribute
¶
model_arn: str
Amazon Resource Name (ARN) associated with this model.
model_kms_key_arn
class-attribute
instance-attribute
¶
model_kms_key_arn: str | None = ...
The custom model is encrypted at rest using this key.
model_status
class-attribute
instance-attribute
¶
model_status: str | None = ...
The current status of the custom model. Possible values include:
-
Creating- The model is being created and validated. -
Active- The model has been successfully created and is ready for use. -
Failed- The model creation process failed. Check thefailureMessagefield for details.
output_data_config
class-attribute
instance-attribute
¶
output_data_config: OutputDataConfig | None = ...
Output data configuration associated with this custom model.
response_metadata
class-attribute
instance-attribute
¶
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.
training_data_config
class-attribute
instance-attribute
¶
training_data_config: TrainingDataConfig | None = ...
Contains information about the training dataset.
training_metrics
class-attribute
instance-attribute
¶
training_metrics: TrainingMetrics | None = ...
Contains training metrics from the job creation.
validation_data_config
class-attribute
instance-attribute
¶
validation_data_config: ValidationDataConfig | None = ...
Contains information about the validation dataset.
validation_metrics
class-attribute
instance-attribute
¶
validation_metrics: list[ValidatorMetric] | None = ...
The validation metrics from the job creation.