JobData

Represents other information about a job required for a job worker to complete the job.

AmazonCI/CDContinuous DeliveryDevOpsPipelineRelease Automation

Properties

Name Type Description
actionTypeId object
actionConfiguration object
pipelineContext object
inputArtifacts object
outputArtifacts object
artifactCredentials object
continuationToken object
encryptionKey object
View JSON Schema on GitHub

JSON Schema

amazon-codepipeline-job-data-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codepipeline/refs/heads/main/json-schema/amazon-codepipeline-job-data-schema.json",
  "title": "JobData",
  "description": "Represents other information about a job required for a job worker to complete the job.",
  "type": "object",
  "properties": {
    "actionTypeId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionTypeId"
        },
        {
          "description": "Represents information about an action type."
        }
      ]
    },
    "actionConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ActionConfiguration"
        },
        {
          "description": "Represents information about an action configuration."
        }
      ]
    },
    "pipelineContext": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PipelineContext"
        },
        {
          "description": "<p>Represents information about a pipeline to a job worker.</p> <note> <p>Includes <code>pipelineArn</code> and <code>pipelineExecutionId</code> for custom jobs.</p> </note>"
        }
      ]
    },
    "inputArtifacts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArtifactList"
        },
        {
          "description": "The artifact supplied to the job."
        }
      ]
    },
    "outputArtifacts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArtifactList"
        },
        {
          "description": "The output of the job."
        }
      ]
    },
    "artifactCredentials": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AWSSessionCredentials"
        },
        {
          "description": "Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline."
        }
      ]
    },
    "continuationToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContinuationToken"
        },
        {
          "description": "A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously."
        }
      ]
    },
    "encryptionKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionKey"
        },
        {
          "description": "Represents information about the key used to encrypt data in the artifact store, such as an KMS key. "
        }
      ]
    }
  }
}