LookoutforVision / Client / describe_model_packaging_job

describe_model_packaging_job#

LookoutforVision.Client.describe_model_packaging_job(**kwargs)#

Describes an Amazon Lookout for Vision model packaging job.

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

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

Request Syntax

response = client.describe_model_packaging_job(
    ProjectName='string',
    JobName='string'
)

Parameters:

ProjectName (string) –
[REQUIRED]

The name of the project that contains the model packaging job that you want to describe.
JobName (string) –
[REQUIRED]

The job name for the model packaging job.

Return type:

dict

Returns:

Response Syntax

{
    'ModelPackagingDescription': {
        'JobName': 'string',
        'ProjectName': 'string',
        'ModelVersion': 'string',
        'ModelPackagingConfiguration': {
            'Greengrass': {
                'CompilerOptions': 'string',
                'TargetDevice': 'jetson_xavier',
                'TargetPlatform': {
                    'Os': 'LINUX',
                    'Arch': 'ARM64'|'X86_64',
                    'Accelerator': 'NVIDIA'
                },
                'S3OutputLocation': {
                    'Bucket': 'string',
                    'Prefix': 'string'
                },
                'ComponentName': 'string',
                'ComponentVersion': 'string',
                'ComponentDescription': 'string',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            }
        },
        'ModelPackagingJobDescription': 'string',
        'ModelPackagingMethod': 'string',
        'ModelPackagingOutputDetails': {
            'Greengrass': {
                'ComponentVersionArn': 'string',
                'ComponentName': 'string',
                'ComponentVersion': 'string'
            }
        },
        'Status': 'CREATED'|'RUNNING'|'SUCCEEDED'|'FAILED',
        'StatusMessage': 'string',
        'CreationTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- ModelPackagingDescription (dict) –
  
  The description of the model packaging job.
  - JobName (string) –
    
    The name of the model packaging job.
  - ProjectName (string) –
    
    The name of the project that’s associated with a model that’s in the model package.
  - ModelVersion (string) –
    
    The version of the model used in the model packaging job.
  - ModelPackagingConfiguration (dict) –
    
    The configuration information used in the model packaging job.
    - Greengrass (dict) –
      
      Configuration information for the AWS IoT Greengrass component in a model packaging job.
      - CompilerOptions (string) –
        
        Additional compiler options for the Greengrass component. Currently, only NVIDIA Graphics Processing Units (GPU) and CPU accelerators are supported. If you specify TargetDevice, don’t specify CompilerOptions.
        
        For more information, see Compiler options in the Amazon Lookout for Vision Developer Guide.
      - TargetDevice (string) –
        
        The target device for the model. Currently the only supported value is jetson_xavier. If you specify TargetDevice, you can’t specify TargetPlatform.
      - TargetPlatform (dict) –
        
        The target platform for the model. If you specify TargetPlatform, you can’t specify TargetDevice.
        
        Os (string) –
        
        The target operating system for the model. Linux is the only operating system that is currently supported.
        
        Arch (string) –
        
        The target architecture for the model. The currently supported architectures are X86_64 (64-bit version of the x86 instruction set) and ARM_64 (ARMv8 64-bit CPU).
        
        Accelerator (string) –
        
        The target accelerator for the model. Currently, Amazon Lookout for Vision only supports NVIDIA (Nvidia graphics processing unit) and CPU accelerators. If you specify NVIDIA as an accelerator, you must also specify the gpu-code, trt-ver, and cuda-ver compiler options. If you don’t specify an accelerator, Lookout for Vision uses the CPU for compilation and we highly recommend that you use the GreengrassConfiguration$CompilerOptions field. For example, you can use the following compiler options for CPU:
        
        mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
        
        mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}
      - S3OutputLocation (dict) –
        
        An S3 location in which Lookout for Vision stores the component artifacts.
        
        Bucket (string) –
        
        The S3 bucket that contains the training or model packaging job output. If you are training a model, the bucket must in your AWS account. If you use an S3 bucket for a model packaging job, the S3 bucket must be in the same AWS Region and AWS account in which you use AWS IoT Greengrass.
        
        Prefix (string) –
        
        The path of the folder, within the S3 bucket, that contains the output.
      - ComponentName (string) –
        
        A name for the AWS IoT Greengrass component.
      - ComponentVersion (string) –
        
        A Version for the AWS IoT Greengrass component. If you don’t provide a value, a default value of Model Version.0.0 is used.
      - ComponentDescription (string) –
        
        A description for the AWS IoT Greengrass component.
      - Tags (list) –
        
        A set of tags (key-value pairs) that you want to attach to the AWS IoT Greengrass component.
        
        (dict) –
        
        A key and value pair that is attached to the specified Amazon Lookout for Vision model.
        
        Key (string) –
        
        The key of the tag that is attached to the specified model.
        
        Value (string) –
        
        The value of the tag that is attached to the specified model.
  - 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.
  - ModelPackagingOutputDetails (dict) –
    
    Information about the output of the model packaging job. For more information, see DescribeModelPackagingJob.
    - Greengrass (dict) –
      
      Information about the AWS IoT Greengrass component in a model packaging job.
      - ComponentVersionArn (string) –
        
        The Amazon Resource Name (ARN) of the component.
      - ComponentName (string) –
        
        The name of the component.
      - ComponentVersion (string) –
        
        The version of the component.
  - 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.

describe_model_packaging_job#

Request Syntax

Response Syntax

Response Structure

Exceptions