LookoutforVision / Client / list_model_packaging_jobs

list_model_packaging_jobs#

LookoutforVision.Client.list_model_packaging_jobs(**kwargs)#

Lists the model packaging jobs created for an Amazon Lookout for Vision project.

This operation requires permissions to perform the lookoutvision:ListModelPackagingJobs operation.

For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_model_packaging_jobs(
    ProjectName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ProjectName (string) –

    [REQUIRED]

    The name of the project for which you want to list the model packaging jobs.

  • NextToken (string) – If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'ModelPackagingJobs': [
        {
            'JobName': 'string',
            'ProjectName': 'string',
            'ModelVersion': 'string',
            'ModelPackagingJobDescription': 'string',
            'ModelPackagingMethod': 'string',
            'Status': 'CREATED'|'RUNNING'|'SUCCEEDED'|'FAILED',
            'StatusMessage': 'string',
            'CreationTimestamp': datetime(2015, 1, 1),
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ModelPackagingJobs (list) –

      A list of the model packaging jobs created for the specified Amazon Lookout for Vision project.

      • (dict) –

        Metadata for a model packaging job. For more information, see ListModelPackagingJobs.

        • JobName (string) –

          The name of the model packaging job.

        • ProjectName (string) –

          The project that contains the model that is in the model package.

        • ModelVersion (string) –

          The version of the model that is in the model package.

        • ModelPackagingJobDescription (string) –

          The description for the model packaging job.

        • ModelPackagingMethod (string) –

          The AWS service used to package the job. Currently Lookout for Vision can package jobs with AWS IoT Greengrass.

        • Status (string) –

          The status of the model packaging job.

        • StatusMessage (string) –

          The status message for the model packaging job.

        • CreationTimestamp (datetime) –

          The Unix timestamp for the time and date that the model packaging job was created.

        • LastUpdatedTimestamp (datetime) –

          The Unix timestamp for the time and date that the model packaging job was last updated.

    • NextToken (string) –

      If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Exceptions