Bedrock / Client / get_model_customization_job

get_model_customization_job

Bedrock.Client.get_model_customization_job(**kwargs)

Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_model_customization_job(
    jobIdentifier='string'
)

Parameters:

jobIdentifier (string) –

[REQUIRED]

Identifier for the customization job.

Return type:

dict

Returns:

Response Syntax

{
    'jobArn': 'string',
    'jobName': 'string',
    'outputModelName': 'string',
    'outputModelArn': 'string',
    'clientRequestToken': 'string',
    'roleArn': 'string',
    'status': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
    'failureMessage': 'string',
    'creationTime': datetime(2015, 1, 1),
    'lastModifiedTime': datetime(2015, 1, 1),
    'endTime': datetime(2015, 1, 1),
    'baseModelArn': 'string',
    'hyperParameters': {
        'string': 'string'
    },
    'trainingDataConfig': {
        's3Uri': 'string'
    },
    'validationDataConfig': {
        'validators': [
            {
                's3Uri': 'string'
            },
        ]
    },
    'outputDataConfig': {
        's3Uri': 'string'
    },
    'customizationType': 'FINE_TUNING'|'CONTINUED_PRE_TRAINING',
    'outputModelKmsKeyArn': 'string',
    'trainingMetrics': {
        'trainingLoss': ...
    },
    'validationMetrics': [
        {
            'validationLoss': ...
        },
    ],
    'vpcConfig': {
        'subnetIds': [
            'string',
        ],
        'securityGroupIds': [
            'string',
        ]
    }
}

Response Structure

• (dict) –

  • jobArn (string) –

    The Amazon Resource Name (ARN) of the customization job.

  • jobName (string) –

    The name of the customization job.

  • outputModelName (string) –

    The name of the output model.

  • outputModelArn (string) –

    The Amazon Resource Name (ARN) of the output model.

  • clientRequestToken (string) –

    The token that you specified in the CreateCustomizationJob request.

  • roleArn (string) –

    The Amazon Resource Name (ARN) of the IAM role.

  • status (string) –

    The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.

  • failureMessage (string) –

    Information about why the job failed.

  • creationTime (datetime) –

    Time that the resource was created.

  • lastModifiedTime (datetime) –

    Time that the resource was last modified.

  • endTime (datetime) –

    Time that the resource transitioned to terminal state.

  • baseModelArn (string) –

    Amazon Resource Name (ARN) of the base model.

  • hyperParameters (dict) –

    The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.

    • (string) –

      • (string) –

  • trainingDataConfig (dict) –

    Contains information about the training dataset.

    • s3Uri (string) –

      The S3 URI where the training data is stored.

  • validationDataConfig (dict) –

    Contains information about the validation dataset.

    • 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

    • s3Uri (string) –

      The S3 URI where the output data is stored.

  • customizationType (string) –

    The type of model customization.

  • outputModelKmsKeyArn (string) –

    The custom model is encrypted at rest using this key.

  • trainingMetrics (dict) –

    Contains training metrics from the job creation.

    • trainingLoss (float) –

      Loss metric associated with the custom job.

  • validationMetrics (list) –

    The loss metric for each validator that you provided in the createjob request.

    • (dict) –

      The metric for the validator.

      • validationLoss (float) –

        The validation loss associated with this validator.

  • vpcConfig (dict) –

    VPC configuration for the custom model job.

    • subnetIds (list) –

      VPC configuration subnets.

      • (string) –

    • securityGroupIds (list) –

      VPC configuration security group Ids.

      • (string) –

Exceptions

• Bedrock.Client.exceptions.ResourceNotFoundException

• Bedrock.Client.exceptions.AccessDeniedException

• Bedrock.Client.exceptions.ValidationException

• Bedrock.Client.exceptions.InternalServerException

• Bedrock.Client.exceptions.ThrottlingException