Sign in

v1

latestOpenAPI 3.1.0BSD-32026-07-2471176175.5 KB
costformation

Cancel a pending CostFormation publish job. Jobs that have already started processing (in_progress) or reached a terminal state cannot be cancelled.

post/v2/costformation/publish-jobs/{jobId}/cancel

Path parameters

jobIdstring required

Unique identifier of a CostFormation publish job.

Response

Successful Operation

job_idstring

Unique identifier for the publish job.

cz_organization_idstring

The organization that owns this job.

statusstring

Current status of the publish job. One of: pending, in_progress, completed, failed, superseded, cancelled.

created_atstring date-time

ISO 8601 timestamp when the job was created.

updated_atstring date-time

ISO 8601 timestamp of the last status update.

attempt_countinteger

Number of processing attempts made.

max_attemptsinteger

Maximum number of processing attempts allowed.

completed_atstring date-time nullable

ISO 8601 timestamp when the job reached a terminal state.

error_messagestring nullable

Error details if the job failed.

error_codestring nullable

Error classification code if the job failed. One of: TRANSIENT, VALIDATION, RESOURCE_NOT_FOUND, RATE_LIMITED, SYSTEM_ERROR.

definition_versionstring nullable

The version of the definition created by this job (set on completion).

validation_errorsobject nullable

Validation error details when a job fails with error_code VALIDATION.

Example response

{
  "job_id": "job-abc123",
  "cz_organization_id": "org-xyz",
  "status": "completed"
}