DOdod-ccpo
provisioning

Get the status of a previously issued provisioning job

Changed on

Queries the CSP for the status of a previously issued provisioning job for which that CSP issued an HTTP 202 response, indicating that the provisioning job was accepted but a response was not available immediately. This allows continuously checking the status to inform the end user. The provisioning job ID must be unique across all provisioning jobs and must never be reused; however, a provisioning job ID must be queryable for at least 168 but no more than 240 hours.

get/provisioning/{provisioningJobId}/status

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (https://cognito-idp-fips.us-gov-west-1.amazonaws.com/us-gov-west-1_2e6R3aYgi/.well-known/openid-configuration, scopes: atat/read-portfolio)

Path parameters

provisioningJobIdstring required

The ID of the provisioning job

Response

Get provisioning status successful

provisioning_job_idstring required

The ID of the Provisioning job; used for retrieving status to inform end user. This ID must be unique across all provisioning jobs across portfolios.

portfolio_idstring

The ID of the Portfolio for which status is being returned

environment_idstring

The ID of the Environment for which status is being returned

status'NOT_STARTED' | 'IN_PROGRESS' | 'SUCCESS' | 'FAILURE' required

Example response

{
  "provisioning_job_id": "123456789"
}

Changes

  • c20f3ebace53Revision changes
    • warning

      added the new FAILURE enum value to the response property for the response status

    • warning

      added the new SUCCESS enum value to the response property for the response status

    • info

      removed the COMPLETE enum value from the response property for the response status

    • info

      removed the FAILED enum value from the response property for the response status

  • 0290bea4247cRevision changes
    • info

      added the new optional header request parameter X-Atat-Api-Version to all path's operations