# GetJobDetails
<a name="API_GetJobDetails"></a>

Returns information about a job. Used for custom actions only.

**Important**  
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

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

```
{
   "jobId": "string"
}
```

## Request Parameters
<a name="API_GetJobDetails_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [jobId](#API_GetJobDetails_RequestSyntax) **   <a name="CodePipeline-GetJobDetails-request-jobId"></a>
The unique system-generated ID for the job.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

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

```
{
   "jobDetails": { 
      "accountId": "string",
      "data": { 
         "actionConfiguration": { 
            "configuration": { 
               "string" : "string" 
            }
         },
         "actionTypeId": { 
            "category": "string",
            "owner": "string",
            "provider": "string",
            "version": "string"
         },
         "artifactCredentials": { 
            "accessKeyId": "string",
            "secretAccessKey": "string",
            "sessionToken": "string"
         },
         "continuationToken": "string",
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "inputArtifacts": [ 
            { 
               "location": { 
                  "s3Location": { 
                     "bucketName": "string",
                     "objectKey": "string"
                  },
                  "type": "string"
               },
               "name": "string",
               "revision": "string"
            }
         ],
         "outputArtifacts": [ 
            { 
               "location": { 
                  "s3Location": { 
                     "bucketName": "string",
                     "objectKey": "string"
                  },
                  "type": "string"
               },
               "name": "string",
               "revision": "string"
            }
         ],
         "pipelineContext": { 
            "action": { 
               "actionExecutionId": "string",
               "name": "string"
            },
            "pipelineArn": "string",
            "pipelineExecutionId": "string",
            "pipelineName": "string",
            "stage": { 
               "name": "string"
            }
         }
      },
      "id": "string"
   }
}
```

## Response Elements
<a name="API_GetJobDetails_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.

 ** [jobDetails](#API_GetJobDetails_ResponseSyntax) **   <a name="CodePipeline-GetJobDetails-response-jobDetails"></a>
The details of the job.  
If AWSSessionCredentials is used, a long-running job can call `GetJobDetails` again to obtain new credentials.
Type: [JobDetails](API_JobDetails.md) object

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

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

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_GetJobDetails_Examples"></a>

### Example
<a name="API_GetJobDetails_Example_1"></a>

This example illustrates one usage of GetJobDetails.

#### Sample Request
<a name="API_GetJobDetails_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 49
X-Amz-Target: CodePipeline_20150709.GetJobDetails
X-Amz-Date: 20151030T230237Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "jobId": "ef66c259-EXAMPLE"
}
```

#### Sample Response
<a name="API_GetJobDetails_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1822

{
  "jobDetails": {
    "accountId": "111111111111",
    "data": {
      "actionConfiguration": {
        "__type": "ActionConfiguration",
        "configuration": {
          "ProjectName": "JenkinsTestProject"
        }
      },
      "actionTypeId": {
        "__type": "ActionTypeId",
        "category": "Test",
        "owner": "Custom",
        "provider": "JenkinsProviderName",
        "version": "1"
      },
      "artifactCredentials": {
        "__type": "AWSSessionCredentials",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        "sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE="
      },
      "inputArtifacts": [
        {
          "__type": "Artifact",
          "location": {
            "s3Location": {
              "bucketName": "amzn-s3-demo-bucket",
              "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
            },
            "type": "S3"
          },
          "name": "MyAppBuild"
        }
      ],
      "outputArtifacts": [],
      "pipelineContext": {
        "__type": "PipelineContext",
        "action": {
          "name": "JenkinsTestAction"
        },
        "pipelineName": "MySecondPipeline",
        "stage": {
          "name": "Testing"
        }
      }
    },
    "id": "ef66c259-EXAMPLE"
  }
}
```

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

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/codepipeline-2015-07-09/GetJobDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/codepipeline-2015-07-09/GetJobDetails)