---
title: "POST /DescribeJobs"
method: POST
path: "/DescribeJobs"
---

# POST /DescribeJobs

`POST /DescribeJobs`

Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

## Query parameters

- `maxResults` string
- `nextToken` string

## Request body

- object
  - `filters` object — Request to describe Job log filters.
    - `fromDate` string — Request to describe Job log filters by date.
    - `jobIDs` JobID[] — Request to describe Job log filters by job ID.
    - `toDate` string — Request to describe job log items by last date.
  - `maxResults` integer — Request to describe job log items by max results.
  - `nextToken` string — Request to describe job log items by next token.

## Response `200`

Success

- DescribeJobsResponse
  - `items` Job[] — Request to describe Job log items.
    - `arn` string — the ARN of the specific Job.
    - `creationDateTime` string — Job creation time.
    - `endDateTime` string — Job end time.
    - `initiatedBy` 'START_TEST' | 'START_CUTOVER' | 'DIAGNOSTIC' | 'TERMINATE' — Job initiated by field.
    - `jobID` string, required — Job ID.
    - `participatingServers` ParticipatingServer[] — Servers participating in a specific Job.
      - `launchStatus` 'PENDING' | 'IN_PROGRESS' | 'LAUNCHED' | 'FAILED' | 'TERMINATED' — Participating server launch status.
      - `launchedEc2InstanceID` string — Participating server's launched ec2 instance ID.
      - `postLaunchActionsStatus` object — Participating server's Post Launch Actions Status.
        - `postLaunchActionsLaunchStatusList` JobPostLaunchActionsLaunchStatus[] — List of Post Launch Action status.
          - `executionID` string — AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
          - `executionStatus` 'IN_PROGRESS' | 'SUCCESS' | 'FAILED' — AWS Systems Manager Document's execution status.
          - `failureReason` string — AWS Systems Manager Document's failure reason.
          - `ssmDocument` object — AWS Systems Manager's Document of the of the Job Post Launch Actions.
            - `actionName` string, required — User-friendly name for the AWS Systems Manager Document.
            - `externalParameters` object — AWS Systems Manager Document external parameters.
            - `mustSucceedForCutover` boolean — If true, Cutover will not be enabled if the document has failed.
            - `parameters` object — AWS Systems Manager Document parameters.
            - `ssmDocumentName` string, required — AWS Systems Manager Document name or full ARN.
            - `timeoutSeconds` integer — AWS Systems Manager Document timeout seconds.
          - `ssmDocumentType` 'AUTOMATION' | 'COMMAND' — AWS Systems Manager Document type.
        - `ssmAgentDiscoveryDatetime` string — Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
      - `sourceServerID` string, required — Participating server Source Server ID.
    - `status` 'PENDING' | 'STARTED' | 'COMPLETED' — Job status.
    - `tags` object — Tags associated with specific Job.
    - `type` 'LAUNCH' | 'TERMINATE' — Job type.
  - `nextToken` string — Request to describe Job response by next token.

## Other responses

- `480` — UninitializedAccountException
- `481` — ValidationException

---

[API](https://skmtc.net/aws/apis/mgn.md) · [All operations](https://skmtc.net/aws/apis/mgn/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/mgn/versions/71048ba96dc1/schema)