AWS 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 AWS 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.
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 AWS 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.
ListWebhooks ( array $params = [] )
Gets a listing of all the webhooks in this region for this account.
PollForJobs ( array $params = [] )
Returns information about any jobs for AWS CodePipeline to act upon.
PollForThirdPartyJobs ( array $params = [] )
Determines whether there are any third party jobs for a job worker to act on.
PutActionRevision ( array $params = [] )
Provides information to AWS CodePipeline about new revisions to a source.
PutApprovalResult ( array $params = [] )
Provides the response to a manual approval request to AWS 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 = [] )
Resumes the pipeline execution by retrying the last failed actions in a stage.
StartPipelineExecution ( array $params = [] )
Starts the specified pipeline.
UpdatePipeline ( array $params = [] )
Updates a specified pipeline with edits or changes to its structure.

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. Only used for custom actions.

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 AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.

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 specified nonce was specified in an invalid format.
JobNotFoundException:
The specified 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. Only used for partner actions.

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 AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.

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 specified nonce was specified in an invalid format.
JobNotFoundException:
The specified 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 AWS account. Only used for custom actions.

Parameter Syntax

$result = $client->createCustomActionType([
    'category' => 'Source|Build|Deploy|Test|Invoke|Approval', // 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>',
    ],
    '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.

Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

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 AWS CodeDeploy.

settings

Type: ActionTypeSettings structure

Returns information about the settings for an action type.

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',
            '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>',
        ],
    ],
]

Result Details

Members

actionType

Required: Yes
Type: ActionType structure

Returns information about the details of an action type.

Errors

ValidationException:
The validation was specified in an invalid format.
LimitExceededException:
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

CreatePipeline

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

Creates a pipeline.

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
            ],
            // ...
        ],
        'name' => '<string>', // REQUIRED
        'roleArn' => '<string>', // REQUIRED
        'stages' => [ // REQUIRED
            [
                'actions' => [ // REQUIRED
                    [
                        'actionTypeId' => [ // REQUIRED
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval', // REQUIRED
                            'owner' => 'AWS|ThirdParty|Custom', // REQUIRED
                            'provider' => '<string>', // REQUIRED
                            'version' => '<string>', // REQUIRED
                        ],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'name' => '<string>', // REQUIRED
                        'outputArtifacts' => [
                            [
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                    ],
                    // ...
                ],
                'blockers' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'type' => 'Schedule', // REQUIRED
                    ],
                    // ...
                ],
                'name' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'version' => <integer>,
    ],
]);

Parameter Details

Members

pipeline

Required: Yes
Type: PipelineDeclaration structure

Represents the structure of actions and stages to be performed in 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',
            ],
            // ...
        ],
        'name' => '<string>',
        'roleArn' => '<string>',
        'stages' => [
            [
                'actions' => [
                    [
                        'actionTypeId' => [
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval',
                            'owner' => 'AWS|ThirdParty|Custom',
                            'provider' => '<string>',
                            'version' => '<string>',
                        ],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'name' => '<string>',
                        'outputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                    ],
                    // ...
                ],
                'blockers' => [
                    [
                        'name' => '<string>',
                        'type' => 'Schedule',
                    ],
                    // ...
                ],
                'name' => '<string>',
            ],
            // ...
        ],
        'version' => <integer>,
    ],
]

Result Details

Members

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.
PipelineNameInUseException:
The specified pipeline name is already in use.
InvalidStageDeclarationException:
The specified stage declaration was specified in an invalid format.
InvalidActionDeclarationException:
The specified action declaration was specified in an invalid format.
InvalidBlockerDeclarationException:
Reserved for future use.
InvalidStructureException:
The specified structure was specified in an invalid format.
LimitExceededException:
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

DeleteCustomActionType

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

Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.

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', // 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 AWS 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.

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.

DeleteWebhook

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

Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API will return 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.

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 only supported 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 why 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 will be 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 specified pipeline was specified in an invalid format or cannot be found.
StageNotFoundException:
The specified 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 will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be 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 specified pipeline was specified in an invalid format or cannot be found.
StageNotFoundException:
The specified stage was specified in an invalid format or cannot be found.

GetJobDetails

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

Returns information about a job. Only used for custom actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API 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',
                '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' => [
                    'name' => '<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 specified 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 under an Amazon Web Services (AWS) user account.

version

Type: int

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

Result Syntax

[
    'metadata' => [
        'created' => <DateTime>,
        'pipelineArn' => '<string>',
        'updated' => <DateTime>,
    ],
    'pipeline' => [
        'artifactStore' => [
            'encryptionKey' => [
                'id' => '<string>',
                'type' => 'KMS',
            ],
            'location' => '<string>',
            'type' => 'S3',
        ],
        'artifactStores' => [
            '<AWSRegionName>' => [
                'encryptionKey' => [
                    'id' => '<string>',
                    'type' => 'KMS',
                ],
                'location' => '<string>',
                'type' => 'S3',
            ],
            // ...
        ],
        'name' => '<string>',
        'roleArn' => '<string>',
        'stages' => [
            [
                'actions' => [
                    [
                        'actionTypeId' => [
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval',
                            'owner' => 'AWS|ThirdParty|Custom',
                            'provider' => '<string>',
                            'version' => '<string>',
                        ],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'name' => '<string>',
                        'outputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                    ],
                    // ...
                ],
                'blockers' => [
                    [
                        'name' => '<string>',
                        'type' => 'Schedule',
                    ],
                    // ...
                ],
                '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 specified pipeline was specified in an invalid format or cannot be found.
PipelineVersionNotFoundException:
The specified 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>',
            ],
            // ...
        ],
        'pipelineExecutionId' => '<string>',
        'pipelineName' => '<string>',
        'pipelineVersion' => <integer>,
        'status' => 'InProgress|Succeeded|Superseded|Failed',
    ],
]

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 specified 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' => [
                        'errorDetails' => [
                            'code' => '<string>',
                            'message' => '<string>',
                        ],
                        'externalExecutionId' => '<string>',
                        'externalExecutionUrl' => '<string>',
                        'lastStatusChange' => <DateTime>,
                        'lastUpdatedBy' => '<string>',
                        'percentComplete' => <integer>,
                        'status' => 'InProgress|Succeeded|Failed',
                        'summary' => '<string>',
                        'token' => '<string>',
                    ],
                    'revisionUrl' => '<string>',
                ],
                // ...
            ],
            'inboundTransitionState' => [
                'disabledReason' => '<string>',
                'enabled' => true || false,
                'lastChangedAt' => <DateTime>,
                'lastChangedBy' => '<string>',
            ],
            'latestExecution' => [
                'pipelineExecutionId' => '<string>',
                'status' => 'InProgress|Failed|Succeeded',
            ],
            '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 specified 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. Only used for partner actions.

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',
                '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' => [
                    'name' => '<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 specified 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 specified 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' => [
        '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. The action execution history is limited to the most recent 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',
                    'owner' => 'AWS|ThirdParty|Custom',
                    'provider' => '<string>',
                    'version' => '<string>',
                ],
                'configuration' => ['<string>', ...],
                'inputArtifacts' => [
                    [
                        'name' => '<string>',
                        's3location' => [
                            'bucket' => '<string>',
                            'key' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'region' => '<string>',
                'roleArn' => '<string>',
            ],
            'lastUpdateTime' => <DateTime>,
            'output' => [
                'executionResult' => [
                    'externalExecutionId' => '<string>',
                    'externalExecutionSummary' => '<string>',
                    'externalExecutionUrl' => '<string>',
                ],
                'outputArtifacts' => [
                    [
                        'name' => '<string>',
                        's3location' => [
                            'bucket' => '<string>',
                            'key' => '<string>',
                        ],
                    ],
                    // ...
                ],
            ],
            'pipelineExecutionId' => '<string>',
            'pipelineVersion' => <integer>,
            'stageName' => '<string>',
            'startTime' => <DateTime>,
            'status' => 'InProgress|Succeeded|Failed',
        ],
        // ...
    ],
    '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 specified 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 provided 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 AWS CodePipeline action types associated with your account.

Parameter Syntax

$result = $client->listActionTypes([
    'actionOwnerFilter' => 'AWS|ThirdParty|Custom',
    'nextToken' => '<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.

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',
                '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 which 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 provided 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.

Parameter Syntax

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

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. The available pipeline execution 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' => [
        [
            'lastUpdateTime' => <DateTime>,
            'pipelineExecutionId' => '<string>',
            'sourceRevisions' => [
                [
                    'actionName' => '<string>',
                    'revisionId' => '<string>',
                    'revisionSummary' => '<string>',
                    'revisionUrl' => '<string>',
                ],
                // ...
            ],
            'startTime' => <DateTime>,
            'status' => 'InProgress|Succeeded|Superseded|Failed',
        ],
        // ...
    ],
]

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 specified 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 provided 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([
    'nextToken' => '<string>',
]);

Parameter Details

Members

nextToken

Type: string

An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.

Result Syntax

[
    'nextToken' => '<string>',
    'pipelines' => [
        [
            'created' => <DateTime>,
            'name' => '<string>',
            'updated' => <DateTime>,
            'version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

If the amount of returned information is significantly large, an identifier is also returned which 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 provided is the token returned by a previous call.

ListWebhooks

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

Gets a listing of all the webhooks in this region for this account. The output lists all webhooks and includes the webhook URL and ARN, as well the configuration for each webhook.

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>,
            '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 provided is the token returned by a previous call.

PollForJobs

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

Returns information about any jobs for AWS CodePipeline to act upon. PollForJobs is only valid 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.

Parameter Syntax

$result = $client->pollForJobs([
    'actionTypeId' => [ // REQUIRED
        'category' => 'Source|Build|Deploy|Test|Invoke|Approval', // 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 will be returned.

Result Syntax

[
    'jobs' => [
        [
            'accountId' => '<string>',
            'data' => [
                'actionConfiguration' => [
                    'configuration' => ['<string>', ...],
                ],
                'actionTypeId' => [
                    'category' => 'Source|Build|Deploy|Test|Invoke|Approval',
                    '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' => [
                        'name' => '<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. Only used for partner actions.

Parameter Syntax

$result = $client->pollForThirdPartyJobs([
    'actionTypeId' => [ // REQUIRED
        'category' => 'Source|Build|Deploy|Test|Invoke|Approval', // 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 AWS 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 will process 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 will start processing the revision to the source.

stageName

Required: Yes
Type: string

The name of the stage that contains the action that will act upon 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 specified pipeline was specified in an invalid format or cannot be found.
StageNotFoundException:
The specified 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.

PutApprovalResult

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

Provides the response to a manual approval request to AWS 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 and is used to validate that the approval request corresponding to this token is still valid.

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 specified pipeline was specified in an invalid format or cannot be found.
StageNotFoundException:
The specified 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. Only used for custom actions.

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 specified job was specified in an invalid format or cannot be found.
InvalidJobStateException:
The specified 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. Only used for custom actions.

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
]);

Parameter Details

Members

continuationToken

Type: string

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional 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 upon 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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
The validation was specified in an invalid format.
JobNotFoundException:
The specified job was specified in an invalid format or cannot be found.
InvalidJobStateException:
The specified job state was specified in an invalid format.

PutThirdPartyJobFailureResult

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

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

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 specified job was specified in an invalid format or cannot be found.
InvalidJobStateException:
The specified 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. Only used for partner actions.

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 an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional 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 specified job was specified in an invalid format or cannot be found.
InvalidJobStateException:
The specified 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.

Parameter Syntax

$result = $client->putWebhook([
    '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

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 which identifies the webhook being defined. You may choose to 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>,
        '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 AWS 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 specified pipeline was specified in an invalid format or cannot be found.

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([/* ... */]);

Resumes the pipeline execution by retrying the last failed actions in a stage.

Parameter Syntax

$result = $client->retryStageExecution([
    'pipelineExecutionId' => '<string>', // REQUIRED
    'pipelineName' => '<string>', // REQUIRED
    'retryMode' => 'FAILED_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. Currently, the only supported value is FAILED_ACTIONS.

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.
PipelineNotFoundException:
The specified pipeline was specified in an invalid format or cannot be found.
StageNotFoundException:
The specified stage was specified in an invalid format or cannot be found.
StageNotRetryableException:
The specified stage can't be retried because the pipeline structure or stage state changed after the stage was not completed; the stage contains no failed actions; one or more actions are still in progress; or another retry attempt is already in progress.
NotLatestPipelineExecutionException:
The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

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
]);

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.

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.
PipelineNotFoundException:
The specified pipeline was specified in an invalid format or 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 in conjunction with 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
            ],
            // ...
        ],
        'name' => '<string>', // REQUIRED
        'roleArn' => '<string>', // REQUIRED
        'stages' => [ // REQUIRED
            [
                'actions' => [ // REQUIRED
                    [
                        'actionTypeId' => [ // REQUIRED
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval', // REQUIRED
                            'owner' => 'AWS|ThirdParty|Custom', // REQUIRED
                            'provider' => '<string>', // REQUIRED
                            'version' => '<string>', // REQUIRED
                        ],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'name' => '<string>', // REQUIRED
                        'outputArtifacts' => [
                            [
                                'name' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                    ],
                    // ...
                ],
                'blockers' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'type' => 'Schedule', // REQUIRED
                    ],
                    // ...
                ],
                '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',
            ],
            // ...
        ],
        'name' => '<string>',
        'roleArn' => '<string>',
        'stages' => [
            [
                'actions' => [
                    [
                        'actionTypeId' => [
                            'category' => 'Source|Build|Deploy|Test|Invoke|Approval',
                            'owner' => 'AWS|ThirdParty|Custom',
                            'provider' => '<string>',
                            'version' => '<string>',
                        ],
                        'configuration' => ['<string>', ...],
                        'inputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'name' => '<string>',
                        'outputArtifacts' => [
                            [
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                        'region' => '<string>',
                        'roleArn' => '<string>',
                        'runOrder' => <integer>,
                    ],
                    // ...
                ],
                'blockers' => [
                    [
                        'name' => '<string>',
                        'type' => 'Schedule',
                    ],
                    // ...
                ],
                '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 specified stage declaration was specified in an invalid format.
InvalidActionDeclarationException:
The specified action declaration was specified in an invalid format.
InvalidBlockerDeclarationException:
Reserved for future use.
InvalidStructureException:
The specified structure was specified in an invalid format.
LimitExceededException:
The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

Shapes

AWSSessionCredentials

Description

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS 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 will be 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 will be used in conjunction 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 additional 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 will preserve the prior value of the secret.

type

Type: string

The type of the configuration property.

ActionContext

Description

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

Members

name

Type: string

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

ActionDeclaration

Description

Represents information about an action declaration.

Members

actionTypeId

Required: Yes
Type: ActionTypeId structure

The configuration information for the action type.

configuration

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

The action declaration's configuration.

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.

outputArtifacts

Type: Array of OutputArtifact structures

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

region

Type: string

The action declaration's AWS Region, such as us-east-1.

roleArn

Type: string

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

runOrder

Type: int

The order in which actions are run.

ActionExecution

Description

Represents information about the run of an action.

Members

errorDetails

Type: ErrorDetails structure

The details of an error returned by a URL external to AWS.

externalExecutionId

Type: string

The external ID of the run of the action.

externalExecutionUrl

Type: string

The URL of a resource external to AWS that will be 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.

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

ActionExecutionFilter

Description

Filter values for the action execution.

Members

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.

region

Type: string

The AWS Region for the action, 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.

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.

ActionExecutionResult

Description

Execution result information, such as the external execution ID.

Members

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.

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.

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 values below.

owner

Required: Yes
Type: string

The creator of the action being called.

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 AWS CodeDeploy, which would be specified as CodeDeploy. To reference a list of action providers by action type, see Valid Action Types and Providers in CodePipeline.

version

Required: Yes
Type: string

A string that describes the action version.

ActionTypeNotFoundException

Description

The specified action type cannot be found.

Members

ActionTypeSettings

Description

Returns information about the settings for an action type.

Members

entityUrlTemplate

Type: string

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

executionUrlTemplate

Type: string

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

revisionUrlTemplate

Type: string

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

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.

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

Represents information about an artifact that will be worked upon by actions in the pipeline.

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 Amazon 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 might be 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 AWS 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 AWS CodeCommit repositories, the commit ID is linked to a commit details page.

ArtifactStore

Description

The Amazon S3 bucket where artifacts are stored for the pipeline.

Members

encryptionKey

Type: EncryptionKey structure

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

location

Required: Yes
Type: string

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

type

Required: Yes
Type: string

The type of the artifact store, such as S3.

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.

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.

EncryptionKey

Description

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

Members

id

Required: Yes
Type: string

The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

type

Required: Yes
Type: string

The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

ErrorDetails

Description

Represents information about an error in AWS CodePipeline.

Members

code

Type: string

The system ID or error 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 AWS CodeDeploy.

percentComplete

Type: int

The percentage of work completed on the action, represented on a scale of zero to one hundred percent.

summary

Type: string

The summary of the current status of the actions.

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.

InputArtifact

Description

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

Members

name

Required: Yes
Type: string

Represents information about a job.

Members

accountId

Type: string

The ID of the AWS account to use when performing the job.

data

Type: JobData structure

Additional data about a job.

id

Type: string

The unique system-generated ID of the job.

nonce

Type: string

A system-generated random number that AWS 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 additional 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

continuationToken

Type: string

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order 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 AWS Key Management Service (AWS 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.

JobDetails

Description

Represents information about the details of a job.

Members

accountId

Type: string

The AWS account ID associated with the job.

data

Type: JobData structure

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

id

Type: string

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.

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 will make the old URL invalid and generate a new URL.

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

name

Required: Yes
Type: string

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

Output artifact names must be unique within a pipeline.

PipelineContext

Description

Represents information about a pipeline to a job worker.

Members

action

Type: ActionContext structure

The context of an action to a job worker within the stage of a 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 Amazon S3 bucket where artifacts are stored for the pipeline.

artifactStores

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

A mapping of artifactStore objects and their corresponding regions. There must be an artifact store for the pipeline region and for each cross-region action within the pipeline. You can only use either artifactStore or artifactStores, not both.

If you create a cross-region action in your pipeline, you must use artifactStores.

name

Required: Yes
Type: string

The name of the action to be performed.

roleArn

Required: Yes
Type: string

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

stages

Required: Yes
Type: Array of StageDeclaration structures

The stage in which to perform the action.

version

Type: int

The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically 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.

pipelineExecutionId

Type: string

The ID of the pipeline execution.

pipelineName

Type: string

The name of the pipeline that was executed.

pipelineVersion

Type: int

The version number of the pipeline that was executed.

status

Type: string

The status of the pipeline execution.

InProgress: The pipeline execution is currently running.
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.
Failed: The pipeline execution was not completed successfully.

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

PipelineExecutionSummary

Description

Summary information about a pipeline execution.

Members

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.

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.
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.
Failed: The pipeline execution was not completed successfully.

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.

updated

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

Members

created

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

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

name

Type: string

The name of the pipeline.

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.

PipelineVersionNotFoundException

Description

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

Members

S3ArtifactLocation

Description

The location of the Amazon S3 bucket that contains a revision.

Members

bucketName

Required: Yes
Type: string

The name of the Amazon S3 bucket.

objectKey

Required: Yes
Type: string

The key of the object in the Amazon 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

revisionUrl

Type: string

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

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.

blockers

Type: Array of BlockerDeclaration structures

Reserved for future use.

name

Required: Yes
Type: string

The name of the stage.

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

Members

actionStates

Type: Array of ActionState structures

The state of the 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.

stageName

Type: string

The name of the stage.

ThirdPartyJob

Description

A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked upon 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 AWS 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

continuationToken

Type: string

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order 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 AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

inputArtifacts

Type: Array of Artifact structures

The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.

pipelineContext

Type: PipelineContext structure

Represents information about a pipeline to a job worker.

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 AWS CodePipeline.

nonce

Type: string

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

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.

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 within a specific IP range. For IP, only the AllowedIPRange property must be set, and 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.

WebhookDefinition

Description

Represents information about a webhook and its definition.

Members

authentication

Required: Yes
Type: string

Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.

GITHUB_HMAC implements the authentication scheme described here: https://developer.github.com/webhooks/securing/
IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
UNAUTHENTICATED will accept 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 will be applied to the body/payload of the webhook. The value selected by JsonPath expression must match the value specified in the matchEquals field, otherwise the request will be ignored. More information on JsonPath expressions can be found here: https://github.com/json-path/JsonPath.

matchEquals

Type: string

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

WebhookNotFoundException

Description

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

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS CodePipeline 2015-07-09

Operation Summary

Operations

AcknowledgeJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AcknowledgeThirdPartyJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCustomActionType

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePipeline

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteCustomActionType

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeletePipeline

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteWebhook

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeregisterWebhookWithThirdParty

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisableStageTransition

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

EnableStageTransition

Parameter Syntax

Parameter Details

Members