QuickSight / Client / describe_automation_job

describe_automation_job

QuickSight.Client.describe_automation_job(**kwargs)

Retrieves the status and details of a specified automation job, including its status and outputs.

See also: AWS API Documentation

Request Syntax

response = client.describe_automation_job(
    AwsAccountId='string',
    AutomationGroupId='string',
    AutomationId='string',
    IncludeInputPayload=True|False,
    IncludeOutputPayload=True|False,
    JobId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the automation job.

  • AutomationGroupId (string) –

    [REQUIRED]

    The ID of the automation group that contains the automation.

  • AutomationId (string) –

    [REQUIRED]

    The ID of the automation that the job belongs to.

  • IncludeInputPayload (boolean) – A Boolean value that indicates whether to include the input payload in the response. If set to true, the input payload will be included. If set to false, the input payload will be returned as null.

  • IncludeOutputPayload (boolean) – A Boolean value that indicates whether to include the output payload in the response. If set to true, the output payload will be included. If set to false, the output payload will be returned as null.

  • JobId (string) –

    [REQUIRED]

    The ID of the automation job to describe.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'StartedAt': datetime(2015, 1, 1),
    'EndedAt': datetime(2015, 1, 1),
    'JobStatus': 'FAILED'|'RUNNING'|'SUCCEEDED'|'QUEUED'|'STOPPED',
    'InputPayload': 'string',
    'OutputPayload': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the automation job.

    • CreatedAt (datetime) –

      The time that the automation job was created.

    • StartedAt (datetime) –

      The time that the automation job started running.

    • EndedAt (datetime) –

      The time that the automation job finished running.

    • JobStatus (string) –

      The current status of the automation job.

    • InputPayload (string) –

      The input payload that was provided when the automation job was started. This field is only included when IncludeInputPayload is set to true in the request.

    • OutputPayload (string) –

      The output payload that was generated by the automation job. This field is only included when IncludeOutputPayload is set to true in the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.AccessDeniedException