Amazon CodePipeline · JSON Structure

Amazon Codepipeline Third Party Job Data Structure

Represents information about the job data for a partner action.

Type: object Properties: 8
AmazonCI/CDContinuous DeliveryDevOpsPipelineRelease Automation

ThirdPartyJobData is a JSON Structure definition published by Amazon CodePipeline, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

actionTypeId actionConfiguration pipelineContext inputArtifacts outputArtifacts artifactCredentials continuationToken encryptionKey

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codepipeline/refs/heads/main/json-structure/amazon-codepipeline-third-party-job-data-structure.json",
  "name": "ThirdPartyJobData",
  "description": "Represents information about the job data for a partner action.",
  "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>Does not include <code>pipelineArn</code> and <code>pipelineExecutionId</code> for ThirdParty jobs.</p> </note>"
        }
      ]
    },
    "inputArtifacts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArtifactList"
        },
        {
          "description": "The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as \"MyApp\", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline."
        }
      ]
    },
    "outputArtifacts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArtifactList"
        },
        {
          "description": "The name of the artifact that is the result of the action, if any. This name might be system-generated, such as \"MyBuiltApp\", or it might be defined by the user when the action is created."
        }
      ]
    },
    "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 artifact for the pipeline in CodePipeline. "
        }
      ]
    },
    "continuationToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContinuationToken"
        },
        {
          "description": "A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously."
        }
      ]
    },
    "encryptionKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionKey"
        },
        {
          "description": "The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present."
        }
      ]
    }
  }
}