:doc:`SageMaker <../../sagemaker>` / Client / describe_edge_packaging_job

***************************
describe_edge_packaging_job
***************************



.. py:method:: SageMaker.Client.describe_edge_packaging_job(**kwargs)

  

  A description of edge packaging jobs.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeEdgePackagingJob>`_  


  **Request Syntax**
  ::

    response = client.describe_edge_packaging_job(
        EdgePackagingJobName='string'
    )
    
  :type EdgePackagingJobName: string
  :param EdgePackagingJobName: **[REQUIRED]** 

    The name of the edge packaging job.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'EdgePackagingJobArn': 'string',
          'EdgePackagingJobName': 'string',
          'CompilationJobName': 'string',
          'ModelName': 'string',
          'ModelVersion': 'string',
          'RoleArn': 'string',
          'OutputConfig': {
              'S3OutputLocation': 'string',
              'KmsKeyId': 'string',
              'PresetDeploymentType': 'GreengrassV2Component',
              'PresetDeploymentConfig': 'string'
          },
          'ResourceKey': 'string',
          'EdgePackagingJobStatus': 'STARTING'|'INPROGRESS'|'COMPLETED'|'FAILED'|'STOPPING'|'STOPPED',
          'EdgePackagingJobStatusMessage': 'string',
          'CreationTime': datetime(2015, 1, 1),
          'LastModifiedTime': datetime(2015, 1, 1),
          'ModelArtifact': 'string',
          'ModelSignature': 'string',
          'PresetDeploymentOutput': {
              'Type': 'GreengrassV2Component',
              'Artifact': 'string',
              'Status': 'COMPLETED'|'FAILED',
              'StatusMessage': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EdgePackagingJobArn** *(string) --* 

        The Amazon Resource Name (ARN) of the edge packaging job.

        
      

      - **EdgePackagingJobName** *(string) --* 

        The name of the edge packaging job.

        
      

      - **CompilationJobName** *(string) --* 

        The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

        
      

      - **ModelName** *(string) --* 

        The name of the model.

        
      

      - **ModelVersion** *(string) --* 

        The version of the model.

        
      

      - **RoleArn** *(string) --* 

        The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

        
      

      - **OutputConfig** *(dict) --* 

        The output configuration for the edge packaging job.

        
        

        - **S3OutputLocation** *(string) --* 

          The Amazon Simple Storage (S3) bucker URI.

          
        

        - **KmsKeyId** *(string) --* 

          The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

          
        

        - **PresetDeploymentType** *(string) --* 

          The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

          
        

        - **PresetDeploymentConfig** *(string) --* 

          The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

           

          
          * ``ComponentName`` (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.
           
          * ``ComponentDescription`` (optional) - Description of the component.
           
          * ``ComponentVersion`` (optional) - The version of the component. 

          .. note::

            Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a* major.minor.patch* number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the `semantic version specification <https://semver.org/>`__.

          
           
          * ``PlatformOS`` (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.
           
          * ``PlatformArchitecture`` (optional) - The processor architecture for the platform. Supported architectures Windows include: Windows32_x86, Windows64_x64. Supported architectures for Linux include: Linux x86_64, Linux ARMV8.
          

          
    
      

      - **ResourceKey** *(string) --* 

        The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

        
      

      - **EdgePackagingJobStatus** *(string) --* 

        The current status of the packaging job.

        
      

      - **EdgePackagingJobStatusMessage** *(string) --* 

        Returns a message describing the job status and error messages.

        
      

      - **CreationTime** *(datetime) --* 

        The timestamp of when the packaging job was created.

        
      

      - **LastModifiedTime** *(datetime) --* 

        The timestamp of when the job was last updated.

        
      

      - **ModelArtifact** *(string) --* 

        The Amazon Simple Storage (S3) URI where model artifacts ares stored.

        
      

      - **ModelSignature** *(string) --* 

        The signature document of files in the model artifact.

        
      

      - **PresetDeploymentOutput** *(dict) --* 

        The output of a SageMaker Edge Manager deployable resource.

        
        

        - **Type** *(string) --* 

          The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

          
        

        - **Artifact** *(string) --* 

          The Amazon Resource Name (ARN) of the generated deployable resource.

          
        

        - **Status** *(string) --* 

          The status of the deployable resource.

          
        

        - **StatusMessage** *(string) --* 

          Returns a message describing the status of the deployed resource.

          
    
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  