NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class CodePipelineClient

Client to interact with AWS CodePipeline

  Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
  Guzzle\Http\Client implements Guzzle\Http\ClientInterface
  Guzzle\Service\Client implements Guzzle\Service\ClientInterface
  Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
  Aws\CodePipeline\CodePipelineClient

Namespace: Aws\CodePipeline
Link: User guide
Link: API docs
Located at Aws/CodePipeline/CodePipelineClient.php

## Methods summary

- `public static` `factory ( array $config = array() )`

  Executes the UpdatePipeline operation.

- `public` `acknowledgeJob ( array $args = array() )`

  Executes the AcknowledgeJob operation.

- `public` `acknowledgeThirdPartyJob ( array $args = array() )`

  Executes the AcknowledgeThirdPartyJob operation.

- `public` `createCustomActionType ( array $args = array() )`

  Executes the CreateCustomActionType operation.

- `public` `createPipeline ( array $args = array() )`

  Executes the CreatePipeline operation.

- `public` `deleteCustomActionType ( array $args = array() )`

  Executes the DeleteCustomActionType operation.

- `public` `deletePipeline ( array $args = array() )`

  Executes the DeletePipeline operation.

- `public` `disableStageTransition ( array $args = array() )`

  Executes the DisableStageTransition operation.

- `public` `enableStageTransition ( array $args = array() )`

  Executes the EnableStageTransition operation.

- `public` `getJobDetails ( array $args = array() )`

  Executes the GetJobDetails operation.

- `public` `getPipeline ( array $args = array() )`

  Executes the GetPipeline operation.

- `public` `getPipelineState ( array $args = array() )`

  Executes the GetPipelineState operation.

- `public` `getThirdPartyJobDetails ( array $args = array() )`

  Executes the GetThirdPartyJobDetails operation.

- `public` `listActionTypes ( array $args = array() )`

  Executes the ListActionTypes operation.

- `public` `listPipelines ( array $args = array() )`

  Executes the ListPipelines operation.

- `public` `pollForJobs ( array $args = array() )`

  Executes the PollForJobs operation.

- `public` `pollForThirdPartyJobs ( array $args = array() )`

  Executes the PollForThirdPartyJobs operation.

- `public` `putActionRevision ( array $args = array() )`

  Executes the PutActionRevision operation.

- `public` `putJobFailureResult ( array $args = array() )`

  Executes the PutJobFailureResult operation.

- `public` `putJobSuccessResult ( array $args = array() )`

  Executes the PutJobSuccessResult operation.

- `public` `putThirdPartyJobFailureResult ( array $args = array() )`

  Executes the PutThirdPartyJobFailureResult operation.

- `public` `putThirdPartyJobSuccessResult ( array $args = array() )`

  Executes the PutThirdPartyJobSuccessResult operation.

- `public` `startPipelineExecution ( array $args = array() )`

  Executes the StartPipelineExecution operation.

- `public` `updatePipeline ( array $args = array() )`

  Executes the UpdatePipeline operation.

## Methods detail

# `public static `Guzzle\Service\Resource\Model``
`factory( array $config = array() )`

Executes the UpdatePipeline operation.

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.

#### Parameters

$config
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - pipeline => (associative-array)

    The name of the pipeline to be updated.

    - name => (string)

      The name of the action to be performed.

    - roleArn => (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.

    - artifactStore => (associative-array)

      The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.

      - => (associative-array)

        Associative array of custom key value pairs

    - stages => (array<associative-array>)

      The stage in which to perform the action.

      - (associative-array)

        Represents information about a stage and its definition.

        - name => (string)

          The name of the stage.

        - blockers => (array<associative-array>)

          The gates included in a stage.

          - (associative-array)

            Represents information about a gate declaration.

            - => (associative-array)

              Associative array of custom key value pairs

        - actions => (array<associative-array>)

          The actions included in a stage.

          - (associative-array)

            Represents information about an action declaration.

            - name => (string)

              The action declaration's name.

            - actionTypeId => (associative-array)

              The configuration information for the action type.

              - category => (string: Source | Build | Deploy | Test | Invoke )

                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 => (string: AWS | ThirdParty | Custom )

                The creator of the action being called.

              - provider => (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.

              - version => (string)

                A string that identifies the action type.

            - runOrder => (int)

              The order in which actions are run.

            - configuration => (associative-array<string>)

              Associative array of <ActionConfigurationKey> keys mapping to (string) values. Each array key should be changed to an appropriate <ActionConfigurationKey>.

              The action declaration's configuration.

              - <ActionConfigurationKey> => (string)
            - inputArtifacts => (array<associative-array>)

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

              - (associative-array)

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

                - name => (string)

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

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

            - roleArn => (string)

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

    - version => (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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- pipeline => (associative-array)

  The structure of the updated pipeline.

  - name => (string)

    The name of the action to be performed.

  - roleArn => (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.

  - artifactStore => (associative-array)

    The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.

    - => (associative-array)

      Associative array of custom key value pairs

  - stages => (array<associative-array>)

    The stage in which to perform the action.

    - (associative-array)

      Represents information about a stage and its definition.

      - name => (string)

        The name of the stage.

      - blockers => (array<associative-array>)

        The gates included in a stage.

        - (associative-array)

          Represents information about a gate declaration.

          - => (associative-array)

            Associative array of custom key value pairs

      - actions => (array<associative-array>)

        The actions included in a stage.

        - (associative-array)

          Represents information about an action declaration.

          - name => (string)

            The action declaration's name.

          - actionTypeId => (associative-array)

            The configuration information for the action type.

            - category => (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 => (string)

              The creator of the action being called.

            - provider => (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.

            - version => (string)

              A string that identifies the action type.

          - runOrder => (int)

            The order in which actions are run.

          - configuration => (associative-array<string>)

            Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

            The action declaration's configuration.

            - <string> => (string)
          - outputArtifacts => (array<associative-array>)

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

            - (associative-array)

              Represents information about the output of an action.

              - name => (string)

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

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

                Output artifact names must be unique within a pipeline.

          - inputArtifacts => (array<associative-array>)

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

            - (associative-array)

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

              - name => (string)

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

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

          - roleArn => (string)

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

  - version => (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.

#### Overrides

`Guzzle\Service\Client::factory`
# `public `Guzzle\Service\Resource\Model``
`acknowledgeJob( array $args = array() )`

Executes the AcknowledgeJob operation.

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

#### Examples

- Basic formatting example

      $result = $client->acknowledgeJob(array(
          // jobId is required
          'jobId' => 'string',
          // nonce is required
          'nonce' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - jobId => (string)

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

  - nonce => (string)

    A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- status => (string)

  Whether the job worker has received the specified job.

# `public `Guzzle\Service\Resource\Model``
`acknowledgeThirdPartyJob( array $args = array() )`

Executes the AcknowledgeThirdPartyJob operation.

Confirms a job worker has received the specified job. Only used for partner actions.

#### Examples

- Basic formatting example

      $result = $client->acknowledgeThirdPartyJob(array(
          // jobId is required
          'jobId' => 'string',
          // nonce is required
          'nonce' => 'string',
          // clientToken is required
          'clientToken' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - jobId => (string)

    The unique system-generated ID of the job.

  - nonce => (string)

    A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.

  - clientToken => (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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- status => (string)

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

# `public `Guzzle\Service\Resource\Model``
`createCustomActionType( array $args = array() )`

Executes the CreateCustomActionType operation.

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

#### Examples

- Basic formatting example

      $result = $client->createCustomActionType(array(
          // category is required
          'category' => 'string',
          // provider is required
          'provider' => 'string',
          // version is required
          'version' => 'string',
          'settings' => array(
              'thirdPartyConfigurationUrl' => 'string',
              'entityUrlTemplate' => 'string',
              'executionUrlTemplate' => 'string',
              'revisionUrlTemplate' => 'string',
          ),
          'configurationProperties' => array(
              array(
                  //  is required
                  '' => array(
                      // Associative array of custom key value pairs
                  ),
              ),
              // ... repeated
          ),
          // inputArtifactDetails is required
          'inputArtifactDetails' => array(
              // minimumCount is required
              'minimumCount' => integer,
              // maximumCount is required
              'maximumCount' => integer,
          ),
          // outputArtifactDetails is required
          'outputArtifactDetails' => array(
              // minimumCount is required
              'minimumCount' => integer,
              // maximumCount is required
              'maximumCount' => integer,
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - category => (string: Source | Build | Deploy | Test | Invoke )

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

  - provider => (string)

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

  - version => (string)

    The version number of the custom action.

    A newly-created custom action is always assigned a version number of 1. This is required.
  - settings => (associative-array)

    Returns information about the settings for an action type.

    - thirdPartyConfigurationUrl => (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.

    - entityUrlTemplate => (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 => (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 => (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.

  - configurationProperties => (array<associative-array>)

    The configuration properties for the custom action.

    - (associative-array)

      Represents information about an action configuration property.

      - => (associative-array)

        Associative array of custom key value pairs

  - inputArtifactDetails => (associative-array)

    Returns information about the details of an artifact.

    - minimumCount => (int)

      The minimum number of artifacts allowed for the action type.

    - maximumCount => (int)

      The maximum number of artifacts allowed for the action type.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- actionType => (associative-array)

  Returns information about the details of an action type.

  - id => (associative-array)

    Represents information about an action type.

    - category => (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 => (string)

      The creator of the action being called.

    - provider => (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.

    - version => (string)

      A string that identifies the action type.

  - settings => (associative-array)

    The settings for the action type.

    - thirdPartyConfigurationUrl => (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.

    - entityUrlTemplate => (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 => (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 => (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.

  - actionConfigurationProperties => (array<associative-array>)

    The configuration properties for the action type.

    - (associative-array)

      Represents information about an action configuration property.

      - => (associative-array)

        Associative array of custom key value pairs

  - inputArtifactDetails => (associative-array)

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

    - minimumCount => (int)

      The minimum number of artifacts allowed for the action type.

    - maximumCount => (int)

      The maximum number of artifacts allowed for the action type.

  - outputArtifactDetails => (associative-array)

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

    - minimumCount => (int)

      The minimum number of artifacts allowed for the action type.

    - maximumCount => (int)

      The maximum number of artifacts allowed for the action type.

# `public `Guzzle\Service\Resource\Model``
`createPipeline( array $args = array() )`

Executes the CreatePipeline operation.

Creates a pipeline.

#### Examples

- Basic formatting example

      $result = $client->createPipeline(array(
          // pipeline is required
          'pipeline' => array(
              // name is required
              'name' => 'string',
              // roleArn is required
              'roleArn' => 'string',
              // artifactStore is required
              'artifactStore' => array(
                  '' => array(
                      // Associative array of custom key value pairs
                  ),
              ),
              // stages is required
              'stages' => array(
                  array(
                      // name is required
                      'name' => 'string',
                      'blockers' => array(
                          array(
                              '' => array(
                                  // Associative array of custom key value pairs
                              ),
                          ),
                          // ... repeated
                      ),
                      // actions is required
                      'actions' => array(
                          array(
                              // name is required
                              'name' => 'string',
                              // actionTypeId is required
                              'actionTypeId' => array(
                                  // category is required
                                  'category' => 'string',
                                  // owner is required
                                  'owner' => 'string',
                                  // provider is required
                                  'provider' => 'string',
                                  // version is required
                                  'version' => 'string',
                              ),
                              'runOrder' => integer,
                              'configuration' => array(
                                  // Associative array of custom 'ActionConfigurationKey' key names
                                  'ActionConfigurationKey' => 'string',
                                  // ... repeated
                              ),
                              'inputArtifacts' => array(
                                  array(
                                      // name is required
                                      'name' => 'string',
                                  ),
                                  // ... repeated
                              ),
                              'roleArn' => 'string',
                          ),
                          // ... repeated
                      ),
                  ),
                  // ... repeated
              ),
              'version' => integer,
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - pipeline => (associative-array)

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

    - name => (string)

      The name of the action to be performed.

    - roleArn => (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.

    - artifactStore => (associative-array)

      The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.

      - => (associative-array)

        Associative array of custom key value pairs

    - stages => (array<associative-array>)

      The stage in which to perform the action.

      - (associative-array)

        Represents information about a stage and its definition.

        - name => (string)

          The name of the stage.

        - blockers => (array<associative-array>)

          The gates included in a stage.

          - (associative-array)

            Represents information about a gate declaration.

            - => (associative-array)

              Associative array of custom key value pairs

        - actions => (array<associative-array>)

          The actions included in a stage.

          - (associative-array)

            Represents information about an action declaration.

            - name => (string)

              The action declaration's name.

            - actionTypeId => (associative-array)

              The configuration information for the action type.

              - category => (string: Source | Build | Deploy | Test | Invoke )

                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 => (string: AWS | ThirdParty | Custom )

                The creator of the action being called.

              - provider => (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.

              - version => (string)

                A string that identifies the action type.

            - runOrder => (int)

              The order in which actions are run.

            - configuration => (associative-array<string>)

              Associative array of <ActionConfigurationKey> keys mapping to (string) values. Each array key should be changed to an appropriate <ActionConfigurationKey>.

              The action declaration's configuration.

              - <ActionConfigurationKey> => (string)
            - inputArtifacts => (array<associative-array>)

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

              - (associative-array)

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

                - name => (string)

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

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

            - roleArn => (string)

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

    - version => (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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- pipeline => (associative-array)

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

  - name => (string)

    The name of the action to be performed.

  - roleArn => (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.

  - artifactStore => (associative-array)

    The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.

    - => (associative-array)

      Associative array of custom key value pairs

  - stages => (array<associative-array>)

    The stage in which to perform the action.

    - (associative-array)

      Represents information about a stage and its definition.

      - name => (string)

        The name of the stage.

      - blockers => (array<associative-array>)

        The gates included in a stage.

        - (associative-array)

          Represents information about a gate declaration.

          - => (associative-array)

            Associative array of custom key value pairs

      - actions => (array<associative-array>)

        The actions included in a stage.

        - (associative-array)

          Represents information about an action declaration.

          - name => (string)

            The action declaration's name.

          - actionTypeId => (associative-array)

            The configuration information for the action type.

            - category => (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 => (string)

              The creator of the action being called.

            - provider => (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.

            - version => (string)

              A string that identifies the action type.

          - runOrder => (int)

            The order in which actions are run.

          - configuration => (associative-array<string>)

            Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

            The action declaration's configuration.

            - <string> => (string)
          - outputArtifacts => (array<associative-array>)

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

            - (associative-array)

              Represents information about the output of an action.

              - name => (string)

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

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

                Output artifact names must be unique within a pipeline.

          - inputArtifacts => (array<associative-array>)

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

            - (associative-array)

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

              - name => (string)

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

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

          - roleArn => (string)

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

  - version => (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.

# `public `Guzzle\Service\Resource\Model``
`deleteCustomActionType( array $args = array() )`

Executes the DeleteCustomActionType operation.

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.

You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.

#### Examples

- Basic formatting example

      $result = $client->deleteCustomActionType(array(
          // category is required
          'category' => 'string',
          // provider is required
          'provider' => 'string',
          // version is required
          'version' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - category => (string: Source | Build | Deploy | Test | Invoke )

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

  - provider => (string)

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

  - version => (string)

    The version of the custom action to delete.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`deletePipeline( array $args = array() )`

Executes the DeletePipeline operation.

Deletes the specified pipeline.

#### Examples

- Basic formatting example

      $result = $client->deletePipeline(array(
          // name is required
          'name' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - name => (string)

    The name of the pipeline to be deleted.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`disableStageTransition( array $args = array() )`

Executes the DisableStageTransition operation.

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

#### Examples

- Basic formatting example

      $result = $client->disableStageTransition(array(
          // pipelineName is required
          'pipelineName' => 'string',
          // stageName is required
          'stageName' => 'string',
          // transitionType is required
          'transitionType' => 'string',
          // reason is required
          'reason' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - pipelineName => (string)

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

  - stageName => (string)

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

  - transitionType => (string: Inbound | Outbound )

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

  - reason => (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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`enableStageTransition( array $args = array() )`

Executes the EnableStageTransition operation.

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

#### Examples

- Basic formatting example

      $result = $client->enableStageTransition(array(
          // pipelineName is required
          'pipelineName' => 'string',
          // stageName is required
          'stageName' => 'string',
          // transitionType is required
          'transitionType' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - pipelineName => (string)

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

  - stageName => (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 => (string: Inbound | Outbound )

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`getJobDetails( array $args = array() )`

Executes the GetJobDetails operation.

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.

#### Examples

- Basic formatting example

      $result = $client->getJobDetails(array(
          // jobId is required
          'jobId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - jobId => (string)

    The unique system-generated ID for the job.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- jobDetails => (associative-array)

  The details of the job.

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

  - id => (string)

    The unique system-generated ID of the job.

  - data => (associative-array)

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

    - actionTypeId => (associative-array)

      Represents information about an action type.

      - category => (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 => (string)

        The creator of the action being called.

      - provider => (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.

      - version => (string)

        A string that identifies the action type.

    - actionConfiguration => (associative-array)

      Represents information about an action configuration.

      - configuration => (associative-array<string>)

        Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

        The configuration data for the action.

        - <string> => (string)
    - pipelineContext => (associative-array)

      Represents information about a pipeline to a job worker.

      - pipelineName => (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 => (associative-array)

        The stage of the pipeline.

        - name => (string)

          The name of the stage.

      - action => (associative-array)

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

        - name => (string)

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

    - inputArtifacts => (array<associative-array>)

      The artifact supplied to the job.

      - (associative-array)

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

        - name => (string)

          The artifact's name.

        - revision => (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).

        - location => (associative-array)

          The location of an artifact.

          - => (associative-array)

            Associative array of custom key value pairs

    - outputArtifacts => (array<associative-array>)

      The output of the job.

      - (associative-array)

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

        - name => (string)

          The artifact's name.

        - revision => (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).

        - location => (associative-array)

          The location of an artifact.

          - => (associative-array)

            Associative array of custom key value pairs

    - artifactCredentials => (associative-array)

      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.

      - accessKeyId => (string)

        The access key for the session.

      - secretAccessKey => (string)

        The secret access key for the session.

      - sessionToken => (string)

        The token for the session.

    - continuationToken => (string)

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

    - encryptionKey => (associative-array)

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

      - => (associative-array)

        Associative array of custom key value pairs

  - accountId => (string)

    The AWS account ID associated with the job.

# `public `Guzzle\Service\Resource\Model``
`getPipeline( array $args = array() )`

Executes the GetPipeline operation.

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.

#### Examples

- Basic formatting example

      $result = $client->getPipeline(array(
          // name is required
          'name' => 'string',
          'version' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - name => (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 => (int)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- pipeline => (associative-array)

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

  - name => (string)

    The name of the action to be performed.

  - roleArn => (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.

  - artifactStore => (associative-array)

    The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.

    - => (associative-array)

      Associative array of custom key value pairs

  - stages => (array<associative-array>)

    The stage in which to perform the action.

    - (associative-array)

      Represents information about a stage and its definition.

      - name => (string)

        The name of the stage.

      - blockers => (array<associative-array>)

        The gates included in a stage.

        - (associative-array)

          Represents information about a gate declaration.

          - => (associative-array)

            Associative array of custom key value pairs

      - actions => (array<associative-array>)

        The actions included in a stage.

        - (associative-array)

          Represents information about an action declaration.

          - name => (string)

            The action declaration's name.

          - actionTypeId => (associative-array)

            The configuration information for the action type.

            - category => (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 => (string)

              The creator of the action being called.

            - provider => (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.

            - version => (string)

              A string that identifies the action type.

          - runOrder => (int)

            The order in which actions are run.

          - configuration => (associative-array<string>)

            Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

            The action declaration's configuration.

            - <string> => (string)
          - outputArtifacts => (array<associative-array>)

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

            - (associative-array)

              Represents information about the output of an action.

              - name => (string)

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

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

                Output artifact names must be unique within a pipeline.

          - inputArtifacts => (array<associative-array>)

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

            - (associative-array)

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

              - name => (string)

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

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

          - roleArn => (string)

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

  - version => (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.

# `public `Guzzle\Service\Resource\Model``
`getPipelineState( array $args = array() )`

Executes the GetPipelineState operation.

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

#### Examples

- Basic formatting example

      $result = $client->getPipelineState(array(
          // name is required
          'name' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - name => (string)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- pipelineName => (string)

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

- pipelineVersion => (int)

  The version number of the pipeline.

  A newly-created pipeline is always assigned a version number of 1.
- stageStates => (array<associative-array>)

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

  - (associative-array)

    Represents information about the state of the stage.

    - stageName => (string)

      The name of the stage.

    - inboundTransitionState => (associative-array)

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

      - enabled => (bool)

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

      - lastChangedBy => (string)

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

      - lastChangedAt => (string)

        The timestamp when the transition state was last changed.

      - disabledReason => (string)

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

    - actionStates => (array<associative-array>)

      The state of the stage.

      - (associative-array)

        Represents information about the state of an action.

        - actionName => (string)

          The name of the action.

        - currentRevision => (associative-array)

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

          - revisionId => (string)

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

          - revisionChangeId => (string)

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

          - created => (string)

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

        - latestExecution => (associative-array)

          Represents information about how an action runs.

          - status => (string)

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

          - summary => (string)

            A summary of the run of the action.

          - lastStatusChange => (string)

            The last status change of the action.

          - externalExecutionId => (string)

            The external ID of the run of the action.

          - externalExecutionUrl => (string)

            The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.

          - percentComplete => (int)

            A percentage of completeness of the action as it runs.

          - errorDetails => (associative-array)

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

            - code => (string)

              The system ID or error number code of the error.

            - message => (string)

              The text of the error message.

        - entityUrl => (string)

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

        - revisionUrl => (string)

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

- created => (string)

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

- updated => (string)

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

# `public `Guzzle\Service\Resource\Model``
`getThirdPartyJobDetails( array $args = array() )`

Executes the GetThirdPartyJobDetails operation.

Requests the details of a job for a third party action. Only used for partner 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.

#### Examples

- Basic formatting example

      $result = $client->getThirdPartyJobDetails(array(
          // jobId is required
          'jobId' => 'string',
          // clientToken is required
          'clientToken' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - jobId => (string)

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

  - clientToken => (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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- jobDetails => (associative-array)

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

  - id => (string)

    The identifier used to identify the job details in AWS CodePipeline.

  - data => (associative-array)

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

    - actionTypeId => (associative-array)

      Represents information about an action type.

      - category => (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 => (string)

        The creator of the action being called.

      - provider => (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.

      - version => (string)

        A string that identifies the action type.

    - actionConfiguration => (associative-array)

      Represents information about an action configuration.

      - configuration => (associative-array<string>)

        Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

        The configuration data for the action.

        - <string> => (string)
    - pipelineContext => (associative-array)

      Represents information about a pipeline to a job worker.

      - pipelineName => (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 => (associative-array)

        The stage of the pipeline.

        - name => (string)

          The name of the stage.

      - action => (associative-array)

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

        - name => (string)

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

    - inputArtifacts => (array<associative-array>)

      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.

      - (associative-array)

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

        - name => (string)

          The artifact's name.

        - revision => (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).

        - location => (associative-array)

          The location of an artifact.

          - => (associative-array)

            Associative array of custom key value pairs

    - outputArtifacts => (array<associative-array>)

      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.

      - (associative-array)

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

        - name => (string)

          The artifact's name.

        - revision => (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).

        - location => (associative-array)

          The location of an artifact.

          - => (associative-array)

            Associative array of custom key value pairs

    - artifactCredentials => (associative-array)

      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.

      - accessKeyId => (string)

        The access key for the session.

      - secretAccessKey => (string)

        The secret access key for the session.

      - sessionToken => (string)

        The token for the session.

    - continuationToken => (string)

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

    - encryptionKey => (associative-array)

      The AWS Key Management Service (AWS KMS) key used to encrypt and decrypt data in the artifact store for the pipeline.

      - => (associative-array)

        Associative array of custom key value pairs

  - nonce => (string)

    A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.

# `public `Guzzle\Service\Resource\Model``
`listActionTypes( array $args = array() )`

Executes the ListActionTypes operation.

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

#### Examples

- Basic formatting example

      $result = $client->listActionTypes(array(
          'actionOwnerFilter' => 'string',
          'nextToken' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - actionOwnerFilter => (string: AWS | ThirdParty | Custom )

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

  - nextToken => (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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- actionTypes => (array<associative-array>)

  Provides details of the action types.

  - (associative-array)

    Returns information about the details of an action type.

    - id => (associative-array)

      Represents information about an action type.

      - category => (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 => (string)

        The creator of the action being called.

      - provider => (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.

      - version => (string)

        A string that identifies the action type.

    - settings => (associative-array)

      The settings for the action type.

      - thirdPartyConfigurationUrl => (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.

      - entityUrlTemplate => (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 => (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 => (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.

    - actionConfigurationProperties => (array<associative-array>)

      The configuration properties for the action type.

      - (associative-array)

        Represents information about an action configuration property.

        - => (associative-array)

          Associative array of custom key value pairs

    - inputArtifactDetails => (associative-array)

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

      - minimumCount => (int)

        The minimum number of artifacts allowed for the action type.

      - maximumCount => (int)

        The maximum number of artifacts allowed for the action type.

    - outputArtifactDetails => (associative-array)

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

      - minimumCount => (int)

        The minimum number of artifacts allowed for the action type.

      - maximumCount => (int)

        The maximum number of artifacts allowed for the action type.

- nextToken => (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.

# `public `Guzzle\Service\Resource\Model``
`listPipelines( array $args = array() )`

Executes the ListPipelines operation.

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

#### Examples

- Basic formatting example

      $result = $client->listPipelines(array(
          'nextToken' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - nextToken => (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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- pipelines => (array<associative-array>)

  The list of pipelines.

  - (associative-array)

    Returns a summary of a pipeline.

    - name => (string)

      The name of the pipeline.

    - version => (int)

      The version number of the pipeline.

    - created => (string)

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

    - updated => (string)

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

- nextToken => (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.

# `public `Guzzle\Service\Resource\Model``
`pollForJobs( array $args = array() )`

Executes the PollForJobs operation.

Returns information about any jobs for AWS CodePipeline to act upon.

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.

#### Examples

- Basic formatting example

      $result = $client->pollForJobs(array(
          // actionTypeId is required
          'actionTypeId' => array(
              // category is required
              'category' => 'string',
              // owner is required
              'owner' => 'string',
              // provider is required
              'provider' => 'string',
              // version is required
              'version' => 'string',
          ),
          'maxBatchSize' => integer,
          'queryParam' => array(
              // Associative array of custom 'ActionConfigurationKey' key names
              'ActionConfigurationKey' => 'string',
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - actionTypeId => (associative-array)

    Represents information about an action type.

    - category => (string: Source | Build | Deploy | Test | Invoke )

      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 => (string: AWS | ThirdParty | Custom )

      The creator of the action being called.

    - provider => (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.

    - version => (string)

      A string that identifies the action type.

  - maxBatchSize => (int)

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

  - queryParam => (associative-array<string>)

    Associative array of <ActionConfigurationKey> keys mapping to (string) values. Each array key should be changed to an appropriate <ActionConfigurationKey>.

    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.

    - <ActionConfigurationKey> => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- jobs => (array<associative-array>)

  Information about the jobs to take action on.

  - (associative-array)

    Represents information about a job.

    - id => (string)

      The unique system-generated ID of the job.

    - data => (associative-array)

      Additional data about a job.

      - actionTypeId => (associative-array)

        Represents information about an action type.

        - category => (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 => (string)

          The creator of the action being called.

        - provider => (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.

        - version => (string)

          A string that identifies the action type.

      - actionConfiguration => (associative-array)

        Represents information about an action configuration.

        - configuration => (associative-array<string>)

          Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

          The configuration data for the action.

          - <string> => (string)
      - pipelineContext => (associative-array)

        Represents information about a pipeline to a job worker.

        - pipelineName => (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 => (associative-array)

          The stage of the pipeline.

          - name => (string)

            The name of the stage.

        - action => (associative-array)

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

          - name => (string)

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

      - inputArtifacts => (array<associative-array>)

        The artifact supplied to the job.

        - (associative-array)

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

          - name => (string)

            The artifact's name.

          - revision => (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).

          - location => (associative-array)

            The location of an artifact.

            - => (associative-array)

              Associative array of custom key value pairs

      - outputArtifacts => (array<associative-array>)

        The output of the job.

        - (associative-array)

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

          - name => (string)

            The artifact's name.

          - revision => (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).

          - location => (associative-array)

            The location of an artifact.

            - => (associative-array)

              Associative array of custom key value pairs

      - artifactCredentials => (associative-array)

        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.

        - accessKeyId => (string)

          The access key for the session.

        - secretAccessKey => (string)

          The secret access key for the session.

        - sessionToken => (string)

          The token for the session.

      - continuationToken => (string)

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

      - encryptionKey => (associative-array)

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

        - => (associative-array)

          Associative array of custom key value pairs

    - nonce => (string)

      A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. This number must be returned in the response.

    - accountId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`pollForThirdPartyJobs( array $args = array() )`

Executes the PollForThirdPartyJobs operation.

Determines whether there are any third party jobs for a job worker to act on. Only used for partner 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.

#### Examples

- Basic formatting example

      $result = $client->pollForThirdPartyJobs(array(
          // actionTypeId is required
          'actionTypeId' => array(
              // category is required
              'category' => 'string',
              // owner is required
              'owner' => 'string',
              // provider is required
              'provider' => 'string',
              // version is required
              'version' => 'string',
          ),
          'maxBatchSize' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - actionTypeId => (associative-array)

    Represents information about an action type.

    - category => (string: Source | Build | Deploy | Test | Invoke )

      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 => (string: AWS | ThirdParty | Custom )

      The creator of the action being called.

    - provider => (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.

    - version => (string)

      A string that identifies the action type.

  - maxBatchSize => (int)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- jobs => (array<associative-array>)

  Information about the jobs to take action on.

  - (associative-array)

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

    - clientId => (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 => (string)

      The identifier used to identify the job in AWS CodePipeline.

# `public `Guzzle\Service\Resource\Model``
`putActionRevision( array $args = array() )`

Executes the PutActionRevision operation.

Provides information to AWS CodePipeline about new revisions to a source.

#### Examples

- Basic formatting example

      $result = $client->putActionRevision(array(
          // pipelineName is required
          'pipelineName' => 'string',
          // stageName is required
          'stageName' => 'string',
          // actionName is required
          'actionName' => 'string',
          // actionRevision is required
          'actionRevision' => array(
              // revisionId is required
              'revisionId' => 'string',
              'revisionChangeId' => 'string',
              // created is required
              'created' => 'mixed type: string (date format)|int (unix timestamp)|\DateTime',
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - pipelineName => (string)

    The name of the pipeline that will start processing the revision to the source.

  - stageName => (string)

    The name of the stage that contains the action that will act upon the revision.

  - actionName => (string)

    The name of the action that will process the revision.

  - actionRevision => (associative-array)

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

    - revisionId => (string)

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

    - revisionChangeId => (string)

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

    - created => (string [date format]|int [unix timestamp]|\DateTime)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- newRevision => (bool)

  The new revision number or ID for the revision after the action completes.

- pipelineExecutionId => (string)

  The ID of the current workflow state of the pipeline.

# `public `Guzzle\Service\Resource\Model``
`putJobFailureResult( array $args = array() )`

Executes the PutJobFailureResult operation.

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

#### Examples

- Basic formatting example

      $result = $client->putJobFailureResult(array(
          // jobId is required
          'jobId' => 'string',
          // failureDetails is required
          'failureDetails' => array(
              '' => array(
                  // Associative array of custom key value pairs
              ),
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - jobId => (string)

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

  - failureDetails => (associative-array)

    The details about the failure of a job.

    - => (associative-array)

      Associative array of custom key value pairs

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`putJobSuccessResult( array $args = array() )`

Executes the PutJobSuccessResult operation.

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

#### Examples

- Basic formatting example

      $result = $client->putJobSuccessResult(array(
          // jobId is required
          'jobId' => 'string',
          'currentRevision' => array(
              // revision is required
              'revision' => 'string',
              // changeIdentifier is required
              'changeIdentifier' => 'string',
          ),
          'continuationToken' => 'string',
          'executionDetails' => array(
              'summary' => 'string',
              'externalExecutionId' => 'string',
              'percentComplete' => integer,
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - jobId => (string)

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

  - currentRevision => (associative-array)

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

    - revision => (string)

      The revision ID of the current version of an artifact.

    - changeIdentifier => (string)

      The change identifier for the current revision.

  - continuationToken => (string)

    A system-generated token, such as a AWS CodeDeploy deployment ID, that the successful job used to complete a job asynchronously.

  - executionDetails => (associative-array)

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

    - summary => (string)

      The summary of the current status of the actions.

    - externalExecutionId => (string)

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

    - percentComplete => (int)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`putThirdPartyJobFailureResult( array $args = array() )`

Executes the PutThirdPartyJobFailureResult operation.

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

#### Examples

- Basic formatting example

      $result = $client->putThirdPartyJobFailureResult(array(
          // jobId is required
          'jobId' => 'string',
          // clientToken is required
          'clientToken' => 'string',
          // failureDetails is required
          'failureDetails' => array(
              '' => array(
                  // Associative array of custom key value pairs
              ),
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - jobId => (string)

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

  - clientToken => (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 => (associative-array)

    Represents information about failure details.

    - => (associative-array)

      Associative array of custom key value pairs

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`putThirdPartyJobSuccessResult( array $args = array() )`

Executes the PutThirdPartyJobSuccessResult operation.

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

#### Examples

- Basic formatting example

      $result = $client->putThirdPartyJobSuccessResult(array(
          // jobId is required
          'jobId' => 'string',
          // clientToken is required
          'clientToken' => 'string',
          'currentRevision' => array(
              // revision is required
              'revision' => 'string',
              // changeIdentifier is required
              'changeIdentifier' => 'string',
          ),
          'continuationToken' => 'string',
          'executionDetails' => array(
              'summary' => 'string',
              'externalExecutionId' => 'string',
              'percentComplete' => integer,
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - jobId => (string)

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

  - clientToken => (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.

  - currentRevision => (associative-array)

    Represents information about a current revision.

    - revision => (string)

      The revision ID of the current version of an artifact.

    - changeIdentifier => (string)

      The change identifier for the current revision.

  - continuationToken => (string)

    A system-generated token, such as a AWS CodeDeploy deployment ID, that a job uses in order to continue the job asynchronously.

  - executionDetails => (associative-array)

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

    - summary => (string)

      The summary of the current status of the actions.

    - externalExecutionId => (string)

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

    - percentComplete => (int)

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

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`startPipelineExecution( array $args = array() )`

Executes the StartPipelineExecution operation.

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

#### Examples

- Basic formatting example

      $result = $client->startPipelineExecution(array(
          // name is required
          'name' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - name => (string)

    The name of the pipeline to start.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- pipelineExecutionId => (string)

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

# `public `Guzzle\Service\Resource\Model``
`updatePipeline( array $args = array() )`

Executes the UpdatePipeline operation.

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.

#### Examples

- Basic formatting example

      $result = $client->updatePipeline(array(
          // pipeline is required
          'pipeline' => array(
              // name is required
              'name' => 'string',
              // roleArn is required
              'roleArn' => 'string',
              // artifactStore is required
              'artifactStore' => array(
                  '' => array(
                      // Associative array of custom key value pairs
                  ),
              ),
              // stages is required
              'stages' => array(
                  array(
                      // name is required
                      'name' => 'string',
                      'blockers' => array(
                          array(
                              '' => array(
                                  // Associative array of custom key value pairs
                              ),
                          ),
                          // ... repeated
                      ),
                      // actions is required
                      'actions' => array(
                          array(
                              // name is required
                              'name' => 'string',
                              // actionTypeId is required
                              'actionTypeId' => array(
                                  // category is required
                                  'category' => 'string',
                                  // owner is required
                                  'owner' => 'string',
                                  // provider is required
                                  'provider' => 'string',
                                  // version is required
                                  'version' => 'string',
                              ),
                              'runOrder' => integer,
                              'configuration' => array(
                                  // Associative array of custom 'ActionConfigurationKey' key names
                                  'ActionConfigurationKey' => 'string',
                                  // ... repeated
                              ),
                              'inputArtifacts' => array(
                                  array(
                                      // name is required
                                      'name' => 'string',
                                  ),
                                  // ... repeated
                              ),
                              'roleArn' => 'string',
                          ),
                          // ... repeated
                      ),
                  ),
                  // ... repeated
              ),
              'version' => integer,
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - pipeline => (associative-array)

    The name of the pipeline to be updated.

    - name => (string)

      The name of the action to be performed.

    - roleArn => (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.

    - artifactStore => (associative-array)

      The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.

      - => (associative-array)

        Associative array of custom key value pairs

    - stages => (array<associative-array>)

      The stage in which to perform the action.

      - (associative-array)

        Represents information about a stage and its definition.

        - name => (string)

          The name of the stage.

        - blockers => (array<associative-array>)

          The gates included in a stage.

          - (associative-array)

            Represents information about a gate declaration.

            - => (associative-array)

              Associative array of custom key value pairs

        - actions => (array<associative-array>)

          The actions included in a stage.

          - (associative-array)

            Represents information about an action declaration.

            - name => (string)

              The action declaration's name.

            - actionTypeId => (associative-array)

              The configuration information for the action type.

              - category => (string: Source | Build | Deploy | Test | Invoke )

                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 => (string: AWS | ThirdParty | Custom )

                The creator of the action being called.

              - provider => (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.

              - version => (string)

                A string that identifies the action type.

            - runOrder => (int)

              The order in which actions are run.

            - configuration => (associative-array<string>)

              Associative array of <ActionConfigurationKey> keys mapping to (string) values. Each array key should be changed to an appropriate <ActionConfigurationKey>.

              The action declaration's configuration.

              - <ActionConfigurationKey> => (string)
            - inputArtifacts => (array<associative-array>)

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

              - (associative-array)

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

                - name => (string)

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

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

            - roleArn => (string)

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

    - version => (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.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- pipeline => (associative-array)

  The structure of the updated pipeline.

  - name => (string)

    The name of the action to be performed.

  - roleArn => (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.

  - artifactStore => (associative-array)

    The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.

    - => (associative-array)

      Associative array of custom key value pairs

  - stages => (array<associative-array>)

    The stage in which to perform the action.

    - (associative-array)

      Represents information about a stage and its definition.

      - name => (string)

        The name of the stage.

      - blockers => (array<associative-array>)

        The gates included in a stage.

        - (associative-array)

          Represents information about a gate declaration.

          - => (associative-array)

            Associative array of custom key value pairs

      - actions => (array<associative-array>)

        The actions included in a stage.

        - (associative-array)

          Represents information about an action declaration.

          - name => (string)

            The action declaration's name.

          - actionTypeId => (associative-array)

            The configuration information for the action type.

            - category => (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 => (string)

              The creator of the action being called.

            - provider => (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.

            - version => (string)

              A string that identifies the action type.

          - runOrder => (int)

            The order in which actions are run.

          - configuration => (associative-array<string>)

            Associative array of <string> keys mapping to (string) values. Each array key should be changed to an appropriate <string>.

            The action declaration's configuration.

            - <string> => (string)
          - outputArtifacts => (array<associative-array>)

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

            - (associative-array)

              Represents information about the output of an action.

              - name => (string)

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

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

                Output artifact names must be unique within a pipeline.

          - inputArtifacts => (array<associative-array>)

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

            - (associative-array)

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

              - name => (string)

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

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

          - roleArn => (string)

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

  - version => (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.

### Methods inherited from Aws\Common\Client\AbstractClient

`__call()`, `__construct()`, `createRequest()`, `getAllEvents()`, `getApiVersion()`, `getCredentials()`, `getRegion()`, `getRegions()`, `getSignature()`, `getWaiter()`, `getWaiterFactory()`, `send()`, `setCredentials()`, `setRegion()`, `setWaiterFactory()`, `waitUntil()`

### Methods inherited from Guzzle\Service\Client

`execute()`, `executeMultiple()`, `getCommand()`, `getCommandFactory()`, `getDescription()`, `getInflector()`, `getIterator()`, `getResourceIteratorFactory()`, `prepareCommand()`, `setCommandFactory()`, `setDescription()`, `setInflector()`, `setResourceIteratorFactory()`

### Methods inherited from Guzzle\Http\Client

`delete()`, `expandTemplate()`, `extractPharCacert()`, `get()`, `getBaseUrl()`, `getConfig()`, `getCurlMulti()`, `getDefaultOption()`, `getDefaultUserAgent()`, `getUriTemplate()`, `head()`, `initSsl()`, `options()`, `patch()`, `post()`, `prepareRequest()`, `put()`, `sendMultiple()`, `setBaseUrl()`, `setConfig()`, `setCurlMulti()`, `setDefaultOption()`, `setRequestFactory()`, `setSslVerification()`, `setUriTemplate()`, `setUserAgent()`

### Methods inherited from Guzzle\Common\AbstractHasDispatcher

`addSubscriber()`, `dispatch()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary

## Constants summary

`string` | `LATEST_API_VERSION` | `'2015-07-09'` | #

### Constants inherited from Guzzle\Service\Client

`COMMAND_PARAMS`

### Constants inherited from Guzzle\Http\Client

`CURL_OPTIONS`, `DEFAULT_SELECT_TIMEOUT`, `DISABLE_REDIRECTS`, `MAX_HANDLES`, `REQUEST_OPTIONS`, `SSL_CERT_AUTHORITY`

### Constants inherited from Guzzle\Http\ClientInterface

`CREATE_REQUEST`, `HTTP_DATE`

## Properties summary

### Properties inherited from Aws\Common\Client\AbstractClient

`$aggregator`, `$credentials`, `$signature`, `$waiterFactory`

### Properties inherited from Guzzle\Service\Client

`$commandFactory`, `$inflector`, `$resourceIteratorFactory`, `$serviceDescription`

### Properties inherited from Guzzle\Http\Client

`$defaultHeaders`, `$requestFactory`, `$userAgent`

### Properties inherited from Guzzle\Common\AbstractHasDispatcher

`$eventDispatcher`