AWS CodePipeline (version v1.*.*)

$body#

Represents the input of an AcknowledgeJob action.

Type: object

{
  "jobId" : "The unique system-generated ID of the job for which you want to confirm receipt.",
  "nonce" : "A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job."
}

$body#

Represents the input of an AcknowledgeThirdPartyJob action.

Type: object

{
  "jobId" : "The unique system-generated ID of the job.",
  "clientToken" : "The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.",
  "nonce" : "A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request."
}

$body#

Represents the input of a CreateCustomActionType operation.

Type: object

{
  "settings" : {
    "executionUrlTemplate" : "The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.",
    "entityUrlTemplate" : "The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.",
    "thirdPartyConfigurationUrl" : "The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.",
    "revisionUrlTemplate" : "The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action."
  },
  "provider" : "The provider of the service used in the custom action, such as AWS CodeDeploy.",
  "inputArtifactDetails" : {
    "maximumCount" : "The maximum number of artifacts allowed for the action type.",
    "minimumCount" : "The minimum number of artifacts allowed for the action type."
  },
  "outputArtifactDetails" : {
    "maximumCount" : "The maximum number of artifacts allowed for the action type.",
    "minimumCount" : "The minimum number of artifacts allowed for the action type."
  },
  "category" : "The category of the custom action, such as a build action or a test action.  \nAlthough Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.",
  "configurationProperties" : [ {
    "queryable" : "Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. \nIf you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.",
    "name" : "The name of the action configuration property.",
    "description" : "The description of the action configuration property that is displayed to users.",
    "secret" : "Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. \nWhen updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.",
    "type" : "The type of the configuration property.",
    "required" : "Whether the configuration property is a required value.",
    "key" : "Whether the configuration property is a key."
  } ],
  "version" : "The version identifier of the custom action.",
  "tags" : [ {
    "value" : "The tag's value.",
    "key" : "The tag's key."
  } ]
}

$body#

Represents the input of a CreatePipeline action.

Type: object

{
  "pipeline" : {
    "artifactStore" : {
      "location" : "The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.",
      "encryptionKey" : {
        "id" : "The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.  \nAliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.",
        "type" : "The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'."
      },
      "type" : "The type of the artifact store, such as S3."
    },
    "roleArn" : "The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.",
    "name" : "The name of the action to be performed.",
    "stages" : [ {
      "name" : "The name of the stage.",
      "blockers" : [ {
        "name" : "Reserved for future use.",
        "type" : "Reserved for future use."
      } ],
      "actions" : [ {
        "runOrder" : "The order in which actions are run.",
        "actionTypeId" : {
          "owner" : "The creator of the action being called.",
          "provider" : "The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.",
          "category" : "A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values. ",
          "version" : "A string that describes the action version."
        },
        "configuration" : "The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide. \nThe values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:  \n JSON:  \n \"Configuration\" : { Key : Value }, ",
        "outputArtifacts" : [ {
          "name" : "The name of the output of an artifact, such as \"My App\". \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. \nOutput artifact names must be unique within a pipeline."
        } ],
        "roleArn" : "The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.",
        "name" : "The action declaration's name.",
        "region" : "The action declaration's AWS Region, such as us-east-1.",
        "inputArtifacts" : [ {
          "name" : "The name of the artifact to be worked on (for example, \"My App\"). \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions."
        } ]
      } ]
    } ],
    "artifactStores" : "A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.  \nYou must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.",
    "version" : "The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated."
  },
  "tags" : [ {
    "value" : "The tag's value.",
    "key" : "The tag's key."
  } ]
}

$body#

Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.

Type: object

{
  "provider" : "The provider of the service used in the custom action, such as AWS CodeDeploy.",
  "category" : "The category of the custom action that you want to delete, such as source or deploy.",
  "version" : "The version of the custom action to delete."
}

$body#

Represents the input of a DeletePipeline action.

Type: object

{
  "name" : "The name of the pipeline to be deleted."
}

$body#

Type: object

{
  "name" : "The name of the webhook you want to delete."
}

$body#

Type: object

{
  "webhookName" : "The name of the webhook you want to deregister."
}

$body#

Represents the input of a DisableStageTransition action.

Type: object

{
  "pipelineName" : "The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.",
  "reason" : "The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.",
  "stageName" : "The name of the stage where you want to disable the inbound or outbound transition of artifacts.",
  "transitionType" : "Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound)."
}

$body#

Represents the input of an EnableStageTransition action.

Type: object

{
  "pipelineName" : "The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.",
  "stageName" : "The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).",
  "transitionType" : "Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound)."
}

$body#

Represents the input of a GetJobDetails action.

Type: object

{
  "jobId" : "The unique system-generated ID for the job."
}

$body#

Represents the input of a GetPipeline action.

Type: object

{
  "name" : "The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.",
  "version" : "The version number of the pipeline. If you do not specify a version, defaults to the current version."
}

$body#

Represents the input of a GetPipelineExecution action.

Type: object

{
  "pipelineName" : "The name of the pipeline about which you want to get execution details.",
  "pipelineExecutionId" : "The ID of the pipeline execution about which you want to get execution details."
}

$body#

Represents the input of a GetPipelineState action.

Type: object

{
  "name" : "The name of the pipeline about which you want to get information."
}

$body#

Represents the input of a GetThirdPartyJobDetails action.

Type: object

{
  "jobId" : "The unique system-generated ID used for identifying the job.",
  "clientToken" : "The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details."
}

$body#

Type: object

{
  "pipelineName" : " The name of the pipeline for which you want to list action execution history.",
  "filter" : {
    "pipelineExecutionId" : "The pipeline execution ID used to filter action execution history."
  }
}

$body#

Represents the input of a ListActionTypes action.

Type: object

{
  "actionOwnerFilter" : "Filters the list of action types to those created by a specified entity."
}

$body#

Represents the input of a ListPipelineExecutions action.

Type: object

{
  "pipelineName" : "The name of the pipeline for which you want to get execution summary information."
}

$body#

Type: object

{
  "resourceArn" : "The Amazon Resource Name (ARN) of the resource to get tags for."
}

$body#

Represents the input of a PollForJobs action.

Type: object

{
  "actionTypeId" : {
    "owner" : "The creator of the action being called.",
    "provider" : "The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.",
    "category" : "A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values. ",
    "version" : "A string that describes the action version."
  },
  "maxBatchSize" : "The maximum number of jobs to return in a poll for jobs call.",
  "queryParam" : "A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned."
}

$body#

Represents the input of a PollForThirdPartyJobs action.

Type: object

{
  "actionTypeId" : {
    "owner" : "The creator of the action being called.",
    "provider" : "The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.",
    "category" : "A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values. ",
    "version" : "A string that describes the action version."
  },
  "maxBatchSize" : "The maximum number of jobs to return in a poll for jobs call."
}

$body#

Represents the input of a PutActionRevision action.

Type: object

{
  "pipelineName" : "The name of the pipeline that starts processing the revision to the source.",
  "actionRevision" : {
    "revisionId" : "The system-generated unique ID that identifies the revision number of the action.",
    "revisionChangeId" : "The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).",
    "created" : "The date and time when the most recent version of the action was created, in timestamp format."
  },
  "stageName" : "The name of the stage that contains the action that acts on the revision.",
  "actionName" : "The name of the action that processes the revision."
}

$body#

Represents the input of a PutApprovalResult action.

Type: object

{
  "pipelineName" : "The name of the pipeline that contains the action. ",
  "result" : {
    "summary" : "The summary of the current status of the approval request.",
    "status" : "The response submitted by a reviewer assigned to an approval action request."
  },
  "stageName" : "The name of the stage that contains the action.",
  "actionName" : "The name of the action for which approval is requested.",
  "token" : "The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid."
}

$body#

Represents the input of a PutJobFailureResult action.

Type: object

{
  "jobId" : "The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.",
  "failureDetails" : {
    "type" : "The type of the failure.",
    "message" : "The message about the failure.",
    "externalExecutionId" : "The external ID of the run of the action that failed."
  }
}

$body#

Represents the input of a PutJobSuccessResult action.

Type: object

{
  "jobId" : "The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.",
  "currentRevision" : {
    "created" : "The date and time when the most recent revision of the artifact was created, in timestamp format.",
    "changeIdentifier" : "The change identifier for the current revision.",
    "revisionSummary" : "The summary of the most recent revision of the artifact.",
    "revision" : "The revision ID of the current version of an artifact."
  },
  "executionDetails" : {
    "summary" : "The summary of the current status of the actions.",
    "percentComplete" : "The percentage of work completed on the action, represented on a scale of 0 to 100 percent.",
    "externalExecutionId" : "The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy."
  },
  "continuationToken" : "A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied."
}

$body#

Represents the input of a PutThirdPartyJobFailureResult action.

Type: object

{
  "jobId" : "The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.",
  "clientToken" : "The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.",
  "failureDetails" : {
    "type" : "The type of the failure.",
    "message" : "The message about the failure.",
    "externalExecutionId" : "The external ID of the run of the action that failed."
  }
}

$body#

Represents the input of a PutThirdPartyJobSuccessResult action.

Type: object

{
  "jobId" : "The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.",
  "currentRevision" : {
    "created" : "The date and time when the most recent revision of the artifact was created, in timestamp format.",
    "changeIdentifier" : "The change identifier for the current revision.",
    "revisionSummary" : "The summary of the most recent revision of the artifact.",
    "revision" : "The revision ID of the current version of an artifact."
  },
  "clientToken" : "The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.",
  "executionDetails" : {
    "summary" : "The summary of the current status of the actions.",
    "percentComplete" : "The percentage of work completed on the action, represented on a scale of 0 to 100 percent.",
    "externalExecutionId" : "The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy."
  },
  "continuationToken" : "A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied."
}

$body#

Type: object

{
  "webhook" : {
    "targetAction" : "The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.",
    "name" : "The name of the webhook.",
    "filters" : [ {
      "matchEquals" : "The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is \"refs/heads/{Branch}\" and the target action has an action configuration property called \"Branch\" with a value of \"master\", the MatchEquals value is evaluated as \"refs/heads/master\". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.",
      "jsonPath" : "A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub."
    } ],
    "targetPipeline" : "The name of the pipeline you want to connect to the webhook.",
    "authenticationConfiguration" : {
      "AllowedIPRange" : "The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.",
      "SecretToken" : "The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set."
    },
    "authentication" : "Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.  \n For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.  \n  IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.  \n  UNAUTHENTICATED accepts all webhook trigger requests regardless of origin. "
  },
  "tags" : [ {
    "value" : "The tag's value.",
    "key" : "The tag's key."
  } ]
}

$body#

Type: object

{
  "webhookName" : "The name of an existing webhook created with PutWebhook to register with a supported third party. "
}

$body#

Represents the input of a RetryStageExecution action.

Type: object

{
  "pipelineName" : "The name of the pipeline that contains the failed stage.",
  "retryMode" : "The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.",
  "stageName" : "The name of the failed stage to be retried.",
  "pipelineExecutionId" : "The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage"
}

$body#

Represents the input of a StartPipelineExecution action.

Type: object

{
  "clientRequestToken" : "The system-generated unique ID used to identify a unique execution request.",
  "name" : "The name of the pipeline to start."
}

$body#

Type: object

{
  "resourceArn" : "The Amazon Resource Name (ARN) of the resource you want to add tags to.",
  "tags" : [ {
    "value" : "The tag's value.",
    "key" : "The tag's key."
  } ]
}

$body#

Type: object

{
  "tagKeys" : [ "string" ],
  "resourceArn" : " The Amazon Resource Name (ARN) of the resource to remove tags from."
}

$body#

Represents the input of an UpdatePipeline action.

Type: object

{
  "pipeline" : {
    "artifactStore" : {
      "location" : "The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.",
      "encryptionKey" : {
        "id" : "The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.  \nAliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.",
        "type" : "The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'."
      },
      "type" : "The type of the artifact store, such as S3."
    },
    "roleArn" : "The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.",
    "name" : "The name of the action to be performed.",
    "stages" : [ {
      "name" : "The name of the stage.",
      "blockers" : [ {
        "name" : "Reserved for future use.",
        "type" : "Reserved for future use."
      } ],
      "actions" : [ {
        "runOrder" : "The order in which actions are run.",
        "actionTypeId" : {
          "owner" : "The creator of the action being called.",
          "provider" : "The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.",
          "category" : "A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values. ",
          "version" : "A string that describes the action version."
        },
        "configuration" : "The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide. \nThe values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:  \n JSON:  \n \"Configuration\" : { Key : Value }, ",
        "outputArtifacts" : [ {
          "name" : "The name of the output of an artifact, such as \"My App\". \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. \nOutput artifact names must be unique within a pipeline."
        } ],
        "roleArn" : "The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.",
        "name" : "The action declaration's name.",
        "region" : "The action declaration's AWS Region, such as us-east-1.",
        "inputArtifacts" : [ {
          "name" : "The name of the artifact to be worked on (for example, \"My App\"). \nThe input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions."
        } ]
      } ]
    } ],
    "artifactStores" : "A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.  \nYou must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.",
    "version" : "The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated."
  }
}