# DescribeAutomationJob
<a name="API_DescribeAutomationJob"></a>

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

## Request Syntax
<a name="API_DescribeAutomationJob_RequestSyntax"></a>

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

## URI Request Parameters
<a name="API_DescribeAutomationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AutomationGroupId](#API_DescribeAutomationJob_RequestSyntax) **   <a name="QS-DescribeAutomationJob-request-uri-AutomationGroupId"></a>
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](#API_DescribeAutomationJob_RequestSyntax) **   <a name="QS-DescribeAutomationJob-request-uri-AutomationId"></a>
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](#API_DescribeAutomationJob_RequestSyntax) **   <a name="QS-DescribeAutomationJob-request-uri-AwsAccountId"></a>
The ID of the AWS account that contains the automation job.  
Length Constraints: Fixed length of 12.  
Pattern: `^[0-9]{12}$`   
Required: Yes

 ** [IncludeInputPayload](#API_DescribeAutomationJob_RequestSyntax) **   <a name="QS-DescribeAutomationJob-request-uri-IncludeInputPayload"></a>
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](#API_DescribeAutomationJob_RequestSyntax) **   <a name="QS-DescribeAutomationJob-request-uri-IncludeOutputPayload"></a>
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](#API_DescribeAutomationJob_RequestSyntax) **   <a name="QS-DescribeAutomationJob-request-uri-JobId"></a>
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
<a name="API_DescribeAutomationJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAutomationJob_ResponseSyntax"></a>

```
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
<a name="API_DescribeAutomationJob_ResponseElements"></a>

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](#API_DescribeAutomationJob_ResponseSyntax) **   <a name="QS-DescribeAutomationJob-response-Arn"></a>
The Amazon Resource Name (ARN) of the automation job.  
Type: String

 ** [JobStatus](#API_DescribeAutomationJob_ResponseSyntax) **   <a name="QS-DescribeAutomationJob-response-JobStatus"></a>
The current status of the automation job.  
Type: String  
Valid Values: `FAILED | RUNNING | SUCCEEDED | QUEUED | STOPPED` 

 ** [CreatedAt](#API_DescribeAutomationJob_ResponseSyntax) **   <a name="QS-DescribeAutomationJob-response-CreatedAt"></a>
The time that the automation job was created.  
Type: Timestamp

 ** [EndedAt](#API_DescribeAutomationJob_ResponseSyntax) **   <a name="QS-DescribeAutomationJob-response-EndedAt"></a>
The time that the automation job finished running.  
Type: Timestamp

 ** [InputPayload](#API_DescribeAutomationJob_ResponseSyntax) **   <a name="QS-DescribeAutomationJob-response-InputPayload"></a>
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](#API_DescribeAutomationJob_ResponseSyntax) **   <a name="QS-DescribeAutomationJob-response-OutputPayload"></a>
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](#API_DescribeAutomationJob_ResponseSyntax) **   <a name="QS-DescribeAutomationJob-response-RequestId"></a>
The AWS request ID for this operation.  
Type: String

 ** [StartedAt](#API_DescribeAutomationJob_ResponseSyntax) **   <a name="QS-DescribeAutomationJob-response-StartedAt"></a>
The time that the automation job started running.  
Type: Timestamp

## Errors
<a name="API_DescribeAutomationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

## See Also
<a name="API_DescribeAutomationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DescribeAutomationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeAutomationJob)