# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AcknowledgeJob](API_AcknowledgeJob.md) 
+  [AcknowledgeThirdPartyJob](API_AcknowledgeThirdPartyJob.md) 
+  [CreateCustomActionType](API_CreateCustomActionType.md) 
+  [CreatePipeline](API_CreatePipeline.md) 
+  [DeleteCustomActionType](API_DeleteCustomActionType.md) 
+  [DeletePipeline](API_DeletePipeline.md) 
+  [DeleteWebhook](API_DeleteWebhook.md) 
+  [DeregisterWebhookWithThirdParty](API_DeregisterWebhookWithThirdParty.md) 
+  [DisableStageTransition](API_DisableStageTransition.md) 
+  [EnableStageTransition](API_EnableStageTransition.md) 
+  [GetActionType](API_GetActionType.md) 
+  [GetJobDetails](API_GetJobDetails.md) 
+  [GetPipeline](API_GetPipeline.md) 
+  [GetPipelineExecution](API_GetPipelineExecution.md) 
+  [GetPipelineState](API_GetPipelineState.md) 
+  [GetThirdPartyJobDetails](API_GetThirdPartyJobDetails.md) 
+  [ListActionExecutions](API_ListActionExecutions.md) 
+  [ListActionTypes](API_ListActionTypes.md) 
+  [ListDeployActionExecutionTargets](API_ListDeployActionExecutionTargets.md) 
+  [ListPipelineExecutions](API_ListPipelineExecutions.md) 
+  [ListPipelines](API_ListPipelines.md) 
+  [ListRuleExecutions](API_ListRuleExecutions.md) 
+  [ListRuleTypes](API_ListRuleTypes.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListWebhooks](API_ListWebhooks.md) 
+  [OverrideStageCondition](API_OverrideStageCondition.md) 
+  [PollForJobs](API_PollForJobs.md) 
+  [PollForThirdPartyJobs](API_PollForThirdPartyJobs.md) 
+  [PutActionRevision](API_PutActionRevision.md) 
+  [PutApprovalResult](API_PutApprovalResult.md) 
+  [PutJobFailureResult](API_PutJobFailureResult.md) 
+  [PutJobSuccessResult](API_PutJobSuccessResult.md) 
+  [PutThirdPartyJobFailureResult](API_PutThirdPartyJobFailureResult.md) 
+  [PutThirdPartyJobSuccessResult](API_PutThirdPartyJobSuccessResult.md) 
+  [PutWebhook](API_PutWebhook.md) 
+  [RegisterWebhookWithThirdParty](API_RegisterWebhookWithThirdParty.md) 
+  [RetryStageExecution](API_RetryStageExecution.md) 
+  [RollbackStage](API_RollbackStage.md) 
+  [StartPipelineExecution](API_StartPipelineExecution.md) 
+  [StopPipelineExecution](API_StopPipelineExecution.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateActionType](API_UpdateActionType.md) 
+  [UpdatePipeline](API_UpdatePipeline.md) 

# AcknowledgeJob
<a name="API_AcknowledgeJob"></a>

Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.

## Request Syntax
<a name="API_AcknowledgeJob_RequestSyntax"></a>

```
{
   "jobId": "string",
   "nonce": "string"
}
```

## Request Parameters
<a name="API_AcknowledgeJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [jobId](#API_AcknowledgeJob_RequestSyntax) **   <a name="CodePipeline-AcknowledgeJob-request-jobId"></a>
The unique system-generated ID of the job for which you want to confirm receipt.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [nonce](#API_AcknowledgeJob_RequestSyntax) **   <a name="CodePipeline-AcknowledgeJob-request-nonce"></a>
A system-generated random number that 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](API_PollForJobs.md) request that returned this job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: Yes

## Response Syntax
<a name="API_AcknowledgeJob_ResponseSyntax"></a>

```
{
   "status": "string"
}
```

## Response Elements
<a name="API_AcknowledgeJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [status](#API_AcknowledgeJob_ResponseSyntax) **   <a name="CodePipeline-AcknowledgeJob-response-status"></a>
Whether the job worker has received the specified job.  
Type: String  
Valid Values: `Created | Queued | Dispatched | InProgress | TimedOut | Succeeded | Failed` 

## Errors
<a name="API_AcknowledgeJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNonceException **   
The nonce was specified in an invalid format.  
HTTP Status Code: 400

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_AcknowledgeJob_Examples"></a>

### Example
<a name="API_AcknowledgeJob_Example_1"></a>

This example illustrates one usage of AcknowledgeJob.

#### Sample Request
<a name="API_AcknowledgeJob_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 63
X-Amz-Target: CodePipeline_20150709.AcknowledgeJob
X-Amz-Date: 20160707T205252Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "nonce": "3",
  "jobId": "f4f4ff82-2d11-EXAMPLE"
}
```

#### Sample Response
<a name="API_AcknowledgeJob_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 23

{
  "status": "InProgress"
}
```

## See Also
<a name="API_AcknowledgeJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/AcknowledgeJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/AcknowledgeJob) 

# AcknowledgeThirdPartyJob
<a name="API_AcknowledgeThirdPartyJob"></a>

Confirms a job worker has received the specified job. Used for partner actions only.

## Request Syntax
<a name="API_AcknowledgeThirdPartyJob_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "jobId": "string",
   "nonce": "string"
}
```

## Request Parameters
<a name="API_AcknowledgeThirdPartyJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_AcknowledgeThirdPartyJob_RequestSyntax) **   <a name="CodePipeline-AcknowledgeThirdPartyJob-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [jobId](#API_AcknowledgeThirdPartyJob_RequestSyntax) **   <a name="CodePipeline-AcknowledgeThirdPartyJob-request-jobId"></a>
The unique system-generated ID of the job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: Yes

 ** [nonce](#API_AcknowledgeThirdPartyJob_RequestSyntax) **   <a name="CodePipeline-AcknowledgeThirdPartyJob-request-nonce"></a>
A system-generated random number that 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](API_GetThirdPartyJobDetails.md) request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: Yes

## Response Syntax
<a name="API_AcknowledgeThirdPartyJob_ResponseSyntax"></a>

```
{
   "status": "string"
}
```

## Response Elements
<a name="API_AcknowledgeThirdPartyJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [status](#API_AcknowledgeThirdPartyJob_ResponseSyntax) **   <a name="CodePipeline-AcknowledgeThirdPartyJob-response-status"></a>
The status information for the third party job, if any.  
Type: String  
Valid Values: `Created | Queued | Dispatched | InProgress | TimedOut | Succeeded | Failed` 

## Errors
<a name="API_AcknowledgeThirdPartyJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidClientTokenException **   
The client token was specified in an invalid format  
HTTP Status Code: 400

 ** InvalidNonceException **   
The nonce was specified in an invalid format.  
HTTP Status Code: 400

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_AcknowledgeThirdPartyJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/AcknowledgeThirdPartyJob) 

# CreateCustomActionType
<a name="API_CreateCustomActionType"></a>

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.

## Request Syntax
<a name="API_CreateCustomActionType_RequestSyntax"></a>

```
{
   "category": "string",
   "configurationProperties": [ 
      { 
         "description": "string",
         "key": boolean,
         "name": "string",
         "queryable": boolean,
         "required": boolean,
         "secret": boolean,
         "type": "string"
      }
   ],
   "inputArtifactDetails": { 
      "maximumCount": number,
      "minimumCount": number
   },
   "outputArtifactDetails": { 
      "maximumCount": number,
      "minimumCount": number
   },
   "provider": "string",
   "settings": { 
      "entityUrlTemplate": "string",
      "executionUrlTemplate": "string",
      "revisionUrlTemplate": "string",
      "thirdPartyConfigurationUrl": "string"
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "version": "string"
}
```

## Request Parameters
<a name="API_CreateCustomActionType_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [category](#API_CreateCustomActionType_RequestSyntax) **   <a name="CodePipeline-CreateCustomActionType-request-category"></a>
The category of the custom action, such as a build action or a test action.  
Type: String  
Valid Values: `Source | Build | Deploy | Test | Invoke | Approval | Compute`   
Required: Yes

 ** [configurationProperties](#API_CreateCustomActionType_RequestSyntax) **   <a name="CodePipeline-CreateCustomActionType-request-configurationProperties"></a>
The configuration properties for the custom action.  
You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of \$1Config:name\$1, as long as the configuration property is both required and not secret. For more information, see [Create a Custom Action for a Pipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html).
Type: Array of [ActionConfigurationProperty](API_ActionConfigurationProperty.md) objects  
Array Members: Maximum number of 10 items.  
Required: No

 ** [inputArtifactDetails](#API_CreateCustomActionType_RequestSyntax) **   <a name="CodePipeline-CreateCustomActionType-request-inputArtifactDetails"></a>
The details of the input artifact for the action, such as its commit ID.  
Type: [ArtifactDetails](API_ArtifactDetails.md) object  
Required: Yes

 ** [outputArtifactDetails](#API_CreateCustomActionType_RequestSyntax) **   <a name="CodePipeline-CreateCustomActionType-request-outputArtifactDetails"></a>
The details of the output artifact of the action, such as its commit ID.  
Type: [ArtifactDetails](API_ArtifactDetails.md) object  
Required: Yes

 ** [provider](#API_CreateCustomActionType_RequestSyntax) **   <a name="CodePipeline-CreateCustomActionType-request-provider"></a>
The provider of the service used in the custom action, such as CodeDeploy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Pattern: `[0-9A-Za-z_-]+`   
Required: Yes

 ** [settings](#API_CreateCustomActionType_RequestSyntax) **   <a name="CodePipeline-CreateCustomActionType-request-settings"></a>
URLs that provide users information about this custom action.  
Type: [ActionTypeSettings](API_ActionTypeSettings.md) object  
Required: No

 ** [tags](#API_CreateCustomActionType_RequestSyntax) **   <a name="CodePipeline-CreateCustomActionType-request-tags"></a>
The tags for the custom action.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [version](#API_CreateCustomActionType_RequestSyntax) **   <a name="CodePipeline-CreateCustomActionType-request-version"></a>
The version identifier of the custom action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 9.  
Pattern: `[0-9A-Za-z_-]+`   
Required: Yes

## Response Syntax
<a name="API_CreateCustomActionType_ResponseSyntax"></a>

```
{
   "actionType": { 
      "actionConfigurationProperties": [ 
         { 
            "description": "string",
            "key": boolean,
            "name": "string",
            "queryable": boolean,
            "required": boolean,
            "secret": boolean,
            "type": "string"
         }
      ],
      "id": { 
         "category": "string",
         "owner": "string",
         "provider": "string",
         "version": "string"
      },
      "inputArtifactDetails": { 
         "maximumCount": number,
         "minimumCount": number
      },
      "outputArtifactDetails": { 
         "maximumCount": number,
         "minimumCount": number
      },
      "settings": { 
         "entityUrlTemplate": "string",
         "executionUrlTemplate": "string",
         "revisionUrlTemplate": "string",
         "thirdPartyConfigurationUrl": "string"
      }
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CreateCustomActionType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionType](#API_CreateCustomActionType_ResponseSyntax) **   <a name="CodePipeline-CreateCustomActionType-response-actionType"></a>
Returns information about the details of an action type.  
Type: [ActionType](API_ActionType.md) object

 ** [tags](#API_CreateCustomActionType_ResponseSyntax) **   <a name="CodePipeline-CreateCustomActionType-response-tags"></a>
Specifies the tags applied to the custom action.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_CreateCustomActionType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Unable to modify the tag due to a simultaneous update request.  
HTTP Status Code: 400

 ** InvalidTagsException **   
The specified resource tags are invalid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The tags limit for a resource has been exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_CreateCustomActionType_Examples"></a>

### Example
<a name="API_CreateCustomActionType_Example_1"></a>

This example illustrates one usage of CreateCustomActionType.

#### Sample Request
<a name="API_CreateCustomActionType_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 665
X-Amz-Target: CodePipeline_20150709.CreateCustomActionType
X-Amz-Date: 20160707T203658Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "category": "Build",
  "settings": {
    "entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/",
    "executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
  },
  "configurationProperties": [
    {
      "description": "The name of the build project must be provided when this action is added to the pipeline.",
      "required": true,
      "secret": false,
      "key": true,
      "type": "String",
      "queryable": false,
      "name": "ProjectName"
    }
  ],
  "version": "1",
  "provider": "JenkinsProviderName",
  "inputArtifactDetails": {
    "maximumCount": 1,
    "minimumCount": 0
  },
  "outputArtifactDetails": {
    "maximumCount": 1,
    "minimumCount": 0
  }
}
```

#### Sample Response
<a name="API_CreateCustomActionType_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 683

{
  "actionType": {
    "actionConfigurationProperties": [
      {
        "description": "The name of the build project must be provided when this action is added to the pipeline.",
        "key": true,
        "name": "ProjectName",
        "queryable": false,
        "required": true,
        "secret": false
      }
    ],
    "id": {
      "__type": "ActionTypeId",
      "category": "Build",
      "owner": "Custom",
      "provider": "JenkinsProviderName",
      "version": "1"
    },
    "inputArtifactDetails": {
      "maximumCount": 1,
      "minimumCount": 0
    },
    "outputArtifactDetails": {
      "maximumCount": 1,
      "minimumCount": 0
    },
    "settings": {
      "entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/",
      "executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
    }
  }
}
```

## See Also
<a name="API_CreateCustomActionType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/CreateCustomActionType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/CreateCustomActionType) 

# CreatePipeline
<a name="API_CreatePipeline"></a>

Creates a pipeline.

**Note**  
In the pipeline structure, you 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`.

## Request Syntax
<a name="API_CreatePipeline_RequestSyntax"></a>

```
{
   "pipeline": { 
      "artifactStore": { 
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "location": "string",
         "type": "string"
      },
      "artifactStores": { 
         "string" : { 
            "encryptionKey": { 
               "id": "string",
               "type": "string"
            },
            "location": "string",
            "type": "string"
         }
      },
      "executionMode": "string",
      "name": "string",
      "pipelineType": "string",
      "roleArn": "string",
      "stages": [ 
         { 
            "actions": [ 
               { 
                  "actionTypeId": { 
                     "category": "string",
                     "owner": "string",
                     "provider": "string",
                     "version": "string"
                  },
                  "commands": [ "string" ],
                  "configuration": { 
                     "string" : "string" 
                  },
                  "environmentVariables": [ 
                     { 
                        "name": "string",
                        "type": "string",
                        "value": "string"
                     }
                  ],
                  "inputArtifacts": [ 
                     { 
                        "name": "string"
                     }
                  ],
                  "name": "string",
                  "namespace": "string",
                  "outputArtifacts": [ 
                     { 
                        "files": [ "string" ],
                        "name": "string"
                     }
                  ],
                  "outputVariables": [ "string" ],
                  "region": "string",
                  "roleArn": "string",
                  "runOrder": number,
                  "timeoutInMinutes": number
               }
            ],
            "beforeEntry": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            },
            "blockers": [ 
               { 
                  "name": "string",
                  "type": "string"
               }
            ],
            "name": "string",
            "onFailure": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ],
               "result": "string",
               "retryConfiguration": { 
                  "retryMode": "string"
               }
            },
            "onSuccess": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            }
         }
      ],
      "triggers": [ 
         { 
            "gitConfiguration": { 
               "pullRequest": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "events": [ "string" ],
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "push": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "tags": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "sourceActionName": "string"
            },
            "providerType": "string"
         }
      ],
      "variables": [ 
         { 
            "defaultValue": "string",
            "description": "string",
            "name": "string"
         }
      ],
      "version": number
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreatePipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipeline](#API_CreatePipeline_RequestSyntax) **   <a name="CodePipeline-CreatePipeline-request-pipeline"></a>
Represents the structure of actions and stages to be performed in the pipeline.   
Type: [PipelineDeclaration](API_PipelineDeclaration.md) object  
Required: Yes

 ** [tags](#API_CreatePipeline_RequestSyntax) **   <a name="CodePipeline-CreatePipeline-request-tags"></a>
The tags for the pipeline.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Syntax
<a name="API_CreatePipeline_ResponseSyntax"></a>

```
{
   "pipeline": { 
      "artifactStore": { 
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "location": "string",
         "type": "string"
      },
      "artifactStores": { 
         "string" : { 
            "encryptionKey": { 
               "id": "string",
               "type": "string"
            },
            "location": "string",
            "type": "string"
         }
      },
      "executionMode": "string",
      "name": "string",
      "pipelineType": "string",
      "roleArn": "string",
      "stages": [ 
         { 
            "actions": [ 
               { 
                  "actionTypeId": { 
                     "category": "string",
                     "owner": "string",
                     "provider": "string",
                     "version": "string"
                  },
                  "commands": [ "string" ],
                  "configuration": { 
                     "string" : "string" 
                  },
                  "environmentVariables": [ 
                     { 
                        "name": "string",
                        "type": "string",
                        "value": "string"
                     }
                  ],
                  "inputArtifacts": [ 
                     { 
                        "name": "string"
                     }
                  ],
                  "name": "string",
                  "namespace": "string",
                  "outputArtifacts": [ 
                     { 
                        "files": [ "string" ],
                        "name": "string"
                     }
                  ],
                  "outputVariables": [ "string" ],
                  "region": "string",
                  "roleArn": "string",
                  "runOrder": number,
                  "timeoutInMinutes": number
               }
            ],
            "beforeEntry": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            },
            "blockers": [ 
               { 
                  "name": "string",
                  "type": "string"
               }
            ],
            "name": "string",
            "onFailure": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ],
               "result": "string",
               "retryConfiguration": { 
                  "retryMode": "string"
               }
            },
            "onSuccess": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            }
         }
      ],
      "triggers": [ 
         { 
            "gitConfiguration": { 
               "pullRequest": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "events": [ "string" ],
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "push": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "tags": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "sourceActionName": "string"
            },
            "providerType": "string"
         }
      ],
      "variables": [ 
         { 
            "defaultValue": "string",
            "description": "string",
            "name": "string"
         }
      ],
      "version": number
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CreatePipeline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [pipeline](#API_CreatePipeline_ResponseSyntax) **   <a name="CodePipeline-CreatePipeline-response-pipeline"></a>
Represents the structure of actions and stages to be performed in the pipeline.   
Type: [PipelineDeclaration](API_PipelineDeclaration.md) object

 ** [tags](#API_CreatePipeline_ResponseSyntax) **   <a name="CodePipeline-CreatePipeline-response-tags"></a>
Specifies the tags applied to the pipeline.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_CreatePipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Unable to modify the tag due to a simultaneous update request.  
HTTP Status Code: 400

 ** InvalidActionDeclarationException **   
The action declaration was specified in an invalid format.  
HTTP Status Code: 400

 ** InvalidBlockerDeclarationException **   
Reserved for future use.  
HTTP Status Code: 400

 ** InvalidStageDeclarationException **   
The stage declaration was specified in an invalid format.  
HTTP Status Code: 400

 ** InvalidStructureException **   
The structure was specified in an invalid format.  
HTTP Status Code: 400

 ** InvalidTagsException **   
The specified resource tags are invalid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.  
HTTP Status Code: 400

 ** PipelineNameInUseException **   
The specified pipeline name is already in use.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The tags limit for a resource has been exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_CreatePipeline_Examples"></a>

### Example
<a name="API_CreatePipeline_Example_1"></a>

This example illustrates one usage of CreatePipeline.

#### Sample Request
<a name="API_CreatePipeline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 923
X-Amz-Target: CodePipeline_20150709.CreatePipeline
X-Amz-Date: 20160707T175936Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "pipeline": {
    "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
    "stages": [
      {
        "name": "Source",
        "actions": [
          {
            "inputArtifacts": [],
            "name": "Source",
            "actionTypeId": {
              "category": "Source",
              "owner": "AWS",
              "version": "1",
              "provider": "S3"
            },
            "outputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "configuration": {
              "S3Bucket": "amzn-s3-demo-bucket",
              "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
            },
            "runOrder": 1
          }
        ]
      },
      {
        "name": "Staging",
        "actions": [
          {
            "inputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "name": "CodePipelineDemoFleet",
            "actionTypeId": {
              "category": "Deploy",
              "owner": "AWS",
              "version": "1",
              "provider": "CodeDeploy"
            },
            "outputArtifacts": [],
            "configuration": {
              "ApplicationName": "CodePipelineDemoApplication",
              "DeploymentGroupName": "CodePipelineDemoFleet"
            },
            "runOrder": 1
          }
        ]
      }
    ],
    "artifactStore": {
      "type": "S3",
      "location": "amzn-s3-demo-bucket"
    },
    "name": "MySecondPipeline",
    "version": 1
  }
}
```

#### Sample Response
<a name="API_CreatePipeline_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 907

{
  "pipeline": {
    "artifactStore": {
      "location": "amzn-s3-demo-bucket",
      "type": "S3"
    },
    "name": "MySecondPipeline",
    "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
    "stages": [
      {
        "actions": [
          {
            "actionTypeId": {
              "__type": "ActionTypeId",
              "category": "Source",
              "owner": "AWS",
              "provider": "S3",
              "version": "1"
            },
            "configuration": {
              "S3Bucket": "amzn-s3-demo-bucket",
              "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
            },
            "inputArtifacts": [],
            "name": "Source",
            "outputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "runOrder": 1
          }
        ],
        "name": "Source"
      },
      {
        "actions": [
          {
            "actionTypeId": {
              "__type": "ActionTypeId",
              "category": "Deploy",
              "owner": "AWS",
              "provider": "CodeDeploy",
              "version": "1"
            },
            "configuration": {
              "ApplicationName": "CodePipelineDemoApplication",
              "DeploymentGroupName": "CodePipelineDemoFleet"
            },
            "inputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "name": "CodePipelineDemoFleet",
            "outputArtifacts": [],
            "runOrder": 1
          }
        ],
        "name": "Staging"
      }
    ],
    "version": 1
  }
}
```

## See Also
<a name="API_CreatePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/CreatePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/CreatePipeline) 

# DeleteCustomActionType
<a name="API_DeleteCustomActionType"></a>

Marks a custom action as deleted. `PollForJobs` for the custom action fails after the action is marked for deletion. Used for custom actions only.

**Important**  
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.

## Request Syntax
<a name="API_DeleteCustomActionType_RequestSyntax"></a>

```
{
   "category": "string",
   "provider": "string",
   "version": "string"
}
```

## Request Parameters
<a name="API_DeleteCustomActionType_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [category](#API_DeleteCustomActionType_RequestSyntax) **   <a name="CodePipeline-DeleteCustomActionType-request-category"></a>
The category of the custom action that you want to delete, such as source or deploy.  
Type: String  
Valid Values: `Source | Build | Deploy | Test | Invoke | Approval | Compute`   
Required: Yes

 ** [provider](#API_DeleteCustomActionType_RequestSyntax) **   <a name="CodePipeline-DeleteCustomActionType-request-provider"></a>
The provider of the service used in the custom action, such as CodeDeploy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Pattern: `[0-9A-Za-z_-]+`   
Required: Yes

 ** [version](#API_DeleteCustomActionType_RequestSyntax) **   <a name="CodePipeline-DeleteCustomActionType-request-version"></a>
The version of the custom action to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 9.  
Pattern: `[0-9A-Za-z_-]+`   
Required: Yes

## Response Elements
<a name="API_DeleteCustomActionType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteCustomActionType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Unable to modify the tag due to a simultaneous update request.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteCustomActionType_Examples"></a>

### Example
<a name="API_DeleteCustomActionType_Example_1"></a>

This example illustrates one usage of DeleteCustomActionType.

#### Sample Request
<a name="API_DeleteCustomActionType_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 68
X-Amz-Target: CodePipeline_20150709.DeleteCustomActionType
X-Amz-Date: 20151030T233944Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "category": "Build",
  "version": "1",
  "provider": "JenkinsProviderName"
}
```

#### Sample Response
<a name="API_DeleteCustomActionType_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0
```

## See Also
<a name="API_DeleteCustomActionType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/DeleteCustomActionType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/DeleteCustomActionType) 

# DeletePipeline
<a name="API_DeletePipeline"></a>

Deletes the specified pipeline.

## Request Syntax
<a name="API_DeletePipeline_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_DeletePipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_DeletePipeline_RequestSyntax) **   <a name="CodePipeline-DeletePipeline-request-name"></a>
The name of the pipeline to be deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Elements
<a name="API_DeletePipeline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Unable to modify the tag due to a simultaneous update request.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_DeletePipeline_Examples"></a>

### Example
<a name="API_DeletePipeline_Example_1"></a>

This example illustrates one usage of DeletePipeline.

#### Sample Request
<a name="API_DeletePipeline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 25
X-Amz-Target: CodePipeline_20150709.DeletePipeline
X-Amz-Date: 20160707T202402Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "name": "MySecondPipeline"
}
```

#### Sample Response
<a name="API_DeletePipeline_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0
```

## See Also
<a name="API_DeletePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/DeletePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/DeletePipeline) 

# DeleteWebhook
<a name="API_DeleteWebhook"></a>

Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.

## Request Syntax
<a name="API_DeleteWebhook_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_DeleteWebhook_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_DeleteWebhook_RequestSyntax) **   <a name="CodePipeline-DeleteWebhook-request-name"></a>
The name of the webhook you want to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Elements
<a name="API_DeleteWebhook_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteWebhook_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Unable to modify the tag due to a simultaneous update request.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteWebhook_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/DeleteWebhook) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/DeleteWebhook) 

# DeregisterWebhookWithThirdParty
<a name="API_DeregisterWebhookWithThirdParty"></a>

Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.

## Request Syntax
<a name="API_DeregisterWebhookWithThirdParty_RequestSyntax"></a>

```
{
   "webhookName": "string"
}
```

## Request Parameters
<a name="API_DeregisterWebhookWithThirdParty_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [webhookName](#API_DeregisterWebhookWithThirdParty_RequestSyntax) **   <a name="CodePipeline-DeregisterWebhookWithThirdParty-request-webhookName"></a>
The name of the webhook you want to deregister.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: No

## Response Elements
<a name="API_DeregisterWebhookWithThirdParty_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeregisterWebhookWithThirdParty_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

 ** WebhookNotFoundException **   
The specified webhook was entered in an invalid format or cannot be found.  
HTTP Status Code: 400

## See Also
<a name="API_DeregisterWebhookWithThirdParty_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/DeregisterWebhookWithThirdParty) 

# DisableStageTransition
<a name="API_DisableStageTransition"></a>

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

## Request Syntax
<a name="API_DisableStageTransition_RequestSyntax"></a>

```
{
   "pipelineName": "string",
   "reason": "string",
   "stageName": "string",
   "transitionType": "string"
}
```

## Request Parameters
<a name="API_DisableStageTransition_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineName](#API_DisableStageTransition_RequestSyntax) **   <a name="CodePipeline-DisableStageTransition-request-pipelineName"></a>
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [reason](#API_DisableStageTransition_RequestSyntax) **   <a name="CodePipeline-DisableStageTransition-request-reason"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Pattern: `[a-zA-Z0-9!@ \(\)\.\*\?\-]+`   
Required: Yes

 ** [stageName](#API_DisableStageTransition_RequestSyntax) **   <a name="CodePipeline-DisableStageTransition-request-stageName"></a>
The name of the stage where you want to disable the inbound or outbound transition of artifacts.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [transitionType](#API_DisableStageTransition_RequestSyntax) **   <a name="CodePipeline-DisableStageTransition-request-transitionType"></a>
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).  
Type: String  
Valid Values: `Inbound | Outbound`   
Required: Yes

## Response Elements
<a name="API_DisableStageTransition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisableStageTransition_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** StageNotFoundException **   
The stage was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_DisableStageTransition_Examples"></a>

### Example
<a name="API_DisableStageTransition_Example_1"></a>

This example illustrates one usage of DisableStageTransition.

#### Sample Request
<a name="API_DisableStageTransition_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 108
X-Amz-Target: CodePipeline_20150709.DisableStageTransition
X-Amz-Date: 20160707T182043Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "reason": "An example reason",
  "pipelineName": "MyFirstPipeline",
  "stageName": "Staging",
  "transitionType": "Inbound"
}
```

#### Sample Response
<a name="API_DisableStageTransition_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0
```

## See Also
<a name="API_DisableStageTransition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/DisableStageTransition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/DisableStageTransition) 

# EnableStageTransition
<a name="API_EnableStageTransition"></a>

Enables artifacts in a pipeline to transition to a stage in a pipeline.

## Request Syntax
<a name="API_EnableStageTransition_RequestSyntax"></a>

```
{
   "pipelineName": "string",
   "stageName": "string",
   "transitionType": "string"
}
```

## Request Parameters
<a name="API_EnableStageTransition_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineName](#API_EnableStageTransition_RequestSyntax) **   <a name="CodePipeline-EnableStageTransition-request-pipelineName"></a>
The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [stageName](#API_EnableStageTransition_RequestSyntax) **   <a name="CodePipeline-EnableStageTransition-request-stageName"></a>
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).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [transitionType](#API_EnableStageTransition_RequestSyntax) **   <a name="CodePipeline-EnableStageTransition-request-transitionType"></a>
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).  
Type: String  
Valid Values: `Inbound | Outbound`   
Required: Yes

## Response Elements
<a name="API_EnableStageTransition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_EnableStageTransition_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** StageNotFoundException **   
The stage was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_EnableStageTransition_Examples"></a>

### Example
<a name="API_EnableStageTransition_Example_1"></a>

This example illustrates one usage of EnableStageTransition.

#### Sample Request
<a name="API_EnableStageTransition_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 85
X-Amz-Target: CodePipeline_20150709.EnableStageTransition
X-Amz-Date: 20160707T182342Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "pipelineName": "MyFirstPipeline",
  "stageName": "Staging",
  "transitionType": "Inbound"
}
```

#### Sample Response
<a name="API_EnableStageTransition_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0
```

## See Also
<a name="API_EnableStageTransition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/EnableStageTransition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/EnableStageTransition) 

# GetActionType
<a name="API_GetActionType"></a>

Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.

## Request Syntax
<a name="API_GetActionType_RequestSyntax"></a>

```
{
   "category": "string",
   "owner": "string",
   "provider": "string",
   "version": "string"
}
```

## Request Parameters
<a name="API_GetActionType_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [category](#API_GetActionType_RequestSyntax) **   <a name="CodePipeline-GetActionType-request-category"></a>
Defines what kind of action can be taken in the stage. The following are the valid values:  
+  `Source` 
+  `Build` 
+  `Test` 
+  `Deploy` 
+  `Approval` 
+  `Invoke` 
+  `Compute` 
Type: String  
Valid Values: `Source | Build | Deploy | Test | Invoke | Approval | Compute`   
Required: Yes

 ** [owner](#API_GetActionType_RequestSyntax) **   <a name="CodePipeline-GetActionType-request-owner"></a>
The creator of an action type that was created with any supported integration model. There are two valid values: `AWS` and `ThirdParty`.  
Type: String  
Pattern: `AWS|ThirdParty`   
Required: Yes

 ** [provider](#API_GetActionType_RequestSyntax) **   <a name="CodePipeline-GetActionType-request-provider"></a>
The provider of the action type being called. The provider name is specified when the action type is created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 35.  
Pattern: `[0-9A-Za-z_-]+`   
Required: Yes

 ** [version](#API_GetActionType_RequestSyntax) **   <a name="CodePipeline-GetActionType-request-version"></a>
A string that describes the action type version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 9.  
Pattern: `[0-9A-Za-z_-]+`   
Required: Yes

## Response Syntax
<a name="API_GetActionType_ResponseSyntax"></a>

```
{
   "actionType": { 
      "description": "string",
      "executor": { 
         "configuration": { 
            "jobWorkerExecutorConfiguration": { 
               "pollingAccounts": [ "string" ],
               "pollingServicePrincipals": [ "string" ]
            },
            "lambdaExecutorConfiguration": { 
               "lambdaFunctionArn": "string"
            }
         },
         "jobTimeout": number,
         "policyStatementsTemplate": "string",
         "type": "string"
      },
      "id": { 
         "category": "string",
         "owner": "string",
         "provider": "string",
         "version": "string"
      },
      "inputArtifactDetails": { 
         "maximumCount": number,
         "minimumCount": number
      },
      "outputArtifactDetails": { 
         "maximumCount": number,
         "minimumCount": number
      },
      "permissions": { 
         "allowedAccounts": [ "string" ]
      },
      "properties": [ 
         { 
            "description": "string",
            "key": boolean,
            "name": "string",
            "noEcho": boolean,
            "optional": boolean,
            "queryable": boolean
         }
      ],
      "urls": { 
         "configurationUrl": "string",
         "entityUrlTemplate": "string",
         "executionUrlTemplate": "string",
         "revisionUrlTemplate": "string"
      }
   }
}
```

## Response Elements
<a name="API_GetActionType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionType](#API_GetActionType_ResponseSyntax) **   <a name="CodePipeline-GetActionType-response-actionType"></a>
The action type information for the requested action type, such as the action type ID.  
Type: [ActionTypeDeclaration](API_ActionTypeDeclaration.md) object

## Errors
<a name="API_GetActionType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ActionTypeNotFoundException **   
The specified action type cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_GetActionType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/GetActionType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/GetActionType) 

# GetJobDetails
<a name="API_GetJobDetails"></a>

Returns information about a job. Used for custom actions only.

**Important**  
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

## Request Syntax
<a name="API_GetJobDetails_RequestSyntax"></a>

```
{
   "jobId": "string"
}
```

## Request Parameters
<a name="API_GetJobDetails_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [jobId](#API_GetJobDetails_RequestSyntax) **   <a name="CodePipeline-GetJobDetails-request-jobId"></a>
The unique system-generated ID for the job.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_GetJobDetails_ResponseSyntax"></a>

```
{
   "jobDetails": { 
      "accountId": "string",
      "data": { 
         "actionConfiguration": { 
            "configuration": { 
               "string" : "string" 
            }
         },
         "actionTypeId": { 
            "category": "string",
            "owner": "string",
            "provider": "string",
            "version": "string"
         },
         "artifactCredentials": { 
            "accessKeyId": "string",
            "secretAccessKey": "string",
            "sessionToken": "string"
         },
         "continuationToken": "string",
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "inputArtifacts": [ 
            { 
               "location": { 
                  "s3Location": { 
                     "bucketName": "string",
                     "objectKey": "string"
                  },
                  "type": "string"
               },
               "name": "string",
               "revision": "string"
            }
         ],
         "outputArtifacts": [ 
            { 
               "location": { 
                  "s3Location": { 
                     "bucketName": "string",
                     "objectKey": "string"
                  },
                  "type": "string"
               },
               "name": "string",
               "revision": "string"
            }
         ],
         "pipelineContext": { 
            "action": { 
               "actionExecutionId": "string",
               "name": "string"
            },
            "pipelineArn": "string",
            "pipelineExecutionId": "string",
            "pipelineName": "string",
            "stage": { 
               "name": "string"
            }
         }
      },
      "id": "string"
   }
}
```

## Response Elements
<a name="API_GetJobDetails_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [jobDetails](#API_GetJobDetails_ResponseSyntax) **   <a name="CodePipeline-GetJobDetails-response-jobDetails"></a>
The details of the job.  
If AWSSessionCredentials is used, a long-running job can call `GetJobDetails` again to obtain new credentials.
Type: [JobDetails](API_JobDetails.md) object

## Errors
<a name="API_GetJobDetails_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_GetJobDetails_Examples"></a>

### Example
<a name="API_GetJobDetails_Example_1"></a>

This example illustrates one usage of GetJobDetails.

#### Sample Request
<a name="API_GetJobDetails_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 49
X-Amz-Target: CodePipeline_20150709.GetJobDetails
X-Amz-Date: 20151030T230237Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "jobId": "ef66c259-EXAMPLE"
}
```

#### Sample Response
<a name="API_GetJobDetails_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1822

{
  "jobDetails": {
    "accountId": "111111111111",
    "data": {
      "actionConfiguration": {
        "__type": "ActionConfiguration",
        "configuration": {
          "ProjectName": "JenkinsTestProject"
        }
      },
      "actionTypeId": {
        "__type": "ActionTypeId",
        "category": "Test",
        "owner": "Custom",
        "provider": "JenkinsProviderName",
        "version": "1"
      },
      "artifactCredentials": {
        "__type": "AWSSessionCredentials",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        "sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE="
      },
      "inputArtifacts": [
        {
          "__type": "Artifact",
          "location": {
            "s3Location": {
              "bucketName": "amzn-s3-demo-bucket",
              "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
            },
            "type": "S3"
          },
          "name": "MyAppBuild"
        }
      ],
      "outputArtifacts": [],
      "pipelineContext": {
        "__type": "PipelineContext",
        "action": {
          "name": "JenkinsTestAction"
        },
        "pipelineName": "MySecondPipeline",
        "stage": {
          "name": "Testing"
        }
      }
    },
    "id": "ef66c259-EXAMPLE"
  }
}
```

## See Also
<a name="API_GetJobDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/GetJobDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/GetJobDetails) 

# GetPipeline
<a name="API_GetPipeline"></a>

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with [UpdatePipeline](API_UpdatePipeline.md).

## Request Syntax
<a name="API_GetPipeline_RequestSyntax"></a>

```
{
   "name": "string",
   "version": number
}
```

## Request Parameters
<a name="API_GetPipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetPipeline_RequestSyntax) **   <a name="CodePipeline-GetPipeline-request-name"></a>
The name of the pipeline for which you want to get information. Pipeline names must be unique in an AWS account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [version](#API_GetPipeline_RequestSyntax) **   <a name="CodePipeline-GetPipeline-request-version"></a>
The version number of the pipeline. If you do not specify a version, defaults to the current version.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## Response Syntax
<a name="API_GetPipeline_ResponseSyntax"></a>

```
{
   "metadata": { 
      "created": number,
      "pipelineArn": "string",
      "pollingDisabledAt": number,
      "updated": number
   },
   "pipeline": { 
      "artifactStore": { 
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "location": "string",
         "type": "string"
      },
      "artifactStores": { 
         "string" : { 
            "encryptionKey": { 
               "id": "string",
               "type": "string"
            },
            "location": "string",
            "type": "string"
         }
      },
      "executionMode": "string",
      "name": "string",
      "pipelineType": "string",
      "roleArn": "string",
      "stages": [ 
         { 
            "actions": [ 
               { 
                  "actionTypeId": { 
                     "category": "string",
                     "owner": "string",
                     "provider": "string",
                     "version": "string"
                  },
                  "commands": [ "string" ],
                  "configuration": { 
                     "string" : "string" 
                  },
                  "environmentVariables": [ 
                     { 
                        "name": "string",
                        "type": "string",
                        "value": "string"
                     }
                  ],
                  "inputArtifacts": [ 
                     { 
                        "name": "string"
                     }
                  ],
                  "name": "string",
                  "namespace": "string",
                  "outputArtifacts": [ 
                     { 
                        "files": [ "string" ],
                        "name": "string"
                     }
                  ],
                  "outputVariables": [ "string" ],
                  "region": "string",
                  "roleArn": "string",
                  "runOrder": number,
                  "timeoutInMinutes": number
               }
            ],
            "beforeEntry": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            },
            "blockers": [ 
               { 
                  "name": "string",
                  "type": "string"
               }
            ],
            "name": "string",
            "onFailure": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ],
               "result": "string",
               "retryConfiguration": { 
                  "retryMode": "string"
               }
            },
            "onSuccess": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            }
         }
      ],
      "triggers": [ 
         { 
            "gitConfiguration": { 
               "pullRequest": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "events": [ "string" ],
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "push": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "tags": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "sourceActionName": "string"
            },
            "providerType": "string"
         }
      ],
      "variables": [ 
         { 
            "defaultValue": "string",
            "description": "string",
            "name": "string"
         }
      ],
      "version": number
   }
}
```

## Response Elements
<a name="API_GetPipeline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [metadata](#API_GetPipeline_ResponseSyntax) **   <a name="CodePipeline-GetPipeline-response-metadata"></a>
Represents the pipeline metadata information returned as part of the output of a `GetPipeline` action.  
Type: [PipelineMetadata](API_PipelineMetadata.md) object

 ** [pipeline](#API_GetPipeline_ResponseSyntax) **   <a name="CodePipeline-GetPipeline-response-pipeline"></a>
Represents the structure of actions and stages to be performed in the pipeline.   
Type: [PipelineDeclaration](API_PipelineDeclaration.md) object

## Errors
<a name="API_GetPipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** PipelineVersionNotFoundException **   
The pipeline version was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_GetPipeline_Examples"></a>

### Example
<a name="API_GetPipeline_Example_1"></a>

This example illustrates one usage of GetPipeline.

#### Sample Request
<a name="API_GetPipeline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: CodePipeline_20150709.GetPipeline
X-Amz-Date: 20160707T171559Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "name": "MyFirstPipeline"
}
```

#### Sample Response
<a name="API_GetPipeline_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 898

{
    "pipeline": {
        "roleArn": "arn:aws:iam::11111EXAMPLE:role/AWS-CodePipeline-Service",
        "stages": [
            {
                "name": "Source",
                "actions": [
                    {
                        "actionTypeId": {
                            "category": "Source",
                            "owner": "AWS",
                            "provider": "S3",
                            "version": "1"
                        },
                        "configuration": {
                            "PollForSourceChanges": "true",
                            "S3Bucket": "amzn-s3-demo-bucket",
                            "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
                        },
                        "inputArtifacts": [],
                        "name": "Source",
                        "outputArtifacts": [
                            {
                                "name": "MyApp"
                            }
                        ],
                        "runOrder": 1
                    }
                ]
            },
            {
                "name": "Build",
                "actions": [
                    {
                        "actionTypeId": {
                            "category": "Build",
                            "owner": "AWS",
                            "provider": "CodeBuild",
                            "version": "1"
                        },
                        "configuration": {
                            "ProjectName": "BuildProject"
                        },
                        "inputArtifacts": [
                            {
                                "name": "MyApp"
                            }
                        ],
                        "name": "CodeBuild",
                        "outputArtifacts": [
                            {
                                "name": "MyAppBuild"
                            }
                        ],
                        "runOrder": 1
                    }
                ]
            }
        ],
        "artifactStore": {
            "type": "S3",
            "location": "codepipeline-us-east-2-250656481468"
        },
        "name": "MyFirstPipeline",
        "version": 1
    },
    "metadata": {
        "pipelineArn": "arn:aws:codepipeline:us-east-2:80398EXAMPLE:MyFirstPipeline",
        "updated": 1501626591.112,
        "created": 1501626591.112
    }
}
```

## See Also
<a name="API_GetPipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/GetPipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/GetPipeline) 

# GetPipelineExecution
<a name="API_GetPipelineExecution"></a>

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

## Request Syntax
<a name="API_GetPipelineExecution_RequestSyntax"></a>

```
{
   "pipelineExecutionId": "string",
   "pipelineName": "string"
}
```

## Request Parameters
<a name="API_GetPipelineExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineExecutionId](#API_GetPipelineExecution_RequestSyntax) **   <a name="CodePipeline-GetPipelineExecution-request-pipelineExecutionId"></a>
The ID of the pipeline execution about which you want to get execution details.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [pipelineName](#API_GetPipelineExecution_RequestSyntax) **   <a name="CodePipeline-GetPipelineExecution-request-pipelineName"></a>
The name of the pipeline about which you want to get execution details.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Syntax
<a name="API_GetPipelineExecution_ResponseSyntax"></a>

```
{
   "pipelineExecution": { 
      "artifactRevisions": [ 
         { 
            "created": number,
            "name": "string",
            "revisionChangeIdentifier": "string",
            "revisionId": "string",
            "revisionSummary": "string",
            "revisionUrl": "string"
         }
      ],
      "executionMode": "string",
      "executionType": "string",
      "pipelineExecutionId": "string",
      "pipelineName": "string",
      "pipelineVersion": number,
      "rollbackMetadata": { 
         "rollbackTargetPipelineExecutionId": "string"
      },
      "status": "string",
      "statusSummary": "string",
      "trigger": { 
         "triggerDetail": "string",
         "triggerType": "string"
      },
      "variables": [ 
         { 
            "name": "string",
            "resolvedValue": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_GetPipelineExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [pipelineExecution](#API_GetPipelineExecution_ResponseSyntax) **   <a name="CodePipeline-GetPipelineExecution-response-pipelineExecution"></a>
Represents information about the execution of a pipeline.  
Type: [PipelineExecution](API_PipelineExecution.md) object

## Errors
<a name="API_GetPipelineExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** PipelineExecutionNotFoundException **   
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.   
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_GetPipelineExecution_Examples"></a>

### Example
<a name="API_GetPipelineExecution_Example_1"></a>

This example illustrates one usage of GetPipelineExecution.

#### Sample Request
<a name="API_GetPipelineExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: CodePipeline_20150709.GetPipelineExecution
X-Amz-Date: 20160707T171559Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
   "pipelineExecutionId": "42ee4d10-e4de-a37c-82b7-36c11EXAMPLE",
   "pipelineName": "MyFirstPipeline"
}
```

#### Sample Response
<a name="API_GetPipelineExecution_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 318

{
    "pipelineExecution": {
        "artifactRevisions": [
            {
                "created": 1427298837.7689769,
		"name": "MyApp",
                "revisionChangeIdentifier": "1427298921.3976923",
                "revisionId": "7636d59f3c461cEXAMPLE8417dbc6371",
                "revisionSummary": "Updating the application for feature 12-4820",
                "revisionUrl": "https://api.github.com/repos/anycompany/MyApp/git/commits/7636d59f3c461cEXAMPLE8417dbc6371"
            }
        ],
        "pipelineExecutionId": "3137f7cb-7cf7-039j-s83l-d7eu3EXAMPLE",
        "pipelineName": "MyFirstPipeline",
        "pipelineVersion": 2,
        "status": "Succeeded"
    }
}
```

## See Also
<a name="API_GetPipelineExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/GetPipelineExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/GetPipelineExecution) 

# GetPipelineState
<a name="API_GetPipelineState"></a>

Returns information about the state of a pipeline, including the stages and actions.

**Note**  
Values returned in the `revisionId` and `revisionUrl` fields indicate the source revision information, such as the commit ID, for the current state.

## Request Syntax
<a name="API_GetPipelineState_RequestSyntax"></a>

```
{
   "name": "string"
}
```

## Request Parameters
<a name="API_GetPipelineState_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [name](#API_GetPipelineState_RequestSyntax) **   <a name="CodePipeline-GetPipelineState-request-name"></a>
The name of the pipeline about which you want to get information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Syntax
<a name="API_GetPipelineState_ResponseSyntax"></a>

```
{
   "created": number,
   "pipelineName": "string",
   "pipelineVersion": number,
   "stageStates": [ 
      { 
         "actionStates": [ 
            { 
               "actionName": "string",
               "currentRevision": { 
                  "created": number,
                  "revisionChangeId": "string",
                  "revisionId": "string"
               },
               "entityUrl": "string",
               "latestExecution": { 
                  "actionExecutionId": "string",
                  "errorDetails": { 
                     "code": "string",
                     "message": "string"
                  },
                  "externalExecutionId": "string",
                  "externalExecutionUrl": "string",
                  "lastStatusChange": number,
                  "lastUpdatedBy": "string",
                  "logStreamARN": "string",
                  "percentComplete": number,
                  "status": "string",
                  "summary": "string",
                  "token": "string"
               },
               "revisionUrl": "string"
            }
         ],
         "beforeEntryConditionState": { 
            "conditionStates": [ 
               { 
                  "latestExecution": { 
                     "lastStatusChange": number,
                     "status": "string",
                     "summary": "string"
                  },
                  "ruleStates": [ 
                     { 
                        "currentRevision": { 
                           "created": number,
                           "revisionChangeId": "string",
                           "revisionId": "string"
                        },
                        "entityUrl": "string",
                        "latestExecution": { 
                           "errorDetails": { 
                              "code": "string",
                              "message": "string"
                           },
                           "externalExecutionId": "string",
                           "externalExecutionUrl": "string",
                           "lastStatusChange": number,
                           "lastUpdatedBy": "string",
                           "ruleExecutionId": "string",
                           "status": "string",
                           "summary": "string",
                           "token": "string"
                        },
                        "revisionUrl": "string",
                        "ruleName": "string"
                     }
                  ]
               }
            ],
            "latestExecution": { 
               "status": "string",
               "summary": "string"
            }
         },
         "inboundExecution": { 
            "pipelineExecutionId": "string",
            "status": "string",
            "type": "string"
         },
         "inboundExecutions": [ 
            { 
               "pipelineExecutionId": "string",
               "status": "string",
               "type": "string"
            }
         ],
         "inboundTransitionState": { 
            "disabledReason": "string",
            "enabled": boolean,
            "lastChangedAt": number,
            "lastChangedBy": "string"
         },
         "latestExecution": { 
            "pipelineExecutionId": "string",
            "status": "string",
            "type": "string"
         },
         "onFailureConditionState": { 
            "conditionStates": [ 
               { 
                  "latestExecution": { 
                     "lastStatusChange": number,
                     "status": "string",
                     "summary": "string"
                  },
                  "ruleStates": [ 
                     { 
                        "currentRevision": { 
                           "created": number,
                           "revisionChangeId": "string",
                           "revisionId": "string"
                        },
                        "entityUrl": "string",
                        "latestExecution": { 
                           "errorDetails": { 
                              "code": "string",
                              "message": "string"
                           },
                           "externalExecutionId": "string",
                           "externalExecutionUrl": "string",
                           "lastStatusChange": number,
                           "lastUpdatedBy": "string",
                           "ruleExecutionId": "string",
                           "status": "string",
                           "summary": "string",
                           "token": "string"
                        },
                        "revisionUrl": "string",
                        "ruleName": "string"
                     }
                  ]
               }
            ],
            "latestExecution": { 
               "status": "string",
               "summary": "string"
            }
         },
         "onSuccessConditionState": { 
            "conditionStates": [ 
               { 
                  "latestExecution": { 
                     "lastStatusChange": number,
                     "status": "string",
                     "summary": "string"
                  },
                  "ruleStates": [ 
                     { 
                        "currentRevision": { 
                           "created": number,
                           "revisionChangeId": "string",
                           "revisionId": "string"
                        },
                        "entityUrl": "string",
                        "latestExecution": { 
                           "errorDetails": { 
                              "code": "string",
                              "message": "string"
                           },
                           "externalExecutionId": "string",
                           "externalExecutionUrl": "string",
                           "lastStatusChange": number,
                           "lastUpdatedBy": "string",
                           "ruleExecutionId": "string",
                           "status": "string",
                           "summary": "string",
                           "token": "string"
                        },
                        "revisionUrl": "string",
                        "ruleName": "string"
                     }
                  ]
               }
            ],
            "latestExecution": { 
               "status": "string",
               "summary": "string"
            }
         },
         "retryStageMetadata": { 
            "autoStageRetryAttempt": number,
            "latestRetryTrigger": "string",
            "manualStageRetryAttempt": number
         },
         "stageName": "string"
      }
   ],
   "updated": number
}
```

## Response Elements
<a name="API_GetPipelineState_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [created](#API_GetPipelineState_ResponseSyntax) **   <a name="CodePipeline-GetPipelineState-response-created"></a>
The date and time the pipeline was created, in timestamp format.  
Type: Timestamp

 ** [pipelineName](#API_GetPipelineState_ResponseSyntax) **   <a name="CodePipeline-GetPipelineState-response-pipelineName"></a>
The name of the pipeline for which you want to get the state.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+` 

 ** [pipelineVersion](#API_GetPipelineState_ResponseSyntax) **   <a name="CodePipeline-GetPipelineState-response-pipelineVersion"></a>
The version number of the pipeline.  
A newly created pipeline is always assigned a version number of `1`.
Type: Integer  
Valid Range: Minimum value of 1.

 ** [stageStates](#API_GetPipelineState_ResponseSyntax) **   <a name="CodePipeline-GetPipelineState-response-stageStates"></a>
A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.  
Type: Array of [StageState](API_StageState.md) objects

 ** [updated](#API_GetPipelineState_ResponseSyntax) **   <a name="CodePipeline-GetPipelineState-response-updated"></a>
The date and time the pipeline was last updated, in timestamp format.  
Type: Timestamp

## Errors
<a name="API_GetPipelineState_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_GetPipelineState_Examples"></a>

### Example
<a name="API_GetPipelineState_Example_1"></a>

This example illustrates one usage of GetPipelineState.

#### Sample Request
<a name="API_GetPipelineState_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: CodePipeline_20150709.GetPipelineState
X-Amz-Date: 20160707T172005Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "name": "MyFirstPipeline"
}
```

#### Sample Response
<a name="API_GetPipelineState_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 827

{
    "created": 1446137312.204,
    "pipelineName": "MyFirstPipeline",
    "pipelineVersion": 1,
    "stageStates": [
        {
            "actionStates": [
                {
                    "actionName": "Source",
                    "currentRevision": {
                        "created": 1446726163.571,
                        "revisionId": "HYGp7zmwbCPPwo234xsCEM7d6ToeAqIl"
                    },
                    "entityUrl": "https://console.aws.amazon.com/s3/home?#",
                    "latestExecution": {
                        "lastStatusChange": 1446137358.328,
                        "status": "Succeeded"
                    }
                }
            ],
            "stageName": "Source"
        },
        {
            "actionStates": [
                {
                    "actionName": "CodePipelineDemoFleet",
                    "currentRevision": {
                        "created": 1466726263.189,
                        "revisionId": "{\"bucket\":\"codepipeline-us-east-1-2770EXAMPLE\",\"key\":\"MyFirstPipeline/MyApp/QI8RTZY.zip\",\"bundleType\":\"zip\",\"version\":null,\"etag\":\"f51889bff5402b0249676e48cEXAMPLE\"}"
                    },
                    "entityUrl": "https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet",
                    "latestExecution": {
                        "externalExecutionId": "d-EXAMPLE",
                        "externalExecutionUrl": "https://console.aws.amazon.com/codedeploy/home?#/deployments/d-EXAMPLE",
                        "lastStatusChange": 1446137493.131,
                        "status": "Succeeded",
                        "summary": "Deployment Succeeded"
                    }
                }
            ],
            "inboundTransitionState": {
                "enabled": true,
                "lastChangedAt": 1470779534.135,
                "lastChangedBy": "arn:aws:iam::111111111111:user/johndoe"
            },
            "stageName": "Staging"
        }
    ],
    "updated": 1446137312.204
}
```

## See Also
<a name="API_GetPipelineState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/GetPipelineState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/GetPipelineState) 

# GetThirdPartyJobDetails
<a name="API_GetThirdPartyJobDetails"></a>

Requests the details of a job for a third party action. Used for partner actions only.

**Important**  
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

## Request Syntax
<a name="API_GetThirdPartyJobDetails_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "jobId": "string"
}
```

## Request Parameters
<a name="API_GetThirdPartyJobDetails_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_GetThirdPartyJobDetails_RequestSyntax) **   <a name="CodePipeline-GetThirdPartyJobDetails-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [jobId](#API_GetThirdPartyJobDetails_RequestSyntax) **   <a name="CodePipeline-GetThirdPartyJobDetails-request-jobId"></a>
The unique system-generated ID used for identifying the job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: Yes

## Response Syntax
<a name="API_GetThirdPartyJobDetails_ResponseSyntax"></a>

```
{
   "jobDetails": { 
      "data": { 
         "actionConfiguration": { 
            "configuration": { 
               "string" : "string" 
            }
         },
         "actionTypeId": { 
            "category": "string",
            "owner": "string",
            "provider": "string",
            "version": "string"
         },
         "artifactCredentials": { 
            "accessKeyId": "string",
            "secretAccessKey": "string",
            "sessionToken": "string"
         },
         "continuationToken": "string",
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "inputArtifacts": [ 
            { 
               "location": { 
                  "s3Location": { 
                     "bucketName": "string",
                     "objectKey": "string"
                  },
                  "type": "string"
               },
               "name": "string",
               "revision": "string"
            }
         ],
         "outputArtifacts": [ 
            { 
               "location": { 
                  "s3Location": { 
                     "bucketName": "string",
                     "objectKey": "string"
                  },
                  "type": "string"
               },
               "name": "string",
               "revision": "string"
            }
         ],
         "pipelineContext": { 
            "action": { 
               "actionExecutionId": "string",
               "name": "string"
            },
            "pipelineArn": "string",
            "pipelineExecutionId": "string",
            "pipelineName": "string",
            "stage": { 
               "name": "string"
            }
         }
      },
      "id": "string",
      "nonce": "string"
   }
}
```

## Response Elements
<a name="API_GetThirdPartyJobDetails_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [jobDetails](#API_GetThirdPartyJobDetails_ResponseSyntax) **   <a name="CodePipeline-GetThirdPartyJobDetails-response-jobDetails"></a>
The details of the job, including any protected values defined for the job.  
Type: [ThirdPartyJobDetails](API_ThirdPartyJobDetails.md) object

## Errors
<a name="API_GetThirdPartyJobDetails_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidClientTokenException **   
The client token was specified in an invalid format  
HTTP Status Code: 400

 ** InvalidJobException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_GetThirdPartyJobDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/GetThirdPartyJobDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/GetThirdPartyJobDetails) 

# ListActionExecutions
<a name="API_ListActionExecutions"></a>

Lists the action executions that have occurred in a pipeline.

## Request Syntax
<a name="API_ListActionExecutions_RequestSyntax"></a>

```
{
   "filter": { 
      "latestInPipelineExecution": { 
         "pipelineExecutionId": "string",
         "startTimeRange": "string"
      },
      "pipelineExecutionId": "string"
   },
   "maxResults": number,
   "nextToken": "string",
   "pipelineName": "string"
}
```

## Request Parameters
<a name="API_ListActionExecutions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filter](#API_ListActionExecutions_RequestSyntax) **   <a name="CodePipeline-ListActionExecutions-request-filter"></a>
Input information used to filter action execution history.  
Type: [ActionExecutionFilter](API_ActionExecutionFilter.md) object  
Required: No

 ** [maxResults](#API_ListActionExecutions_RequestSyntax) **   <a name="CodePipeline-ListActionExecutions-request-maxResults"></a>
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListActionExecutions_RequestSyntax) **   <a name="CodePipeline-ListActionExecutions-request-nextToken"></a>
The token that was returned from the previous `ListActionExecutions` call, which can be used to return the next set of action executions in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [pipelineName](#API_ListActionExecutions_RequestSyntax) **   <a name="CodePipeline-ListActionExecutions-request-pipelineName"></a>
 The name of the pipeline for which you want to list action execution history.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Syntax
<a name="API_ListActionExecutions_ResponseSyntax"></a>

```
{
   "actionExecutionDetails": [ 
      { 
         "actionExecutionId": "string",
         "actionName": "string",
         "input": { 
            "actionTypeId": { 
               "category": "string",
               "owner": "string",
               "provider": "string",
               "version": "string"
            },
            "configuration": { 
               "string" : "string" 
            },
            "inputArtifacts": [ 
               { 
                  "name": "string",
                  "s3location": { 
                     "bucket": "string",
                     "key": "string"
                  }
               }
            ],
            "namespace": "string",
            "region": "string",
            "resolvedConfiguration": { 
               "string" : "string" 
            },
            "roleArn": "string"
         },
         "lastUpdateTime": number,
         "output": { 
            "executionResult": { 
               "errorDetails": { 
                  "code": "string",
                  "message": "string"
               },
               "externalExecutionId": "string",
               "externalExecutionSummary": "string",
               "externalExecutionUrl": "string",
               "logStreamARN": "string"
            },
            "outputArtifacts": [ 
               { 
                  "name": "string",
                  "s3location": { 
                     "bucket": "string",
                     "key": "string"
                  }
               }
            ],
            "outputVariables": { 
               "string" : "string" 
            }
         },
         "pipelineExecutionId": "string",
         "pipelineVersion": number,
         "stageName": "string",
         "startTime": number,
         "status": "string",
         "updatedBy": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListActionExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionExecutionDetails](#API_ListActionExecutions_ResponseSyntax) **   <a name="CodePipeline-ListActionExecutions-response-actionExecutionDetails"></a>
The details for a list of recent executions, such as action execution ID.  
Type: Array of [ActionExecutionDetail](API_ActionExecutionDetail.md) objects

 ** [nextToken](#API_ListActionExecutions_ResponseSyntax) **   <a name="CodePipeline-ListActionExecutions-response-nextToken"></a>
If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent `ListActionExecutions` call to return the next set of action executions in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListActionExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** PipelineExecutionNotFoundException **   
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.   
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_ListActionExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListActionExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListActionExecutions) 

# ListActionTypes
<a name="API_ListActionTypes"></a>

Gets a summary of all CodePipeline action types associated with your account.

## Request Syntax
<a name="API_ListActionTypes_RequestSyntax"></a>

```
{
   "actionOwnerFilter": "string",
   "nextToken": "string",
   "regionFilter": "string"
}
```

## Request Parameters
<a name="API_ListActionTypes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [actionOwnerFilter](#API_ListActionTypes_RequestSyntax) **   <a name="CodePipeline-ListActionTypes-request-actionOwnerFilter"></a>
Filters the list of action types to those created by a specified entity.  
Type: String  
Valid Values: `AWS | ThirdParty | Custom`   
Required: No

 ** [nextToken](#API_ListActionTypes_RequestSyntax) **   <a name="CodePipeline-ListActionTypes-request-nextToken"></a>
An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [regionFilter](#API_ListActionTypes_RequestSyntax) **   <a name="CodePipeline-ListActionTypes-request-regionFilter"></a>
The Region to filter on for the list of action types.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 30.  
Required: No

## Response Syntax
<a name="API_ListActionTypes_ResponseSyntax"></a>

```
{
   "actionTypes": [ 
      { 
         "actionConfigurationProperties": [ 
            { 
               "description": "string",
               "key": boolean,
               "name": "string",
               "queryable": boolean,
               "required": boolean,
               "secret": boolean,
               "type": "string"
            }
         ],
         "id": { 
            "category": "string",
            "owner": "string",
            "provider": "string",
            "version": "string"
         },
         "inputArtifactDetails": { 
            "maximumCount": number,
            "minimumCount": number
         },
         "outputArtifactDetails": { 
            "maximumCount": number,
            "minimumCount": number
         },
         "settings": { 
            "entityUrlTemplate": "string",
            "executionUrlTemplate": "string",
            "revisionUrlTemplate": "string",
            "thirdPartyConfigurationUrl": "string"
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListActionTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionTypes](#API_ListActionTypes_ResponseSyntax) **   <a name="CodePipeline-ListActionTypes-response-actionTypes"></a>
Provides details of the action types.  
Type: Array of [ActionType](API_ActionType.md) objects

 ** [nextToken](#API_ListActionTypes_ResponseSyntax) **   <a name="CodePipeline-ListActionTypes-response-nextToken"></a>
If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list action types call to return the next set of action types in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListActionTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_ListActionTypes_Examples"></a>

### Example
<a name="API_ListActionTypes_Example_1"></a>

This example illustrates one usage of ListActionTypes.

#### Sample Request
<a name="API_ListActionTypes_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: CodePipeline_20150709.ListActionTypes
X-Amz-Date: 20160707T160551Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{}
```

#### Sample Response
<a name="API_ListActionTypes_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 8363

{
    "actionTypes": [
        {
            "inputArtifactDetails": {
                "maximumCount": 0, 
                "minimumCount": 0
            }, 
            "actionConfigurationProperties": [
                {
                    "description": "The S3 Bucket", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "S3Bucket"
                }, 
                {
                    "description": "The Amazon S3 object key", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "S3ObjectKey"
                }
            ], 
            "outputArtifactDetails": {
                "maximumCount": 1, 
                "minimumCount": 1
            }, 
            "id": {
                "category": "Source", 
                "owner": "AWS", 
                "version": "1", 
                "provider": "S3"
            }, 
            "settings": {
                "entityUrlTemplate": "https://console.aws.amazon.com/s3/home?#"
            }
        }, 
        {
            "inputArtifactDetails": {
                "maximumCount": 1, 
                "minimumCount": 1
            }, 
            "actionConfigurationProperties": [
                {
                    "description": "The Elastic Beanstalk Application name", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "ApplicationName"
                }, 
                {
                    "description": "The Elastic Beanstalk Environment name", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "EnvironmentName"
                }
            ], 
            "outputArtifactDetails": {
                "maximumCount": 0, 
                "minimumCount": 0
            }, 
            "id": {
                "category": "Deploy", 
                "owner": "AWS", 
                "version": "1", 
                "provider": "ElasticBeanstalk"
            }, 
            "settings": {
                "entityUrlTemplate": "https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}", 
                "executionUrlTemplate": "https://console.aws.amazon.com/elasticbeanstalk/r/application/{Config:ApplicationName}"
            }
        }, 
        {
            "inputArtifactDetails": {
                "maximumCount": 1, 
                "minimumCount": 1
            }, 
            "actionConfigurationProperties": [
                {
                    "description": "The deployment application name", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "ApplicationName"
                }, 
                {
                    "description": "The deployment group name", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "DeploymentGroupName"
                }
            ], 
            "outputArtifactDetails": {
                "maximumCount": 0, 
                "minimumCount": 0
            }, 
            "id": {
                "category": "Deploy", 
                "owner": "AWS", 
                "version": "1", 
                "provider": "CodeDeploy"
            }, 
            "settings": {
                "entityUrlTemplate": "https://console.aws.amazon.com/codedeploy/home?#/applications/{Config:ApplicationName}/deployment-groups/{Config:DeploymentGroupName}", 
                "executionUrlTemplate": "https://console.aws.amazon.com/codedeploy/home?#/deployments/{ExternalExecutionId}"
            }
        }, 
        {
            "inputArtifactDetails": {
                "maximumCount": 0, 
                "minimumCount": 0
            }, 
            "actionConfigurationProperties": [
                {
                    "description": "The repository owner (username or organization)", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "Owner"
                }, 
                {
                    "description": "The name of the repository", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "Repo"
                }, 
                {
                    "description": "The tracked branch", 
                    "required": true, 
                    "secret": false, 
                    "key": true, 
                    "queryable": false, 
                    "name": "Branch"
                }, 
                {
                    "description": "The OAuth2 token", 
                    "required": true, 
                    "secret": true, 
                    "key": false, 
                    "queryable": false, 
                    "name": "OAuthToken"
                }
            ], 
            "outputArtifactDetails": {
                "maximumCount": 1, 
                "minimumCount": 1
            }, 
            "id": {
                "category": "Source", 
                "owner": "ThirdParty", 
                "version": "1", 
                "provider": "GitHub"
            }, 
            "settings": {
                "entityUrlTemplate": "https://github.com/{Config:Owner}/{Config:Repo}/tree/{Config:Branch}", 
                "revisionUrlTemplate": "https://github.com/{Config:Owner}/{Config:Repo}/commit/{RevisionId}"
            }
        }, 
        {
            "inputArtifactDetails": {
                "maximumCount": 5, 
                "minimumCount": 0
            }, 
            "actionConfigurationProperties": [
                {
                    "secret": false, 
                    "required": true, 
                    "name": "JenkinsBuildProject", 
                    "key": true, 
                    "queryable": true
                }
            ], 
            "outputArtifactDetails": {
                "maximumCount": 5, 
                "minimumCount": 0
            }, 
            "id": {
                "category": "Build", 
                "owner": "Custom", 
                "version": "1", 
                "provider": "JenkinsProviderName"
            }, 
            "settings": {
                "entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}", 
                "executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}"
            }
        }, 
        {
            "inputArtifactDetails": {
                "maximumCount": 5, 
                "minimumCount": 0
            }, 
            "actionConfigurationProperties": [
                {
                    "secret": false, 
                    "required": true, 
                    "name": "JenkinsTestProject", 
                    "key": true, 
                    "queryable": true
                }
            ], 
            "outputArtifactDetails": {
                "maximumCount": 5, 
                "minimumCount": 0
            }, 
            "id": {
                "category": "Test", 
                "owner": "Custom", 
                "version": "1", 
                "provider": "JenkinsProviderName"
            }, 
            "settings": {
                "entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}", 
                "executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}"
            }
        }
    ]
}
```

## See Also
<a name="API_ListActionTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListActionTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListActionTypes) 

# ListDeployActionExecutionTargets
<a name="API_ListDeployActionExecutionTargets"></a>

Lists the targets for the deploy action.

## Request Syntax
<a name="API_ListDeployActionExecutionTargets_RequestSyntax"></a>

```
{
   "actionExecutionId": "string",
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "pipelineName": "string"
}
```

## Request Parameters
<a name="API_ListDeployActionExecutionTargets_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [actionExecutionId](#API_ListDeployActionExecutionTargets_RequestSyntax) **   <a name="CodePipeline-ListDeployActionExecutionTargets-request-actionExecutionId"></a>
The execution ID for the deploy action.  
Type: String  
Required: Yes

 ** [filters](#API_ListDeployActionExecutionTargets_RequestSyntax) **   <a name="CodePipeline-ListDeployActionExecutionTargets-request-filters"></a>
Filters the targets for a specified deploy action.  
Type: Array of [TargetFilter](API_TargetFilter.md) objects  
Required: No

 ** [maxResults](#API_ListDeployActionExecutionTargets_RequestSyntax) **   <a name="CodePipeline-ListDeployActionExecutionTargets-request-maxResults"></a>
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListDeployActionExecutionTargets_RequestSyntax) **   <a name="CodePipeline-ListDeployActionExecutionTargets-request-nextToken"></a>
An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [pipelineName](#API_ListDeployActionExecutionTargets_RequestSyntax) **   <a name="CodePipeline-ListDeployActionExecutionTargets-request-pipelineName"></a>
The name of the pipeline with the deploy action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: No

## Response Syntax
<a name="API_ListDeployActionExecutionTargets_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "targets": [ 
      { 
         "endTime": number,
         "events": [ 
            { 
               "context": { 
                  "message": "string",
                  "ssmCommandId": "string"
               },
               "endTime": number,
               "name": "string",
               "startTime": number,
               "status": "string"
            }
         ],
         "startTime": number,
         "status": "string",
         "targetId": "string",
         "targetType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListDeployActionExecutionTargets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListDeployActionExecutionTargets_ResponseSyntax) **   <a name="CodePipeline-ListDeployActionExecutionTargets-response-nextToken"></a>
An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [targets](#API_ListDeployActionExecutionTargets_ResponseSyntax) **   <a name="CodePipeline-ListDeployActionExecutionTargets-response-targets"></a>
The targets for the deploy action.  
Type: Array of [DeployActionExecutionTarget](API_DeployActionExecutionTarget.md) objects

## Errors
<a name="API_ListDeployActionExecutionTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ActionExecutionNotFoundException **   
The action execution was not found.  
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_ListDeployActionExecutionTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListDeployActionExecutionTargets) 

# ListPipelineExecutions
<a name="API_ListPipelineExecutions"></a>

Gets a summary of the most recent executions for a pipeline.

**Note**  
When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.

## Request Syntax
<a name="API_ListPipelineExecutions_RequestSyntax"></a>

```
{
   "filter": { 
      "succeededInStage": { 
         "stageName": "string"
      }
   },
   "maxResults": number,
   "nextToken": "string",
   "pipelineName": "string"
}
```

## Request Parameters
<a name="API_ListPipelineExecutions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filter](#API_ListPipelineExecutions_RequestSyntax) **   <a name="CodePipeline-ListPipelineExecutions-request-filter"></a>
The pipeline execution to filter on.  
Type: [PipelineExecutionFilter](API_PipelineExecutionFilter.md) object  
Required: No

 ** [maxResults](#API_ListPipelineExecutions_RequestSyntax) **   <a name="CodePipeline-ListPipelineExecutions-request-maxResults"></a>
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListPipelineExecutions_RequestSyntax) **   <a name="CodePipeline-ListPipelineExecutions-request-nextToken"></a>
The token that was returned from the previous `ListPipelineExecutions` call, which can be used to return the next set of pipeline executions in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [pipelineName](#API_ListPipelineExecutions_RequestSyntax) **   <a name="CodePipeline-ListPipelineExecutions-request-pipelineName"></a>
The name of the pipeline for which you want to get execution summary information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Syntax
<a name="API_ListPipelineExecutions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "pipelineExecutionSummaries": [ 
      { 
         "executionMode": "string",
         "executionType": "string",
         "lastUpdateTime": number,
         "pipelineExecutionId": "string",
         "rollbackMetadata": { 
            "rollbackTargetPipelineExecutionId": "string"
         },
         "sourceRevisions": [ 
            { 
               "actionName": "string",
               "revisionId": "string",
               "revisionSummary": "string",
               "revisionUrl": "string"
            }
         ],
         "startTime": number,
         "status": "string",
         "statusSummary": "string",
         "stopTrigger": { 
            "reason": "string"
         },
         "trigger": { 
            "triggerDetail": "string",
            "triggerType": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListPipelineExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListPipelineExecutions_ResponseSyntax) **   <a name="CodePipeline-ListPipelineExecutions-response-nextToken"></a>
A token that can be used in the next `ListPipelineExecutions` call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [pipelineExecutionSummaries](#API_ListPipelineExecutions_ResponseSyntax) **   <a name="CodePipeline-ListPipelineExecutions-response-pipelineExecutionSummaries"></a>
A list of executions in the history of a pipeline.  
Type: Array of [PipelineExecutionSummary](API_PipelineExecutionSummary.md) objects

## Errors
<a name="API_ListPipelineExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_ListPipelineExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListPipelineExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListPipelineExecutions) 

# ListPipelines
<a name="API_ListPipelines"></a>

Gets a summary of all of the pipelines associated with your account.

## Request Syntax
<a name="API_ListPipelines_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListPipelines_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListPipelines_RequestSyntax) **   <a name="CodePipeline-ListPipelines-request-maxResults"></a>
The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListPipelines_RequestSyntax) **   <a name="CodePipeline-ListPipelines-request-nextToken"></a>
An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListPipelines_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "pipelines": [ 
      { 
         "created": number,
         "executionMode": "string",
         "name": "string",
         "pipelineType": "string",
         "updated": number,
         "version": number
      }
   ]
}
```

## Response Elements
<a name="API_ListPipelines_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListPipelines_ResponseSyntax) **   <a name="CodePipeline-ListPipelines-response-nextToken"></a>
If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list pipelines call to return the next set of pipelines in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [pipelines](#API_ListPipelines_ResponseSyntax) **   <a name="CodePipeline-ListPipelines-response-pipelines"></a>
The list of pipelines.  
Type: Array of [PipelineSummary](API_PipelineSummary.md) objects

## Errors
<a name="API_ListPipelines_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_ListPipelines_Examples"></a>

### Example
<a name="API_ListPipelines_Example_1"></a>

This example illustrates one usage of ListPipelines.

#### Sample Request
<a name="API_ListPipelines_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: CodePipeline_20150709.ListPipelines
X-Amz-Date: 20160707T160211Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{}
```

#### Sample Response
<a name="API_ListPipelines_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 668

{
    "pipelines": [
        {
            "updated": 1444681408.094,
            "version": 1,
            "name": "MyFirstPipeline",
            "created": 1444681408.094
        },
        {
            "updated": 1443048299.639,
            "version": 3,
            "name": "MySecondPipeline",
            "created": 1443046290.003
        }
    ]
}
```

## See Also
<a name="API_ListPipelines_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListPipelines) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListPipelines) 

# ListRuleExecutions
<a name="API_ListRuleExecutions"></a>

Lists the rule executions that have occurred in a pipeline configured for conditions with rules.

## Request Syntax
<a name="API_ListRuleExecutions_RequestSyntax"></a>

```
{
   "filter": { 
      "latestInPipelineExecution": { 
         "pipelineExecutionId": "string",
         "startTimeRange": "string"
      },
      "pipelineExecutionId": "string"
   },
   "maxResults": number,
   "nextToken": "string",
   "pipelineName": "string"
}
```

## Request Parameters
<a name="API_ListRuleExecutions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filter](#API_ListRuleExecutions_RequestSyntax) **   <a name="CodePipeline-ListRuleExecutions-request-filter"></a>
Input information used to filter rule execution history.  
Type: [RuleExecutionFilter](API_RuleExecutionFilter.md) object  
Required: No

 ** [maxResults](#API_ListRuleExecutions_RequestSyntax) **   <a name="CodePipeline-ListRuleExecutions-request-maxResults"></a>
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListRuleExecutions_RequestSyntax) **   <a name="CodePipeline-ListRuleExecutions-request-nextToken"></a>
The token that was returned from the previous `ListRuleExecutions` call, which can be used to return the next set of rule executions in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [pipelineName](#API_ListRuleExecutions_RequestSyntax) **   <a name="CodePipeline-ListRuleExecutions-request-pipelineName"></a>
The name of the pipeline for which you want to get execution summary information.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Syntax
<a name="API_ListRuleExecutions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "ruleExecutionDetails": [ 
      { 
         "input": { 
            "configuration": { 
               "string" : "string" 
            },
            "inputArtifacts": [ 
               { 
                  "name": "string",
                  "s3location": { 
                     "bucket": "string",
                     "key": "string"
                  }
               }
            ],
            "region": "string",
            "resolvedConfiguration": { 
               "string" : "string" 
            },
            "roleArn": "string",
            "ruleTypeId": { 
               "category": "string",
               "owner": "string",
               "provider": "string",
               "version": "string"
            }
         },
         "lastUpdateTime": number,
         "output": { 
            "executionResult": { 
               "errorDetails": { 
                  "code": "string",
                  "message": "string"
               },
               "externalExecutionId": "string",
               "externalExecutionSummary": "string",
               "externalExecutionUrl": "string"
            }
         },
         "pipelineExecutionId": "string",
         "pipelineVersion": number,
         "ruleExecutionId": "string",
         "ruleName": "string",
         "stageName": "string",
         "startTime": number,
         "status": "string",
         "updatedBy": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRuleExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListRuleExecutions_ResponseSyntax) **   <a name="CodePipeline-ListRuleExecutions-response-nextToken"></a>
A token that can be used in the next `ListRuleExecutions` call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [ruleExecutionDetails](#API_ListRuleExecutions_ResponseSyntax) **   <a name="CodePipeline-ListRuleExecutions-response-ruleExecutionDetails"></a>
Details about the output for listing rule executions.  
Type: Array of [RuleExecutionDetail](API_RuleExecutionDetail.md) objects

## Errors
<a name="API_ListRuleExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** PipelineExecutionNotFoundException **   
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.   
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_ListRuleExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListRuleExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListRuleExecutions) 

# ListRuleTypes
<a name="API_ListRuleTypes"></a>

Lists the rules for the condition. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html).For more information about rules, see the [AWS CodePipeline rule reference](https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html).

## Request Syntax
<a name="API_ListRuleTypes_RequestSyntax"></a>

```
{
   "regionFilter": "string",
   "ruleOwnerFilter": "string"
}
```

## Request Parameters
<a name="API_ListRuleTypes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [regionFilter](#API_ListRuleTypes_RequestSyntax) **   <a name="CodePipeline-ListRuleTypes-request-regionFilter"></a>
The rule Region to filter on.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 30.  
Required: No

 ** [ruleOwnerFilter](#API_ListRuleTypes_RequestSyntax) **   <a name="CodePipeline-ListRuleTypes-request-ruleOwnerFilter"></a>
The rule owner to filter on.  
Type: String  
Valid Values: `AWS`   
Required: No

## Response Syntax
<a name="API_ListRuleTypes_ResponseSyntax"></a>

```
{
   "ruleTypes": [ 
      { 
         "id": { 
            "category": "string",
            "owner": "string",
            "provider": "string",
            "version": "string"
         },
         "inputArtifactDetails": { 
            "maximumCount": number,
            "minimumCount": number
         },
         "ruleConfigurationProperties": [ 
            { 
               "description": "string",
               "key": boolean,
               "name": "string",
               "queryable": boolean,
               "required": boolean,
               "secret": boolean,
               "type": "string"
            }
         ],
         "settings": { 
            "entityUrlTemplate": "string",
            "executionUrlTemplate": "string",
            "revisionUrlTemplate": "string",
            "thirdPartyConfigurationUrl": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListRuleTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ruleTypes](#API_ListRuleTypes_ResponseSyntax) **   <a name="CodePipeline-ListRuleTypes-response-ruleTypes"></a>
Lists the rules that are configured for the condition.  
Type: Array of [RuleType](API_RuleType.md) objects

## Errors
<a name="API_ListRuleTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_ListRuleTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListRuleTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListRuleTypes) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Gets the set of key-value pairs (metadata) that are used to manage the resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListTagsForResource_RequestSyntax) **   <a name="CodePipeline-ListTagsForResource-request-maxResults"></a>
The maximum number of results to return in a single call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_ListTagsForResource_RequestSyntax) **   <a name="CodePipeline-ListTagsForResource-request-nextToken"></a>
The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="CodePipeline-ListTagsForResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to get tags for.  
Type: String  
Pattern: `arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+`   
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListTagsForResource_ResponseSyntax) **   <a name="CodePipeline-ListTagsForResource-response-nextToken"></a>
If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent API call to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="CodePipeline-ListTagsForResource-response-tags"></a>
The tags for the resource.  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidArnException **   
The specified resource ARN is invalid.  
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was specified in an invalid format.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListTagsForResource) 

# ListWebhooks
<a name="API_ListWebhooks"></a>

Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

**Note**  
If a secret token was provided, it will be redacted in the response.

## Request Syntax
<a name="API_ListWebhooks_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListWebhooks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListWebhooks_RequestSyntax) **   <a name="CodePipeline-ListWebhooks-request-MaxResults"></a>
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListWebhooks_RequestSyntax) **   <a name="CodePipeline-ListWebhooks-request-NextToken"></a>
The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListWebhooks_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "webhooks": [ 
      { 
         "arn": "string",
         "definition": { 
            "authentication": "string",
            "authenticationConfiguration": { 
               "AllowedIPRange": "string",
               "SecretToken": "string"
            },
            "filters": [ 
               { 
                  "jsonPath": "string",
                  "matchEquals": "string"
               }
            ],
            "name": "string",
            "targetAction": "string",
            "targetPipeline": "string"
         },
         "errorCode": "string",
         "errorMessage": "string",
         "lastTriggered": number,
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "url": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListWebhooks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListWebhooks_ResponseSyntax) **   <a name="CodePipeline-ListWebhooks-response-NextToken"></a>
If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [webhooks](#API_ListWebhooks_ResponseSyntax) **   <a name="CodePipeline-ListWebhooks-response-webhooks"></a>
The JSON detail returned for each webhook in the list output for the ListWebhooks call.  
Type: Array of [ListWebhookItem](API_ListWebhookItem.md) objects

## Errors
<a name="API_ListWebhooks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidNextTokenException **   
The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_ListWebhooks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/ListWebhooks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/ListWebhooks) 

# OverrideStageCondition
<a name="API_OverrideStageCondition"></a>

Used to override a stage condition. For more information about conditions, see [Stage conditions](https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html) and [How do stage conditions work?](https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html).

## Request Syntax
<a name="API_OverrideStageCondition_RequestSyntax"></a>

```
{
   "conditionType": "string",
   "pipelineExecutionId": "string",
   "pipelineName": "string",
   "stageName": "string"
}
```

## Request Parameters
<a name="API_OverrideStageCondition_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [conditionType](#API_OverrideStageCondition_RequestSyntax) **   <a name="CodePipeline-OverrideStageCondition-request-conditionType"></a>
The type of condition to override for the stage, such as entry conditions, failure conditions, or success conditions.  
Type: String  
Valid Values: `BEFORE_ENTRY | ON_SUCCESS`   
Required: Yes

 ** [pipelineExecutionId](#API_OverrideStageCondition_RequestSyntax) **   <a name="CodePipeline-OverrideStageCondition-request-pipelineExecutionId"></a>
The ID of the pipeline execution for the override.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [pipelineName](#API_OverrideStageCondition_RequestSyntax) **   <a name="CodePipeline-OverrideStageCondition-request-pipelineName"></a>
The name of the pipeline with the stage that will override the condition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [stageName](#API_OverrideStageCondition_RequestSyntax) **   <a name="CodePipeline-OverrideStageCondition-request-stageName"></a>
The name of the stage for the override.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Elements
<a name="API_OverrideStageCondition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_OverrideStageCondition_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentPipelineExecutionsLimitExceededException **   
The pipeline has reached the limit for concurrent pipeline executions.  
HTTP Status Code: 400

 ** ConditionNotOverridableException **   
Unable to override because the condition does not allow overrides.  
HTTP Status Code: 400

 ** ConflictException **   
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.  
HTTP Status Code: 400

 ** NotLatestPipelineExecutionException **   
The stage has failed in a later run of the pipeline and the `pipelineExecutionId` associated with the request is out of date.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** StageNotFoundException **   
The stage was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_OverrideStageCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/OverrideStageCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/OverrideStageCondition) 

# PollForJobs
<a name="API_PollForJobs"></a>

Returns information about any jobs for CodePipeline to act on. `PollForJobs` is valid only for action types with "Custom" in the owner field. If the action type contains `AWS` or `ThirdParty` in the owner field, the `PollForJobs` action returns an error.

**Important**  
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

## Request Syntax
<a name="API_PollForJobs_RequestSyntax"></a>

```
{
   "actionTypeId": { 
      "category": "string",
      "owner": "string",
      "provider": "string",
      "version": "string"
   },
   "maxBatchSize": number,
   "queryParam": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_PollForJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [actionTypeId](#API_PollForJobs_RequestSyntax) **   <a name="CodePipeline-PollForJobs-request-actionTypeId"></a>
Represents information about an action type.  
Type: [ActionTypeId](API_ActionTypeId.md) object  
Required: Yes

 ** [maxBatchSize](#API_PollForJobs_RequestSyntax) **   <a name="CodePipeline-PollForJobs-request-maxBatchSize"></a>
The maximum number of jobs to return in a poll for jobs call.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [queryParam](#API_PollForJobs_RequestSyntax) **   <a name="CodePipeline-PollForJobs-request-queryParam"></a>
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.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 1 item.  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Value Length Constraints: Minimum length of 1. Maximum length of 50.  
Value Pattern: `[a-zA-Z0-9_-]+`   
Required: No

## Response Syntax
<a name="API_PollForJobs_ResponseSyntax"></a>

```
{
   "jobs": [ 
      { 
         "accountId": "string",
         "data": { 
            "actionConfiguration": { 
               "configuration": { 
                  "string" : "string" 
               }
            },
            "actionTypeId": { 
               "category": "string",
               "owner": "string",
               "provider": "string",
               "version": "string"
            },
            "artifactCredentials": { 
               "accessKeyId": "string",
               "secretAccessKey": "string",
               "sessionToken": "string"
            },
            "continuationToken": "string",
            "encryptionKey": { 
               "id": "string",
               "type": "string"
            },
            "inputArtifacts": [ 
               { 
                  "location": { 
                     "s3Location": { 
                        "bucketName": "string",
                        "objectKey": "string"
                     },
                     "type": "string"
                  },
                  "name": "string",
                  "revision": "string"
               }
            ],
            "outputArtifacts": [ 
               { 
                  "location": { 
                     "s3Location": { 
                        "bucketName": "string",
                        "objectKey": "string"
                     },
                     "type": "string"
                  },
                  "name": "string",
                  "revision": "string"
               }
            ],
            "pipelineContext": { 
               "action": { 
                  "actionExecutionId": "string",
                  "name": "string"
               },
               "pipelineArn": "string",
               "pipelineExecutionId": "string",
               "pipelineName": "string",
               "stage": { 
                  "name": "string"
               }
            }
         },
         "id": "string",
         "nonce": "string"
      }
   ]
}
```

## Response Elements
<a name="API_PollForJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [jobs](#API_PollForJobs_ResponseSyntax) **   <a name="CodePipeline-PollForJobs-response-jobs"></a>
Information about the jobs to take action on.  
Type: Array of [Job](API_Job.md) objects

## Errors
<a name="API_PollForJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ActionTypeNotFoundException **   
The specified action type cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_PollForJobs_Examples"></a>

### Example
<a name="API_PollForJobs_Example_1"></a>

This example illustrates one usage of PollForJobs.

#### Sample Request
<a name="API_PollForJobs_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 173
X-Amz-Target: CodePipeline_20150709.PollForJobs
X-Amz-Date: 20151030T230047Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "actionTypeId": {
    "category": "Test",
    "owner": "Custom",
    "version": "1",
    "provider": "JenkinsProviderName"
  },
  "maxBatchSize": 5,
  "queryParam": {
    "ProjectName": "JenkinsTestProject"
  }
}
```

#### Sample Response
<a name="API_PollForJobs_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1830

{
  "jobs": [
    {
      "accountId": "111111111111",
      "data": {
        "actionConfiguration": {
          "__type": "ActionConfiguration",
          "configuration": {
            "ProjectName": "JenkinsTestProject"
          }
        },
        "actionTypeId": {
          "__type": "ActionTypeId",
          "category": "Test",
          "owner": "Custom",
          "provider": "JenkinsProviderName",
          "version": "1"
        },
        "artifactCredentials": {
          "__type": "AWSSessionCredentials",
          "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
          "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
          "sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE="
        },
        "inputArtifacts": [
          {
            "__type": "Artifact",
            "location": {
              "s3Location": {
                "bucketName": "amzn-s3-demo-bucket",
                "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
              },
              "type": "S3"
            },
            "name": "MyAppBuild"
          }
        ],
        "outputArtifacts": [],
        "pipelineContext": {
          "__type": "PipelineContext",
          "action": {
            "name": "JenkinsTestAction"
          },
          "pipelineName": "MySecondPipeline",
          "stage": {
            "name": "Testing"
          }
        }
      },
      "id": "ef66c259-64f9-EXAMPLE",
      "nonce": "3"
    }
  ]
}
```

## See Also
<a name="API_PollForJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PollForJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PollForJobs) 

# PollForThirdPartyJobs
<a name="API_PollForThirdPartyJobs"></a>

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

**Important**  
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.

## Request Syntax
<a name="API_PollForThirdPartyJobs_RequestSyntax"></a>

```
{
   "actionTypeId": { 
      "category": "string",
      "owner": "string",
      "provider": "string",
      "version": "string"
   },
   "maxBatchSize": number
}
```

## Request Parameters
<a name="API_PollForThirdPartyJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [actionTypeId](#API_PollForThirdPartyJobs_RequestSyntax) **   <a name="CodePipeline-PollForThirdPartyJobs-request-actionTypeId"></a>
Represents information about an action type.  
Type: [ActionTypeId](API_ActionTypeId.md) object  
Required: Yes

 ** [maxBatchSize](#API_PollForThirdPartyJobs_RequestSyntax) **   <a name="CodePipeline-PollForThirdPartyJobs-request-maxBatchSize"></a>
The maximum number of jobs to return in a poll for jobs call.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## Response Syntax
<a name="API_PollForThirdPartyJobs_ResponseSyntax"></a>

```
{
   "jobs": [ 
      { 
         "clientId": "string",
         "jobId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_PollForThirdPartyJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [jobs](#API_PollForThirdPartyJobs_ResponseSyntax) **   <a name="CodePipeline-PollForThirdPartyJobs-response-jobs"></a>
Information about the jobs to take action on.  
Type: Array of [ThirdPartyJob](API_ThirdPartyJob.md) objects

## Errors
<a name="API_PollForThirdPartyJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ActionTypeNotFoundException **   
The specified action type cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_PollForThirdPartyJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PollForThirdPartyJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PollForThirdPartyJobs) 

# PutActionRevision
<a name="API_PutActionRevision"></a>

Provides information to CodePipeline about new revisions to a source.

## Request Syntax
<a name="API_PutActionRevision_RequestSyntax"></a>

```
{
   "actionName": "string",
   "actionRevision": { 
      "created": number,
      "revisionChangeId": "string",
      "revisionId": "string"
   },
   "pipelineName": "string",
   "stageName": "string"
}
```

## Request Parameters
<a name="API_PutActionRevision_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [actionName](#API_PutActionRevision_RequestSyntax) **   <a name="CodePipeline-PutActionRevision-request-actionName"></a>
The name of the action that processes the revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [actionRevision](#API_PutActionRevision_RequestSyntax) **   <a name="CodePipeline-PutActionRevision-request-actionRevision"></a>
Represents information about the version (or revision) of an action.  
Type: [ActionRevision](API_ActionRevision.md) object  
Required: Yes

 ** [pipelineName](#API_PutActionRevision_RequestSyntax) **   <a name="CodePipeline-PutActionRevision-request-pipelineName"></a>
The name of the pipeline that starts processing the revision to the source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [stageName](#API_PutActionRevision_RequestSyntax) **   <a name="CodePipeline-PutActionRevision-request-stageName"></a>
The name of the stage that contains the action that acts on the revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Syntax
<a name="API_PutActionRevision_ResponseSyntax"></a>

```
{
   "newRevision": boolean,
   "pipelineExecutionId": "string"
}
```

## Response Elements
<a name="API_PutActionRevision_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [newRevision](#API_PutActionRevision_ResponseSyntax) **   <a name="CodePipeline-PutActionRevision-response-newRevision"></a>
Indicates whether the artifact revision was previously used in an execution of the specified pipeline.  
Type: Boolean

 ** [pipelineExecutionId](#API_PutActionRevision_ResponseSyntax) **   <a name="CodePipeline-PutActionRevision-response-pipelineExecutionId"></a>
The ID of the current workflow state of the pipeline.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

## Errors
<a name="API_PutActionRevision_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ActionNotFoundException **   
The specified action cannot be found.  
HTTP Status Code: 400

 ** ConcurrentPipelineExecutionsLimitExceededException **   
The pipeline has reached the limit for concurrent pipeline executions.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** StageNotFoundException **   
The stage was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_PutActionRevision_Examples"></a>

### Example
<a name="API_PutActionRevision_Example_1"></a>

This example illustrates one usage of PutActionRevision.

#### Sample Request
<a name="API_PutActionRevision_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 173
X-Amz-Target: CodePipeline_20150709.PutActionRevision
X-Amz-Date: 20151030T230047Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
   "actionName": "Source",
   "actionRevision": { 
      "created": 1446726163.571,
	  "revisionChangeId": "3fdd7b9196697a096d5af1d649e26a4a",
      "revisionId": "HYGp7zmwbCPPwo234xsCEM7d6ToeAqIl"
   },
   "pipelineName": "MyFirstPipeline",
   "stageName": "Staging"
}
```

#### Sample Response
<a name="API_PutActionRevision_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1830

{
   "newRevision": true,
   "pipelineExecutionId": "42ee4d10-e4de-a37c-82b7-36c11EXAMPLE"
}
```

## See Also
<a name="API_PutActionRevision_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PutActionRevision) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PutActionRevision) 

# PutApprovalResult
<a name="API_PutApprovalResult"></a>

Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.

## Request Syntax
<a name="API_PutApprovalResult_RequestSyntax"></a>

```
{
   "actionName": "string",
   "pipelineName": "string",
   "result": { 
      "status": "string",
      "summary": "string"
   },
   "stageName": "string",
   "token": "string"
}
```

## Request Parameters
<a name="API_PutApprovalResult_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [actionName](#API_PutApprovalResult_RequestSyntax) **   <a name="CodePipeline-PutApprovalResult-request-actionName"></a>
The name of the action for which approval is requested.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [pipelineName](#API_PutApprovalResult_RequestSyntax) **   <a name="CodePipeline-PutApprovalResult-request-pipelineName"></a>
The name of the pipeline that contains the action.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [result](#API_PutApprovalResult_RequestSyntax) **   <a name="CodePipeline-PutApprovalResult-request-result"></a>
Represents information about the result of the approval request.  
Type: [ApprovalResult](API_ApprovalResult.md) object  
Required: Yes

 ** [stageName](#API_PutApprovalResult_RequestSyntax) **   <a name="CodePipeline-PutApprovalResult-request-stageName"></a>
The name of the stage that contains the action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [token](#API_PutApprovalResult_RequestSyntax) **   <a name="CodePipeline-PutApprovalResult-request-token"></a>
The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the [GetPipelineState](API_GetPipelineState.md) action. It is used to validate that the approval request corresponding to this token is still valid.  
For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject an approval request as detailed above is not available. Instead, use the `externalExecutionId` in the response output from the [ListActionExecutions](API_ListActionExecutions.md) action as the token in the approval request.
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_PutApprovalResult_ResponseSyntax"></a>

```
{
   "approvedAt": number
}
```

## Response Elements
<a name="API_PutApprovalResult_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [approvedAt](#API_PutApprovalResult_ResponseSyntax) **   <a name="CodePipeline-PutApprovalResult-response-approvedAt"></a>
The timestamp showing when the approval or rejection was submitted.  
Type: Timestamp

## Errors
<a name="API_PutApprovalResult_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ActionNotFoundException **   
The specified action cannot be found.  
HTTP Status Code: 400

 ** ApprovalAlreadyCompletedException **   
The approval action has already been approved or rejected.  
HTTP Status Code: 400

 ** InvalidApprovalTokenException **   
The approval request already received a response or has expired.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** StageNotFoundException **   
The stage was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_PutApprovalResult_Examples"></a>

### Example
<a name="API_PutApprovalResult_Example_1"></a>

This example illustrates one usage of PutApprovalResult.

#### Sample Request
<a name="API_PutApprovalResult_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 173
X-Amz-Target: CodePipeline_20150709.PutApprovalResult
X-Amz-Date: 20151030T230047Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
   "actionName": "MyApprovalAction",
   "pipelineName": "MyFirstPipeline",
   "result": { 
      "status": "Approved",
      "summary": "Latest changes meet the bar. Ship it!"
   },
   "stageName": "MyApprovalStage",
   "token": "1a2b3c4d-573f-4ea7-a67E-XAMPLETOKEN"
}
```

#### Sample Response
<a name="API_PutApprovalResult_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 24

{
   "approvedAt": 1466137312.204
}
```

## See Also
<a name="API_PutApprovalResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PutApprovalResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PutApprovalResult) 

# PutJobFailureResult
<a name="API_PutJobFailureResult"></a>

Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.

## Request Syntax
<a name="API_PutJobFailureResult_RequestSyntax"></a>

```
{
   "failureDetails": { 
      "externalExecutionId": "string",
      "message": "string",
      "type": "string"
   },
   "jobId": "string"
}
```

## Request Parameters
<a name="API_PutJobFailureResult_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [failureDetails](#API_PutJobFailureResult_RequestSyntax) **   <a name="CodePipeline-PutJobFailureResult-request-failureDetails"></a>
The details about the failure of a job.  
Type: [FailureDetails](API_FailureDetails.md) object  
Required: Yes

 ** [jobId](#API_PutJobFailureResult_RequestSyntax) **   <a name="CodePipeline-PutJobFailureResult-request-jobId"></a>
The unique system-generated ID of the job that failed. This is the same ID returned from `PollForJobs`.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Elements
<a name="API_PutJobFailureResult_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutJobFailureResult_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidJobStateException **   
The job state was specified in an invalid format.  
HTTP Status Code: 400

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_PutJobFailureResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PutJobFailureResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PutJobFailureResult) 

# PutJobSuccessResult
<a name="API_PutJobSuccessResult"></a>

Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.

## Request Syntax
<a name="API_PutJobSuccessResult_RequestSyntax"></a>

```
{
   "continuationToken": "string",
   "currentRevision": { 
      "changeIdentifier": "string",
      "created": number,
      "revision": "string",
      "revisionSummary": "string"
   },
   "executionDetails": { 
      "externalExecutionId": "string",
      "percentComplete": number,
      "summary": "string"
   },
   "jobId": "string",
   "outputVariables": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_PutJobSuccessResult_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [continuationToken](#API_PutJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutJobSuccessResult-request-continuationToken"></a>
A token generated by a job worker, such as a 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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [currentRevision](#API_PutJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutJobSuccessResult-request-currentRevision"></a>
The ID of the current revision of the artifact successfully worked on by the job.  
Type: [CurrentRevision](API_CurrentRevision.md) object  
Required: No

 ** [executionDetails](#API_PutJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutJobSuccessResult-request-executionDetails"></a>
The execution details of the successful job, such as the actions taken by the job worker.  
Type: [ExecutionDetails](API_ExecutionDetails.md) object  
Required: No

 ** [jobId](#API_PutJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutJobSuccessResult-request-jobId"></a>
The unique system-generated ID of the job that succeeded. This is the same ID returned from `PollForJobs`.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [outputVariables](#API_PutJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutJobSuccessResult-request-outputVariables"></a>
Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. `outputVariables` can be included only when there is no continuation token on the request.  
Type: String to string map  
Key Pattern: `[A-Za-z0-9@\-_]+`   
Required: No

## Response Elements
<a name="API_PutJobSuccessResult_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutJobSuccessResult_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidJobStateException **   
The job state was specified in an invalid format.  
HTTP Status Code: 400

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** OutputVariablesSizeExceededException **   
Exceeded the total size limit for all variables in the pipeline.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_PutJobSuccessResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PutJobSuccessResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PutJobSuccessResult) 

# PutThirdPartyJobFailureResult
<a name="API_PutThirdPartyJobFailureResult"></a>

Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

## Request Syntax
<a name="API_PutThirdPartyJobFailureResult_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "failureDetails": { 
      "externalExecutionId": "string",
      "message": "string",
      "type": "string"
   },
   "jobId": "string"
}
```

## Request Parameters
<a name="API_PutThirdPartyJobFailureResult_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_PutThirdPartyJobFailureResult_RequestSyntax) **   <a name="CodePipeline-PutThirdPartyJobFailureResult-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [failureDetails](#API_PutThirdPartyJobFailureResult_RequestSyntax) **   <a name="CodePipeline-PutThirdPartyJobFailureResult-request-failureDetails"></a>
Represents information about failure details.  
Type: [FailureDetails](API_FailureDetails.md) object  
Required: Yes

 ** [jobId](#API_PutThirdPartyJobFailureResult_RequestSyntax) **   <a name="CodePipeline-PutThirdPartyJobFailureResult-request-jobId"></a>
The ID of the job that failed. This is the same ID returned from `PollForThirdPartyJobs`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: Yes

## Response Elements
<a name="API_PutThirdPartyJobFailureResult_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutThirdPartyJobFailureResult_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidClientTokenException **   
The client token was specified in an invalid format  
HTTP Status Code: 400

 ** InvalidJobStateException **   
The job state was specified in an invalid format.  
HTTP Status Code: 400

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_PutThirdPartyJobFailureResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PutThirdPartyJobFailureResult) 

# PutThirdPartyJobSuccessResult
<a name="API_PutThirdPartyJobSuccessResult"></a>

Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

## Request Syntax
<a name="API_PutThirdPartyJobSuccessResult_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "continuationToken": "string",
   "currentRevision": { 
      "changeIdentifier": "string",
      "created": number,
      "revision": "string",
      "revisionSummary": "string"
   },
   "executionDetails": { 
      "externalExecutionId": "string",
      "percentComplete": number,
      "summary": "string"
   },
   "jobId": "string"
}
```

## Request Parameters
<a name="API_PutThirdPartyJobSuccessResult_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_PutThirdPartyJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutThirdPartyJobSuccessResult-request-clientToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [continuationToken](#API_PutThirdPartyJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutThirdPartyJobSuccessResult-request-continuationToken"></a>
A token generated by a job worker, such as a 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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [currentRevision](#API_PutThirdPartyJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutThirdPartyJobSuccessResult-request-currentRevision"></a>
Represents information about a current revision.  
Type: [CurrentRevision](API_CurrentRevision.md) object  
Required: No

 ** [executionDetails](#API_PutThirdPartyJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutThirdPartyJobSuccessResult-request-executionDetails"></a>
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.   
Type: [ExecutionDetails](API_ExecutionDetails.md) object  
Required: No

 ** [jobId](#API_PutThirdPartyJobSuccessResult_RequestSyntax) **   <a name="CodePipeline-PutThirdPartyJobSuccessResult-request-jobId"></a>
The ID of the job that successfully completed. This is the same ID returned from `PollForThirdPartyJobs`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: Yes

## Response Elements
<a name="API_PutThirdPartyJobSuccessResult_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutThirdPartyJobSuccessResult_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidClientTokenException **   
The client token was specified in an invalid format  
HTTP Status Code: 400

 ** InvalidJobStateException **   
The job state was specified in an invalid format.  
HTTP Status Code: 400

 ** JobNotFoundException **   
The job was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_PutThirdPartyJobSuccessResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PutThirdPartyJobSuccessResult) 

# PutWebhook
<a name="API_PutWebhook"></a>

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.

**Important**  
When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

**Note**  
If a secret token was provided, it will be redacted in the response.

## Request Syntax
<a name="API_PutWebhook_RequestSyntax"></a>

```
{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "webhook": { 
      "authentication": "string",
      "authenticationConfiguration": { 
         "AllowedIPRange": "string",
         "SecretToken": "string"
      },
      "filters": [ 
         { 
            "jsonPath": "string",
            "matchEquals": "string"
         }
      ],
      "name": "string",
      "targetAction": "string",
      "targetPipeline": "string"
   }
}
```

## Request Parameters
<a name="API_PutWebhook_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [tags](#API_PutWebhook_RequestSyntax) **   <a name="CodePipeline-PutWebhook-request-tags"></a>
The tags for the webhook.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** [webhook](#API_PutWebhook_RequestSyntax) **   <a name="CodePipeline-PutWebhook-request-webhook"></a>
The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.  
Type: [WebhookDefinition](API_WebhookDefinition.md) object  
Required: Yes

## Response Syntax
<a name="API_PutWebhook_ResponseSyntax"></a>

```
{
   "webhook": { 
      "arn": "string",
      "definition": { 
         "authentication": "string",
         "authenticationConfiguration": { 
            "AllowedIPRange": "string",
            "SecretToken": "string"
         },
         "filters": [ 
            { 
               "jsonPath": "string",
               "matchEquals": "string"
            }
         ],
         "name": "string",
         "targetAction": "string",
         "targetPipeline": "string"
      },
      "errorCode": "string",
      "errorMessage": "string",
      "lastTriggered": number,
      "tags": [ 
         { 
            "key": "string",
            "value": "string"
         }
      ],
      "url": "string"
   }
}
```

## Response Elements
<a name="API_PutWebhook_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [webhook](#API_PutWebhook_ResponseSyntax) **   <a name="CodePipeline-PutWebhook-response-webhook"></a>
The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.  
Type: [ListWebhookItem](API_ListWebhookItem.md) object

## Errors
<a name="API_PutWebhook_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Unable to modify the tag due to a simultaneous update request.  
HTTP Status Code: 400

 ** InvalidTagsException **   
The specified resource tags are invalid.  
HTTP Status Code: 400

 ** InvalidWebhookAuthenticationParametersException **   
The specified authentication type is in an invalid format.  
HTTP Status Code: 400

 ** InvalidWebhookFilterPatternException **   
The specified event filter rule is in an invalid format.  
HTTP Status Code: 400

 ** LimitExceededException **   
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The tags limit for a resource has been exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_PutWebhook_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/PutWebhook) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/PutWebhook) 

# RegisterWebhookWithThirdParty
<a name="API_RegisterWebhookWithThirdParty"></a>

Configures a connection between the webhook that was created and the external tool with events to be detected.

## Request Syntax
<a name="API_RegisterWebhookWithThirdParty_RequestSyntax"></a>

```
{
   "webhookName": "string"
}
```

## Request Parameters
<a name="API_RegisterWebhookWithThirdParty_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [webhookName](#API_RegisterWebhookWithThirdParty_RequestSyntax) **   <a name="CodePipeline-RegisterWebhookWithThirdParty-request-webhookName"></a>
The name of an existing webhook created with PutWebhook to register with a supported third party.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: No

## Response Elements
<a name="API_RegisterWebhookWithThirdParty_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_RegisterWebhookWithThirdParty_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

 ** WebhookNotFoundException **   
The specified webhook was entered in an invalid format or cannot be found.  
HTTP Status Code: 400

## See Also
<a name="API_RegisterWebhookWithThirdParty_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/RegisterWebhookWithThirdParty) 

# RetryStageExecution
<a name="API_RetryStageExecution"></a>

You can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.

## Request Syntax
<a name="API_RetryStageExecution_RequestSyntax"></a>

```
{
   "pipelineExecutionId": "string",
   "pipelineName": "string",
   "retryMode": "string",
   "stageName": "string"
}
```

## Request Parameters
<a name="API_RetryStageExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineExecutionId](#API_RetryStageExecution_RequestSyntax) **   <a name="CodePipeline-RetryStageExecution-request-pipelineExecutionId"></a>
The ID of the pipeline execution in the failed stage to be retried. Use the [GetPipelineState](API_GetPipelineState.md) action to retrieve the current pipelineExecutionId of the failed stage  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [pipelineName](#API_RetryStageExecution_RequestSyntax) **   <a name="CodePipeline-RetryStageExecution-request-pipelineName"></a>
The name of the pipeline that contains the failed stage.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [retryMode](#API_RetryStageExecution_RequestSyntax) **   <a name="CodePipeline-RetryStageExecution-request-retryMode"></a>
The scope of the retry attempt.  
Type: String  
Valid Values: `FAILED_ACTIONS | ALL_ACTIONS`   
Required: Yes

 ** [stageName](#API_RetryStageExecution_RequestSyntax) **   <a name="CodePipeline-RetryStageExecution-request-stageName"></a>
The name of the failed stage to be retried.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

## Response Syntax
<a name="API_RetryStageExecution_ResponseSyntax"></a>

```
{
   "pipelineExecutionId": "string"
}
```

## Response Elements
<a name="API_RetryStageExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [pipelineExecutionId](#API_RetryStageExecution_ResponseSyntax) **   <a name="CodePipeline-RetryStageExecution-response-pipelineExecutionId"></a>
The ID of the current workflow execution in the failed stage.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

## Errors
<a name="API_RetryStageExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentPipelineExecutionsLimitExceededException **   
The pipeline has reached the limit for concurrent pipeline executions.  
HTTP Status Code: 400

 ** ConflictException **   
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.  
HTTP Status Code: 400

 ** NotLatestPipelineExecutionException **   
The stage has failed in a later run of the pipeline and the `pipelineExecutionId` associated with the request is out of date.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** StageNotFoundException **   
The stage was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** StageNotRetryableException **   
Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_RetryStageExecution_Examples"></a>

### Example
<a name="API_RetryStageExecution_Example_1"></a>

This example illustrates one usage of RetryStageExecution.

#### Sample Request
<a name="API_RetryStageExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 173
X-Amz-Target: CodePipeline_20150709.RetryStageExecution
X-Amz-Date: 20151030T230047Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
   "pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE",
   "pipelineName": "MyFirstPipeline",
   "retryMode": "FAILED_ACTIONS",
   "stageName": "Staging"
}
```

#### Sample Response
<a name="API_RetryStageExecution_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 30

{
   "pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}
```

## See Also
<a name="API_RetryStageExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/RetryStageExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/RetryStageExecution) 

# RollbackStage
<a name="API_RollbackStage"></a>

Rolls back a stage execution.

## Request Syntax
<a name="API_RollbackStage_RequestSyntax"></a>

```
{
   "pipelineName": "string",
   "stageName": "string",
   "targetPipelineExecutionId": "string"
}
```

## Request Parameters
<a name="API_RollbackStage_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipelineName](#API_RollbackStage_RequestSyntax) **   <a name="CodePipeline-RollbackStage-request-pipelineName"></a>
The name of the pipeline for which the stage will be rolled back.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [stageName](#API_RollbackStage_RequestSyntax) **   <a name="CodePipeline-RollbackStage-request-stageName"></a>
The name of the stage in the pipeline to be rolled back.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [targetPipelineExecutionId](#API_RollbackStage_RequestSyntax) **   <a name="CodePipeline-RollbackStage-request-targetPipelineExecutionId"></a>
The pipeline execution ID for the stage to be rolled back to.   
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

## Response Syntax
<a name="API_RollbackStage_ResponseSyntax"></a>

```
{
   "pipelineExecutionId": "string"
}
```

## Response Elements
<a name="API_RollbackStage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [pipelineExecutionId](#API_RollbackStage_ResponseSyntax) **   <a name="CodePipeline-RollbackStage-response-pipelineExecutionId"></a>
The execution ID of the pipeline execution for the stage that has been rolled back.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

## Errors
<a name="API_RollbackStage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.  
HTTP Status Code: 400

 ** PipelineExecutionNotFoundException **   
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.   
HTTP Status Code: 400

 ** PipelineExecutionOutdatedException **   
The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** StageNotFoundException **   
The stage was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** UnableToRollbackStageException **   
Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_RollbackStage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/RollbackStage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/RollbackStage) 

# StartPipelineExecution
<a name="API_StartPipelineExecution"></a>

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

## Request Syntax
<a name="API_StartPipelineExecution_RequestSyntax"></a>

```
{
   "clientRequestToken": "string",
   "name": "string",
   "sourceRevisions": [ 
      { 
         "actionName": "string",
         "revisionType": "string",
         "revisionValue": "string"
      }
   ],
   "variables": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_StartPipelineExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_StartPipelineExecution_RequestSyntax) **   <a name="CodePipeline-StartPipelineExecution-request-clientRequestToken"></a>
The system-generated unique ID used to identify a unique execution request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: No

 ** [name](#API_StartPipelineExecution_RequestSyntax) **   <a name="CodePipeline-StartPipelineExecution-request-name"></a>
The name of the pipeline to start.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [sourceRevisions](#API_StartPipelineExecution_RequestSyntax) **   <a name="CodePipeline-StartPipelineExecution-request-sourceRevisions"></a>
A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.  
Type: Array of [SourceRevisionOverride](API_SourceRevisionOverride.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [variables](#API_StartPipelineExecution_RequestSyntax) **   <a name="CodePipeline-StartPipelineExecution-request-variables"></a>
A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match `[A-Za-z0-9@\-_]+`, and the values can be anything except an empty string.  
Type: Array of [PipelineVariable](API_PipelineVariable.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_StartPipelineExecution_ResponseSyntax"></a>

```
{
   "pipelineExecutionId": "string"
}
```

## Response Elements
<a name="API_StartPipelineExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [pipelineExecutionId](#API_StartPipelineExecution_ResponseSyntax) **   <a name="CodePipeline-StartPipelineExecution-response-pipelineExecutionId"></a>
The unique system-generated ID of the pipeline execution that was started.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

## Errors
<a name="API_StartPipelineExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentPipelineExecutionsLimitExceededException **   
The pipeline has reached the limit for concurrent pipeline executions.  
HTTP Status Code: 400

 ** ConflictException **   
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_StartPipelineExecution_Examples"></a>

### Example
<a name="API_StartPipelineExecution_Example_1"></a>

This example illustrates one usage of StartPipelineExecution.

#### Sample Request
<a name="API_StartPipelineExecution_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: CodePipeline_20150709.StartPipelineExecution
X-Amz-Date: 20160707T172713Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "name": "MyFirstPipeline"
}
```

#### Sample Response
<a name="API_StartPipelineExecution_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 62

{
  "pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}
```

## See Also
<a name="API_StartPipelineExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/StartPipelineExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/StartPipelineExecution) 

# StopPipelineExecution
<a name="API_StopPipelineExecution"></a>

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a `Stopping` state. After all in-progress actions are completed or abandoned, the pipeline execution is in a `Stopped` state.

## Request Syntax
<a name="API_StopPipelineExecution_RequestSyntax"></a>

```
{
   "abandon": boolean,
   "pipelineExecutionId": "string",
   "pipelineName": "string",
   "reason": "string"
}
```

## Request Parameters
<a name="API_StopPipelineExecution_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [abandon](#API_StopPipelineExecution_RequestSyntax) **   <a name="CodePipeline-StopPipelineExecution-request-abandon"></a>
Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.  
This option can lead to failed or out-of-sequence tasks.
Type: Boolean  
Required: No

 ** [pipelineExecutionId](#API_StopPipelineExecution_RequestSyntax) **   <a name="CodePipeline-StopPipelineExecution-request-pipelineExecutionId"></a>
The ID of the pipeline execution to be stopped in the current stage. Use the `GetPipelineState` action to retrieve the current pipelineExecutionId.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** [pipelineName](#API_StopPipelineExecution_RequestSyntax) **   <a name="CodePipeline-StopPipelineExecution-request-pipelineName"></a>
The name of the pipeline to stop.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[A-Za-z0-9.@\-_]+`   
Required: Yes

 ** [reason](#API_StopPipelineExecution_RequestSyntax) **   <a name="CodePipeline-StopPipelineExecution-request-reason"></a>
Use this option to enter comments, such as the reason the pipeline was stopped.  
Type: String  
Length Constraints: Maximum length of 200.  
Required: No

## Response Syntax
<a name="API_StopPipelineExecution_ResponseSyntax"></a>

```
{
   "pipelineExecutionId": "string"
}
```

## Response Elements
<a name="API_StopPipelineExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [pipelineExecutionId](#API_StopPipelineExecution_ResponseSyntax) **   <a name="CodePipeline-StopPipelineExecution-response-pipelineExecutionId"></a>
The unique system-generated ID of the pipeline execution that was stopped.  
Type: String  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` 

## Errors
<a name="API_StopPipelineExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.  
HTTP Status Code: 400

 ** DuplicatedStopRequestException **   
The pipeline execution is already in a `Stopping` state. If you already chose to stop and wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you cannot make that request again.  
HTTP Status Code: 400

 ** PipelineExecutionNotStoppableException **   
Unable to stop the pipeline execution. The execution might already be in a `Stopped` state, or it might no longer be in progress.  
HTTP Status Code: 400

 ** PipelineNotFoundException **   
The pipeline was specified in an invalid format or cannot be found.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_StopPipelineExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/StopPipelineExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/StopPipelineExecution) 

# TagResource
<a name="API_TagResource"></a>

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. 

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="CodePipeline-TagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource you want to add tags to.  
Type: String  
Pattern: `arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+`   
Required: Yes

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="CodePipeline-TagResource-request-tags"></a>
The tags you want to modify or add to the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Unable to modify the tag due to a simultaneous update request.  
HTTP Status Code: 400

 ** InvalidArnException **   
The specified resource ARN is invalid.  
HTTP Status Code: 400

 ** InvalidTagsException **   
The specified resource tags are invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was specified in an invalid format.  
HTTP Status Code: 400

 ** TooManyTagsException **   
The tags limit for a resource has been exceeded.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes tags from an AWS resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="CodePipeline-UntagResource-request-resourceArn"></a>
 The Amazon Resource Name (ARN) of the resource to remove tags from.  
Type: String  
Pattern: `arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+`   
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="CodePipeline-UntagResource-request-tagKeys"></a>
The list of keys for the tags to be removed from the resource.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
Unable to modify the tag due to a simultaneous update request.  
HTTP Status Code: 400

 ** InvalidArnException **   
The specified resource ARN is invalid.  
HTTP Status Code: 400

 ** InvalidTagsException **   
The specified resource tags are invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource was specified in an invalid format.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/UntagResource) 

# UpdateActionType
<a name="API_UpdateActionType"></a>

Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and `UpdateActionType` to provide the full structure.

## Request Syntax
<a name="API_UpdateActionType_RequestSyntax"></a>

```
{
   "actionType": { 
      "description": "string",
      "executor": { 
         "configuration": { 
            "jobWorkerExecutorConfiguration": { 
               "pollingAccounts": [ "string" ],
               "pollingServicePrincipals": [ "string" ]
            },
            "lambdaExecutorConfiguration": { 
               "lambdaFunctionArn": "string"
            }
         },
         "jobTimeout": number,
         "policyStatementsTemplate": "string",
         "type": "string"
      },
      "id": { 
         "category": "string",
         "owner": "string",
         "provider": "string",
         "version": "string"
      },
      "inputArtifactDetails": { 
         "maximumCount": number,
         "minimumCount": number
      },
      "outputArtifactDetails": { 
         "maximumCount": number,
         "minimumCount": number
      },
      "permissions": { 
         "allowedAccounts": [ "string" ]
      },
      "properties": [ 
         { 
            "description": "string",
            "key": boolean,
            "name": "string",
            "noEcho": boolean,
            "optional": boolean,
            "queryable": boolean
         }
      ],
      "urls": { 
         "configurationUrl": "string",
         "entityUrlTemplate": "string",
         "executionUrlTemplate": "string",
         "revisionUrlTemplate": "string"
      }
   }
}
```

## Request Parameters
<a name="API_UpdateActionType_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [actionType](#API_UpdateActionType_RequestSyntax) **   <a name="CodePipeline-UpdateActionType-request-actionType"></a>
The action type definition for the action type to be updated.  
Type: [ActionTypeDeclaration](API_ActionTypeDeclaration.md) object  
Required: Yes

## Response Elements
<a name="API_UpdateActionType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateActionType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ActionTypeNotFoundException **   
The specified action type cannot be found.  
HTTP Status Code: 400

 ** RequestFailedException **   
The request failed because of an unknown error, exception, or failure.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateActionType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/UpdateActionType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/UpdateActionType) 

# UpdatePipeline
<a name="API_UpdatePipeline"></a>

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and `UpdatePipeline` to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

## Request Syntax
<a name="API_UpdatePipeline_RequestSyntax"></a>

```
{
   "pipeline": { 
      "artifactStore": { 
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "location": "string",
         "type": "string"
      },
      "artifactStores": { 
         "string" : { 
            "encryptionKey": { 
               "id": "string",
               "type": "string"
            },
            "location": "string",
            "type": "string"
         }
      },
      "executionMode": "string",
      "name": "string",
      "pipelineType": "string",
      "roleArn": "string",
      "stages": [ 
         { 
            "actions": [ 
               { 
                  "actionTypeId": { 
                     "category": "string",
                     "owner": "string",
                     "provider": "string",
                     "version": "string"
                  },
                  "commands": [ "string" ],
                  "configuration": { 
                     "string" : "string" 
                  },
                  "environmentVariables": [ 
                     { 
                        "name": "string",
                        "type": "string",
                        "value": "string"
                     }
                  ],
                  "inputArtifacts": [ 
                     { 
                        "name": "string"
                     }
                  ],
                  "name": "string",
                  "namespace": "string",
                  "outputArtifacts": [ 
                     { 
                        "files": [ "string" ],
                        "name": "string"
                     }
                  ],
                  "outputVariables": [ "string" ],
                  "region": "string",
                  "roleArn": "string",
                  "runOrder": number,
                  "timeoutInMinutes": number
               }
            ],
            "beforeEntry": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            },
            "blockers": [ 
               { 
                  "name": "string",
                  "type": "string"
               }
            ],
            "name": "string",
            "onFailure": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ],
               "result": "string",
               "retryConfiguration": { 
                  "retryMode": "string"
               }
            },
            "onSuccess": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            }
         }
      ],
      "triggers": [ 
         { 
            "gitConfiguration": { 
               "pullRequest": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "events": [ "string" ],
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "push": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "tags": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "sourceActionName": "string"
            },
            "providerType": "string"
         }
      ],
      "variables": [ 
         { 
            "defaultValue": "string",
            "description": "string",
            "name": "string"
         }
      ],
      "version": number
   }
}
```

## Request Parameters
<a name="API_UpdatePipeline_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [pipeline](#API_UpdatePipeline_RequestSyntax) **   <a name="CodePipeline-UpdatePipeline-request-pipeline"></a>
The name of the pipeline to be updated.  
Type: [PipelineDeclaration](API_PipelineDeclaration.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdatePipeline_ResponseSyntax"></a>

```
{
   "pipeline": { 
      "artifactStore": { 
         "encryptionKey": { 
            "id": "string",
            "type": "string"
         },
         "location": "string",
         "type": "string"
      },
      "artifactStores": { 
         "string" : { 
            "encryptionKey": { 
               "id": "string",
               "type": "string"
            },
            "location": "string",
            "type": "string"
         }
      },
      "executionMode": "string",
      "name": "string",
      "pipelineType": "string",
      "roleArn": "string",
      "stages": [ 
         { 
            "actions": [ 
               { 
                  "actionTypeId": { 
                     "category": "string",
                     "owner": "string",
                     "provider": "string",
                     "version": "string"
                  },
                  "commands": [ "string" ],
                  "configuration": { 
                     "string" : "string" 
                  },
                  "environmentVariables": [ 
                     { 
                        "name": "string",
                        "type": "string",
                        "value": "string"
                     }
                  ],
                  "inputArtifacts": [ 
                     { 
                        "name": "string"
                     }
                  ],
                  "name": "string",
                  "namespace": "string",
                  "outputArtifacts": [ 
                     { 
                        "files": [ "string" ],
                        "name": "string"
                     }
                  ],
                  "outputVariables": [ "string" ],
                  "region": "string",
                  "roleArn": "string",
                  "runOrder": number,
                  "timeoutInMinutes": number
               }
            ],
            "beforeEntry": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            },
            "blockers": [ 
               { 
                  "name": "string",
                  "type": "string"
               }
            ],
            "name": "string",
            "onFailure": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ],
               "result": "string",
               "retryConfiguration": { 
                  "retryMode": "string"
               }
            },
            "onSuccess": { 
               "conditions": [ 
                  { 
                     "result": "string",
                     "rules": [ 
                        { 
                           "commands": [ "string" ],
                           "configuration": { 
                              "string" : "string" 
                           },
                           "inputArtifacts": [ 
                              { 
                                 "name": "string"
                              }
                           ],
                           "name": "string",
                           "region": "string",
                           "roleArn": "string",
                           "ruleTypeId": { 
                              "category": "string",
                              "owner": "string",
                              "provider": "string",
                              "version": "string"
                           },
                           "timeoutInMinutes": number
                        }
                     ]
                  }
               ]
            }
         }
      ],
      "triggers": [ 
         { 
            "gitConfiguration": { 
               "pullRequest": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "events": [ "string" ],
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "push": [ 
                  { 
                     "branches": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "filePaths": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     },
                     "tags": { 
                        "excludes": [ "string" ],
                        "includes": [ "string" ]
                     }
                  }
               ],
               "sourceActionName": "string"
            },
            "providerType": "string"
         }
      ],
      "variables": [ 
         { 
            "defaultValue": "string",
            "description": "string",
            "name": "string"
         }
      ],
      "version": number
   }
}
```

## Response Elements
<a name="API_UpdatePipeline_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [pipeline](#API_UpdatePipeline_ResponseSyntax) **   <a name="CodePipeline-UpdatePipeline-response-pipeline"></a>
The structure of the updated pipeline.  
Type: [PipelineDeclaration](API_PipelineDeclaration.md) object

## Errors
<a name="API_UpdatePipeline_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidActionDeclarationException **   
The action declaration was specified in an invalid format.  
HTTP Status Code: 400

 ** InvalidBlockerDeclarationException **   
Reserved for future use.  
HTTP Status Code: 400

 ** InvalidStageDeclarationException **   
The stage declaration was specified in an invalid format.  
HTTP Status Code: 400

 ** InvalidStructureException **   
The structure was specified in an invalid format.  
HTTP Status Code: 400

 ** LimitExceededException **   
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.  
HTTP Status Code: 400

 ** ValidationException **   
The validation was specified in an invalid format.  
HTTP Status Code: 400

## Examples
<a name="API_UpdatePipeline_Examples"></a>

### Example
<a name="API_UpdatePipeline_Example_1"></a>

This example illustrates one usage of UpdatePipeline.

#### Sample Request
<a name="API_UpdatePipeline_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 914
X-Amz-Target: CodePipeline_20150709.UpdatePipeline
X-Amz-Date: 20160707T174930Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE

{
  "pipeline": {
    "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
    "stages": [
      {
        "name": "Source",
        "actions": [
          {
            "inputArtifacts": [],
            "name": "Source",
            "actionTypeId": {
              "category": "Source",
              "owner": "AWS",
              "version": "1",
              "provider": "S3"
            },
            "outputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "configuration": {
              "S3Bucket": "amzn-s3-demo-bucket",
              "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
            },
            "runOrder": 1
          }
        ]
      },
      {
        "name": "Staging",
        "actions": [
          {
            "inputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "name": "CodePipelineDemoFleet",
            "actionTypeId": {
              "category": "Deploy",
              "owner": "AWS",
              "version": "1",
              "provider": "CodeDeploy"
            },
            "outputArtifacts": [],
            "configuration": {
              "ApplicationName": "CodePipelineDemoApplication",
              "DeploymentGroupName": "CodePipelineDemoFleet"
            },
            "runOrder": 1
          }
        ]
      }
    ],
    "artifactStore": {
      "type": "S3",
      "location": "codepipeline-us-east-1-11EXAMPLE11"
    },
    "name": "MyFirstPipeline",
    "version": 1
  }
}
```

#### Sample Response
<a name="API_UpdatePipeline_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 898

{
  "pipeline": {
    "artifactStore": {
      "location": "amzn-s3-demo-bucket",
      "type": "S3"
    },
    "name": "MyFirstPipeline",
    "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
    "stages": [
      {
        "actions": [
          {
            "actionTypeId": {
              "__type": "ActionTypeId",
              "category": "Source",
              "owner": "AWS",
              "provider": "S3",
              "version": "1"
            },
            "configuration": {
              "S3Bucket": "amzn-s3-demo-bucket",
              "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
            },
            "inputArtifacts": [],
            "name": "Source",
            "outputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "runOrder": 1
          }
        ],
        "name": "Source"
      },
      {
        "actions": [
          {
            "actionTypeId": {
              "__type": "ActionTypeId",
              "category": "Deploy",
              "owner": "AWS",
              "provider": "CodeDeploy",
              "version": "1"
            },
            "configuration": {
              "ApplicationName": "CodePipelineDemoApplication",
              "DeploymentGroupName": "CodePipelineDemoFleet"
            },
            "inputArtifacts": [
              {
                "name": "MyApp"
              }
            ],
            "name": "CodePipelineDemoFleet",
            "outputArtifacts": [],
            "runOrder": 1
          }
        ],
        "name": "Staging"
      }
    ],
    "version": 3
  }
}
```

## See Also
<a name="API_UpdatePipeline_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/codepipeline-2015-07-09/UpdatePipeline) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/codepipeline-2015-07-09/UpdatePipeline)