get_job¶

EndUserMessaging.Client.get_job(**kwargs)¶

Retrieves the current state of an asynchronous job, including its status and any resources that it created or updated.

Request Syntax

response = client.get_job(
    jobId='string'
)

Parameters:

jobId (string) –

[REQUIRED]

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'status': 'SUCCESS'|'PROCESSING'|'FAILED',
    'operationType': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'brandProfileId': 'string',
    'errorCode': 'string',
    'errorMessage': 'string',
    'resources': [
        {
            'resourceType': 'REGISTRATION'|'BRAND_PROFILE',
            'resourceId': 'string',
            'resourceArn': 'string'
        },
    ]
}

Response Structure

(dict) –

Information about an async job tracked by the service. GetJob returns the full Job, which may grow detail-only fields that are not part of the JobSummary list view.
- jobId (string) –
  
  The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
- status (string) –
  
  The current lifecycle status of the job.
- operationType (string) –
  
  The type of mutating operation that created the job.
- createdAt (datetime) –
  
  The time when the resource was created, in Unix epoch time.
- updatedAt (datetime) –
  
  The time when the resource was last updated, in Unix epoch time.
- brandProfileId (string) –
  
  The brand profile that the job operates on. This value is absent for operations that create a brand profile.
- errorCode (string) –
  
  A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.
- errorMessage (string) –
  
  A human-readable description of why the job failed. This value is present only when the job status is FAILED.
- resources (list) –
  
  The resources that were created or updated by the job.
  - (dict) –
    
    Contains information about a resource that was created or updated by an asynchronous job.
    - resourceType (string) –
      
      The type of the resource that the job created or updated.
    - resourceId (string) –
      
      The identifier of the resource that the job created or updated.
    - resourceArn (string) –
      
      The Amazon Resource Name (ARN) of the resource.

Exceptions

EndUserMessaging.Client.exceptions.ValidationException
EndUserMessaging.Client.exceptions.ThrottlingException
EndUserMessaging.Client.exceptions.AccessDeniedException
EndUserMessaging.Client.exceptions.ResourceNotFoundException
EndUserMessaging.Client.exceptions.InternalServerException