Bedrock / Client / list_model_customization_jobs

list_model_customization_jobs#

Bedrock.Client.list_model_customization_jobs(**kwargs)#

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.

For more information, see Custom models in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_model_customization_jobs(
    creationTimeAfter=datetime(2015, 1, 1),
    creationTimeBefore=datetime(2015, 1, 1),
    statusEquals='InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
    nameContains='string',
    maxResults=123,
    nextToken='string',
    sortBy='CreationTime',
    sortOrder='Ascending'|'Descending'
)
Parameters:

  • creationTimeAfter (datetime) – Return customization jobs created after the specified time.

  • creationTimeBefore (datetime) – Return customization jobs created before the specified time.

  • statusEquals (string) – Return customization jobs with the specified status.

  • nameContains (string) – Return customization jobs only if the job name contains these characters.

  • maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

  • sortBy (string) – The field to sort by in the returned list of jobs.

  • sortOrder (string) – The sort order of the results.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'modelCustomizationJobSummaries': [
        {
            'jobArn': 'string',
            'baseModelArn': 'string',
            'jobName': 'string',
            'status': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
            'lastModifiedTime': datetime(2015, 1, 1),
            'creationTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'customModelArn': 'string',
            'customModelName': 'string',
            'customizationType': 'FINE_TUNING'|'CONTINUED_PRE_TRAINING'|'DISTILLATION'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

    • modelCustomizationJobSummaries (list) –

      Job summaries.

      • (dict) –

        Information about one customization job

        • jobArn (string) –

          Amazon Resource Name (ARN) of the customization job.

        • baseModelArn (string) –

          Amazon Resource Name (ARN) of the base model.

        • jobName (string) –

          Name of the customization job.

        • status (string) –

          Status of the customization job.

        • lastModifiedTime (datetime) –

          Time that the customization job was last modified.

        • creationTime (datetime) –

          Creation time of the custom model.

        • endTime (datetime) –

          Time that the customization job ended.

        • customModelArn (string) –

          Amazon Resource Name (ARN) of the custom model.

        • customModelName (string) –

          Name of the custom model.

        • customizationType (string) –

          Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.

Exceptions