SDK for PHP 3.x

Client: Aws\CodePipeline\CodePipelineClient
Service ID: codepipeline
Version: 2015-07-09

This page describes the parameters and results for the operations of the AWS CodePipeline (2015-07-09), and shows how to use the Aws\CodePipeline\CodePipelineClient object to call the described operations. This documentation is specific to the 2015-07-09 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcknowledgeJob ( array $params = [] )
Returns information about a specified job and whether that job has been received by the job worker.
AcknowledgeThirdPartyJob ( array $params = [] )
Confirms a job worker has received the specified job.
CreateCustomActionType ( array $params = [] )
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account.
CreatePipeline ( array $params = [] )
Creates a pipeline.
DeleteCustomActionType ( array $params = [] )
Marks a custom action as deleted.
DeletePipeline ( array $params = [] )
Deletes the specified pipeline.
DeleteWebhook ( array $params = [] )
Deletes a previously created webhook by name.
DeregisterWebhookWithThirdParty ( array $params = [] )
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected.
DisableStageTransition ( array $params = [] )
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
EnableStageTransition ( array $params = [] )
Enables artifacts in a pipeline to transition to a stage in a pipeline.
GetActionType ( array $params = [] )
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider.
GetJobDetails ( array $params = [] )
Returns information about a job.
GetPipeline ( array $params = [] )
Returns the metadata, structure, stages, and actions of a pipeline.
GetPipelineExecution ( array $params = [] )
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.
GetPipelineState ( array $params = [] )
Returns information about the state of a pipeline, including the stages and actions.
GetThirdPartyJobDetails ( array $params = [] )
Requests the details of a job for a third party action.
ListActionExecutions ( array $params = [] )
Lists the action executions that have occurred in a pipeline.
ListActionTypes ( array $params = [] )
Gets a summary of all CodePipeline action types associated with your account.
ListPipelineExecutions ( array $params = [] )
Gets a summary of the most recent executions for a pipeline.
ListPipelines ( array $params = [] )
Gets a summary of all of the pipelines associated with your account.
ListRuleExecutions ( array $params = [] )
Lists the rule executions that have occurred in a pipeline configured for conditions with rules.
ListRuleTypes ( array $params = [] )
Lists the rules for the condition.
ListTagsForResource ( array $params = [] )
Gets the set of key-value pairs (metadata) that are used to manage the resource.
ListWebhooks ( array $params = [] )
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
OverrideStageCondition ( array $params = [] )
Used to override a stage condition.
PollForJobs ( array $params = [] )
Returns information about any jobs for CodePipeline to act on.
PollForThirdPartyJobs ( array $params = [] )
Determines whether there are any third party jobs for a job worker to act on.
PutActionRevision ( array $params = [] )
Provides information to CodePipeline about new revisions to a source.
PutApprovalResult ( array $params = [] )
Provides the response to a manual approval request to CodePipeline.
PutJobFailureResult ( array $params = [] )
Represents the failure of a job as returned to the pipeline by a job worker.
PutJobSuccessResult ( array $params = [] )
Represents the success of a job as returned to the pipeline by a job worker.
PutThirdPartyJobFailureResult ( array $params = [] )
Represents the failure of a third party job as returned to the pipeline by a job worker.
PutThirdPartyJobSuccessResult ( array $params = [] )
Represents the success of a third party job as returned to the pipeline by a job worker.
PutWebhook ( array $params = [] )
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
RegisterWebhookWithThirdParty ( array $params = [] )
Configures a connection between the webhook that was created and the external tool with events to be detected.
RetryStageExecution ( array $params = [] )
You can retry a stage that has failed without having to run a pipeline again from the beginning.
RollbackStage ( array $params = [] )
Rolls back a stage execution.
StartPipelineExecution ( array $params = [] )
Starts the specified pipeline.
StopPipelineExecution ( array $params = [] )
Stops the specified pipeline execution.
TagResource ( array $params = [] )
Adds to or modifies the tags of the given resource.
UntagResource ( array $params = [] )
Removes tags from an Amazon Web Services resource.
UpdateActionType ( array $params = [] )
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.
UpdatePipeline ( array $params = [] )
Updates a specified pipeline with edits or changes to its structure.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListActionExecutions
ListActionTypes
ListPipelineExecutions
ListPipelines
ListRuleExecutions
ListTagsForResource
ListWebhooks

Operations

AcknowledgeJob

$result = $client->acknowledgeJob([/* ... */]);
$promise = $client->acknowledgeJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->acknowledgeJob([
    'jobId' => '<string>', // REQUIRED
    'nonce' => '<string>', // REQUIRED
]);

Parameter Details

Members
jobId
Required: Yes
Type: string

The unique system-generated ID of the job for which you want to confirm receipt.

nonce
Required: Yes
Type: string

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 request that returned this job.

Result Syntax

[
    'status' => 'Created|Queued|Dispatched|InProgress|TimedOut|Succeeded|Failed',
]

Result Details

Members
status
Type: string

Whether the job worker has received the specified job.

Errors

ValidationException:

The validation was specified in an invalid format.

InvalidNonceException:

The nonce was specified in an invalid format.

JobNotFoundException:

The job was specified in an invalid format or cannot be found.

AcknowledgeThirdPartyJob

$result = $client->acknowledgeThirdPartyJob([/* ... */]);
$promise = $client->acknowledgeThirdPartyJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->acknowledgeThirdPartyJob([
    'clientToken' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
    'nonce' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Required: Yes
Type: string

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.

jobId
Required: Yes
Type: string

The unique system-generated ID of the job.

nonce
Required: Yes
Type: string

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 request.

Result Syntax

[
    'status' => 'Created|Queued|Dispatched|InProgress|TimedOut|Succeeded|Failed',
]

Result Details

Members
status
Type: string

The status information for the third party job, if any.

Errors

ValidationException:

The validation was specified in an invalid format.

InvalidNonceException:

The nonce was specified in an invalid format.

JobNotFoundException:

The job was specified in an invalid format or cannot be found.

InvalidClientTokenException:

The client token was specified in an invalid format

CreateCustomActionType

$result = $client->createCustomActionType([/* ... */]);
$promise = $client->createCustomActionTypeAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createCustomActionType([
    'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute', // REQUIRED
    'configurationProperties' => [
        [
            'description' => '<string>',
            'key' => true || false, // REQUIRED
            'name' => '<string>', // REQUIRED
            'queryable' => true || false,
            'required' => true || false, // REQUIRED
            'secret' => true || false, // REQUIRED
            'type' => 'String|Number|Boolean',
        ],
        // ...
    ],
    'inputArtifactDetails' => [ // REQUIRED
        'maximumCount' => <integer>, // REQUIRED
        'minimumCount' => <integer>, // REQUIRED
    ],
    'outputArtifactDetails' => [ // REQUIRED
        'maximumCount' => <integer>, // REQUIRED
        'minimumCount' => <integer>, // REQUIRED
    ],
    'provider' => '<string>', // REQUIRED
    'settings' => [
        'entityUrlTemplate' => '<string>',
        'executionUrlTemplate' => '<string>',
        'revisionUrlTemplate' => '<string>',
        'thirdPartyConfigurationUrl' => '<string>',
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Members
category
Required: Yes
Type: string

The category of the custom action, such as a build action or a test action.

configurationProperties
Type: Array of ActionConfigurationProperty structures

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 {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

inputArtifactDetails
Required: Yes
Type: ArtifactDetails structure

The details of the input artifact for the action, such as its commit ID.

outputArtifactDetails
Required: Yes
Type: ArtifactDetails structure

The details of the output artifact of the action, such as its commit ID.

provider
Required: Yes
Type: string

The provider of the service used in the custom action, such as CodeDeploy.

settings
Type: ActionTypeSettings structure

URLs that provide users information about this custom action.

tags
Type: Array of Tag structures

The tags for the custom action.

version
Required: Yes
Type: string

The version identifier of the custom action.

Result Syntax

[
    'actionType' => [
        'actionConfigurationProperties' => [
            [
                'description' => '<string>',
                'key' => true || false,
                'name' => '<string>',
                'queryable' => true || false,
                'required' => true || false,
                'secret' => true || false,
                'type' => 'String|Number|Boolean',
            ],
            // ...
        ],
        'id' => [
            'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
            'owner' => 'AWS|ThirdParty|Custom',
            'provider' => '<string>',
            'version' => '<string>',
        ],
        'inputArtifactDetails' => [
            'maximumCount' => <integer>,
            'minimumCount' => <integer>,
        ],
        'outputArtifactDetails' => [
            'maximumCount' => <integer>,
            'minimumCount' => <integer>,
        ],
        'settings' => [
            'entityUrlTemplate' => '<string>',
            'executionUrlTemplate' => '<string>',
            'revisionUrlTemplate' => '<string>',
            'thirdPartyConfigurationUrl' => '<string>',
        ],
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
actionType
Required: Yes
Type: ActionType structure

Returns information about the details of an action type.

tags
Type: Array of Tag structures

Specifies the tags applied to the custom action.

Errors

ValidationException:

The validation was specified in an invalid format.

LimitExceededException:

The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.

TooManyTagsException:

The tags limit for a resource has been exceeded.

InvalidTagsException:

The specified resource tags are invalid.

ConcurrentModificationException:

Unable to modify the tag due to a simultaneous update request.

CreatePipeline

$result = $client->createPipeline([/* ... */]);
$promise = $client->createPipelineAsync([/* ... */]);

Creates a pipeline.

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.

Parameter Syntax

$result = $client->createPipeline([
    'pipeline' => [ // REQUIRED
        'artifactStore' => [
            'encryptionKey' => [
                'id' => '<string>', // REQUIRED
                'type' => 'KMS', // REQUIRED
            ],
            'location' => '<string>', // REQUIRED
            'type' => 'S3', // REQUIRED
        ],
        'artifactStores' => [
            '<AWSRegionName>' => [
                'encryptionKey' => [
                    'id' => '<string>', // REQUIRED
                    'type' => 'KMS', // REQUIRED
                ],
                'location' => '<string>', // REQUIRED
                'type' => 'S3', // REQUIRED
            ],
            // ...
        ],
        'executionMode' => 'QUEUED|SUPERSEDED|PARALLEL',
        'name' => '<string>', // REQUIRED
        'pipelineType' => 'V1|V2',
        'roleArn' => '<string>', // REQUIRED
        'stages' => [ // REQUIRED
            [
                'actions' => [ // REQUIRED
                    [
                        'actionTypeId' => [ // REQUIRED
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute', // REQUIRED
                            'owner' => 'AWS|ThirdParty|Custom', // REQUIRED
                            'provider' => '<string>', // REQUIRED
                            'version' => '<string>', // REQUIRED
                        ],
                        'commands' => ['<string>', ...],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'name' => '<string>', // REQUIRED
                        'namespace' => '<string>',
                        'outputArtifacts' => [
                            [
                                'files' => ['<string>', ...],
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'outputVariables' => ['<string>', ...],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                        'timeoutInMinutes' => <integer>,
                    ],
                    // ...
                ],
                'beforeEntry' => [
                    'conditions' => [ // REQUIRED
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>', // REQUIRED
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [ // REQUIRED
                                        'category' => 'Rule', // REQUIRED
                                        'owner' => 'AWS',
                                        'provider' => '<string>', // REQUIRED
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                'blockers' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'type' => 'Schedule', // REQUIRED
                    ],
                    // ...
                ],
                'name' => '<string>', // REQUIRED
                'onFailure' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>', // REQUIRED
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [ // REQUIRED
                                        'category' => 'Rule', // REQUIRED
                                        'owner' => 'AWS',
                                        'provider' => '<string>', // REQUIRED
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                    'retryConfiguration' => [
                        'retryMode' => 'FAILED_ACTIONS|ALL_ACTIONS',
                    ],
                ],
                'onSuccess' => [
                    'conditions' => [ // REQUIRED
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>', // REQUIRED
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [ // REQUIRED
                                        'category' => 'Rule', // REQUIRED
                                        'owner' => 'AWS',
                                        'provider' => '<string>', // REQUIRED
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        'triggers' => [
            [
                'gitConfiguration' => [ // REQUIRED
                    '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>', // REQUIRED
                ],
                'providerType' => 'CodeStarSourceConnection', // REQUIRED
            ],
            // ...
        ],
        'variables' => [
            [
                'defaultValue' => '<string>',
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'version' => <integer>,
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
pipeline
Required: Yes
Type: PipelineDeclaration structure

Represents the structure of actions and stages to be performed in the pipeline.

tags
Type: Array of Tag structures

The tags for the pipeline.

Result Syntax

[
    'pipeline' => [
        'artifactStore' => [
            'encryptionKey' => [
                'id' => '<string>',
                'type' => 'KMS',
            ],
            'location' => '<string>',
            'type' => 'S3',
        ],
        'artifactStores' => [
            '<AWSRegionName>' => [
                'encryptionKey' => [
                    'id' => '<string>',
                    'type' => 'KMS',
                ],
                'location' => '<string>',
                'type' => 'S3',
            ],
            // ...
        ],
        'executionMode' => 'QUEUED|SUPERSEDED|PARALLEL',
        'name' => '<string>',
        'pipelineType' => 'V1|V2',
        'roleArn' => '<string>',
        'stages' => [
            [
                'actions' => [
                    [
                        'actionTypeId' => [
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
                            'owner' => 'AWS|ThirdParty|Custom',
                            'provider' => '<string>',
                            'version' => '<string>',
                        ],
                        'commands' => ['<string>', ...],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'name' => '<string>',
                        'namespace' => '<string>',
                        'outputArtifacts' => [
                            [
                                'files' => ['<string>', ...],
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'outputVariables' => ['<string>', ...],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                        'timeoutInMinutes' => <integer>,
                    ],
                    // ...
                ],
                'beforeEntry' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                'blockers' => [
                    [
                        'name' => '<string>',
                        'type' => 'Schedule',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'onFailure' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                    'retryConfiguration' => [
                        'retryMode' => 'FAILED_ACTIONS|ALL_ACTIONS',
                    ],
                ],
                'onSuccess' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        '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' => 'CodeStarSourceConnection',
            ],
            // ...
        ],
        'variables' => [
            [
                'defaultValue' => '<string>',
                'description' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'version' => <integer>,
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
pipeline
Type: PipelineDeclaration structure

Represents the structure of actions and stages to be performed in the pipeline.

tags
Type: Array of Tag structures

Specifies the tags applied to the pipeline.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNameInUseException:

The specified pipeline name is already in use.

InvalidStageDeclarationException:

The stage declaration was specified in an invalid format.

InvalidActionDeclarationException:

The action declaration was specified in an invalid format.

InvalidBlockerDeclarationException:

Reserved for future use.

InvalidStructureException:

The structure was specified in an invalid format.

LimitExceededException:

The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.

TooManyTagsException:

The tags limit for a resource has been exceeded.

InvalidTagsException:

The specified resource tags are invalid.

ConcurrentModificationException:

Unable to modify the tag due to a simultaneous update request.

DeleteCustomActionType

$result = $client->deleteCustomActionType([/* ... */]);
$promise = $client->deleteCustomActionTypeAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->deleteCustomActionType([
    'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute', // REQUIRED
    'provider' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Members
category
Required: Yes
Type: string

The category of the custom action that you want to delete, such as source or deploy.

provider
Required: Yes
Type: string

The provider of the service used in the custom action, such as CodeDeploy.

version
Required: Yes
Type: string

The version of the custom action to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

ConcurrentModificationException:

Unable to modify the tag due to a simultaneous update request.

DeletePipeline

$result = $client->deletePipeline([/* ... */]);
$promise = $client->deletePipelineAsync([/* ... */]);

Deletes the specified pipeline.

Parameter Syntax

$result = $client->deletePipeline([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the pipeline to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

ConcurrentModificationException:

Unable to modify the tag due to a simultaneous update request.

DeleteWebhook

$result = $client->deleteWebhook([/* ... */]);
$promise = $client->deleteWebhookAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteWebhook([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the webhook you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

ConcurrentModificationException:

Unable to modify the tag due to a simultaneous update request.

DeregisterWebhookWithThirdParty

$result = $client->deregisterWebhookWithThirdParty([/* ... */]);
$promise = $client->deregisterWebhookWithThirdPartyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deregisterWebhookWithThirdParty([
    'webhookName' => '<string>',
]);

Parameter Details

Members
webhookName
Type: string

The name of the webhook you want to deregister.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

WebhookNotFoundException:

The specified webhook was entered in an invalid format or cannot be found.

DisableStageTransition

$result = $client->disableStageTransition([/* ... */]);
$promise = $client->disableStageTransitionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disableStageTransition([
    'pipelineName' => '<string>', // REQUIRED
    'reason' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
    'transitionType' => 'Inbound|Outbound', // REQUIRED
]);

Parameter Details

Members
pipelineName
Required: Yes
Type: string

The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

reason
Required: Yes
Type: string

The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

stageName
Required: Yes
Type: string

The name of the stage where you want to disable the inbound or outbound transition of artifacts.

transitionType
Required: Yes
Type: string

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).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

StageNotFoundException:

The stage was specified in an invalid format or cannot be found.

EnableStageTransition

$result = $client->enableStageTransition([/* ... */]);
$promise = $client->enableStageTransitionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->enableStageTransition([
    'pipelineName' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
    'transitionType' => 'Inbound|Outbound', // REQUIRED
]);

Parameter Details

Members
pipelineName
Required: Yes
Type: string

The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.

stageName
Required: Yes
Type: string

The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).

transitionType
Required: Yes
Type: string

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).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

StageNotFoundException:

The stage was specified in an invalid format or cannot be found.

GetActionType

$result = $client->getActionType([/* ... */]);
$promise = $client->getActionTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getActionType([
    'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute', // REQUIRED
    'owner' => '<string>', // REQUIRED
    'provider' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Members
category
Required: Yes
Type: string

Defines what kind of action can be taken in the stage. The following are the valid values:

  • Source

  • Build

  • Test

  • Deploy

  • Approval

  • Invoke

owner
Required: Yes
Type: string

The creator of an action type that was created with any supported integration model. There are two valid values: AWS and ThirdParty.

provider
Required: Yes
Type: string

The provider of the action type being called. The provider name is specified when the action type is created.

version
Required: Yes
Type: string

A string that describes the action type version.

Result Syntax

[
    'actionType' => [
        'description' => '<string>',
        'executor' => [
            'configuration' => [
                'jobWorkerExecutorConfiguration' => [
                    'pollingAccounts' => ['<string>', ...],
                    'pollingServicePrincipals' => ['<string>', ...],
                ],
                'lambdaExecutorConfiguration' => [
                    'lambdaFunctionArn' => '<string>',
                ],
            ],
            'jobTimeout' => <integer>,
            'policyStatementsTemplate' => '<string>',
            'type' => 'JobWorker|Lambda',
        ],
        'id' => [
            'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
            'owner' => '<string>',
            'provider' => '<string>',
            'version' => '<string>',
        ],
        'inputArtifactDetails' => [
            'maximumCount' => <integer>,
            'minimumCount' => <integer>,
        ],
        'outputArtifactDetails' => [
            'maximumCount' => <integer>,
            'minimumCount' => <integer>,
        ],
        'permissions' => [
            'allowedAccounts' => ['<string>', ...],
        ],
        'properties' => [
            [
                'description' => '<string>',
                'key' => true || false,
                'name' => '<string>',
                'noEcho' => true || false,
                'optional' => true || false,
                'queryable' => true || false,
            ],
            // ...
        ],
        'urls' => [
            'configurationUrl' => '<string>',
            'entityUrlTemplate' => '<string>',
            'executionUrlTemplate' => '<string>',
            'revisionUrlTemplate' => '<string>',
        ],
    ],
]

Result Details

Members
actionType
Type: ActionTypeDeclaration structure

The action type information for the requested action type, such as the action type ID.

Errors

ActionTypeNotFoundException:

The specified action type cannot be found.

ValidationException:

The validation was specified in an invalid format.

GetJobDetails

$result = $client->getJobDetails([/* ... */]);
$promise = $client->getJobDetailsAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->getJobDetails([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
jobId
Required: Yes
Type: string

The unique system-generated ID for the job.

Result Syntax

[
    'jobDetails' => [
        'accountId' => '<string>',
        'data' => [
            'actionConfiguration' => [
                'configuration' => ['<string>', ...],
            ],
            'actionTypeId' => [
                'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
                'owner' => 'AWS|ThirdParty|Custom',
                'provider' => '<string>',
                'version' => '<string>',
            ],
            'artifactCredentials' => [
                'accessKeyId' => '<string>',
                'secretAccessKey' => '<string>',
                'sessionToken' => '<string>',
            ],
            'continuationToken' => '<string>',
            'encryptionKey' => [
                'id' => '<string>',
                'type' => 'KMS',
            ],
            'inputArtifacts' => [
                [
                    'location' => [
                        's3Location' => [
                            'bucketName' => '<string>',
                            'objectKey' => '<string>',
                        ],
                        'type' => 'S3',
                    ],
                    'name' => '<string>',
                    'revision' => '<string>',
                ],
                // ...
            ],
            'outputArtifacts' => [
                [
                    'location' => [
                        's3Location' => [
                            'bucketName' => '<string>',
                            'objectKey' => '<string>',
                        ],
                        'type' => 'S3',
                    ],
                    'name' => '<string>',
                    'revision' => '<string>',
                ],
                // ...
            ],
            'pipelineContext' => [
                'action' => [
                    'actionExecutionId' => '<string>',
                    'name' => '<string>',
                ],
                'pipelineArn' => '<string>',
                'pipelineExecutionId' => '<string>',
                'pipelineName' => '<string>',
                'stage' => [
                    'name' => '<string>',
                ],
            ],
        ],
        'id' => '<string>',
    ],
]

Result Details

Members
jobDetails
Type: JobDetails structure

The details of the job.

If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.

Errors

ValidationException:

The validation was specified in an invalid format.

JobNotFoundException:

The job was specified in an invalid format or cannot be found.

GetPipeline

$result = $client->getPipeline([/* ... */]);
$promise = $client->getPipelineAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getPipeline([
    'name' => '<string>', // REQUIRED
    'version' => <integer>,
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.

version
Type: int

The version number of the pipeline. If you do not specify a version, defaults to the current version.

Result Syntax

[
    'metadata' => [
        'created' => <DateTime>,
        'pipelineArn' => '<string>',
        'pollingDisabledAt' => <DateTime>,
        'updated' => <DateTime>,
    ],
    'pipeline' => [
        'artifactStore' => [
            'encryptionKey' => [
                'id' => '<string>',
                'type' => 'KMS',
            ],
            'location' => '<string>',
            'type' => 'S3',
        ],
        'artifactStores' => [
            '<AWSRegionName>' => [
                'encryptionKey' => [
                    'id' => '<string>',
                    'type' => 'KMS',
                ],
                'location' => '<string>',
                'type' => 'S3',
            ],
            // ...
        ],
        'executionMode' => 'QUEUED|SUPERSEDED|PARALLEL',
        'name' => '<string>',
        'pipelineType' => 'V1|V2',
        'roleArn' => '<string>',
        'stages' => [
            [
                'actions' => [
                    [
                        'actionTypeId' => [
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
                            'owner' => 'AWS|ThirdParty|Custom',
                            'provider' => '<string>',
                            'version' => '<string>',
                        ],
                        'commands' => ['<string>', ...],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'name' => '<string>',
                        'namespace' => '<string>',
                        'outputArtifacts' => [
                            [
                                'files' => ['<string>', ...],
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'outputVariables' => ['<string>', ...],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                        'timeoutInMinutes' => <integer>,
                    ],
                    // ...
                ],
                'beforeEntry' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                'blockers' => [
                    [
                        'name' => '<string>',
                        'type' => 'Schedule',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'onFailure' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                    'retryConfiguration' => [
                        'retryMode' => 'FAILED_ACTIONS|ALL_ACTIONS',
                    ],
                ],
                'onSuccess' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        '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' => 'CodeStarSourceConnection',
            ],
            // ...
        ],
        'variables' => [
            [
                'defaultValue' => '<string>',
                'description' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'version' => <integer>,
    ],
]

Result Details

Members
metadata
Type: PipelineMetadata structure

Represents the pipeline metadata information returned as part of the output of a GetPipeline action.

pipeline
Type: PipelineDeclaration structure

Represents the structure of actions and stages to be performed in the pipeline.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

PipelineVersionNotFoundException:

The pipeline version was specified in an invalid format or cannot be found.

GetPipelineExecution

$result = $client->getPipelineExecution([/* ... */]);
$promise = $client->getPipelineExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getPipelineExecution([
    'pipelineExecutionId' => '<string>', // REQUIRED
    'pipelineName' => '<string>', // REQUIRED
]);

Parameter Details

Members
pipelineExecutionId
Required: Yes
Type: string

The ID of the pipeline execution about which you want to get execution details.

pipelineName
Required: Yes
Type: string

The name of the pipeline about which you want to get execution details.

Result Syntax

[
    'pipelineExecution' => [
        'artifactRevisions' => [
            [
                'created' => <DateTime>,
                'name' => '<string>',
                'revisionChangeIdentifier' => '<string>',
                'revisionId' => '<string>',
                'revisionSummary' => '<string>',
                'revisionUrl' => '<string>',
            ],
            // ...
        ],
        'executionMode' => 'QUEUED|SUPERSEDED|PARALLEL',
        'executionType' => 'STANDARD|ROLLBACK',
        'pipelineExecutionId' => '<string>',
        'pipelineName' => '<string>',
        'pipelineVersion' => <integer>,
        'rollbackMetadata' => [
            'rollbackTargetPipelineExecutionId' => '<string>',
        ],
        'status' => 'Cancelled|InProgress|Stopped|Stopping|Succeeded|Superseded|Failed',
        'statusSummary' => '<string>',
        'trigger' => [
            'triggerDetail' => '<string>',
            'triggerType' => 'CreatePipeline|StartPipelineExecution|PollForSourceChanges|Webhook|CloudWatchEvent|PutActionRevision|WebhookV2|ManualRollback|AutomatedRollback',
        ],
        'variables' => [
            [
                'name' => '<string>',
                'resolvedValue' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
pipelineExecution
Type: PipelineExecution structure

Represents information about the execution of a pipeline.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

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.

GetPipelineState

$result = $client->getPipelineState([/* ... */]);
$promise = $client->getPipelineStateAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->getPipelineState([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the pipeline about which you want to get information.

Result Syntax

[
    'created' => <DateTime>,
    'pipelineName' => '<string>',
    'pipelineVersion' => <integer>,
    'stageStates' => [
        [
            'actionStates' => [
                [
                    'actionName' => '<string>',
                    'currentRevision' => [
                        'created' => <DateTime>,
                        'revisionChangeId' => '<string>',
                        'revisionId' => '<string>',
                    ],
                    'entityUrl' => '<string>',
                    'latestExecution' => [
                        'actionExecutionId' => '<string>',
                        'errorDetails' => [
                            'code' => '<string>',
                            'message' => '<string>',
                        ],
                        'externalExecutionId' => '<string>',
                        'externalExecutionUrl' => '<string>',
                        'lastStatusChange' => <DateTime>,
                        'lastUpdatedBy' => '<string>',
                        'logStreamARN' => '<string>',
                        'percentComplete' => <integer>,
                        'status' => 'InProgress|Abandoned|Succeeded|Failed',
                        'summary' => '<string>',
                        'token' => '<string>',
                    ],
                    'revisionUrl' => '<string>',
                ],
                // ...
            ],
            'beforeEntryConditionState' => [
                'conditionStates' => [
                    [
                        'latestExecution' => [
                            'lastStatusChange' => <DateTime>,
                            'status' => 'InProgress|Failed|Errored|Succeeded|Cancelled|Abandoned|Overridden',
                            'summary' => '<string>',
                        ],
                        'ruleStates' => [
                            [
                                'currentRevision' => [
                                    'created' => <DateTime>,
                                    'revisionChangeId' => '<string>',
                                    'revisionId' => '<string>',
                                ],
                                'entityUrl' => '<string>',
                                'latestExecution' => [
                                    'errorDetails' => [
                                        'code' => '<string>',
                                        'message' => '<string>',
                                    ],
                                    'externalExecutionId' => '<string>',
                                    'externalExecutionUrl' => '<string>',
                                    'lastStatusChange' => <DateTime>,
                                    'lastUpdatedBy' => '<string>',
                                    'ruleExecutionId' => '<string>',
                                    'status' => 'InProgress|Abandoned|Succeeded|Failed',
                                    'summary' => '<string>',
                                    'token' => '<string>',
                                ],
                                'revisionUrl' => '<string>',
                                'ruleName' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'latestExecution' => [
                    'status' => 'InProgress|Failed|Errored|Succeeded|Cancelled|Abandoned|Overridden',
                    'summary' => '<string>',
                ],
            ],
            'inboundExecution' => [
                'pipelineExecutionId' => '<string>',
                'status' => 'Cancelled|InProgress|Failed|Stopped|Stopping|Succeeded|Skipped',
                'type' => 'STANDARD|ROLLBACK',
            ],
            'inboundExecutions' => [
                [
                    'pipelineExecutionId' => '<string>',
                    'status' => 'Cancelled|InProgress|Failed|Stopped|Stopping|Succeeded|Skipped',
                    'type' => 'STANDARD|ROLLBACK',
                ],
                // ...
            ],
            'inboundTransitionState' => [
                'disabledReason' => '<string>',
                'enabled' => true || false,
                'lastChangedAt' => <DateTime>,
                'lastChangedBy' => '<string>',
            ],
            'latestExecution' => [
                'pipelineExecutionId' => '<string>',
                'status' => 'Cancelled|InProgress|Failed|Stopped|Stopping|Succeeded|Skipped',
                'type' => 'STANDARD|ROLLBACK',
            ],
            'onFailureConditionState' => [
                'conditionStates' => [
                    [
                        'latestExecution' => [
                            'lastStatusChange' => <DateTime>,
                            'status' => 'InProgress|Failed|Errored|Succeeded|Cancelled|Abandoned|Overridden',
                            'summary' => '<string>',
                        ],
                        'ruleStates' => [
                            [
                                'currentRevision' => [
                                    'created' => <DateTime>,
                                    'revisionChangeId' => '<string>',
                                    'revisionId' => '<string>',
                                ],
                                'entityUrl' => '<string>',
                                'latestExecution' => [
                                    'errorDetails' => [
                                        'code' => '<string>',
                                        'message' => '<string>',
                                    ],
                                    'externalExecutionId' => '<string>',
                                    'externalExecutionUrl' => '<string>',
                                    'lastStatusChange' => <DateTime>,
                                    'lastUpdatedBy' => '<string>',
                                    'ruleExecutionId' => '<string>',
                                    'status' => 'InProgress|Abandoned|Succeeded|Failed',
                                    'summary' => '<string>',
                                    'token' => '<string>',
                                ],
                                'revisionUrl' => '<string>',
                                'ruleName' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'latestExecution' => [
                    'status' => 'InProgress|Failed|Errored|Succeeded|Cancelled|Abandoned|Overridden',
                    'summary' => '<string>',
                ],
            ],
            'onSuccessConditionState' => [
                'conditionStates' => [
                    [
                        'latestExecution' => [
                            'lastStatusChange' => <DateTime>,
                            'status' => 'InProgress|Failed|Errored|Succeeded|Cancelled|Abandoned|Overridden',
                            'summary' => '<string>',
                        ],
                        'ruleStates' => [
                            [
                                'currentRevision' => [
                                    'created' => <DateTime>,
                                    'revisionChangeId' => '<string>',
                                    'revisionId' => '<string>',
                                ],
                                'entityUrl' => '<string>',
                                'latestExecution' => [
                                    'errorDetails' => [
                                        'code' => '<string>',
                                        'message' => '<string>',
                                    ],
                                    'externalExecutionId' => '<string>',
                                    'externalExecutionUrl' => '<string>',
                                    'lastStatusChange' => <DateTime>,
                                    'lastUpdatedBy' => '<string>',
                                    'ruleExecutionId' => '<string>',
                                    'status' => 'InProgress|Abandoned|Succeeded|Failed',
                                    'summary' => '<string>',
                                    'token' => '<string>',
                                ],
                                'revisionUrl' => '<string>',
                                'ruleName' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'latestExecution' => [
                    'status' => 'InProgress|Failed|Errored|Succeeded|Cancelled|Abandoned|Overridden',
                    'summary' => '<string>',
                ],
            ],
            'retryStageMetadata' => [
                'autoStageRetryAttempt' => <integer>,
                'latestRetryTrigger' => 'AutomatedStageRetry|ManualStageRetry',
                'manualStageRetryAttempt' => <integer>,
            ],
            'stageName' => '<string>',
        ],
        // ...
    ],
    'updated' => <DateTime>,
]

Result Details

Members
created
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the pipeline was created, in timestamp format.

pipelineName
Type: string

The name of the pipeline for which you want to get the state.

pipelineVersion
Type: int

The version number of the pipeline.

A newly created pipeline is always assigned a version number of 1.

stageStates
Type: Array of StageState structures

A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

updated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the pipeline was last updated, in timestamp format.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

GetThirdPartyJobDetails

$result = $client->getThirdPartyJobDetails([/* ... */]);
$promise = $client->getThirdPartyJobDetailsAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->getThirdPartyJobDetails([
    'clientToken' => '<string>', // REQUIRED
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Required: Yes
Type: string

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.

jobId
Required: Yes
Type: string

The unique system-generated ID used for identifying the job.

Result Syntax

[
    'jobDetails' => [
        'data' => [
            'actionConfiguration' => [
                'configuration' => ['<string>', ...],
            ],
            'actionTypeId' => [
                'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
                'owner' => 'AWS|ThirdParty|Custom',
                'provider' => '<string>',
                'version' => '<string>',
            ],
            'artifactCredentials' => [
                'accessKeyId' => '<string>',
                'secretAccessKey' => '<string>',
                'sessionToken' => '<string>',
            ],
            'continuationToken' => '<string>',
            'encryptionKey' => [
                'id' => '<string>',
                'type' => 'KMS',
            ],
            'inputArtifacts' => [
                [
                    'location' => [
                        's3Location' => [
                            'bucketName' => '<string>',
                            'objectKey' => '<string>',
                        ],
                        'type' => 'S3',
                    ],
                    'name' => '<string>',
                    'revision' => '<string>',
                ],
                // ...
            ],
            'outputArtifacts' => [
                [
                    'location' => [
                        's3Location' => [
                            'bucketName' => '<string>',
                            'objectKey' => '<string>',
                        ],
                        'type' => 'S3',
                    ],
                    'name' => '<string>',
                    'revision' => '<string>',
                ],
                // ...
            ],
            'pipelineContext' => [
                'action' => [
                    'actionExecutionId' => '<string>',
                    'name' => '<string>',
                ],
                'pipelineArn' => '<string>',
                'pipelineExecutionId' => '<string>',
                'pipelineName' => '<string>',
                'stage' => [
                    'name' => '<string>',
                ],
            ],
        ],
        'id' => '<string>',
        'nonce' => '<string>',
    ],
]

Result Details

Members
jobDetails
Type: ThirdPartyJobDetails structure

The details of the job, including any protected values defined for the job.

Errors

JobNotFoundException:

The job was specified in an invalid format or cannot be found.

ValidationException:

The validation was specified in an invalid format.

InvalidClientTokenException:

The client token was specified in an invalid format

InvalidJobException:

The job was specified in an invalid format or cannot be found.

ListActionExecutions

$result = $client->listActionExecutions([/* ... */]);
$promise = $client->listActionExecutionsAsync([/* ... */]);

Lists the action executions that have occurred in a pipeline.

Parameter Syntax

$result = $client->listActionExecutions([
    'filter' => [
        'latestInPipelineExecution' => [
            'pipelineExecutionId' => '<string>', // REQUIRED
            'startTimeRange' => 'Latest|All', // REQUIRED
        ],
        'pipelineExecutionId' => '<string>',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pipelineName' => '<string>', // REQUIRED
]);

Parameter Details

Members
filter
Type: ActionExecutionFilter structure

Input information used to filter action execution history.

maxResults
Type: int

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.

nextToken
Type: string

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.

pipelineName
Required: Yes
Type: string

The name of the pipeline for which you want to list action execution history.

Result Syntax

[
    'actionExecutionDetails' => [
        [
            'actionExecutionId' => '<string>',
            'actionName' => '<string>',
            'input' => [
                'actionTypeId' => [
                    'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
                    'owner' => 'AWS|ThirdParty|Custom',
                    'provider' => '<string>',
                    'version' => '<string>',
                ],
                'configuration' => ['<string>', ...],
                'inputArtifacts' => [
                    [
                        'name' => '<string>',
                        's3location' => [
                            'bucket' => '<string>',
                            'key' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'namespace' => '<string>',
                'region' => '<string>',
                'resolvedConfiguration' => ['<string>', ...],
                'roleArn' => '<string>',
            ],
            'lastUpdateTime' => <DateTime>,
            '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>', ...],
            ],
            'pipelineExecutionId' => '<string>',
            'pipelineVersion' => <integer>,
            'stageName' => '<string>',
            'startTime' => <DateTime>,
            'status' => 'InProgress|Abandoned|Succeeded|Failed',
            'updatedBy' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
actionExecutionDetails
Type: Array of ActionExecutionDetail structures

The details for a list of recent executions, such as action execution ID.

nextToken
Type: string

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.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

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.

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.

ListActionTypes

$result = $client->listActionTypes([/* ... */]);
$promise = $client->listActionTypesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listActionTypes([
    'actionOwnerFilter' => 'AWS|ThirdParty|Custom',
    'nextToken' => '<string>',
    'regionFilter' => '<string>',
]);

Parameter Details

Members
actionOwnerFilter
Type: string

Filters the list of action types to those created by a specified entity.

nextToken
Type: string

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.

regionFilter
Type: string

The Region to filter on for the list of action types.

Result Syntax

[
    'actionTypes' => [
        [
            'actionConfigurationProperties' => [
                [
                    'description' => '<string>',
                    'key' => true || false,
                    'name' => '<string>',
                    'queryable' => true || false,
                    'required' => true || false,
                    'secret' => true || false,
                    'type' => 'String|Number|Boolean',
                ],
                // ...
            ],
            'id' => [
                'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
                'owner' => 'AWS|ThirdParty|Custom',
                'provider' => '<string>',
                'version' => '<string>',
            ],
            'inputArtifactDetails' => [
                'maximumCount' => <integer>,
                'minimumCount' => <integer>,
            ],
            'outputArtifactDetails' => [
                'maximumCount' => <integer>,
                'minimumCount' => <integer>,
            ],
            'settings' => [
                'entityUrlTemplate' => '<string>',
                'executionUrlTemplate' => '<string>',
                'revisionUrlTemplate' => '<string>',
                'thirdPartyConfigurationUrl' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
actionTypes
Required: Yes
Type: Array of ActionType structures

Provides details of the action types.

nextToken
Type: string

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.

Errors

ValidationException:

The validation was specified in an invalid format.

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.

ListPipelineExecutions

$result = $client->listPipelineExecutions([/* ... */]);
$promise = $client->listPipelineExecutionsAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->listPipelineExecutions([
    'filter' => [
        'succeededInStage' => [
            'stageName' => '<string>',
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pipelineName' => '<string>', // REQUIRED
]);

Parameter Details

Members
filter
Type: PipelineExecutionFilter structure

The pipeline execution to filter on.

maxResults
Type: int

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.

nextToken
Type: string

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.

pipelineName
Required: Yes
Type: string

The name of the pipeline for which you want to get execution summary information.

Result Syntax

[
    'nextToken' => '<string>',
    'pipelineExecutionSummaries' => [
        [
            'executionMode' => 'QUEUED|SUPERSEDED|PARALLEL',
            'executionType' => 'STANDARD|ROLLBACK',
            'lastUpdateTime' => <DateTime>,
            'pipelineExecutionId' => '<string>',
            'rollbackMetadata' => [
                'rollbackTargetPipelineExecutionId' => '<string>',
            ],
            'sourceRevisions' => [
                [
                    'actionName' => '<string>',
                    'revisionId' => '<string>',
                    'revisionSummary' => '<string>',
                    'revisionUrl' => '<string>',
                ],
                // ...
            ],
            'startTime' => <DateTime>,
            'status' => 'Cancelled|InProgress|Stopped|Stopping|Succeeded|Superseded|Failed',
            'statusSummary' => '<string>',
            'stopTrigger' => [
                'reason' => '<string>',
            ],
            'trigger' => [
                'triggerDetail' => '<string>',
                'triggerType' => 'CreatePipeline|StartPipelineExecution|PollForSourceChanges|Webhook|CloudWatchEvent|PutActionRevision|WebhookV2|ManualRollback|AutomatedRollback',
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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.

pipelineExecutionSummaries
Type: Array of PipelineExecutionSummary structures

A list of executions in the history of a pipeline.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

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.

ListPipelines

$result = $client->listPipelines([/* ... */]);
$promise = $client->listPipelinesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPipelines([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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.

nextToken
Type: string

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.

Result Syntax

[
    'nextToken' => '<string>',
    'pipelines' => [
        [
            'created' => <DateTime>,
            'executionMode' => 'QUEUED|SUPERSEDED|PARALLEL',
            'name' => '<string>',
            'pipelineType' => 'V1|V2',
            'updated' => <DateTime>,
            'version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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.

pipelines
Type: Array of PipelineSummary structures

The list of pipelines.

Errors

ValidationException:

The validation was specified in an invalid format.

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.

ListRuleExecutions

$result = $client->listRuleExecutions([/* ... */]);
$promise = $client->listRuleExecutionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listRuleExecutions([
    'filter' => [
        'latestInPipelineExecution' => [
            'pipelineExecutionId' => '<string>', // REQUIRED
            'startTimeRange' => 'Latest|All', // REQUIRED
        ],
        'pipelineExecutionId' => '<string>',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pipelineName' => '<string>', // REQUIRED
]);

Parameter Details

Members
filter
Type: RuleExecutionFilter structure

Input information used to filter rule execution history.

maxResults
Type: int

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.

nextToken
Type: string

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.

pipelineName
Required: Yes
Type: string

The name of the pipeline for which you want to get execution summary information.

Result Syntax

[
    'nextToken' => '<string>',
    'ruleExecutionDetails' => [
        [
            'input' => [
                'configuration' => ['<string>', ...],
                'inputArtifacts' => [
                    [
                        'name' => '<string>',
                        's3location' => [
                            'bucket' => '<string>',
                            'key' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'region' => '<string>',
                'resolvedConfiguration' => ['<string>', ...],
                'roleArn' => '<string>',
                'ruleTypeId' => [
                    'category' => 'Rule',
                    'owner' => 'AWS',
                    'provider' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'lastUpdateTime' => <DateTime>,
            'output' => [
                'executionResult' => [
                    'errorDetails' => [
                        'code' => '<string>',
                        'message' => '<string>',
                    ],
                    'externalExecutionId' => '<string>',
                    'externalExecutionSummary' => '<string>',
                    'externalExecutionUrl' => '<string>',
                ],
            ],
            'pipelineExecutionId' => '<string>',
            'pipelineVersion' => <integer>,
            'ruleExecutionId' => '<string>',
            'ruleName' => '<string>',
            'stageName' => '<string>',
            'startTime' => <DateTime>,
            'status' => 'InProgress|Abandoned|Succeeded|Failed',
            'updatedBy' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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.

ruleExecutionDetails
Type: Array of RuleExecutionDetail structures

Details about the output for listing rule executions.

Errors

ValidationException:

The validation was specified in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

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.

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.

ListRuleTypes

$result = $client->listRuleTypes([/* ... */]);
$promise = $client->listRuleTypesAsync([/* ... */]);

Lists the rules for the condition.

Parameter Syntax

$result = $client->listRuleTypes([
    'regionFilter' => '<string>',
    'ruleOwnerFilter' => 'AWS',
]);

Parameter Details

Members
regionFilter
Type: string

The rule Region to filter on.

ruleOwnerFilter
Type: string

The rule owner to filter on.

Result Syntax

[
    'ruleTypes' => [
        [
            'id' => [
                'category' => 'Rule',
                'owner' => 'AWS',
                'provider' => '<string>',
                'version' => '<string>',
            ],
            'inputArtifactDetails' => [
                'maximumCount' => <integer>,
                'minimumCount' => <integer>,
            ],
            'ruleConfigurationProperties' => [
                [
                    'description' => '<string>',
                    'key' => true || false,
                    'name' => '<string>',
                    'queryable' => true || false,
                    'required' => true || false,
                    'secret' => true || false,
                    'type' => 'String|Number|Boolean',
                ],
                // ...
            ],
            'settings' => [
                'entityUrlTemplate' => '<string>',
                'executionUrlTemplate' => '<string>',
                'revisionUrlTemplate' => '<string>',
                'thirdPartyConfigurationUrl' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members
ruleTypes
Required: Yes
Type: Array of RuleType structures

Lists the rules that are configured for the condition.

Errors

ValidationException:

The validation was specified in an invalid format.

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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return in a single call.

nextToken
Type: string

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.

resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to get tags for.

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

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.

tags
Type: Array of Tag structures

The tags for the resource.

Errors

ValidationException:

The validation was specified in an invalid format.

ResourceNotFoundException:

The resource was specified in an invalid format.

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.

InvalidArnException:

The specified resource ARN is invalid.

ListWebhooks

$result = $client->listWebhooks([/* ... */]);
$promise = $client->listWebhooksAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->listWebhooks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken
Type: string

The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.

Result Syntax

[
    'NextToken' => '<string>',
    'webhooks' => [
        [
            'arn' => '<string>',
            'definition' => [
                'authentication' => 'GITHUB_HMAC|IP|UNAUTHENTICATED',
                'authenticationConfiguration' => [
                    'AllowedIPRange' => '<string>',
                    'SecretToken' => '<string>',
                ],
                'filters' => [
                    [
                        'jsonPath' => '<string>',
                        'matchEquals' => '<string>',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'targetAction' => '<string>',
                'targetPipeline' => '<string>',
            ],
            'errorCode' => '<string>',
            'errorMessage' => '<string>',
            'lastTriggered' => <DateTime>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'url' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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.

webhooks
Type: Array of ListWebhookItem structures

The JSON detail returned for each webhook in the list output for the ListWebhooks call.

Errors

ValidationException:

The validation was specified in an invalid format.

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.

OverrideStageCondition

$result = $client->overrideStageCondition([/* ... */]);
$promise = $client->overrideStageConditionAsync([/* ... */]);

Used to override a stage condition.

Parameter Syntax

$result = $client->overrideStageCondition([
    'conditionType' => 'BEFORE_ENTRY|ON_SUCCESS', // REQUIRED
    'pipelineExecutionId' => '<string>', // REQUIRED
    'pipelineName' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
conditionType
Required: Yes
Type: string

The type of condition to override for the stage, such as entry conditions, failure conditions, or success conditions.

pipelineExecutionId
Required: Yes
Type: string

The ID of the pipeline execution for the override.

pipelineName
Required: Yes
Type: string

The name of the pipeline with the stage that will override the condition.

stageName
Required: Yes
Type: string

The name of the stage for the override.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

ConflictException:

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

StageNotFoundException:

The stage was specified in an invalid format or cannot be found.

ConditionNotOverridableException:

Unable to override because the condition does not allow overrides.

NotLatestPipelineExecutionException:

The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

ConcurrentPipelineExecutionsLimitExceededException:

The pipeline has reached the limit for concurrent pipeline executions.

PollForJobs

$result = $client->pollForJobs([/* ... */]);
$promise = $client->pollForJobsAsync([/* ... */]);

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.

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.

Parameter Syntax

$result = $client->pollForJobs([
    'actionTypeId' => [ // REQUIRED
        'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute', // REQUIRED
        'owner' => 'AWS|ThirdParty|Custom', // REQUIRED
        'provider' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'maxBatchSize' => <integer>,
    'queryParam' => ['<string>', ...],
]);

Parameter Details

Members
actionTypeId
Required: Yes
Type: ActionTypeId structure

Represents information about an action type.

maxBatchSize
Type: int

The maximum number of jobs to return in a poll for jobs call.

queryParam
Type: Associative array of custom strings keys (ActionConfigurationKey) to strings

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.

Result Syntax

[
    'jobs' => [
        [
            'accountId' => '<string>',
            'data' => [
                'actionConfiguration' => [
                    'configuration' => ['<string>', ...],
                ],
                'actionTypeId' => [
                    'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
                    'owner' => 'AWS|ThirdParty|Custom',
                    'provider' => '<string>',
                    'version' => '<string>',
                ],
                'artifactCredentials' => [
                    'accessKeyId' => '<string>',
                    'secretAccessKey' => '<string>',
                    'sessionToken' => '<string>',
                ],
                'continuationToken' => '<string>',
                'encryptionKey' => [
                    'id' => '<string>',
                    'type' => 'KMS',
                ],
                'inputArtifacts' => [
                    [
                        'location' => [
                            's3Location' => [
                                'bucketName' => '<string>',
                                'objectKey' => '<string>',
                            ],
                            'type' => 'S3',
                        ],
                        'name' => '<string>',
                        'revision' => '<string>',
                    ],
                    // ...
                ],
                'outputArtifacts' => [
                    [
                        'location' => [
                            's3Location' => [
                                'bucketName' => '<string>',
                                'objectKey' => '<string>',
                            ],
                            'type' => 'S3',
                        ],
                        'name' => '<string>',
                        'revision' => '<string>',
                    ],
                    // ...
                ],
                'pipelineContext' => [
                    'action' => [
                        'actionExecutionId' => '<string>',
                        'name' => '<string>',
                    ],
                    'pipelineArn' => '<string>',
                    'pipelineExecutionId' => '<string>',
                    'pipelineName' => '<string>',
                    'stage' => [
                        'name' => '<string>',
                    ],
                ],
            ],
            'id' => '<string>',
            'nonce' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
jobs
Type: Array of Job structures

Information about the jobs to take action on.

Errors

ValidationException:

The validation was specified in an invalid format.

ActionTypeNotFoundException:

The specified action type cannot be found.

PollForThirdPartyJobs

$result = $client->pollForThirdPartyJobs([/* ... */]);
$promise = $client->pollForThirdPartyJobsAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->pollForThirdPartyJobs([
    'actionTypeId' => [ // REQUIRED
        'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute', // REQUIRED
        'owner' => 'AWS|ThirdParty|Custom', // REQUIRED
        'provider' => '<string>', // REQUIRED
        'version' => '<string>', // REQUIRED
    ],
    'maxBatchSize' => <integer>,
]);

Parameter Details

Members
actionTypeId
Required: Yes
Type: ActionTypeId structure

Represents information about an action type.

maxBatchSize
Type: int

The maximum number of jobs to return in a poll for jobs call.

Result Syntax

[
    'jobs' => [
        [
            'clientId' => '<string>',
            'jobId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
jobs
Type: Array of ThirdPartyJob structures

Information about the jobs to take action on.

Errors

ActionTypeNotFoundException:

The specified action type cannot be found.

ValidationException:

The validation was specified in an invalid format.

PutActionRevision

$result = $client->putActionRevision([/* ... */]);
$promise = $client->putActionRevisionAsync([/* ... */]);

Provides information to CodePipeline about new revisions to a source.

Parameter Syntax

$result = $client->putActionRevision([
    'actionName' => '<string>', // REQUIRED
    'actionRevision' => [ // REQUIRED
        'created' => <integer || string || DateTime>, // REQUIRED
        'revisionChangeId' => '<string>', // REQUIRED
        'revisionId' => '<string>', // REQUIRED
    ],
    'pipelineName' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
actionName
Required: Yes
Type: string

The name of the action that processes the revision.

actionRevision
Required: Yes
Type: ActionRevision structure

Represents information about the version (or revision) of an action.

pipelineName
Required: Yes
Type: string

The name of the pipeline that starts processing the revision to the source.

stageName
Required: Yes
Type: string

The name of the stage that contains the action that acts on the revision.

Result Syntax

[
    'newRevision' => true || false,
    'pipelineExecutionId' => '<string>',
]

Result Details

Members
newRevision
Type: boolean

Indicates whether the artifact revision was previously used in an execution of the specified pipeline.

pipelineExecutionId
Type: string

The ID of the current workflow state of the pipeline.

Errors

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

StageNotFoundException:

The stage was specified in an invalid format or cannot be found.

ActionNotFoundException:

The specified action cannot be found.

ValidationException:

The validation was specified in an invalid format.

ConcurrentPipelineExecutionsLimitExceededException:

The pipeline has reached the limit for concurrent pipeline executions.

PutApprovalResult

$result = $client->putApprovalResult([/* ... */]);
$promise = $client->putApprovalResultAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putApprovalResult([
    'actionName' => '<string>', // REQUIRED
    'pipelineName' => '<string>', // REQUIRED
    'result' => [ // REQUIRED
        'status' => 'Approved|Rejected', // REQUIRED
        'summary' => '<string>', // REQUIRED
    ],
    'stageName' => '<string>', // REQUIRED
    'token' => '<string>', // REQUIRED
]);

Parameter Details

Members
actionName
Required: Yes
Type: string

The name of the action for which approval is requested.

pipelineName
Required: Yes
Type: string

The name of the pipeline that contains the action.

result
Required: Yes
Type: ApprovalResult structure

Represents information about the result of the approval request.

stageName
Required: Yes
Type: string

The name of the stage that contains the action.

token
Required: Yes
Type: string

The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.

For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject approval request as detailed above is not available. Instead, use the externalExecutionId from the GetPipelineState action as the token in the approval request.

Result Syntax

[
    'approvedAt' => <DateTime>,
]

Result Details

Members
approvedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp showing when the approval or rejection was submitted.

Errors

InvalidApprovalTokenException:

The approval request already received a response or has expired.

ApprovalAlreadyCompletedException:

The approval action has already been approved or rejected.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

StageNotFoundException:

The stage was specified in an invalid format or cannot be found.

ActionNotFoundException:

The specified action cannot be found.

ValidationException:

The validation was specified in an invalid format.

PutJobFailureResult

$result = $client->putJobFailureResult([/* ... */]);
$promise = $client->putJobFailureResultAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putJobFailureResult([
    'failureDetails' => [ // REQUIRED
        'externalExecutionId' => '<string>',
        'message' => '<string>', // REQUIRED
        'type' => 'JobFailed|ConfigurationError|PermissionError|RevisionOutOfSync|RevisionUnavailable|SystemUnavailable', // REQUIRED
    ],
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
failureDetails
Required: Yes
Type: FailureDetails structure

The details about the failure of a job.

jobId
Required: Yes
Type: string

The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

JobNotFoundException:

The job was specified in an invalid format or cannot be found.

InvalidJobStateException:

The job state was specified in an invalid format.

PutJobSuccessResult

$result = $client->putJobSuccessResult([/* ... */]);
$promise = $client->putJobSuccessResultAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putJobSuccessResult([
    'continuationToken' => '<string>',
    'currentRevision' => [
        'changeIdentifier' => '<string>', // REQUIRED
        'created' => <integer || string || DateTime>,
        'revision' => '<string>', // REQUIRED
        'revisionSummary' => '<string>',
    ],
    'executionDetails' => [
        'externalExecutionId' => '<string>',
        'percentComplete' => <integer>,
        'summary' => '<string>',
    ],
    'jobId' => '<string>', // REQUIRED
    'outputVariables' => ['<string>', ...],
]);

Parameter Details

Members
continuationToken
Type: string

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.

currentRevision
Type: CurrentRevision structure

The ID of the current revision of the artifact successfully worked on by the job.

executionDetails
Type: ExecutionDetails structure

The execution details of the successful job, such as the actions taken by the job worker.

jobId
Required: Yes
Type: string

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

outputVariables
Type: Associative array of custom strings keys (OutputVariablesKey) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

JobNotFoundException:

The job was specified in an invalid format or cannot be found.

InvalidJobStateException:

The job state was specified in an invalid format.

OutputVariablesSizeExceededException:

Exceeded the total size limit for all variables in the pipeline.

PutThirdPartyJobFailureResult

$result = $client->putThirdPartyJobFailureResult([/* ... */]);
$promise = $client->putThirdPartyJobFailureResultAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putThirdPartyJobFailureResult([
    'clientToken' => '<string>', // REQUIRED
    'failureDetails' => [ // REQUIRED
        'externalExecutionId' => '<string>',
        'message' => '<string>', // REQUIRED
        'type' => 'JobFailed|ConfigurationError|PermissionError|RevisionOutOfSync|RevisionUnavailable|SystemUnavailable', // REQUIRED
    ],
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Required: Yes
Type: string

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

failureDetails
Required: Yes
Type: FailureDetails structure

Represents information about failure details.

jobId
Required: Yes
Type: string

The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

JobNotFoundException:

The job was specified in an invalid format or cannot be found.

InvalidJobStateException:

The job state was specified in an invalid format.

InvalidClientTokenException:

The client token was specified in an invalid format

PutThirdPartyJobSuccessResult

$result = $client->putThirdPartyJobSuccessResult([/* ... */]);
$promise = $client->putThirdPartyJobSuccessResultAsync([/* ... */]);

Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

Parameter Syntax

$result = $client->putThirdPartyJobSuccessResult([
    'clientToken' => '<string>', // REQUIRED
    'continuationToken' => '<string>',
    'currentRevision' => [
        'changeIdentifier' => '<string>', // REQUIRED
        'created' => <integer || string || DateTime>,
        'revision' => '<string>', // REQUIRED
        'revisionSummary' => '<string>',
    ],
    'executionDetails' => [
        'externalExecutionId' => '<string>',
        'percentComplete' => <integer>,
        'summary' => '<string>',
    ],
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Required: Yes
Type: string

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.

continuationToken
Type: string

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.

currentRevision
Type: CurrentRevision structure

Represents information about a current revision.

executionDetails
Type: ExecutionDetails structure

The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

jobId
Required: Yes
Type: string

The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

JobNotFoundException:

The job was specified in an invalid format or cannot be found.

InvalidJobStateException:

The job state was specified in an invalid format.

InvalidClientTokenException:

The client token was specified in an invalid format

PutWebhook

$result = $client->putWebhook([/* ... */]);
$promise = $client->putWebhookAsync([/* ... */]);

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.

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.

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

Parameter Syntax

$result = $client->putWebhook([
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'webhook' => [ // REQUIRED
        'authentication' => 'GITHUB_HMAC|IP|UNAUTHENTICATED', // REQUIRED
        'authenticationConfiguration' => [ // REQUIRED
            'AllowedIPRange' => '<string>',
            'SecretToken' => '<string>',
        ],
        'filters' => [ // REQUIRED
            [
                'jsonPath' => '<string>', // REQUIRED
                'matchEquals' => '<string>',
            ],
            // ...
        ],
        'name' => '<string>', // REQUIRED
        'targetAction' => '<string>', // REQUIRED
        'targetPipeline' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
tags
Type: Array of Tag structures

The tags for the webhook.

webhook
Required: Yes
Type: WebhookDefinition structure

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.

Result Syntax

[
    'webhook' => [
        'arn' => '<string>',
        'definition' => [
            'authentication' => 'GITHUB_HMAC|IP|UNAUTHENTICATED',
            'authenticationConfiguration' => [
                'AllowedIPRange' => '<string>',
                'SecretToken' => '<string>',
            ],
            'filters' => [
                [
                    'jsonPath' => '<string>',
                    'matchEquals' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'targetAction' => '<string>',
            'targetPipeline' => '<string>',
        ],
        'errorCode' => '<string>',
        'errorMessage' => '<string>',
        'lastTriggered' => <DateTime>,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'url' => '<string>',
    ],
]

Result Details

Members
webhook
Type: ListWebhookItem structure

The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.

Errors

ValidationException:

The validation was specified in an invalid format.

LimitExceededException:

The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.

InvalidWebhookFilterPatternException:

The specified event filter rule is in an invalid format.

InvalidWebhookAuthenticationParametersException:

The specified authentication type is in an invalid format.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

TooManyTagsException:

The tags limit for a resource has been exceeded.

InvalidTagsException:

The specified resource tags are invalid.

ConcurrentModificationException:

Unable to modify the tag due to a simultaneous update request.

RegisterWebhookWithThirdParty

$result = $client->registerWebhookWithThirdParty([/* ... */]);
$promise = $client->registerWebhookWithThirdPartyAsync([/* ... */]);

Configures a connection between the webhook that was created and the external tool with events to be detected.

Parameter Syntax

$result = $client->registerWebhookWithThirdParty([
    'webhookName' => '<string>',
]);

Parameter Details

Members
webhookName
Type: string

The name of an existing webhook created with PutWebhook to register with a supported third party.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

WebhookNotFoundException:

The specified webhook was entered in an invalid format or cannot be found.

RetryStageExecution

$result = $client->retryStageExecution([/* ... */]);
$promise = $client->retryStageExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->retryStageExecution([
    'pipelineExecutionId' => '<string>', // REQUIRED
    'pipelineName' => '<string>', // REQUIRED
    'retryMode' => 'FAILED_ACTIONS|ALL_ACTIONS', // REQUIRED
    'stageName' => '<string>', // REQUIRED
]);

Parameter Details

Members
pipelineExecutionId
Required: Yes
Type: string

The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage

pipelineName
Required: Yes
Type: string

The name of the pipeline that contains the failed stage.

retryMode
Required: Yes
Type: string

The scope of the retry attempt.

stageName
Required: Yes
Type: string

The name of the failed stage to be retried.

Result Syntax

[
    'pipelineExecutionId' => '<string>',
]

Result Details

Members
pipelineExecutionId
Type: string

The ID of the current workflow execution in the failed stage.

Errors

ValidationException:

The validation was specified in an invalid format.

ConflictException:

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

StageNotFoundException:

The stage was specified in an invalid format or cannot be found.

StageNotRetryableException:

Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.

NotLatestPipelineExecutionException:

The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

ConcurrentPipelineExecutionsLimitExceededException:

The pipeline has reached the limit for concurrent pipeline executions.

RollbackStage

$result = $client->rollbackStage([/* ... */]);
$promise = $client->rollbackStageAsync([/* ... */]);

Rolls back a stage execution.

Parameter Syntax

$result = $client->rollbackStage([
    'pipelineName' => '<string>', // REQUIRED
    'stageName' => '<string>', // REQUIRED
    'targetPipelineExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
pipelineName
Required: Yes
Type: string

The name of the pipeline for which the stage will be rolled back.

stageName
Required: Yes
Type: string

The name of the stage in the pipeline to be rolled back.

targetPipelineExecutionId
Required: Yes
Type: string

The pipeline execution ID for the stage to be rolled back to.

Result Syntax

[
    'pipelineExecutionId' => '<string>',
]

Result Details

Members
pipelineExecutionId
Required: Yes
Type: string

The execution ID of the pipeline execution for the stage that has been rolled back.

Errors

ValidationException:

The validation was specified in an invalid format.

ConflictException:

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

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.

PipelineExecutionOutdatedException:

The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.

StageNotFoundException:

The stage was specified in an invalid format or cannot be found.

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.

StartPipelineExecution

$result = $client->startPipelineExecution([/* ... */]);
$promise = $client->startPipelineExecutionAsync([/* ... */]);

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Parameter Syntax

$result = $client->startPipelineExecution([
    'clientRequestToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'sourceRevisions' => [
        [
            'actionName' => '<string>', // REQUIRED
            'revisionType' => 'COMMIT_ID|IMAGE_DIGEST|S3_OBJECT_VERSION_ID|S3_OBJECT_KEY', // REQUIRED
            'revisionValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'variables' => [
        [
            'name' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
clientRequestToken
Type: string

The system-generated unique ID used to identify a unique execution request.

name
Required: Yes
Type: string

The name of the pipeline to start.

sourceRevisions
Type: Array of SourceRevisionOverride structures

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.

variables
Type: Array of PipelineVariable structures

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.

Result Syntax

[
    'pipelineExecutionId' => '<string>',
]

Result Details

Members
pipelineExecutionId
Type: string

The unique system-generated ID of the pipeline execution that was started.

Errors

ValidationException:

The validation was specified in an invalid format.

ConflictException:

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

ConcurrentPipelineExecutionsLimitExceededException:

The pipeline has reached the limit for concurrent pipeline executions.

StopPipelineExecution

$result = $client->stopPipelineExecution([/* ... */]);
$promise = $client->stopPipelineExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopPipelineExecution([
    'abandon' => true || false,
    'pipelineExecutionId' => '<string>', // REQUIRED
    'pipelineName' => '<string>', // REQUIRED
    'reason' => '<string>',
]);

Parameter Details

Members
abandon
Type: boolean

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.

pipelineExecutionId
Required: Yes
Type: string

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

pipelineName
Required: Yes
Type: string

The name of the pipeline to stop.

reason
Type: string

Use this option to enter comments, such as the reason the pipeline was stopped.

Result Syntax

[
    'pipelineExecutionId' => '<string>',
]

Result Details

Members
pipelineExecutionId
Type: string

The unique system-generated ID of the pipeline execution that was stopped.

Errors

ValidationException:

The validation was specified in an invalid format.

ConflictException:

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

PipelineNotFoundException:

The pipeline was specified in an invalid format or cannot be found.

PipelineExecutionNotStoppableException:

Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it might no longer be in progress.

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource you want to add tags to.

tags
Required: Yes
Type: Array of Tag structures

The tags you want to modify or add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

ResourceNotFoundException:

The resource was specified in an invalid format.

InvalidArnException:

The specified resource ARN is invalid.

TooManyTagsException:

The tags limit for a resource has been exceeded.

InvalidTagsException:

The specified resource tags are invalid.

ConcurrentModificationException:

Unable to modify the tag due to a simultaneous update request.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from an Amazon Web Services resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to remove tags from.

tagKeys
Required: Yes
Type: Array of strings

The list of keys for the tags to be removed from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The validation was specified in an invalid format.

ResourceNotFoundException:

The resource was specified in an invalid format.

InvalidArnException:

The specified resource ARN is invalid.

InvalidTagsException:

The specified resource tags are invalid.

ConcurrentModificationException:

Unable to modify the tag due to a simultaneous update request.

UpdateActionType

$result = $client->updateActionType([/* ... */]);
$promise = $client->updateActionTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateActionType([
    'actionType' => [ // REQUIRED
        'description' => '<string>',
        'executor' => [ // REQUIRED
            'configuration' => [ // REQUIRED
                'jobWorkerExecutorConfiguration' => [
                    'pollingAccounts' => ['<string>', ...],
                    'pollingServicePrincipals' => ['<string>', ...],
                ],
                'lambdaExecutorConfiguration' => [
                    'lambdaFunctionArn' => '<string>', // REQUIRED
                ],
            ],
            'jobTimeout' => <integer>,
            'policyStatementsTemplate' => '<string>',
            'type' => 'JobWorker|Lambda', // REQUIRED
        ],
        'id' => [ // REQUIRED
            'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute', // REQUIRED
            'owner' => '<string>', // REQUIRED
            'provider' => '<string>', // REQUIRED
            'version' => '<string>', // REQUIRED
        ],
        'inputArtifactDetails' => [ // REQUIRED
            'maximumCount' => <integer>, // REQUIRED
            'minimumCount' => <integer>, // REQUIRED
        ],
        'outputArtifactDetails' => [ // REQUIRED
            'maximumCount' => <integer>, // REQUIRED
            'minimumCount' => <integer>, // REQUIRED
        ],
        'permissions' => [
            'allowedAccounts' => ['<string>', ...], // REQUIRED
        ],
        'properties' => [
            [
                'description' => '<string>',
                'key' => true || false, // REQUIRED
                'name' => '<string>', // REQUIRED
                'noEcho' => true || false, // REQUIRED
                'optional' => true || false, // REQUIRED
                'queryable' => true || false,
            ],
            // ...
        ],
        'urls' => [
            'configurationUrl' => '<string>',
            'entityUrlTemplate' => '<string>',
            'executionUrlTemplate' => '<string>',
            'revisionUrlTemplate' => '<string>',
        ],
    ],
]);

Parameter Details

Members
actionType
Required: Yes
Type: ActionTypeDeclaration structure

The action type definition for the action type to be updated.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

RequestFailedException:

The request failed because of an unknown error, exception, or failure.

ValidationException:

The validation was specified in an invalid format.

ActionTypeNotFoundException:

The specified action type cannot be found.

UpdatePipeline

$result = $client->updatePipeline([/* ... */]);
$promise = $client->updatePipelineAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updatePipeline([
    'pipeline' => [ // REQUIRED
        'artifactStore' => [
            'encryptionKey' => [
                'id' => '<string>', // REQUIRED
                'type' => 'KMS', // REQUIRED
            ],
            'location' => '<string>', // REQUIRED
            'type' => 'S3', // REQUIRED
        ],
        'artifactStores' => [
            '<AWSRegionName>' => [
                'encryptionKey' => [
                    'id' => '<string>', // REQUIRED
                    'type' => 'KMS', // REQUIRED
                ],
                'location' => '<string>', // REQUIRED
                'type' => 'S3', // REQUIRED
            ],
            // ...
        ],
        'executionMode' => 'QUEUED|SUPERSEDED|PARALLEL',
        'name' => '<string>', // REQUIRED
        'pipelineType' => 'V1|V2',
        'roleArn' => '<string>', // REQUIRED
        'stages' => [ // REQUIRED
            [
                'actions' => [ // REQUIRED
                    [
                        'actionTypeId' => [ // REQUIRED
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute', // REQUIRED
                            'owner' => 'AWS|ThirdParty|Custom', // REQUIRED
                            'provider' => '<string>', // REQUIRED
                            'version' => '<string>', // REQUIRED
                        ],
                        'commands' => ['<string>', ...],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'name' => '<string>', // REQUIRED
                        'namespace' => '<string>',
                        'outputArtifacts' => [
                            [
                                'files' => ['<string>', ...],
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'outputVariables' => ['<string>', ...],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                        'timeoutInMinutes' => <integer>,
                    ],
                    // ...
                ],
                'beforeEntry' => [
                    'conditions' => [ // REQUIRED
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>', // REQUIRED
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [ // REQUIRED
                                        'category' => 'Rule', // REQUIRED
                                        'owner' => 'AWS',
                                        'provider' => '<string>', // REQUIRED
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                'blockers' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'type' => 'Schedule', // REQUIRED
                    ],
                    // ...
                ],
                'name' => '<string>', // REQUIRED
                'onFailure' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>', // REQUIRED
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [ // REQUIRED
                                        'category' => 'Rule', // REQUIRED
                                        'owner' => 'AWS',
                                        'provider' => '<string>', // REQUIRED
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                    'retryConfiguration' => [
                        'retryMode' => 'FAILED_ACTIONS|ALL_ACTIONS',
                    ],
                ],
                'onSuccess' => [
                    'conditions' => [ // REQUIRED
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>', // REQUIRED
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [ // REQUIRED
                                        'category' => 'Rule', // REQUIRED
                                        'owner' => 'AWS',
                                        'provider' => '<string>', // REQUIRED
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        'triggers' => [
            [
                'gitConfiguration' => [ // REQUIRED
                    '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>', // REQUIRED
                ],
                'providerType' => 'CodeStarSourceConnection', // REQUIRED
            ],
            // ...
        ],
        'variables' => [
            [
                'defaultValue' => '<string>',
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'version' => <integer>,
    ],
]);

Parameter Details

Members
pipeline
Required: Yes
Type: PipelineDeclaration structure

The name of the pipeline to be updated.

Result Syntax

[
    'pipeline' => [
        'artifactStore' => [
            'encryptionKey' => [
                'id' => '<string>',
                'type' => 'KMS',
            ],
            'location' => '<string>',
            'type' => 'S3',
        ],
        'artifactStores' => [
            '<AWSRegionName>' => [
                'encryptionKey' => [
                    'id' => '<string>',
                    'type' => 'KMS',
                ],
                'location' => '<string>',
                'type' => 'S3',
            ],
            // ...
        ],
        'executionMode' => 'QUEUED|SUPERSEDED|PARALLEL',
        'name' => '<string>',
        'pipelineType' => 'V1|V2',
        'roleArn' => '<string>',
        'stages' => [
            [
                'actions' => [
                    [
                        'actionTypeId' => [
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval|Compute',
                            'owner' => 'AWS|ThirdParty|Custom',
                            'provider' => '<string>',
                            'version' => '<string>',
                        ],
                        'commands' => ['<string>', ...],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'name' => '<string>',
                        'namespace' => '<string>',
                        'outputArtifacts' => [
                            [
                                'files' => ['<string>', ...],
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'outputVariables' => ['<string>', ...],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                        'timeoutInMinutes' => <integer>,
                    ],
                    // ...
                ],
                'beforeEntry' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                'blockers' => [
                    [
                        'name' => '<string>',
                        'type' => 'Schedule',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'onFailure' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                    'retryConfiguration' => [
                        'retryMode' => 'FAILED_ACTIONS|ALL_ACTIONS',
                    ],
                ],
                'onSuccess' => [
                    'conditions' => [
                        [
                            'result' => 'ROLLBACK|FAIL|RETRY|SKIP',
                            'rules' => [
                                [
                                    'configuration' => ['<string>', ...],
                                    'inputArtifacts' => [
                                        [
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'region' => '<string>',
                                    'roleArn' => '<string>',
                                    'ruleTypeId' => [
                                        'category' => 'Rule',
                                        'owner' => 'AWS',
                                        'provider' => '<string>',
                                        'version' => '<string>',
                                    ],
                                    'timeoutInMinutes' => <integer>,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        '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' => 'CodeStarSourceConnection',
            ],
            // ...
        ],
        'variables' => [
            [
                'defaultValue' => '<string>',
                'description' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'version' => <integer>,
    ],
]

Result Details

Members
pipeline
Type: PipelineDeclaration structure

The structure of the updated pipeline.

Errors

ValidationException:

The validation was specified in an invalid format.

InvalidStageDeclarationException:

The stage declaration was specified in an invalid format.

InvalidActionDeclarationException:

The action declaration was specified in an invalid format.

InvalidBlockerDeclarationException:

Reserved for future use.

InvalidStructureException:

The structure was specified in an invalid format.

LimitExceededException:

The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.

Shapes

AWSSessionCredentials

Description

Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.

Members
accessKeyId
Required: Yes
Type: string

The access key for the session.

secretAccessKey
Required: Yes
Type: string

The secret access key for the session.

sessionToken
Required: Yes
Type: string

The token for the session.

ActionConfiguration

Description

Represents information about an action configuration.

Members
configuration
Type: Associative array of custom strings keys (ActionConfigurationKey) to strings

The configuration data for the action.

ActionConfigurationProperty

Description

Represents information about an action configuration property.

Members
description
Type: string

The description of the action configuration property that is displayed to users.

key
Required: Yes
Type: boolean

Whether the configuration property is a key.

name
Required: Yes
Type: string

The name of the action configuration property.

queryable
Type: boolean

Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

required
Required: Yes
Type: boolean

Whether the configuration property is a required value.

secret
Required: Yes
Type: boolean

Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

type
Type: string

The type of the configuration property.

ActionContext

Description

Represents the context of an action in the stage of a pipeline to a job worker.

Members
actionExecutionId
Type: string

The system-generated unique ID that corresponds to an action's execution.

name
Type: string

The name of the action in the context of a job.

ActionDeclaration

Description

Represents information about an action declaration.

Members
actionTypeId
Required: Yes
Type: ActionTypeId structure

Specifies the action type and the provider of the action.

commands
Type: Array of strings

The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

Using compute time for this action will incur separate charges in CodeBuild.

configuration
Type: Associative array of custom strings keys (ActionConfigurationKey) to strings

The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.

The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

JSON:

"Configuration" : { Key : Value },

inputArtifacts
Type: Array of InputArtifact structures

The name or ID of the artifact consumed by the action, such as a test or build artifact.

name
Required: Yes
Type: string

The action declaration's name.

namespace
Type: string

The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

outputArtifacts
Type: Array of OutputArtifact structures

The name or ID of the result of the action declaration, such as a test or build artifact.

outputVariables
Type: Array of strings

The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.

region
Type: string

The action declaration's Amazon Web Services Region, such as us-east-1.

roleArn
Type: string

The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

runOrder
Type: int

The order in which actions are run.

timeoutInMinutes
Type: int

A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline . This attribute is available only to the manual approval ActionType.

ActionExecution

Description

Represents information about the run of an action.

Members
actionExecutionId
Type: string

ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.

For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.

errorDetails
Type: ErrorDetails structure

The details of an error returned by a URL external to Amazon Web Services.

externalExecutionId
Type: string

The external ID of the run of the action.

externalExecutionUrl
Type: string

The URL of a resource external to Amazon Web Services that is used when running the action (for example, an external repository URL).

lastStatusChange
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last status change of the action.

lastUpdatedBy
Type: string

The ARN of the user who last changed the pipeline.

logStreamARN
Type: string

The Amazon Resource Name (ARN) of the log stream for the action compute.

percentComplete
Type: int

A percentage of completeness of the action as it runs.

status
Type: string

The status of the action, or for a completed action, the last status of the action.

summary
Type: string

A summary of the run of the action.

token
Type: string

The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command. It is used to validate that the approval request corresponding to this token is still valid.

ActionExecutionDetail

Description

Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.

Members
actionExecutionId
Type: string

The action execution ID.

actionName
Type: string

The name of the action.

input
Type: ActionExecutionInput structure

Input details for the action execution, such as role ARN, Region, and input artifacts.

lastUpdateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last update time of the action execution.

output
Type: ActionExecutionOutput structure

Output details for the action execution, such as the action execution result.

pipelineExecutionId
Type: string

The pipeline execution ID for the action execution.

pipelineVersion
Type: int

The version of the pipeline where the action was run.

stageName
Type: string

The name of the stage that contains the action.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the action execution.

status
Type: string

The status of the action execution. Status categories are InProgress, Succeeded, and Failed.

updatedBy
Type: string

The ARN of the user who changed the pipeline execution details.

ActionExecutionFilter

Description

Filter values for the action execution.

Members
latestInPipelineExecution

The latest execution in the pipeline.

Filtering on the latest execution is available for executions run on or after February 08, 2024.

pipelineExecutionId
Type: string

The pipeline execution ID used to filter action execution history.

ActionExecutionInput

Description

Input information used for an action execution.

Members
actionTypeId
Type: ActionTypeId structure

Represents information about an action type.

configuration
Type: Associative array of custom strings keys (ActionConfigurationKey) to strings

Configuration data for an action execution.

inputArtifacts
Type: Array of ArtifactDetail structures

Details of input artifacts of the action that correspond to the action execution.

namespace
Type: string

The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.

region
Type: string

The Amazon Web Services Region for the action, such as us-east-1.

resolvedConfiguration
Type: Associative array of custom strings keys (String) to strings

Configuration data for an action execution with all variable references replaced with their real values for the execution.

roleArn
Type: string

The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

ActionExecutionOutput

Description

Output details listed for an action execution, such as the action execution result.

Members
executionResult
Type: ActionExecutionResult structure

Execution result information listed in the output details for an action execution.

outputArtifacts
Type: Array of ArtifactDetail structures

Details of output artifacts of the action that correspond to the action execution.

outputVariables
Type: Associative array of custom strings keys (OutputVariablesKey) to strings

The outputVariables field shows the key-value pairs that were output as part of that execution.

ActionExecutionResult

Description

Execution result information, such as the external execution ID.

Members
errorDetails
Type: ErrorDetails structure

Represents information about an error in CodePipeline.

externalExecutionId
Type: string

The action provider's external ID for the action execution.

externalExecutionSummary
Type: string

The action provider's summary for the action execution.

externalExecutionUrl
Type: string

The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.

logStreamARN
Type: string

The Amazon Resource Name (ARN) of the log stream for the action compute.

ActionNotFoundException

Description

The specified action cannot be found.

Members

ActionRevision

Description

Represents information about the version (or revision) of an action.

Members
created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the most recent version of the action was created, in timestamp format.

revisionChangeId
Required: Yes
Type: string

The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).

revisionId
Required: Yes
Type: string

The system-generated unique ID that identifies the revision number of the action.

ActionState

Description

Represents information about the state of an action.

Members
actionName
Type: string

The name of the action.

currentRevision
Type: ActionRevision structure

Represents information about the version (or revision) of an action.

entityUrl
Type: string

A URL link for more information about the state of the action, such as a deployment group details page.

latestExecution
Type: ActionExecution structure

Represents information about the run of an action.

revisionUrl
Type: string

A URL link for more information about the revision, such as a commit details page.

ActionType

Description

Returns information about the details of an action type.

Members
actionConfigurationProperties
Type: Array of ActionConfigurationProperty structures

The configuration properties for the action type.

id
Required: Yes
Type: ActionTypeId structure

Represents information about an action type.

inputArtifactDetails
Required: Yes
Type: ArtifactDetails structure

The details of the input artifact for the action, such as its commit ID.

outputArtifactDetails
Required: Yes
Type: ArtifactDetails structure

The details of the output artifact of the action, such as its commit ID.

settings
Type: ActionTypeSettings structure

The settings for the action type.

ActionTypeAlreadyExistsException

Description

The specified action type already exists with a different definition.

Members

ActionTypeArtifactDetails

Description

Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.

Members
maximumCount
Required: Yes
Type: int

The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source.

minimumCount
Required: Yes
Type: int

The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source.

ActionTypeDeclaration

Description

The parameters for the action type definition that are provided when the action type is created or updated.

Members
description
Type: string

The description for the action type to be updated.

executor
Required: Yes
Type: ActionTypeExecutor structure

Information about the executor for an action type that was created with any supported integration model.

id
Required: Yes
Type: ActionTypeIdentifier structure

The action category, owner, provider, and version of the action type to be updated.

inputArtifactDetails
Required: Yes
Type: ActionTypeArtifactDetails structure

Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.

outputArtifactDetails
Required: Yes
Type: ActionTypeArtifactDetails structure

Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.

permissions
Type: ActionTypePermissions structure

Details identifying the accounts with permissions to use the action type.

properties
Type: Array of ActionTypeProperty structures

The properties of the action type to be updated.

urls
Type: ActionTypeUrls structure

The links associated with the action type to be updated.

ActionTypeExecutor

Description

The action engine, or executor, for an action type created for a provider, where the action is to be used by customers of the provider. The action engine is associated with the model used to create and update the action, such as the Lambda integration model.

Members
configuration
Required: Yes
Type: ExecutorConfiguration structure

The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.

jobTimeout
Type: int

The timeout in seconds for the job. An action execution can have multiple jobs. This is the timeout for a single job, not the entire action execution.

policyStatementsTemplate
Type: string

The policy statement that specifies the permissions in the CodePipeline customer account that are needed to successfully run an action.

To grant permission to another account, specify the account ID as the Principal, a domain-style identifier defined by the service, for example codepipeline.amazonaws.com.

The size of the passed JSON policy document cannot exceed 2048 characters.

type
Required: Yes
Type: string

The integration model used to create and update the action type, Lambda or JobWorker.

ActionTypeId

Description

Represents information about an action type.

Members
category
Required: Yes
Type: string

A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.

  • Source

  • Build

  • Test

  • Deploy

  • Invoke

  • Approval

owner
Required: Yes
Type: string

The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.

provider
Required: Yes
Type: string

The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.

version
Required: Yes
Type: string

A string that describes the action version.

ActionTypeIdentifier

Description

Specifies the category, owner, provider, and version of the action type.

Members
category
Required: Yes
Type: string

Defines what kind of action can be taken in the stage, one of the following:

  • Source

  • Build

  • Test

  • Deploy

  • Approval

  • Invoke

owner
Required: Yes
Type: string

The creator of the action type being called: AWS or ThirdParty.

provider
Required: Yes
Type: string

The provider of the action type being called. The provider name is supplied when the action type is created.

version
Required: Yes
Type: string

A string that describes the action type version.

ActionTypeNotFoundException

Description

The specified action type cannot be found.

Members

ActionTypePermissions

Description

Details identifying the users with permissions to use the action type.

Members
allowedAccounts
Required: Yes
Type: Array of strings

A list of Amazon Web Services account IDs with access to use the action type in their pipelines.

ActionTypeProperty

Description

Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.

Members
description
Type: string

The description of the property that is displayed to users.

key
Required: Yes
Type: boolean

Whether the configuration property is a key.

name
Required: Yes
Type: string

The property name that is displayed to users.

noEcho
Required: Yes
Type: boolean

Whether to omit the field value entered by the customer in the log. If true, the value is not saved in CloudTrail logs for the action execution.

optional
Required: Yes
Type: boolean

Whether the configuration property is an optional value.

queryable
Type: boolean

Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.

ActionTypeSettings

Description

Returns information about the settings for an action type.

Members
entityUrlTemplate
Type: string

The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

executionUrlTemplate
Type: string

The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.

revisionUrlTemplate
Type: string

The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

thirdPartyConfigurationUrl
Type: string

The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

ActionTypeUrls

Description

Returns information about URLs for web pages that display to customers as links on the pipeline view, such as an external configuration page for the action type.

Members
configurationUrl
Type: string

The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.

entityUrlTemplate
Type: string

The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action display in the pipeline.

executionUrlTemplate
Type: string

The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.

revisionUrlTemplate
Type: string

The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

ApprovalAlreadyCompletedException

Description

The approval action has already been approved or rejected.

Members

ApprovalResult

Description

Represents information about the result of an approval request.

Members
status
Required: Yes
Type: string

The response submitted by a reviewer assigned to an approval action request.

summary
Required: Yes
Type: string

The summary of the current status of the approval request.

Artifact

Description

Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip

Members
location
Type: ArtifactLocation structure

The location of an artifact.

name
Type: string

The artifact's name.

revision
Type: string

The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).

ArtifactDetail

Description

Artifact details for the action execution, such as the artifact location.

Members
name
Type: string

The artifact object name for the action execution.

s3location
Type: S3Location structure

The Amazon S3 artifact location for the action execution.

ArtifactDetails

Description

Returns information about the details of an artifact.

Members
maximumCount
Required: Yes
Type: int

The maximum number of artifacts allowed for the action type.

minimumCount
Required: Yes
Type: int

The minimum number of artifacts allowed for the action type.

ArtifactLocation

Description

Represents information about the location of an artifact.

Members
s3Location
Type: S3ArtifactLocation structure

The S3 bucket that contains the artifact.

type
Type: string

The type of artifact in the location.

ArtifactRevision

Description

Represents revision details of an artifact.

Members
created
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the most recent revision of the artifact was created, in timestamp format.

name
Type: string

The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.

revisionChangeIdentifier
Type: string

An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.

revisionId
Type: string

The revision ID of the artifact.

revisionSummary
Type: string

Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.

revisionUrl
Type: string

The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.

ArtifactStore

Description

The S3 bucket where artifacts for the pipeline are stored.

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.

Members
encryptionKey
Type: EncryptionKey structure

The encryption key used to encrypt the data in the artifact store, such as an Amazon Web Services Key Management Service key. If this is undefined, the default key for Amazon S3 is used.

location
Required: Yes
Type: string

The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same Amazon Web Services Region as the pipeline to store your pipeline artifacts.

type
Required: Yes
Type: string

The type of the artifact store, such as S3.

BeforeEntryConditions

Description

The conditions for making checks for entry to a stage.

Members
conditions
Required: Yes
Type: Array of Condition structures

The conditions that are configured as entry conditions.

BlockerDeclaration

Description

Reserved for future use.

Members
name
Required: Yes
Type: string

Reserved for future use.

type
Required: Yes
Type: string

Reserved for future use.

ConcurrentModificationException

Description

Unable to modify the tag due to a simultaneous update request.

Members
message
Type: string

ConcurrentPipelineExecutionsLimitExceededException

Description

The pipeline has reached the limit for concurrent pipeline executions.

Members
message
Type: string

Condition

Description

The condition for the stage. A condition is made up of the rules and the result for the condition.

Members
result
Type: string

The action to be done when the condition is met. For example, rolling back an execution for a failure condition.

rules
Type: Array of RuleDeclaration structures

The rules that make up the condition.

ConditionExecution

Description

The run of a condition.

Members
lastStatusChange
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last status change of the condition.

status
Type: string

The status of the run for a condition.

summary
Type: string

The summary of information about a run for a condition.

ConditionNotOverridableException

Description

Unable to override because the condition does not allow overrides.

Members
message
Type: string

ConditionState

Description

Information about the state of the condition.

Members
latestExecution
Type: ConditionExecution structure

The state of the latest run of the rule.

ruleStates
Type: Array of RuleState structures

The state of the rules for the condition.

ConflictException

Description

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

Members
message
Type: string

CurrentRevision

Description

Represents information about a current revision.

Members
changeIdentifier
Required: Yes
Type: string

The change identifier for the current revision.

created
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the most recent revision of the artifact was created, in timestamp format.

revision
Required: Yes
Type: string

The revision ID of the current version of an artifact.

revisionSummary
Type: string

The summary of the most recent revision of the artifact.

DuplicatedStopRequestException

Description

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.

Members
message
Type: string

EncryptionKey

Description

Represents information about the key used to encrypt data in the artifact store, such as an Amazon Web Services Key Management Service (Key Management Service) key.

Members
id
Required: Yes
Type: string

The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.

Aliases are recognized only in the account that created the KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).

type
Required: Yes
Type: string

The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

ErrorDetails

Description

Represents information about an error in CodePipeline.

Members
code
Type: string

The system ID or number code of the error.

message
Type: string

The text of the error message.

ExecutionDetails

Description

The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

Members
externalExecutionId
Type: string

The system-generated unique ID of this action used to identify this job worker in any external systems, such as CodeDeploy.

percentComplete
Type: int

The percentage of work completed on the action, represented on a scale of 0 to 100 percent.

summary
Type: string

The summary of the current status of the actions.

ExecutionTrigger

Description

The interaction or event that started a pipeline execution.

Members
triggerDetail
Type: string

Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.

triggerType
Type: string

The type of change-detection method, command, or user interaction that started a pipeline execution.

ExecutorConfiguration

Description

The action engine, or executor, related to the supported integration model used to create and update the action type. The available executor types are Lambda and JobWorker.

Members
jobWorkerExecutorConfiguration

Details about the JobWorker executor of the action type.

lambdaExecutorConfiguration
Type: LambdaExecutorConfiguration structure

Details about the Lambda executor of the action type.

FailureConditions

Description

The configuration that specifies the result, such as rollback, to occur upon stage failure.

Members
conditions
Type: Array of Condition structures

The conditions that are configured as failure conditions.

result
Type: string

The specified result for when the failure conditions are met, such as rolling back the stage.

retryConfiguration
Type: RetryConfiguration structure

The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

FailureDetails

Description

Represents information about failure details.

Members
externalExecutionId
Type: string

The external ID of the run of the action that failed.

message
Required: Yes
Type: string

The message about the failure.

type
Required: Yes
Type: string

The type of the failure.

GitBranchFilterCriteria

Description

The Git repository branches specified as filter criteria to start the pipeline.

Members
excludes
Type: Array of strings

The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.

includes
Type: Array of strings

The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.

GitConfiguration

Description

A type of trigger configuration for Git-based source actions.

You can specify the Git configuration trigger type for all third-party Git-based source actions that are supported by the CodeStarSourceConnection action type.

Members
pullRequest
Type: Array of GitPullRequestFilter structures

The field where the repository event that will start the pipeline is specified as pull requests.

push
Type: Array of GitPushFilter structures

The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.

sourceActionName
Required: Yes
Type: string

The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only.

You can only specify one trigger configuration per source action.

GitFilePathFilterCriteria

Description

The Git repository file paths specified as filter criteria to start the pipeline.

Members
excludes
Type: Array of strings

The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.

includes
Type: Array of strings

The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.

GitPullRequestFilter

Description

The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.

Members
branches
Type: GitBranchFilterCriteria structure

The field that specifies to filter on branches for the pull request trigger configuration.

events
Type: Array of strings

The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.

filePaths
Type: GitFilePathFilterCriteria structure

The field that specifies to filter on file paths for the pull request trigger configuration.

GitPushFilter

Description

The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.

Members
branches
Type: GitBranchFilterCriteria structure

The field that specifies to filter on branches for the push trigger configuration.

filePaths
Type: GitFilePathFilterCriteria structure

The field that specifies to filter on file paths for the push trigger configuration.

tags
Type: GitTagFilterCriteria structure

The field that contains the details for the Git tags trigger configuration.

GitTagFilterCriteria

Description

The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.

Members
excludes
Type: Array of strings

The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.

includes
Type: Array of strings

The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.

InputArtifact

Description

Represents information about an artifact to be worked on, such as a test or build artifact.

Members
name
Required: Yes
Type: string

The name of the artifact to be worked on (for example, "My App").

Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip

The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

InvalidActionDeclarationException

Description

The action declaration was specified in an invalid format.

Members

InvalidApprovalTokenException

Description

The approval request already received a response or has expired.

Members

InvalidArnException

Description

The specified resource ARN is invalid.

Members
message
Type: string

InvalidBlockerDeclarationException

Description

Reserved for future use.

Members

InvalidClientTokenException

Description

The client token was specified in an invalid format

Members

InvalidJobException

Description

The job was specified in an invalid format or cannot be found.

Members

InvalidJobStateException

Description

The job state was specified in an invalid format.

Members

InvalidNextTokenException

Description

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.

Members

InvalidNonceException

Description

The nonce was specified in an invalid format.

Members

InvalidStageDeclarationException

Description

The stage declaration was specified in an invalid format.

Members

InvalidStructureException

Description

The structure was specified in an invalid format.

Members

InvalidTagsException

Description

The specified resource tags are invalid.

Members
message
Type: string

InvalidWebhookAuthenticationParametersException

Description

The specified authentication type is in an invalid format.

Members

InvalidWebhookFilterPatternException

Description

The specified event filter rule is in an invalid format.

Members

Job

Description

Represents information about a job.

Members
accountId
Type: string

The ID of the Amazon Web Services account to use when performing the job.

data
Type: JobData structure

Other data about a job.

id
Type: string

The unique system-generated ID of the job.

nonce
Type: string

A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.

JobData

Description

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

Members
actionConfiguration
Type: ActionConfiguration structure

Represents information about an action configuration.

actionTypeId
Type: ActionTypeId structure

Represents information about an action type.

artifactCredentials
Type: AWSSessionCredentials structure

Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline.

continuationToken
Type: string

A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.

encryptionKey
Type: EncryptionKey structure

Represents information about the key used to encrypt data in the artifact store, such as an KMS key.

inputArtifacts
Type: Array of Artifact structures

The artifact supplied to the job.

outputArtifacts
Type: Array of Artifact structures

The output of the job.

pipelineContext
Type: PipelineContext structure

Represents information about a pipeline to a job worker.

Includes pipelineArn and pipelineExecutionId for custom jobs.

JobDetails

Description

Represents information about the details of a job.

Members
accountId
Type: string

The Amazon Web Services account ID associated with the job.

data
Type: JobData structure

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

id
Type: string

The unique system-generated ID of the job.

JobNotFoundException

Description

The job was specified in an invalid format or cannot be found.

Members

JobWorkerExecutorConfiguration

Description

Details about the polling configuration for the JobWorker action engine, or executor.

Members
pollingAccounts
Type: Array of strings

The accounts in which the job worker is configured and might poll for jobs as part of the action execution.

pollingServicePrincipals
Type: Array of strings

The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.

LambdaExecutorConfiguration

Description

Details about the configuration for the Lambda action engine, or executor.

Members
lambdaFunctionArn
Required: Yes
Type: string

The ARN of the Lambda function used by the action engine.

LatestInPipelineExecutionFilter

Description

The field that specifies to filter on the latest execution in the pipeline.

Filtering on the latest execution is available for executions run on or after February 08, 2024.

Members
pipelineExecutionId
Required: Yes
Type: string

The execution ID for the latest execution in the pipeline.

startTimeRange
Required: Yes
Type: string

The start time to filter on for the latest execution in the pipeline. Valid options:

  • All

  • Latest

LimitExceededException

Description

The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.

Members

ListWebhookItem

Description

The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.

Members
arn
Type: string

The Amazon Resource Name (ARN) of the webhook.

definition
Required: Yes
Type: WebhookDefinition structure

The detail returned for each webhook, such as the webhook authentication type and filter rules.

errorCode
Type: string

The number code of the error.

errorMessage
Type: string

The text of the error message about the webhook.

lastTriggered
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time a webhook was last successfully triggered, in timestamp format.

tags
Type: Array of Tag structures

Specifies the tags applied to the webhook.

url
Required: Yes
Type: string

A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.

NotLatestPipelineExecutionException

Description

The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

Members

OutputArtifact

Description

Represents information about the output of an action.

Members
files
Type: Array of strings

The files that you want to associate with the output artifact that will be exported from the compute action.

name
Required: Yes
Type: string

The name of the output of an artifact, such as "My App".

The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

Output artifact names must be unique within a pipeline.

OutputVariablesSizeExceededException

Description

Exceeded the total size limit for all variables in the pipeline.

Members
message
Type: string

PipelineContext

Description

Represents information about a pipeline to a job worker.

PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.

Members
action
Type: ActionContext structure

The context of an action to a job worker in the stage of a pipeline.

pipelineArn
Type: string

The Amazon Resource Name (ARN) of the pipeline.

pipelineExecutionId
Type: string

The execution ID of the pipeline.

pipelineName
Type: string

The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

stage
Type: StageContext structure

The stage of the pipeline.

PipelineDeclaration

Description

Represents the structure of actions and stages to be performed in the pipeline.

Members
artifactStore
Type: ArtifactStore structure

Represents information about the S3 bucket where artifacts are stored for the pipeline.

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.

artifactStores
Type: Associative array of custom strings keys (AWSRegionName) to ArtifactStore structures

A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

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.

executionMode
Type: string

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

name
Required: Yes
Type: string

The name of the pipeline.

pipelineType
Type: string

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

  • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

  • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

For information about pricing for CodePipeline, see Pricing.

For information about which type of pipeline to choose, see What type of pipeline is right for me?.

roleArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

stages
Required: Yes
Type: Array of StageDeclaration structures

The stage in which to perform the action.

triggers
Type: Array of PipelineTriggerDeclaration structures

The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

variables
Type: Array of PipelineVariableDeclaration structures

A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

version
Type: int

The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.

PipelineExecution

Description

Represents information about an execution of a pipeline.

Members
artifactRevisions
Type: Array of ArtifactRevision structures

A list of ArtifactRevision objects included in a pipeline execution.

executionMode
Type: string

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

executionType
Type: string

The type of the pipeline execution.

pipelineExecutionId
Type: string

The ID of the pipeline execution.

pipelineName
Type: string

The name of the pipeline with the specified pipeline execution.

pipelineVersion
Type: int

The version number of the pipeline with the specified pipeline execution.

rollbackMetadata
Type: PipelineRollbackMetadata structure

The metadata about the execution pertaining to stage rollback.

status
Type: string

The status of the pipeline execution.

  • Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.

  • InProgress: The pipeline execution is currently running.

  • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

  • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

  • Succeeded: The pipeline execution was completed successfully.

  • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

  • Failed: The pipeline execution was not completed successfully.

statusSummary
Type: string

A summary that contains a description of the pipeline execution status.

trigger
Type: ExecutionTrigger structure

The interaction or event that started a pipeline execution.

variables
Type: Array of ResolvedPipelineVariable structures

A list of pipeline variables used for the pipeline execution.

PipelineExecutionFilter

Description

The pipeline execution to filter on.

Members
succeededInStage
Type: SucceededInStageFilter structure

Filter for pipeline executions where the stage was successful in the current pipeline version.

PipelineExecutionNotFoundException

Description

The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.

Members

PipelineExecutionNotStoppableException

Description

Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it might no longer be in progress.

Members
message
Type: string

PipelineExecutionOutdatedException

Description

The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.

Members
message
Type: string

PipelineExecutionSummary

Description

Summary information about a pipeline execution.

Members
executionMode
Type: string

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

executionType
Type: string

Type of the pipeline execution.

lastUpdateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time of the last change to the pipeline execution, in timestamp format.

pipelineExecutionId
Type: string

The ID of the pipeline execution.

rollbackMetadata
Type: PipelineRollbackMetadata structure

The metadata for the stage execution to be rolled back.

sourceRevisions
Type: Array of SourceRevision structures

A list of the source artifact revisions that initiated a pipeline execution.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the pipeline execution began, in timestamp format.

status
Type: string

The status of the pipeline execution.

  • InProgress: The pipeline execution is currently running.

  • Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.

  • Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.

  • Succeeded: The pipeline execution was completed successfully.

  • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.

  • Failed: The pipeline execution was not completed successfully.

statusSummary
Type: string

Status summary for the pipeline.

stopTrigger
Type: StopExecutionTrigger structure

The interaction that stopped a pipeline execution.

trigger
Type: ExecutionTrigger structure

The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.

PipelineMetadata

Description

Information about a pipeline.

Members
created
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the pipeline was created, in timestamp format.

pipelineArn
Type: string

The Amazon Resource Name (ARN) of the pipeline.

pollingDisabledAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use event-based change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling pipelines to use event-based change detection in the CodePipeline User Guide.

updated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the pipeline was last updated, in timestamp format.

PipelineNameInUseException

Description

The specified pipeline name is already in use.

Members

PipelineNotFoundException

Description

The pipeline was specified in an invalid format or cannot be found.

Members

PipelineRollbackMetadata

Description

The metadata for the stage execution to be rolled back.

Members
rollbackTargetPipelineExecutionId
Type: string

The pipeline execution ID to which the stage will be rolled back.

PipelineSummary

Description

Returns a summary of a pipeline.

Members
created
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the pipeline was created, in timestamp format.

executionMode
Type: string

The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.

name
Type: string

The name of the pipeline.

pipelineType
Type: string

CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.

  • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.

  • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

For information about pricing for CodePipeline, see Pricing.

For information about which type of pipeline to choose, see What type of pipeline is right for me?.

updated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time of the last update to the pipeline, in timestamp format.

version
Type: int

The version number of the pipeline.

PipelineTriggerDeclaration

Description

Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.

This is only supported for the CodeStarSourceConnection action type.

When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

Members
gitConfiguration
Required: Yes
Type: GitConfiguration structure

Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.

providerType
Required: Yes
Type: string

The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.

PipelineVariable

Description

A pipeline-level variable used for a pipeline execution.

Members
name
Required: Yes
Type: string

The name of a pipeline-level variable.

value
Required: Yes
Type: string

The value of a pipeline-level variable.

PipelineVariableDeclaration

Description

A variable declared at the pipeline level.

Members
defaultValue
Type: string

The value of a pipeline-level variable.

description
Type: string

The description of a pipeline-level variable. It's used to add additional context about the variable, and not being used at time when pipeline executes.

name
Required: Yes
Type: string

The name of a pipeline-level variable.

PipelineVersionNotFoundException

Description

The pipeline version was specified in an invalid format or cannot be found.

Members

RequestFailedException

Description

The request failed because of an unknown error, exception, or failure.

Members
message
Type: string

ResolvedPipelineVariable

Description

A pipeline-level variable used for a pipeline execution.

Members
name
Type: string

The name of a pipeline-level variable.

resolvedValue
Type: string

The resolved value of a pipeline-level variable.

ResourceNotFoundException

Description

The resource was specified in an invalid format.

Members

RetryConfiguration

Description

The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.

Members
retryMode
Type: string

The method that you want to configure for automatic stage retry on stage failure. You can specify to retry only failed action in the stage or all actions in the stage.

RetryStageMetadata

Description

The details of a specific automatic retry on stage failure, including the attempt number and trigger.

Members
autoStageRetryAttempt
Type: int

The number of attempts for a specific stage with automatic retry on stage failure. One attempt is allowed for automatic stage retry on failure.

latestRetryTrigger
Type: string

The latest trigger for a specific stage where manual or automatic retries have been made upon stage failure.

manualStageRetryAttempt
Type: int

The number of attempts for a specific stage where manual retries have been made upon stage failure.

RuleConfigurationProperty

Description

Represents information about a rule configuration property.

Members
description
Type: string

The description of the action configuration property that is displayed to users.

key
Required: Yes
Type: boolean

Whether the configuration property is a key.

name
Required: Yes
Type: string

The name of the rule configuration property.

queryable
Type: boolean

Indicates whether the property can be queried.

If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

required
Required: Yes
Type: boolean

Whether the configuration property is a required value.

secret
Required: Yes
Type: boolean

Whether the configuration property is secret.

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

type
Type: string

The type of the configuration property.

RuleDeclaration

Description

Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.

Members
configuration
Type: Associative array of custom strings keys (RuleConfigurationKey) to strings

The action configuration fields for the rule.

inputArtifacts
Type: Array of InputArtifact structures

The input artifacts fields for the rule, such as specifying an input file for the rule.

name
Required: Yes
Type: string

The name of the rule that is created for the condition, such as CheckAllResults.

region
Type: string

The Region for the condition associated with the rule.

roleArn
Type: string

The pipeline role ARN associated with the rule.

ruleTypeId
Required: Yes
Type: RuleTypeId structure

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

timeoutInMinutes
Type: int

The action timeout for the rule.

RuleExecution

Description

Represents information about each time a rule is run as part of the pipeline execution for a pipeline configured with conditions.

Members
errorDetails
Type: ErrorDetails structure

Represents information about an error in CodePipeline.

externalExecutionId
Type: string

The external ID of the run of the rule.

externalExecutionUrl
Type: string

The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).

lastStatusChange
Type: timestamp (string|DateTime or anything parsable by strtotime)

The last status change of the rule.

lastUpdatedBy
Type: string

The ARN of the user who last changed the rule.

ruleExecutionId
Type: string

The execution ID for the run of the rule.

status
Type: string

The status of the run of the rule, such as FAILED.

summary
Type: string

A summary of the run of the rule.

token
Type: string

The system-generated token used to identify a unique request.

RuleExecutionDetail

Description

The details of the runs for a rule and the results produced on an artifact as it passes through stages in the pipeline.

Members
input
Type: RuleExecutionInput structure

Input details for the rule execution, such as role ARN, Region, and input artifacts.

lastUpdateTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time of the last change to the rule execution, in timestamp format.

output
Type: RuleExecutionOutput structure

Output details for the rule execution, such as the rule execution result.

pipelineExecutionId
Type: string

The ID of the pipeline execution in the stage where the rule was run. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the stage.

pipelineVersion
Type: int

The version number of the pipeline with the stage where the rule was run.

ruleExecutionId
Type: string

The ID of the run for the rule.

ruleName
Type: string

The name of the rule that was run in the stage.

stageName
Type: string

The name of the stage where the rule was run.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the rule execution.

status
Type: string

The status of the rule execution. Status categories are InProgress, Succeeded, and Failed.

updatedBy
Type: string

The ARN of the user who changed the rule execution details.

RuleExecutionFilter

Description

Filter values for the rule execution.

Members
latestInPipelineExecution

The field that specifies to filter on the latest execution in the pipeline.

Filtering on the latest execution is available for executions run on or after February 08, 2024.

pipelineExecutionId
Type: string

The pipeline execution ID used to filter rule execution history.

RuleExecutionInput

Description

Input information used for a rule execution.

Members
configuration
Type: Associative array of custom strings keys (RuleConfigurationKey) to strings

Configuration data for a rule execution, such as the resolved values for that run.

inputArtifacts
Type: Array of ArtifactDetail structures

Details of input artifacts of the rule that correspond to the rule execution.

region
Type: string

The Amazon Web Services Region for the rule, such as us-east-1.

resolvedConfiguration
Type: Associative array of custom strings keys (String) to strings

Configuration data for a rule execution with all variable references replaced with their real values for the execution.

roleArn
Type: string

The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline.

ruleTypeId
Type: RuleTypeId structure

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

RuleExecutionOutput

Description

Output details listed for a rule execution, such as the rule execution result.

Members
executionResult
Type: RuleExecutionResult structure

Execution result information listed in the output details for a rule execution.

RuleExecutionResult

Description

Execution result information, such as the external execution ID.

Members
errorDetails
Type: ErrorDetails structure

Represents information about an error in CodePipeline.

externalExecutionId
Type: string

The external ID for the rule execution.

externalExecutionSummary
Type: string

The external provider summary for the rule execution.

externalExecutionUrl
Type: string

The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the rule.

RuleRevision

Description

The change to a rule that creates a revision of the rule.

Members
created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the most recent version of the rule was created, in timestamp format.

revisionChangeId
Required: Yes
Type: string

The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).

revisionId
Required: Yes
Type: string

The system-generated unique ID that identifies the revision number of the rule.

RuleState

Description

Returns information about the state of a rule.

Values returned in the revisionId field indicate the rule revision information, such as the commit ID, for the current state.

Members
currentRevision
Type: RuleRevision structure

The ID of the current revision of the artifact successfully worked on by the job.

entityUrl
Type: string

A URL link for more information about the state of the action, such as a details page.

latestExecution
Type: RuleExecution structure

Represents information about the latest run of an rule.

revisionUrl
Type: string

A URL link for more information about the revision, such as a commit details page.

ruleName
Type: string

The name of the rule.

RuleType

Description

The rule type, which is made up of the combined values for category, owner, provider, and version.

Members
id
Required: Yes
Type: RuleTypeId structure

Represents information about a rule type.

inputArtifactDetails
Required: Yes
Type: ArtifactDetails structure

Returns information about the details of an artifact.

ruleConfigurationProperties
Type: Array of RuleConfigurationProperty structures

The configuration properties for the rule type.

settings
Type: RuleTypeSettings structure

Returns information about the settings for a rule type.

RuleTypeId

Description

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Members
category
Required: Yes
Type: string

A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is Rule.

owner
Type: string

The creator of the rule being called. The valid value for the Owner field in the rule category is AWS.

provider
Required: Yes
Type: string

The rule provider, such as the DeploymentWindow rule.

version
Type: string

A string that describes the rule version.

RuleTypeSettings

Description

Returns information about the settings for a rule type.

Members
entityUrlTemplate
Type: string

The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

executionUrlTemplate
Type: string

The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.

revisionUrlTemplate
Type: string

The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

thirdPartyConfigurationUrl
Type: string

The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

S3ArtifactLocation

Description

The location of the S3 bucket that contains a revision.

Members
bucketName
Required: Yes
Type: string

The name of the S3 bucket.

objectKey
Required: Yes
Type: string

The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.

S3Location

Description

The Amazon S3 artifact location for an action's artifacts.

Members
bucket
Type: string

The Amazon S3 artifact bucket for an action's artifacts.

key
Type: string

The artifact name.

SourceRevision

Description

Information about the version (or revision) of a source artifact that initiated a pipeline execution.

Members
actionName
Required: Yes
Type: string

The name of the action that processed the revision to the source artifact.

revisionId
Type: string

The system-generated unique ID that identifies the revision number of the artifact.

revisionSummary
Type: string

Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.

revisionUrl
Type: string

The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.

SourceRevisionOverride

Description

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.

For the S3_OBJECT_VERSION_ID and S3_OBJECT_KEY types of source revisions, either of the types can be used independently, or they can be used together to override the source with a specific ObjectKey and VersionID.

Members
actionName
Required: Yes
Type: string

The name of the action where the override will be applied.

revisionType
Required: Yes
Type: string

The type of source revision, based on the source provider. For example, the revision type for the CodeCommit action provider is the commit ID.

revisionValue
Required: Yes
Type: string

The source revision, or version of your source artifact, with the changes that you want to run in the pipeline execution.

StageConditionState

Description

The state of a run of a condition for a stage.

Members
conditionStates
Type: Array of ConditionState structures

The states of the conditions for a run of a condition for a stage.

latestExecution
Type: StageConditionsExecution structure

Represents information about the latest run of a condition for a stage.

StageConditionsExecution

Description

Represents information about the run of a condition for a stage.

Members
status
Type: string

The status of a run of a condition for a stage.

summary
Type: string

A summary of the run of the condition for a stage.

StageContext

Description

Represents information about a stage to a job worker.

Members
name
Type: string

The name of the stage.

StageDeclaration

Description

Represents information about a stage and its definition.

Members
actions
Required: Yes
Type: Array of ActionDeclaration structures

The actions included in a stage.

beforeEntry
Type: BeforeEntryConditions structure

The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

blockers
Type: Array of BlockerDeclaration structures

Reserved for future use.

name
Required: Yes
Type: string

The name of the stage.

onFailure
Type: FailureConditions structure

The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

onSuccess
Type: SuccessConditions structure

The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

StageExecution

Description

Represents information about the run of a stage.

Members
pipelineExecutionId
Required: Yes
Type: string

The ID of the pipeline execution associated with the stage.

status
Required: Yes
Type: string

The status of the stage, or for a completed stage, the last status of the stage.

A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.

type
Type: string

The type of pipeline execution for the stage, such as a rollback pipeline execution.

StageNotFoundException

Description

The stage was specified in an invalid format or cannot be found.

Members

StageNotRetryableException

Description

Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.

Members

StageState

Description

Represents information about the state of the stage.

Members
actionStates
Type: Array of ActionState structures

The state of the stage.

beforeEntryConditionState
Type: StageConditionState structure

The state of the entry conditions for a stage.

inboundExecution
Type: StageExecution structure

Represents information about the run of a stage.

inboundExecutions
Type: Array of StageExecution structures

The inbound executions for a stage.

inboundTransitionState
Type: TransitionState structure

The state of the inbound transition, which is either enabled or disabled.

latestExecution
Type: StageExecution structure

Information about the latest execution in the stage, including its ID and status.

onFailureConditionState
Type: StageConditionState structure

The state of the failure conditions for a stage.

onSuccessConditionState
Type: StageConditionState structure

The state of the success conditions for a stage.

retryStageMetadata
Type: RetryStageMetadata structure

he details of a specific automatic retry on stage failure, including the attempt number and trigger.

stageName
Type: string

The name of the stage.

StopExecutionTrigger

Description

The interaction that stopped a pipeline execution.

Members
reason
Type: string

The user-specified reason the pipeline was stopped.

SucceededInStageFilter

Description

Filter for pipeline executions that have successfully completed the stage in the current pipeline version.

Members
stageName
Type: string

The name of the stage for filtering for pipeline executions where the stage was successful in the current pipeline version.

SuccessConditions

Description

The conditions for making checks that, if met, succeed a stage.

Members
conditions
Required: Yes
Type: Array of Condition structures

The conditions that are success conditions.

Tag

Description

A tag is a key-value pair that is used to manage the resource.

Members
key
Required: Yes
Type: string

The tag's key.

value
Required: Yes
Type: string

The tag's value.

ThirdPartyJob

Description

A response to a PollForThirdPartyJobs request returned by CodePipeline when there is a job to be worked on by a partner action.

Members
clientId
Type: string

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.

jobId
Type: string

The identifier used to identify the job in CodePipeline.

ThirdPartyJobData

Description

Represents information about the job data for a partner action.

Members
actionConfiguration
Type: ActionConfiguration structure

Represents information about an action configuration.

actionTypeId
Type: ActionTypeId structure

Represents information about an action type.

artifactCredentials
Type: AWSSessionCredentials structure

Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.

continuationToken
Type: string

A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.

encryptionKey
Type: EncryptionKey structure

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.

inputArtifacts
Type: Array of Artifact structures

The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

outputArtifacts
Type: Array of Artifact structures

The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.

pipelineContext
Type: PipelineContext structure

Represents information about a pipeline to a job worker.

Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

ThirdPartyJobDetails

Description

The details of a job sent in response to a GetThirdPartyJobDetails request.

Members
data
Type: ThirdPartyJobData structure

The data to be returned by the third party job worker.

id
Type: string

The identifier used to identify the job details in CodePipeline.

nonce
Type: string

A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.

TooManyTagsException

Description

The tags limit for a resource has been exceeded.

Members
message
Type: string

TransitionState

Description

Represents information about the state of transitions between one stage and another stage.

Members
disabledReason
Type: string

The user-specified reason why the transition between two stages of a pipeline was disabled.

enabled
Type: boolean

Whether the transition between stages is enabled (true) or disabled (false).

lastChangedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the transition state was last changed.

lastChangedBy
Type: string

The ID of the user who last changed the transition state.

UnableToRollbackStageException

Description

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.

Members
message
Type: string

ValidationException

Description

The validation was specified in an invalid format.

Members

WebhookAuthConfiguration

Description

The authentication applied to incoming webhook trigger requests.

Members
AllowedIPRange
Type: string

The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.

SecretToken
Type: string

The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

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.

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

WebhookDefinition

Description

Represents information about a webhook and its definition.

Members
authentication
Required: Yes
Type: string

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

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.

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

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

authenticationConfiguration
Required: Yes
Type: WebhookAuthConfiguration structure

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

filters
Required: Yes
Type: Array of WebhookFilterRule structures

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

name
Required: Yes
Type: string

The name of the webhook.

targetAction
Required: Yes
Type: string

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

targetPipeline
Required: Yes
Type: string

The name of the pipeline you want to connect to the webhook.

WebhookFilterRule

Description

The event criteria that specify when a webhook notification is sent to your URL.

Members
jsonPath
Required: Yes
Type: string

A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.

matchEquals
Type: string

The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

WebhookNotFoundException

Description

The specified webhook was entered in an invalid format or cannot be found.

Members