Class: AWS.CodePipeline

Inherits:
AWS.Service show all
Identifier:
codepipeline
API Version:
2015-07-09
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using CodePipeline

var codepipeline = new AWS.CodePipeline();
codepipeline.acknowledgeJob(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodePipeline object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codepipeline = new AWS.CodePipeline({apiVersion: '2015-07-09'});

You can also set the API version globally in AWS.config.apiVersions using the codepipeline service identifier:

AWS.config.apiVersions = {
  codepipeline: '2015-07-09',
  // other service API versions
};

var codepipeline = new AWS.CodePipeline();

Version:

  • 2015-07-09

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CodePipeline(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CodePipeline object

var codepipeline = new AWS.CodePipeline({apiVersion: '2015-07-09'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.CodePipeline.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.CodePipeline.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CodePipeline.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

acknowledgeJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the acknowledgeJob operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  nonce: 'STRING_VALUE' /* required */
};
codepipeline.acknowledgeJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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. Get this number from the response of the PollForJobs request that returned this job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

        Whether the job worker has received the specified job.

        Possible values include:
        • "Created"
        • "Queued"
        • "Dispatched"
        • "InProgress"
        • "TimedOut"
        • "Succeeded"
        • "Failed"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

acknowledgeThirdPartyJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the acknowledgeThirdPartyJob operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE', /* required */
  nonce: 'STRING_VALUE' /* required */
};
codepipeline.acknowledgeThirdPartyJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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. Get this number from the response to a GetThirdPartyJobDetails request.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • status — (String)

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

        Possible values include:
        • "Created"
        • "Queued"
        • "Dispatched"
        • "InProgress"
        • "TimedOut"
        • "Succeeded"
        • "Failed"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCustomActionType(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createCustomActionType operation

var params = {
  category: Source | Build | Deploy | Test | Invoke | Approval, /* required */
  inputArtifactDetails: { /* required */
    maximumCount: 0, /* required */
    minimumCount: 0 /* required */
  },
  outputArtifactDetails: { /* required */
    maximumCount: 0, /* required */
    minimumCount: 0 /* required */
  },
  provider: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE', /* required */
  configurationProperties: [
    {
      key: true || false, /* required */
      name: 'STRING_VALUE', /* required */
      required: true || false, /* required */
      secret: true || false, /* required */
      description: 'STRING_VALUE',
      queryable: true || false,
      type: String | Number | Boolean
    },
    /* more items */
  ],
  settings: {
    entityUrlTemplate: 'STRING_VALUE',
    executionUrlTemplate: 'STRING_VALUE',
    revisionUrlTemplate: 'STRING_VALUE',
    thirdPartyConfigurationUrl: 'STRING_VALUE'
  }
};
codepipeline.createCustomActionType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • category — (String)

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

      Note: Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.
      Possible values include:
      • "Source"
      • "Build"
      • "Deploy"
      • "Test"
      • "Invoke"
      • "Approval"
    • provider — (String)

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

    • version — (String)

      The version identifier of the custom action.

    • settings — (map)

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

      The configuration properties for the custom action.

      Note: You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.
      • namerequired — (String)

        The name of the action configuration property.

      • requiredrequired — (Boolean)

        Whether the configuration property is a required value.

      • keyrequired — (Boolean)

        Whether the configuration property is a key.

      • secretrequired — (Boolean)

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

        When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

      • queryable — (Boolean)

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

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

      • description — (String)

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

      • type — (String)

        The type of the configuration property.

        Possible values include:
        • "String"
        • "Number"
        • "Boolean"
    • inputArtifactDetails — (map)

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

      • minimumCountrequired — (Integer)

        The minimum number of artifacts allowed for the action type.

      • maximumCountrequired — (Integer)

        The maximum number of artifacts allowed for the action type.

    • outputArtifactDetails — (map)

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

      • minimumCountrequired — (Integer)

        The minimum number of artifacts allowed for the action type.

      • maximumCountrequired — (Integer)

        The maximum number of artifacts allowed for the action type.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • actionType — (map)

        Returns information about the details of an action type.

        • idrequired — (map)

          Represents information about an action type.

          • categoryrequired — (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.

            Possible values include:
            • "Source"
            • "Build"
            • "Deploy"
            • "Test"
            • "Invoke"
            • "Approval"
          • ownerrequired — (String)

            The creator of the action being called.

            Possible values include:
            • "AWS"
            • "ThirdParty"
            • "Custom"
          • providerrequired — (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.

          • versionrequired — (String)

            A string that identifies the action type.

        • settings — (map)

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

          The configuration properties for the action type.

          • namerequired — (String)

            The name of the action configuration property.

          • requiredrequired — (Boolean)

            Whether the configuration property is a required value.

          • keyrequired — (Boolean)

            Whether the configuration property is a key.

          • secretrequired — (Boolean)

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

            When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

          • queryable — (Boolean)

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

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

          • description — (String)

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

          • type — (String)

            The type of the configuration property.

            Possible values include:
            • "String"
            • "Number"
            • "Boolean"
        • inputArtifactDetailsrequired — (map)

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

          • minimumCountrequired — (Integer)

            The minimum number of artifacts allowed for the action type.

          • maximumCountrequired — (Integer)

            The maximum number of artifacts allowed for the action type.

        • outputArtifactDetailsrequired — (map)

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

          • minimumCountrequired — (Integer)

            The minimum number of artifacts allowed for the action type.

          • maximumCountrequired — (Integer)

            The maximum number of artifacts allowed for the action type.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createPipeline(params = {}, callback) ⇒ AWS.Request

Creates a pipeline.

Service Reference:

Examples:

Calling the createPipeline operation

var params = {
  pipeline: { /* required */
    artifactStore: { /* required */
      location: 'STRING_VALUE', /* required */
      type: S3, /* required */
      encryptionKey: {
        id: 'STRING_VALUE', /* required */
        type: KMS /* required */
      }
    },
    name: 'STRING_VALUE', /* required */
    roleArn: 'STRING_VALUE', /* required */
    stages: [ /* required */
      {
        actions: [ /* required */
          {
            actionTypeId: { /* required */
              category: Source | Build | Deploy | Test | Invoke | Approval, /* required */
              owner: AWS | ThirdParty | Custom, /* required */
              provider: 'STRING_VALUE', /* required */
              version: 'STRING_VALUE' /* required */
            },
            name: 'STRING_VALUE', /* required */
            configuration: {
              '<ActionConfigurationKey>': 'STRING_VALUE',
              /* '<ActionConfigurationKey>': ... */
            },
            inputArtifacts: [
              {
                name: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            outputArtifacts: [
              {
                name: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            roleArn: 'STRING_VALUE',
            runOrder: 0
          },
          /* more items */
        ],
        name: 'STRING_VALUE', /* required */
        blockers: [
          {
            name: 'STRING_VALUE', /* required */
            type: Schedule /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    version: 0
  }
};
codepipeline.createPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • pipeline — (map)

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

      • namerequired — (String)

        The name of the action to be performed.

      • roleArnrequired — (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.

      • artifactStorerequired — (map)

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

        • typerequired — (String)

          The type of the artifact store, such as S3.

          Possible values include:
          • "S3"
        • locationrequired — (String)

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

        • encryptionKey — (map)

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

          • idrequired — (String)

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

          • typerequired — (String)

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

            Possible values include:
            • "KMS"
      • stagesrequired — (Array<map>)

        The stage in which to perform the action.

        • namerequired — (String)

          The name of the stage.

        • blockers — (Array<map>)

          Reserved for future use.

          • namerequired — (String)

            Reserved for future use.

          • typerequired — (String)

            Reserved for future use.

            Possible values include:
            • "Schedule"
        • actionsrequired — (Array<map>)

          The actions included in a stage.

          • namerequired — (String)

            The action declaration's name.

          • actionTypeIdrequired — (map)

            The configuration information for the action type.

            • categoryrequired — (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.

              Possible values include:
              • "Source"
              • "Build"
              • "Deploy"
              • "Test"
              • "Invoke"
              • "Approval"
            • ownerrequired — (String)

              The creator of the action being called.

              Possible values include:
              • "AWS"
              • "ThirdParty"
              • "Custom"
            • providerrequired — (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.

            • versionrequired — (String)

              A string that identifies the action type.

          • runOrder — (Integer)

            The order in which actions are run.

          • configuration — (map<String>)

            The action declaration's configuration.

          • outputArtifacts — (Array<map>)

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

            • namerequired — (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<map>)

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

            • namerequired — (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 — (Integer)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipeline — (map)

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

        • namerequired — (String)

          The name of the action to be performed.

        • roleArnrequired — (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.

        • artifactStorerequired — (map)

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

          • typerequired — (String)

            The type of the artifact store, such as S3.

            Possible values include:
            • "S3"
          • locationrequired — (String)

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

          • encryptionKey — (map)

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

            • idrequired — (String)

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

            • typerequired — (String)

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

              Possible values include:
              • "KMS"
        • stagesrequired — (Array<map>)

          The stage in which to perform the action.

          • namerequired — (String)

            The name of the stage.

          • blockers — (Array<map>)

            Reserved for future use.

            • namerequired — (String)

              Reserved for future use.

            • typerequired — (String)

              Reserved for future use.

              Possible values include:
              • "Schedule"
          • actionsrequired — (Array<map>)

            The actions included in a stage.

            • namerequired — (String)

              The action declaration's name.

            • actionTypeIdrequired — (map)

              The configuration information for the action type.

              • categoryrequired — (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.

                Possible values include:
                • "Source"
                • "Build"
                • "Deploy"
                • "Test"
                • "Invoke"
                • "Approval"
              • ownerrequired — (String)

                The creator of the action being called.

                Possible values include:
                • "AWS"
                • "ThirdParty"
                • "Custom"
              • providerrequired — (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.

              • versionrequired — (String)

                A string that identifies the action type.

            • runOrder — (Integer)

              The order in which actions are run.

            • configuration — (map<String>)

              The action declaration's configuration.

            • outputArtifacts — (Array<map>)

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

              • namerequired — (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<map>)

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

              • namerequired — (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 — (Integer)

          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:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteCustomActionType(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteCustomActionType operation

var params = {
  category: Source | Build | Deploy | Test | Invoke | Approval, /* required */
  provider: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE' /* required */
};
codepipeline.deleteCustomActionType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • category — (String)

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

      Possible values include:
      • "Source"
      • "Build"
      • "Deploy"
      • "Test"
      • "Invoke"
      • "Approval"
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deletePipeline(params = {}, callback) ⇒ AWS.Request

Deletes the specified pipeline.

Service Reference:

Examples:

Calling the deletePipeline operation

var params = {
  name: 'STRING_VALUE' /* required */
};
codepipeline.deletePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the pipeline to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disableStageTransition(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the disableStageTransition operation

var params = {
  pipelineName: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE', /* required */
  stageName: 'STRING_VALUE', /* required */
  transitionType: Inbound | Outbound /* required */
};
codepipeline.disableStageTransition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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)

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

      Possible values include:
      • "Inbound"
      • "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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

enableStageTransition(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the enableStageTransition operation

var params = {
  pipelineName: 'STRING_VALUE', /* required */
  stageName: 'STRING_VALUE', /* required */
  transitionType: Inbound | Outbound /* required */
};
codepipeline.enableStageTransition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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)

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

      Possible values include:
      • "Inbound"
      • "Outbound"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getJobDetails(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getJobDetails operation

var params = {
  jobId: 'STRING_VALUE' /* required */
};
codepipeline.getJobDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobId — (String)

      The unique system-generated ID for the job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobDetails — (map)

        The details of the job.

        Note: 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 — (map)

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

          • actionTypeId — (map)

            Represents information about an action type.

            • categoryrequired — (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.

              Possible values include:
              • "Source"
              • "Build"
              • "Deploy"
              • "Test"
              • "Invoke"
              • "Approval"
            • ownerrequired — (String)

              The creator of the action being called.

              Possible values include:
              • "AWS"
              • "ThirdParty"
              • "Custom"
            • providerrequired — (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.

            • versionrequired — (String)

              A string that identifies the action type.

          • actionConfiguration — (map)

            Represents information about an action configuration.

            • configuration — (map<String>)

              The configuration data for the action.

          • pipelineContext — (map)

            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 — (map)

              The stage of the pipeline.

              • name — (String)

                The name of the stage.

            • action — (map)

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

              • name — (String)

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

          • inputArtifacts — (Array<map>)

            The artifact supplied to the job.

            • 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 — (map)

              The location of an artifact.

              • type — (String)

                The type of artifact in the location.

                Possible values include:
                • "S3"
              • s3Location — (map)

                The Amazon S3 bucket that contains the artifact.

                • bucketNamerequired — (String)

                  The name of the Amazon S3 bucket.

                • objectKeyrequired — (String)

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

          • outputArtifacts — (Array<map>)

            The output of the job.

            • 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 — (map)

              The location of an artifact.

              • type — (String)

                The type of artifact in the location.

                Possible values include:
                • "S3"
              • s3Location — (map)

                The Amazon S3 bucket that contains the artifact.

                • bucketNamerequired — (String)

                  The name of the Amazon S3 bucket.

                • objectKeyrequired — (String)

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

          • artifactCredentials — (map)

            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.

            • accessKeyIdrequired — (String)

              The access key for the session.

            • secretAccessKeyrequired — (String)

              The secret access key for the session.

            • sessionTokenrequired — (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 — (map)

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

            • idrequired — (String)

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

            • typerequired — (String)

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

              Possible values include:
              • "KMS"
        • accountId — (String)

          The AWS account ID associated with the job.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPipeline(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getPipeline operation

var params = {
  name: 'STRING_VALUE', /* required */
  version: 0
};
codepipeline.getPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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 — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipeline — (map)

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

        • namerequired — (String)

          The name of the action to be performed.

        • roleArnrequired — (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.

        • artifactStorerequired — (map)

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

          • typerequired — (String)

            The type of the artifact store, such as S3.

            Possible values include:
            • "S3"
          • locationrequired — (String)

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

          • encryptionKey — (map)

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

            • idrequired — (String)

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

            • typerequired — (String)

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

              Possible values include:
              • "KMS"
        • stagesrequired — (Array<map>)

          The stage in which to perform the action.

          • namerequired — (String)

            The name of the stage.

          • blockers — (Array<map>)

            Reserved for future use.

            • namerequired — (String)

              Reserved for future use.

            • typerequired — (String)

              Reserved for future use.

              Possible values include:
              • "Schedule"
          • actionsrequired — (Array<map>)

            The actions included in a stage.

            • namerequired — (String)

              The action declaration's name.

            • actionTypeIdrequired — (map)

              The configuration information for the action type.

              • categoryrequired — (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.

                Possible values include:
                • "Source"
                • "Build"
                • "Deploy"
                • "Test"
                • "Invoke"
                • "Approval"
              • ownerrequired — (String)

                The creator of the action being called.

                Possible values include:
                • "AWS"
                • "ThirdParty"
                • "Custom"
              • providerrequired — (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.

              • versionrequired — (String)

                A string that identifies the action type.

            • runOrder — (Integer)

              The order in which actions are run.

            • configuration — (map<String>)

              The action declaration's configuration.

            • outputArtifacts — (Array<map>)

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

              • namerequired — (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<map>)

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

              • namerequired — (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 — (Integer)

          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.

      • metadata — (map)

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

        • pipelineArn — (String)

          The Amazon Resource Name (ARN) of the pipeline.

        • created — (Date)

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

        • updated — (Date)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPipelineExecution(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getPipelineExecution operation

var params = {
  pipelineExecutionId: 'STRING_VALUE', /* required */
  pipelineName: 'STRING_VALUE' /* required */
};
codepipeline.getPipelineExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • pipelineName — (String)

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

    • pipelineExecutionId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipelineExecution — (map)

        Represents information about the execution of a pipeline.

        • pipelineName — (String)

          The name of the pipeline that was executed.

        • pipelineVersion — (Integer)

          The version number of the pipeline that was executed.

        • pipelineExecutionId — (String)

          The ID of the pipeline execution.

        • status — (String)

          The status of the pipeline execution.

          • InProgress: The pipeline execution is currently running.

          • Succeeded: The pipeline execution was completed successfully.

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

          • Failed: The pipeline execution was not completed successfully.

          Possible values include:
          • "InProgress"
          • "Succeeded"
          • "Superseded"
          • "Failed"
        • artifactRevisions — (Array<map>)

          A list of ArtifactRevision objects included in a pipeline execution.

          • name — (String)

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

          • revisionId — (String)

            The revision ID of the artifact.

          • revisionChangeIdentifier — (String)

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

          • revisionSummary — (String)

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

          • created — (Date)

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

          • revisionUrl — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPipelineState(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getPipelineState operation

var params = {
  name: 'STRING_VALUE' /* required */
};
codepipeline.getPipelineState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipelineName — (String)

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

      • pipelineVersion — (Integer)

        The version number of the pipeline.

        Note: A newly-created pipeline is always assigned a version number of 1.
      • stageStates — (Array<map>)

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

        • stageName — (String)

          The name of the stage.

        • inboundTransitionState — (map)

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

          • enabled — (Boolean)

            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 — (Date)

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

          The state of the stage.

          • actionName — (String)

            The name of the action.

          • currentRevision — (map)

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

            • revisionIdrequired — (String)

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

            • revisionChangeIdrequired — (String)

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

            • createdrequired — (Date)

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

          • latestExecution — (map)

            Represents information about the run of an action.

            • status — (String)

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

              Possible values include:
              • "InProgress"
              • "Succeeded"
              • "Failed"
            • summary — (String)

              A summary of the run of the action.

            • lastStatusChange — (Date)

              The last status change of the action.

            • token — (String)

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

            • lastUpdatedBy — (String)

              The ARN of the user who last changed the pipeline.

            • 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 — (Integer)

              A percentage of completeness of the action as it runs.

            • errorDetails — (map)

              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.

        • latestExecution — (map)

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

          • pipelineExecutionIdrequired — (String)

            The ID of the pipeline execution associated with the stage.

          • statusrequired — (String)

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

            Possible values include:
            • "InProgress"
            • "Failed"
            • "Succeeded"
      • created — (Date)

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

      • updated — (Date)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getThirdPartyJobDetails(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getThirdPartyJobDetails operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE' /* required */
};
codepipeline.getThirdPartyJobDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobDetails — (map)

        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 — (map)

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

          • actionTypeId — (map)

            Represents information about an action type.

            • categoryrequired — (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.

              Possible values include:
              • "Source"
              • "Build"
              • "Deploy"
              • "Test"
              • "Invoke"
              • "Approval"
            • ownerrequired — (String)

              The creator of the action being called.

              Possible values include:
              • "AWS"
              • "ThirdParty"
              • "Custom"
            • providerrequired — (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.

            • versionrequired — (String)

              A string that identifies the action type.

          • actionConfiguration — (map)

            Represents information about an action configuration.

            • configuration — (map<String>)

              The configuration data for the action.

          • pipelineContext — (map)

            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 — (map)

              The stage of the pipeline.

              • name — (String)

                The name of the stage.

            • action — (map)

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

              • name — (String)

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

          • inputArtifacts — (Array<map>)

            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.

            • 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 — (map)

              The location of an artifact.

              • type — (String)

                The type of artifact in the location.

                Possible values include:
                • "S3"
              • s3Location — (map)

                The Amazon S3 bucket that contains the artifact.

                • bucketNamerequired — (String)

                  The name of the Amazon S3 bucket.

                • objectKeyrequired — (String)

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

          • outputArtifacts — (Array<map>)

            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.

            • 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 — (map)

              The location of an artifact.

              • type — (String)

                The type of artifact in the location.

                Possible values include:
                • "S3"
              • s3Location — (map)

                The Amazon S3 bucket that contains the artifact.

                • bucketNamerequired — (String)

                  The name of the Amazon S3 bucket.

                • objectKeyrequired — (String)

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

          • artifactCredentials — (map)

            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.

            • accessKeyIdrequired — (String)

              The access key for the session.

            • secretAccessKeyrequired — (String)

              The secret access key for the session.

            • sessionTokenrequired — (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 — (map)

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

            • idrequired — (String)

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

            • typerequired — (String)

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

              Possible values include:
              • "KMS"
        • 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. Use this number in an AcknowledgeThirdPartyJob request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listActionTypes(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listActionTypes operation

var params = {
  actionOwnerFilter: AWS | ThirdParty | Custom,
  nextToken: 'STRING_VALUE'
};
codepipeline.listActionTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • actionOwnerFilter — (String)

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

      Possible values include:
      • "AWS"
      • "ThirdParty"
      • "Custom"
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • actionTypes — (Array<map>)

        Provides details of the action types.

        • idrequired — (map)

          Represents information about an action type.

          • categoryrequired — (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.

            Possible values include:
            • "Source"
            • "Build"
            • "Deploy"
            • "Test"
            • "Invoke"
            • "Approval"
          • ownerrequired — (String)

            The creator of the action being called.

            Possible values include:
            • "AWS"
            • "ThirdParty"
            • "Custom"
          • providerrequired — (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.

          • versionrequired — (String)

            A string that identifies the action type.

        • settings — (map)

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

          The configuration properties for the action type.

          • namerequired — (String)

            The name of the action configuration property.

          • requiredrequired — (Boolean)

            Whether the configuration property is a required value.

          • keyrequired — (Boolean)

            Whether the configuration property is a key.

          • secretrequired — (Boolean)

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

            When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

          • queryable — (Boolean)

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

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

          • description — (String)

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

          • type — (String)

            The type of the configuration property.

            Possible values include:
            • "String"
            • "Number"
            • "Boolean"
        • inputArtifactDetailsrequired — (map)

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

          • minimumCountrequired — (Integer)

            The minimum number of artifacts allowed for the action type.

          • maximumCountrequired — (Integer)

            The maximum number of artifacts allowed for the action type.

        • outputArtifactDetailsrequired — (map)

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

          • minimumCountrequired — (Integer)

            The minimum number of artifacts allowed for the action type.

          • maximumCountrequired — (Integer)

            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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPipelineExecutions(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listPipelineExecutions operation

var params = {
  pipelineName: 'STRING_VALUE', /* required */
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
codepipeline.listPipelineExecutions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • pipelineName — (String)

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

    • maxResults — (Integer)

      The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. The available pipeline execution history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.

    • nextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipelineExecutionSummaries — (Array<map>)

        A list of executions in the history of a pipeline.

        • pipelineExecutionId — (String)

          The ID of the pipeline execution.

        • status — (String)

          The status of the pipeline execution.

          • InProgress: The pipeline execution is currently running.

          • Succeeded: The pipeline execution was completed successfully.

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

          • Failed: The pipeline execution was not completed successfully.

          Possible values include:
          • "InProgress"
          • "Succeeded"
          • "Superseded"
          • "Failed"
        • startTime — (Date)

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

        • lastUpdateTime — (Date)

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

      • nextToken — (String)

        A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listPipelines(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listPipelines operation

var params = {
  nextToken: 'STRING_VALUE'
};
codepipeline.listPipelines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipelines — (Array<map>)

        The list of pipelines.

        • name — (String)

          The name of the pipeline.

        • version — (Integer)

          The version number of the pipeline.

        • created — (Date)

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

        • updated — (Date)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

pollForJobs(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the pollForJobs operation

var params = {
  actionTypeId: { /* required */
    category: Source | Build | Deploy | Test | Invoke | Approval, /* required */
    owner: AWS | ThirdParty | Custom, /* required */
    provider: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  },
  maxBatchSize: 0,
  queryParam: {
    '<ActionConfigurationKey>': 'STRING_VALUE',
    /* '<ActionConfigurationKey>': ... */
  }
};
codepipeline.pollForJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • actionTypeId — (map)

      Represents information about an action type.

      • categoryrequired — (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.

        Possible values include:
        • "Source"
        • "Build"
        • "Deploy"
        • "Test"
        • "Invoke"
        • "Approval"
      • ownerrequired — (String)

        The creator of the action being called.

        Possible values include:
        • "AWS"
        • "ThirdParty"
        • "Custom"
      • providerrequired — (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.

      • versionrequired — (String)

        A string that identifies the action type.

    • maxBatchSize — (Integer)

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

    • queryParam — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobs — (Array<map>)

        Information about the jobs to take action on.

        • id — (String)

          The unique system-generated ID of the job.

        • data — (map)

          Additional data about a job.

          • actionTypeId — (map)

            Represents information about an action type.

            • categoryrequired — (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.

              Possible values include:
              • "Source"
              • "Build"
              • "Deploy"
              • "Test"
              • "Invoke"
              • "Approval"
            • ownerrequired — (String)

              The creator of the action being called.

              Possible values include:
              • "AWS"
              • "ThirdParty"
              • "Custom"
            • providerrequired — (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.

            • versionrequired — (String)

              A string that identifies the action type.

          • actionConfiguration — (map)

            Represents information about an action configuration.

            • configuration — (map<String>)

              The configuration data for the action.

          • pipelineContext — (map)

            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 — (map)

              The stage of the pipeline.

              • name — (String)

                The name of the stage.

            • action — (map)

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

              • name — (String)

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

          • inputArtifacts — (Array<map>)

            The artifact supplied to the job.

            • 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 — (map)

              The location of an artifact.

              • type — (String)

                The type of artifact in the location.

                Possible values include:
                • "S3"
              • s3Location — (map)

                The Amazon S3 bucket that contains the artifact.

                • bucketNamerequired — (String)

                  The name of the Amazon S3 bucket.

                • objectKeyrequired — (String)

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

          • outputArtifacts — (Array<map>)

            The output of the job.

            • 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 — (map)

              The location of an artifact.

              • type — (String)

                The type of artifact in the location.

                Possible values include:
                • "S3"
              • s3Location — (map)

                The Amazon S3 bucket that contains the artifact.

                • bucketNamerequired — (String)

                  The name of the Amazon S3 bucket.

                • objectKeyrequired — (String)

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

          • artifactCredentials — (map)

            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.

            • accessKeyIdrequired — (String)

              The access key for the session.

            • secretAccessKeyrequired — (String)

              The secret access key for the session.

            • sessionTokenrequired — (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 — (map)

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

            • idrequired — (String)

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

            • typerequired — (String)

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

              Possible values include:
              • "KMS"
        • 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. Use this number in an AcknowledgeJob request.

        • accountId — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

pollForThirdPartyJobs(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the pollForThirdPartyJobs operation

var params = {
  actionTypeId: { /* required */
    category: Source | Build | Deploy | Test | Invoke | Approval, /* required */
    owner: AWS | ThirdParty | Custom, /* required */
    provider: 'STRING_VALUE', /* required */
    version: 'STRING_VALUE' /* required */
  },
  maxBatchSize: 0
};
codepipeline.pollForThirdPartyJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • actionTypeId — (map)

      Represents information about an action type.

      • categoryrequired — (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.

        Possible values include:
        • "Source"
        • "Build"
        • "Deploy"
        • "Test"
        • "Invoke"
        • "Approval"
      • ownerrequired — (String)

        The creator of the action being called.

        Possible values include:
        • "AWS"
        • "ThirdParty"
        • "Custom"
      • providerrequired — (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.

      • versionrequired — (String)

        A string that identifies the action type.

    • maxBatchSize — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobs — (Array<map>)

        Information about the jobs to take action on.

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putActionRevision(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putActionRevision operation

var params = {
  actionName: 'STRING_VALUE', /* required */
  actionRevision: { /* required */
    created: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    revisionChangeId: 'STRING_VALUE', /* required */
    revisionId: 'STRING_VALUE' /* required */
  },
  pipelineName: 'STRING_VALUE', /* required */
  stageName: 'STRING_VALUE' /* required */
};
codepipeline.putActionRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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 — (map)

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

      • revisionIdrequired — (String)

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

      • revisionChangeIdrequired — (String)

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

      • createdrequired — (Date)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • newRevision — (Boolean)

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

      • pipelineExecutionId — (String)

        The ID of the current workflow state of the pipeline.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putApprovalResult(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putApprovalResult operation

var params = {
  actionName: 'STRING_VALUE', /* required */
  pipelineName: 'STRING_VALUE', /* required */
  result: { /* required */
    status: Approved | Rejected, /* required */
    summary: 'STRING_VALUE' /* required */
  },
  stageName: 'STRING_VALUE', /* required */
  token: 'STRING_VALUE' /* required */
};
codepipeline.putApprovalResult(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • pipelineName — (String)

      The name of the pipeline that contains the action.

    • stageName — (String)

      The name of the stage that contains the action.

    • actionName — (String)

      The name of the action for which approval is requested.

    • result — (map)

      Represents information about the result of the approval request.

      • summaryrequired — (String)

        The summary of the current status of the approval request.

      • statusrequired — (String)

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

        Possible values include:
        • "Approved"
        • "Rejected"
    • token — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • approvedAt — (Date)

        The timestamp showing when the approval or rejection was submitted.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putJobFailureResult(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putJobFailureResult operation

var params = {
  failureDetails: { /* required */
    message: 'STRING_VALUE', /* required */
    type: JobFailed | ConfigurationError | PermissionError | RevisionOutOfSync | RevisionUnavailable | SystemUnavailable, /* required */
    externalExecutionId: 'STRING_VALUE'
  },
  jobId: 'STRING_VALUE' /* required */
};
codepipeline.putJobFailureResult(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobId — (String)

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

    • failureDetails — (map)

      The details about the failure of a job.

      • typerequired — (String)

        The type of the failure.

        Possible values include:
        • "JobFailed"
        • "ConfigurationError"
        • "PermissionError"
        • "RevisionOutOfSync"
        • "RevisionUnavailable"
        • "SystemUnavailable"
      • messagerequired — (String)

        The message about the failure.

      • externalExecutionId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putJobSuccessResult(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putJobSuccessResult operation

var params = {
  jobId: 'STRING_VALUE', /* required */
  continuationToken: 'STRING_VALUE',
  currentRevision: {
    changeIdentifier: 'STRING_VALUE', /* required */
    revision: 'STRING_VALUE', /* required */
    created: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    revisionSummary: 'STRING_VALUE'
  },
  executionDetails: {
    externalExecutionId: 'STRING_VALUE',
    percentComplete: 0,
    summary: 'STRING_VALUE'
  }
};
codepipeline.putJobSuccessResult(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • jobId — (String)

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

    • currentRevision — (map)

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

      • revisionrequired — (String)

        The revision ID of the current version of an artifact.

      • changeIdentifierrequired — (String)

        The change identifier for the current revision.

      • created — (Date)

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

      • revisionSummary — (String)

        The summary of the most recent revision of the artifact.

    • continuationToken — (String)

      A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

    • executionDetails — (map)

      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 — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putThirdPartyJobFailureResult(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putThirdPartyJobFailureResult operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  failureDetails: { /* required */
    message: 'STRING_VALUE', /* required */
    type: JobFailed | ConfigurationError | PermissionError | RevisionOutOfSync | RevisionUnavailable | SystemUnavailable, /* required */
    externalExecutionId: 'STRING_VALUE'
  },
  jobId: 'STRING_VALUE' /* required */
};
codepipeline.putThirdPartyJobFailureResult(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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 — (map)

      Represents information about failure details.

      • typerequired — (String)

        The type of the failure.

        Possible values include:
        • "JobFailed"
        • "ConfigurationError"
        • "PermissionError"
        • "RevisionOutOfSync"
        • "RevisionUnavailable"
        • "SystemUnavailable"
      • messagerequired — (String)

        The message about the failure.

      • externalExecutionId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putThirdPartyJobSuccessResult(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putThirdPartyJobSuccessResult operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE', /* required */
  continuationToken: 'STRING_VALUE',
  currentRevision: {
    changeIdentifier: 'STRING_VALUE', /* required */
    revision: 'STRING_VALUE', /* required */
    created: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    revisionSummary: 'STRING_VALUE'
  },
  executionDetails: {
    externalExecutionId: 'STRING_VALUE',
    percentComplete: 0,
    summary: 'STRING_VALUE'
  }
};
codepipeline.putThirdPartyJobSuccessResult(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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 — (map)

      Represents information about a current revision.

      • revisionrequired — (String)

        The revision ID of the current version of an artifact.

      • changeIdentifierrequired — (String)

        The change identifier for the current revision.

      • created — (Date)

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

      • revisionSummary — (String)

        The summary of the most recent revision of the artifact.

    • continuationToken — (String)

      A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied.

    • executionDetails — (map)

      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 — (Integer)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

retryStageExecution(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the retryStageExecution operation

var params = {
  pipelineExecutionId: 'STRING_VALUE', /* required */
  pipelineName: 'STRING_VALUE', /* required */
  retryMode: FAILED_ACTIONS, /* required */
  stageName: 'STRING_VALUE' /* required */
};
codepipeline.retryStageExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • pipelineName — (String)

      The name of the pipeline that contains the failed stage.

    • stageName — (String)

      The name of the failed stage to be retried.

    • pipelineExecutionId — (String)

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

    • retryMode — (String)

      The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.

      Possible values include:
      • "FAILED_ACTIONS"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipelineExecutionId — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startPipelineExecution(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startPipelineExecution operation

var params = {
  name: 'STRING_VALUE' /* required */
};
codepipeline.startPipelineExecution(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the pipeline to start.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipelineExecutionId — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updatePipeline(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updatePipeline operation

var params = {
  pipeline: { /* required */
    artifactStore: { /* required */
      location: 'STRING_VALUE', /* required */
      type: S3, /* required */
      encryptionKey: {
        id: 'STRING_VALUE', /* required */
        type: KMS /* required */
      }
    },
    name: 'STRING_VALUE', /* required */
    roleArn: 'STRING_VALUE', /* required */
    stages: [ /* required */
      {
        actions: [ /* required */
          {
            actionTypeId: { /* required */
              category: Source | Build | Deploy | Test | Invoke | Approval, /* required */
              owner: AWS | ThirdParty | Custom, /* required */
              provider: 'STRING_VALUE', /* required */
              version: 'STRING_VALUE' /* required */
            },
            name: 'STRING_VALUE', /* required */
            configuration: {
              '<ActionConfigurationKey>': 'STRING_VALUE',
              /* '<ActionConfigurationKey>': ... */
            },
            inputArtifacts: [
              {
                name: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            outputArtifacts: [
              {
                name: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            roleArn: 'STRING_VALUE',
            runOrder: 0
          },
          /* more items */
        ],
        name: 'STRING_VALUE', /* required */
        blockers: [
          {
            name: 'STRING_VALUE', /* required */
            type: Schedule /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    version: 0
  }
};
codepipeline.updatePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • pipeline — (map)

      The name of the pipeline to be updated.

      • namerequired — (String)

        The name of the action to be performed.

      • roleArnrequired — (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.

      • artifactStorerequired — (map)

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

        • typerequired — (String)

          The type of the artifact store, such as S3.

          Possible values include:
          • "S3"
        • locationrequired — (String)

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

        • encryptionKey — (map)

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

          • idrequired — (String)

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

          • typerequired — (String)

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

            Possible values include:
            • "KMS"
      • stagesrequired — (Array<map>)

        The stage in which to perform the action.

        • namerequired — (String)

          The name of the stage.

        • blockers — (Array<map>)

          Reserved for future use.

          • namerequired — (String)

            Reserved for future use.

          • typerequired — (String)

            Reserved for future use.

            Possible values include:
            • "Schedule"
        • actionsrequired — (Array<map>)

          The actions included in a stage.

          • namerequired — (String)

            The action declaration's name.

          • actionTypeIdrequired — (map)

            The configuration information for the action type.

            • categoryrequired — (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.

              Possible values include:
              • "Source"
              • "Build"
              • "Deploy"
              • "Test"
              • "Invoke"
              • "Approval"
            • ownerrequired — (String)

              The creator of the action being called.

              Possible values include:
              • "AWS"
              • "ThirdParty"
              • "Custom"
            • providerrequired — (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.

            • versionrequired — (String)

              A string that identifies the action type.

          • runOrder — (Integer)

            The order in which actions are run.

          • configuration — (map<String>)

            The action declaration's configuration.

          • outputArtifacts — (Array<map>)

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

            • namerequired — (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<map>)

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

            • namerequired — (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 — (Integer)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipeline — (map)

        The structure of the updated pipeline.

        • namerequired — (String)

          The name of the action to be performed.

        • roleArnrequired — (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.

        • artifactStorerequired — (map)

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

          • typerequired — (String)

            The type of the artifact store, such as S3.

            Possible values include:
            • "S3"
          • locationrequired — (String)

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

          • encryptionKey — (map)

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

            • idrequired — (String)

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

            • typerequired — (String)

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

              Possible values include:
              • "KMS"
        • stagesrequired — (Array<map>)

          The stage in which to perform the action.

          • namerequired — (String)

            The name of the stage.

          • blockers — (Array<map>)

            Reserved for future use.

            • namerequired — (String)

              Reserved for future use.

            • typerequired — (String)

              Reserved for future use.

              Possible values include:
              • "Schedule"
          • actionsrequired — (Array<map>)

            The actions included in a stage.

            • namerequired — (String)

              The action declaration's name.

            • actionTypeIdrequired — (map)

              The configuration information for the action type.

              • categoryrequired — (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.

                Possible values include:
                • "Source"
                • "Build"
                • "Deploy"
                • "Test"
                • "Invoke"
                • "Approval"
              • ownerrequired — (String)

                The creator of the action being called.

                Possible values include:
                • "AWS"
                • "ThirdParty"
                • "Custom"
              • providerrequired — (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.

              • versionrequired — (String)

                A string that identifies the action type.

            • runOrder — (Integer)

              The order in which actions are run.

            • configuration — (map<String>)

              The action declaration's configuration.

            • outputArtifacts — (Array<map>)

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

              • namerequired — (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<map>)

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

              • namerequired — (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 — (Integer)

          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:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.