Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeAutomationJob

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

Request Syntax


GET /accounts/AwsAccountId/automation-groups/AutomationGroupId/automations/AutomationId/jobs/JobId?includeInputPayload=IncludeInputPayload&includeOutputPayload=IncludeOutputPayload HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AutomationGroupId

The ID of the automation group that contains the automation.

Pattern: [0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}

Required: Yes

AutomationId

The ID of the automation that the job belongs to.

Pattern: [0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}

Required: Yes

AwsAccountId

The ID of the AWS account that contains the automation job.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

IncludeInputPayload

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

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

The ID of the automation job to describe.

Pattern: [0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreatedAt": number,
   "EndedAt": number,
   "InputPayload": "string",
   "JobStatus": "string",
   "OutputPayload": "string",
   "RequestId": "string",
   "StartedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

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

Type: String

JobStatus

The current status of the automation job.

Type: String

Valid Values: FAILED | RUNNING | SUCCEEDED | QUEUED | STOPPED

CreatedAt

The time that the automation job was created.

Type: Timestamp

EndedAt

The time that the automation job finished running.

Type: Timestamp

InputPayload

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 7000000.

Pattern: [\s\S]*[{\[].*[}\]]\s*

OutputPayload

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 7000000.

Pattern: [\s\S]*[{\[].*[}\]]\s*

RequestId

The AWS request ID for this operation.

Type: String

StartedAt

The time that the automation job started running.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The AWS request ID for this request.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

RequestId: The AWS request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

RequestId: The AWS request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429