Bedrock / Client / get_custom_model

get_custom_model

Bedrock.Client.get_custom_model(**kwargs)

Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_custom_model(
    modelIdentifier='string'
)

Parameters:

modelIdentifier (string) –

[REQUIRED]

Name or ARN of the custom model.

Return type:

dict

Returns:

Response Syntax

{
    'modelArn': 'string',
    'modelName': 'string',
    'jobName': 'string',
    'jobArn': 'string',
    'baseModelArn': 'string',
    'modelKmsKeyArn': 'string',
    'hyperParameters': {
        'string': 'string'
    },
    'trainingDataConfig': {
        's3Uri': 'string'
    },
    'validationDataConfig': {
        'validators': [
            {
                's3Uri': 'string'
            },
        ]
    },
    'outputDataConfig': {
        's3Uri': 'string'
    },
    'trainingMetrics': {
        'trainingLoss': ...
    },
    'validationMetrics': [
        {
            'validationLoss': ...
        },
    ],
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • modelArn (string) –

    ARN associated with this model.

  • modelName (string) –

    Model name associated with this model.

  • jobName (string) –

    Job name associated with this model.

  • jobArn (string) –

    Job ARN associated with this model.

  • baseModelArn (string) –

    ARN of the base model.

  • modelKmsKeyArn (string) –

    The custom model is encrypted at rest using this key.

  • hyperParameters (dict) –

    Hyperparameter values associated with this model.

    • (string) –

      • (string) –

  • trainingDataConfig (dict) –

    Information about the training dataset.

    • s3Uri (string) –

      The S3 URI where the training data is stored.

  • validationDataConfig (dict) –

    Array of up to 10 validators.

    • validators (list) –

      Information about the validators.

      • (dict) –

        Information about a validator.

        • s3Uri (string) –

          The S3 URI where the validation data is stored.

  • outputDataConfig (dict) –

    Output data configuration associated with this custom model.

    • s3Uri (string) –

      The S3 URI where the output data is stored.

  • trainingMetrics (dict) –

    The training metrics from the job creation.

    • trainingLoss (float) –

      Loss metric associated with the custom job.

  • validationMetrics (list) –

    The validation metrics from the job creation.

    • (dict) –

      The metric for the validator.

      • validationLoss (float) –

        The validation loss associated with this validator.

  • creationTime (datetime) –

    Creation time of the model.

Exceptions

• Bedrock.Client.exceptions.ResourceNotFoundException

• Bedrock.Client.exceptions.AccessDeniedException

• Bedrock.Client.exceptions.ValidationException

• Bedrock.Client.exceptions.InternalServerException

• Bedrock.Client.exceptions.ThrottlingException