Class: AWS.CodePipeline

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

var params = {
  category: Source | Build | Deploy | Test | Invoke | Approval, /* required */
  inputArtifactDetails: { /* required */
    maximumCount: 'NUMBER_VALUE', /* required */
    minimumCount: 'NUMBER_VALUE' /* required */
  },
  outputArtifactDetails: { /* required */
    maximumCount: 'NUMBER_VALUE', /* required */
    minimumCount: 'NUMBER_VALUE' /* 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'
  },
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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.

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

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

  • version — (String)

    The version identifier of the custom action.

  • settings — (map)

    URLs that provide users information about this custom action.

    • 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 CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

    • executionUrlTemplate — (String)

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

    • revisionUrlTemplate — (String)

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

  • 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.
    • name — required — (String)

      The name of the action configuration property.

    • required — required — (Boolean)

      Whether the configuration property is a required value.

    • key — required — (Boolean)

      Whether the configuration property is a key.

    • secret — required — (Boolean)

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

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

    • queryable — (Boolean)

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

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

    • description — (String)

      The description of the action configuration property that is 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.

    • minimumCount — required — (Integer)

      The minimum number of artifacts allowed for the action type.

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

    • minimumCount — required — (Integer)

      The minimum number of artifacts allowed for the action type.

    • maximumCount — required — (Integer)

      The maximum number of artifacts allowed for the action type.

  • tags — (Array<map>)

    The tags for the custom action.

    • key — required — (String)

      The tag's key.

    • value — required — (String)

      The tag's value.

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.

      • id — required — (map)

        Represents information about an action type.

        • category — required — (String)

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

          • Source

          • Build

          • Test

          • Deploy

          • Invoke

          • Approval

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

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

          Possible values include:
          • "AWS"
          • "ThirdParty"
          • "Custom"
        • provider — required — (String)

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

        • version — required — (String)

          A string that describes the action version.

      • 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 CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

        • executionUrlTemplate — (String)

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

        • revisionUrlTemplate — (String)

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

      • actionConfigurationProperties — (Array<map>)

        The configuration properties for the action type.

        • name — required — (String)

          The name of the action configuration property.

        • required — required — (Boolean)

          Whether the configuration property is a required value.

        • key — required — (Boolean)

          Whether the configuration property is a key.

        • secret — required — (Boolean)

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

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

        • queryable — (Boolean)

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

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

        • description — (String)

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

        • type — (String)

          The type of the configuration property.

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

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

        • minimumCount — required — (Integer)

          The minimum number of artifacts allowed for the action type.

        • maximumCount — required — (Integer)

          The maximum number of artifacts allowed for the action type.

      • outputArtifactDetails — required — (map)

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

        • minimumCount — required — (Integer)

          The minimum number of artifacts allowed for the action type.

        • maximumCount — required — (Integer)

          The maximum number of artifacts allowed for the action type.

    • tags — (Array<map>)

      Specifies the tags applied to the custom action.

      • key — required — (String)

        The tag's key.

      • value — required — (String)

        The tag's value.

Returns:

• (AWS.Request) —

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

var params = {
  pipeline: { /* 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 */
            ],
            namespace: 'STRING_VALUE',
            outputArtifacts: [
              {
                name: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            region: 'STRING_VALUE',
            roleArn: 'STRING_VALUE',
            runOrder: 'NUMBER_VALUE',
            timeoutInMinutes: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        name: 'STRING_VALUE', /* required */
        beforeEntry: {
          conditions: [ /* required */
            {
              result: ROLLBACK | FAIL,
              rules: [
                {
                  name: 'STRING_VALUE', /* required */
                  ruleTypeId: { /* required */
                    category: Rule, /* required */
                    provider: 'STRING_VALUE', /* required */
                    owner: AWS,
                    version: 'STRING_VALUE'
                  },
                  configuration: {
                    '<RuleConfigurationKey>': 'STRING_VALUE',
                    /* '<RuleConfigurationKey>': ... */
                  },
                  inputArtifacts: [
                    {
                      name: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  region: 'STRING_VALUE',
                  roleArn: 'STRING_VALUE',
                  timeoutInMinutes: 'NUMBER_VALUE'
                },
                /* more items */
              ]
            },
            /* more items */
          ]
        },
        blockers: [
          {
            name: 'STRING_VALUE', /* required */
            type: Schedule /* required */
          },
          /* more items */
        ],
        onFailure: {
          conditions: [
            {
              result: ROLLBACK | FAIL,
              rules: [
                {
                  name: 'STRING_VALUE', /* required */
                  ruleTypeId: { /* required */
                    category: Rule, /* required */
                    provider: 'STRING_VALUE', /* required */
                    owner: AWS,
                    version: 'STRING_VALUE'
                  },
                  configuration: {
                    '<RuleConfigurationKey>': 'STRING_VALUE',
                    /* '<RuleConfigurationKey>': ... */
                  },
                  inputArtifacts: [
                    {
                      name: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  region: 'STRING_VALUE',
                  roleArn: 'STRING_VALUE',
                  timeoutInMinutes: 'NUMBER_VALUE'
                },
                /* more items */
              ]
            },
            /* more items */
          ],
          result: ROLLBACK | FAIL
        },
        onSuccess: {
          conditions: [ /* required */
            {
              result: ROLLBACK | FAIL,
              rules: [
                {
                  name: 'STRING_VALUE', /* required */
                  ruleTypeId: { /* required */
                    category: Rule, /* required */
                    provider: 'STRING_VALUE', /* required */
                    owner: AWS,
                    version: 'STRING_VALUE'
                  },
                  configuration: {
                    '<RuleConfigurationKey>': 'STRING_VALUE',
                    /* '<RuleConfigurationKey>': ... */
                  },
                  inputArtifacts: [
                    {
                      name: 'STRING_VALUE' /* required */
                    },
                    /* more items */
                  ],
                  region: 'STRING_VALUE',
                  roleArn: 'STRING_VALUE',
                  timeoutInMinutes: 'NUMBER_VALUE'
                },
                /* more items */
              ]
            },
            /* more items */
          ]
        }
      },
      /* more items */
    ],
    artifactStore: {
      location: 'STRING_VALUE', /* required */
      type: S3, /* required */
      encryptionKey: {
        id: 'STRING_VALUE', /* required */
        type: KMS /* required */
      }
    },
    artifactStores: {
      '<AWSRegionName>': {
        location: 'STRING_VALUE', /* required */
        type: S3, /* required */
        encryptionKey: {
          id: 'STRING_VALUE', /* required */
          type: KMS /* required */
        }
      },
      /* '<AWSRegionName>': ... */
    },
    executionMode: QUEUED | SUPERSEDED | PARALLEL,
    pipelineType: V1 | V2,
    triggers: [
      {
        gitConfiguration: { /* required */
          sourceActionName: 'STRING_VALUE', /* required */
          pullRequest: [
            {
              branches: {
                excludes: [
                  'STRING_VALUE',
                  /* more items */
                ],
                includes: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              events: [
                OPEN | UPDATED | CLOSED,
                /* more items */
              ],
              filePaths: {
                excludes: [
                  'STRING_VALUE',
                  /* more items */
                ],
                includes: [
                  'STRING_VALUE',
                  /* more items */
                ]
              }
            },
            /* more items */
          ],
          push: [
            {
              branches: {
                excludes: [
                  'STRING_VALUE',
                  /* more items */
                ],
                includes: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              filePaths: {
                excludes: [
                  'STRING_VALUE',
                  /* more items */
                ],
                includes: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              tags: {
                excludes: [
                  'STRING_VALUE',
                  /* more items */
                ],
                includes: [
                  'STRING_VALUE',
                  /* more items */
                ]
              }
            },
            /* more items */
          ]
        },
        providerType: CodeStarSourceConnection /* required */
      },
      /* more items */
    ],
    variables: [
      {
        name: 'STRING_VALUE', /* required */
        defaultValue: 'STRING_VALUE',
        description: 'STRING_VALUE'
      },
      /* more items */
    ],
    version: 'NUMBER_VALUE'
  },
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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.

    • name — required — (String)

      The name of the pipeline.

    • roleArn — required — (String)

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

    • artifactStore — (map)

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

      Note: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
      • type — required — (String)

        The type of the artifact store, such as S3.

        Possible values include:
        • "S3"
      • location — required — (String)

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

      • encryptionKey — (map)

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

        • id — required — (String)

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

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

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

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

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

      Note: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
      • type — required — (String)

        The type of the artifact store, such as S3.

        Possible values include:
        • "S3"
      • location — required — (String)

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

      • encryptionKey — (map)

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

        • id — required — (String)

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

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

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

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

      The stage in which to perform the action.

      • name — required — (String)

        The name of the stage.

      • blockers — (Array<map>)

        Reserved for future use.

        • name — required — (String)

          Reserved for future use.

        • type — required — (String)

          Reserved for future use.

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

        The actions included in a stage.

        • name — required — (String)

          The action declaration's name.

        • actionTypeId — required — (map)

          Specifies the action type and the provider of the action.

          • category — required — (String)

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

            • Source

            • Build

            • Test

            • Deploy

            • Invoke

            • Approval

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

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

            Possible values include:
            • "AWS"
            • "ThirdParty"
            • "Custom"
          • provider — required — (String)

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

          • version — required — (String)

            A string that describes the action version.

        • runOrder — (Integer)

          The order in which actions are run.

        • configuration — (map<String>)

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

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

          JSON:

          "Configuration" : { Key : Value },

        • outputArtifacts — (Array<map>)

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

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

          • name — required — (String)

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

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

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

        • roleArn — (String)

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

        • region — (String)

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

        • namespace — (String)

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

        • timeoutInMinutes — (Integer)

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

      • onFailure — (map)

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

        • result — (String)

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

          Possible values include:
          • "ROLLBACK"
          • "FAIL"
        • conditions — (Array<map>)

          The conditions that are configured as failure conditions.

          • result — (String)

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

            Possible values include:
            • "ROLLBACK"
            • "FAIL"
          • rules — (Array<map>)

            The rules that make up the condition.

            • name — required — (String)

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

            • ruleTypeId — required — (map)

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

              • category — required — (String)

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

                Possible values include:
                • "Rule"
              • owner — (String)

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

                Possible values include:
                • "AWS"
              • provider — required — (String)

                The rule provider, such as the DeploymentWindow rule.

              • version — (String)

                A string that describes the rule version.

            • configuration — (map<String>)

              The action configuration fields for the rule.

            • inputArtifacts — (Array<map>)

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

              • name — required — (String)

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

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

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

            • roleArn — (String)

              The pipeline role ARN associated with the rule.

            • region — (String)

              The Region for the condition associated with the rule.

            • timeoutInMinutes — (Integer)

              The action timeout for the rule.

      • onSuccess — (map)

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

        • conditions — required — (Array<map>)

          The conditions that are success conditions.

          • result — (String)

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

            Possible values include:
            • "ROLLBACK"
            • "FAIL"
          • rules — (Array<map>)

            The rules that make up the condition.

            • name — required — (String)

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

            • ruleTypeId — required — (map)

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

              • category — required — (String)

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

                Possible values include:
                • "Rule"
              • owner — (String)

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

                Possible values include:
                • "AWS"
              • provider — required — (String)

                The rule provider, such as the DeploymentWindow rule.

              • version — (String)

                A string that describes the rule version.

            • configuration — (map<String>)

              The action configuration fields for the rule.

            • inputArtifacts — (Array<map>)

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

              • name — required — (String)

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

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

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

            • roleArn — (String)

              The pipeline role ARN associated with the rule.

            • region — (String)

              The Region for the condition associated with the rule.

            • timeoutInMinutes — (Integer)

              The action timeout for the rule.

      • beforeEntry — (map)

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

        • conditions — required — (Array<map>)

          The conditions that are configured as entry conditions.

          • result — (String)

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

            Possible values include:
            • "ROLLBACK"
            • "FAIL"
          • rules — (Array<map>)

            The rules that make up the condition.

            • name — required — (String)

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

            • ruleTypeId — required — (map)

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

              • category — required — (String)

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

                Possible values include:
                • "Rule"
              • owner — (String)

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

                Possible values include:
                • "AWS"
              • provider — required — (String)

                The rule provider, such as the DeploymentWindow rule.

              • version — (String)

                A string that describes the rule version.

            • configuration — (map<String>)

              The action configuration fields for the rule.

            • inputArtifacts — (Array<map>)

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

              • name — required — (String)

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

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

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

            • roleArn — (String)

              The pipeline role ARN associated with the rule.

            • region — (String)

              The Region for the condition associated with the rule.

            • timeoutInMinutes — (Integer)

              The action timeout for the rule.

    • version — (Integer)

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

    • executionMode — (String)

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

      Possible values include:
      • "QUEUED"
      • "SUPERSEDED"
      • "PARALLEL"
    • pipelineType — (String)

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

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

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

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

      For information about pricing for CodePipeline, see Pricing.

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

      Possible values include:
      • "V1"
      • "V2"
    • variables — (Array<map>)

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

      • name — required — (String)

        The name of a pipeline-level variable.

      • defaultValue — (String)

        The value of a pipeline-level variable.

      • description — (String)

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

    • triggers — (Array<map>)

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

      Note: When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
      • providerType — required — (String)

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

        Possible values include:
        • "CodeStarSourceConnection"
      • gitConfiguration — required — (map)

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

        • sourceActionName — required — (String)

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

          Note: You can only specify one trigger configuration per source action.
        • push — (Array<map>)

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

          • tags — (map)

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

            • includes — (Array<String>)

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

            • excludes — (Array<String>)

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

          • branches — (map)

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

            • includes — (Array<String>)

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

            • excludes — (Array<String>)

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

          • filePaths — (map)

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

            • includes — (Array<String>)

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

            • excludes — (Array<String>)

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

        • pullRequest — (Array<map>)

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

          • events — (Array<String>)

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

          • branches — (map)

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

            • includes — (Array<String>)

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

            • excludes — (Array<String>)

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

          • filePaths — (map)

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

            • includes — (Array<String>)

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

            • excludes — (Array<String>)

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

  • tags — (Array<map>)

    The tags for the pipeline.

    • key — required — (String)

      The tag's key.

    • value — required — (String)

      The tag's value.

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.

      • name — required — (String)

        The name of the pipeline.

      • roleArn — required — (String)

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

      • artifactStore — (map)

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

        Note: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
        • type — required — (String)

          The type of the artifact store, such as S3.

          Possible values include:
          • "S3"
        • location — required — (String)

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

        • encryptionKey — (map)

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

          • id — required — (String)

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

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

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

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

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

        Note: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
        • type — required — (String)

          The type of the artifact store, such as S3.

          Possible values include:
          • "S3"
        • location — required — (String)

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

        • encryptionKey — (map)

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

          • id — required — (String)

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

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

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

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

        The stage in which to perform the action.

        • name — required — (String)

          The name of the stage.

        • blockers — (Array<map>)

          Reserved for future use.

          • name — required — (String)

            Reserved for future use.

          • type — required — (String)

            Reserved for future use.

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

          The actions included in a stage.

          • name — required — (String)

            The action declaration's name.

          • actionTypeId — required — (map)

            Specifies the action type and the provider of the action.

            • category — required — (String)

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

              • Source

              • Build

              • Test

              • Deploy

              • Invoke

              • Approval

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

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

              Possible values include:
              • "AWS"
              • "ThirdParty"
              • "Custom"
            • provider — required — (String)

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

            • version — required — (String)

              A string that describes the action version.

          • runOrder — (Integer)

            The order in which actions are run.

          • configuration — (map<String>)

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

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

            JSON:

            "Configuration" : { Key : Value },

          • outputArtifacts — (Array<map>)

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

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

            • name — required — (String)

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

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

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

          • roleArn — (String)

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

          • region — (String)

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

          • namespace — (String)

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

          • timeoutInMinutes — (Integer)

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

        • onFailure — (map)

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

          • result — (String)

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

            Possible values include:
            • "ROLLBACK"
            • "FAIL"
          • conditions — (Array<map>)

            The conditions that are configured as failure conditions.

            • result — (String)

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

              Possible values include:
              • "ROLLBACK"
              • "FAIL"
            • rules — (Array<map>)

              The rules that make up the condition.

              • name — required — (String)

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

              • ruleTypeId — required — (map)

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

                • category — required — (String)

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

                  Possible values include:
                  • "Rule"
                • owner — (String)

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

                  Possible values include:
                  • "AWS"
                • provider — required — (String)

                  The rule provider, such as the DeploymentWindow rule.

                • version — (String)

                  A string that describes the rule version.

              • configuration — (map<String>)

                The action configuration fields for the rule.

              • inputArtifacts — (Array<map>)

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

                • name — required — (String)

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

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

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

              • roleArn — (String)

                The pipeline role ARN associated with the rule.

              • region — (String)

                The Region for the condition associated with the rule.

              • timeoutInMinutes — (Integer)

                The action timeout for the rule.

        • onSuccess — (map)

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

          • conditions — required — (Array<map>)

            The conditions that are success conditions.

            • result — (String)

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

              Possible values include:
              • "ROLLBACK"
              • "FAIL"
            • rules — (Array<map>)

              The rules that make up the condition.

              • name — required — (String)

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

              • ruleTypeId — required — (map)

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

                • category — required — (String)

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

                  Possible values include:
                  • "Rule"
                • owner — (String)

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

                  Possible values include:
                  • "AWS"
                • provider — required — (String)

                  The rule provider, such as the DeploymentWindow rule.

                • version — (String)

                  A string that describes the rule version.

              • configuration — (map<String>)

                The action configuration fields for the rule.

              • inputArtifacts — (Array<map>)

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

                • name — required — (String)

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

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

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

              • roleArn — (String)

                The pipeline role ARN associated with the rule.

              • region — (String)

                The Region for the condition associated with the rule.

              • timeoutInMinutes — (Integer)

                The action timeout for the rule.

        • beforeEntry — (map)

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

          • conditions — required — (Array<map>)

            The conditions that are configured as entry conditions.

            • result — (String)

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

              Possible values include:
              • "ROLLBACK"
              • "FAIL"
            • rules — (Array<map>)

              The rules that make up the condition.

              • name — required — (String)

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

              • ruleTypeId — required — (map)

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

                • category — required — (String)

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

                  Possible values include:
                  • "Rule"
                • owner — (String)

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

                  Possible values include:
                  • "AWS"
                • provider — required — (String)

                  The rule provider, such as the DeploymentWindow rule.

                • version — (String)

                  A string that describes the rule version.

              • configuration — (map<String>)

                The action configuration fields for the rule.

              • inputArtifacts — (Array<map>)

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

                • name — required — (String)

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

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

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

              • roleArn — (String)

                The pipeline role ARN associated with the rule.

              • region — (String)

                The Region for the condition associated with the rule.

              • timeoutInMinutes — (Integer)

                The action timeout for the rule.

      • version — (Integer)

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

      • executionMode — (String)

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

        Possible values include:
        • "QUEUED"
        • "SUPERSEDED"
        • "PARALLEL"
      • pipelineType — (String)

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

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

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

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

        For information about pricing for CodePipeline, see Pricing.

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

        Possible values include:
        • "V1"
        • "V2"
      • variables — (Array<map>)

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

        • name — required — (String)

          The name of a pipeline-level variable.

        • defaultValue — (String)

          The value of a pipeline-level variable.

        • description — (String)

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

      • triggers — (Array<map>)

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

        Note: When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
        • providerType — required — (String)

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

          Possible values include:
          • "CodeStarSourceConnection"
        • gitConfiguration — required — (map)

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

          • sourceActionName — required — (String)

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

            Note: You can only specify one trigger configuration per source action.
          • push — (Array<map>)

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

            • tags — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

            • branches — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

            • filePaths — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

          • pullRequest — (Array<map>)

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

            • events — (Array<String>)

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

            • branches — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

            • filePaths — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

    • tags — (Array<map>)

      Specifies the tags applied to the pipeline.

      • key — required — (String)

        The tag's key.

      • value — required — (String)

        The tag's value.

Returns:

• (AWS.Request) —

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

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

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.

var params = {
  name: 'STRING_VALUE' /* required */
};
codepipeline.deleteWebhook(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 webhook you want 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.

var params = {
  webhookName: 'STRING_VALUE'
};
codepipeline.deregisterWebhookWithThirdParty(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: {}) —
  • webhookName — (String)

    The name of the webhook you want to deregister.

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.

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 are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

    Possible values include:
    • "Inbound"
    • "Outbound"
  • reason — (String)

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

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.

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 are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).

    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.

var params = {
  category: Source | Build | Deploy | Test | Invoke | Approval, /* required */
  owner: 'STRING_VALUE', /* required */
  provider: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE' /* required */
};
codepipeline.getActionType(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)

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

    • Source

    • Build

    • Test

    • Deploy

    • Approval

    • Invoke

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

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

  • provider — (String)

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

  • version — (String)

    A string that describes the action type 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:

    • actionType — (map)

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

      • description — (String)

        The description for the action type to be updated.

      • executor — required — (map)

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

        • configuration — required — (map)

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

          • lambdaExecutorConfiguration — (map)

            Details about the Lambda executor of the action type.

            • lambdaFunctionArn — required — (String)

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

          • jobWorkerExecutorConfiguration — (map)

            Details about the JobWorker executor of the action type.

            • pollingAccounts — (Array<String>)

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

            • pollingServicePrincipals — (Array<String>)

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

        • type — required — (String)

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

          Possible values include:
          • "JobWorker"
          • "Lambda"
        • policyStatementsTemplate — (String)

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

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

          Note: The size of the passed JSON policy document cannot exceed 2048 characters.
        • jobTimeout — (Integer)

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

      • id — required — (map)

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

        • category — required — (String)

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

          • Source

          • Build

          • Test

          • Deploy

          • Approval

          • Invoke

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

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

        • provider — required — (String)

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

        • version — required — (String)

          A string that describes the action type version.

      • inputArtifactDetails — required — (map)

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

        • minimumCount — required — (Integer)

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

        • maximumCount — required — (Integer)

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

      • outputArtifactDetails — required — (map)

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

        • minimumCount — required — (Integer)

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

        • maximumCount — required — (Integer)

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

      • permissions — (map)

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

        • allowedAccounts — required — (Array<String>)

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

      • properties — (Array<map>)

        The properties of the action type to be updated.

        • name — required — (String)

          The property name that is displayed to users.

        • optional — required — (Boolean)

          Whether the configuration property is an optional value.

        • key — required — (Boolean)

          Whether the configuration property is a key.

        • noEcho — required — (Boolean)

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

        • queryable — (Boolean)

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

        • description — (String)

          The description of the property that is displayed to users.

      • urls — (map)

        The links associated with the action type to be updated.

        • configurationUrl — (String)

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

        • entityUrlTemplate — (String)

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

        • executionUrlTemplate — (String)

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

        • revisionUrlTemplate — (String)

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

Returns:

• (AWS.Request) —

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

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 other information about a job required for a job worker to complete the job.

        • actionTypeId — (map)

          Represents information about an action type.

          • category — required — (String)

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

            • Source

            • Build

            • Test

            • Deploy

            • Invoke

            • Approval

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

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

            Possible values include:
            • "AWS"
            • "ThirdParty"
            • "Custom"
          • provider — required — (String)

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

          • version — required — (String)

            A string that describes the action version.

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

          Note: Includes pipelineArn and pipelineExecutionId for custom jobs.
          • 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 in the stage of a pipeline.

            • name — (String)

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

            • actionExecutionId — (String)

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

          • pipelineArn — (String)

            The Amazon Resource Name (ARN) of the pipeline.

          • pipelineExecutionId — (String)

            The execution ID of the pipeline.

        • 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 S3 bucket that contains the artifact.

              • bucketName — required — (String)

                The name of the S3 bucket.

              • objectKey — required — (String)

                The key of the object in the 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 S3 bucket that contains the artifact.

              • bucketName — required — (String)

                The name of the S3 bucket.

              • objectKey — required — (String)

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

        • artifactCredentials — (map)

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

          • accessKeyId — required — (String)

            The access key for the session.

          • secretAccessKey — required — (String)

            The secret access key for the session.

          • sessionToken — required — (String)

            The token for the session.

        • continuationToken — (String)

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

        • encryptionKey — (map)

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

          • id — required — (String)

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

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

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

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

        The Amazon Web Services account ID associated with the job.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  version: 'NUMBER_VALUE'
};
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 in an Amazon Web Services account.

  • version — (Integer)

    The version number of the pipeline. If you do not specify a version, defaults to the 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.

      • name — required — (String)

        The name of the pipeline.

      • roleArn — required — (String)

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

      • artifactStore — (map)

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

        Note: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
        • type — required — (String)

          The type of the artifact store, such as S3.

          Possible values include:
          • "S3"
        • location — required — (String)

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

        • encryptionKey — (map)

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

          • id — required — (String)

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

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

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

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

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

        Note: You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
        • type — required — (String)

          The type of the artifact store, such as S3.

          Possible values include:
          • "S3"
        • location — required — (String)

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

        • encryptionKey — (map)

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

          • id — required — (String)

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

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

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

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

        The stage in which to perform the action.

        • name — required — (String)

          The name of the stage.

        • blockers — (Array<map>)

          Reserved for future use.

          • name — required — (String)

            Reserved for future use.

          • type — required — (String)

            Reserved for future use.

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

          The actions included in a stage.

          • name — required — (String)

            The action declaration's name.

          • actionTypeId — required — (map)

            Specifies the action type and the provider of the action.

            • category — required — (String)

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

              • Source

              • Build

              • Test

              • Deploy

              • Invoke

              • Approval

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

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

              Possible values include:
              • "AWS"
              • "ThirdParty"
              • "Custom"
            • provider — required — (String)

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

            • version — required — (String)

              A string that describes the action version.

          • runOrder — (Integer)

            The order in which actions are run.

          • configuration — (map<String>)

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

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

            JSON:

            "Configuration" : { Key : Value },

          • outputArtifacts — (Array<map>)

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

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

            • name — required — (String)

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

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

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

          • roleArn — (String)

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

          • region — (String)

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

          • namespace — (String)

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

          • timeoutInMinutes — (Integer)

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

        • onFailure — (map)

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

          • result — (String)

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

            Possible values include:
            • "ROLLBACK"
            • "FAIL"
          • conditions — (Array<map>)

            The conditions that are configured as failure conditions.

            • result — (String)

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

              Possible values include:
              • "ROLLBACK"
              • "FAIL"
            • rules — (Array<map>)

              The rules that make up the condition.

              • name — required — (String)

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

              • ruleTypeId — required — (map)

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

                • category — required — (String)

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

                  Possible values include:
                  • "Rule"
                • owner — (String)

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

                  Possible values include:
                  • "AWS"
                • provider — required — (String)

                  The rule provider, such as the DeploymentWindow rule.

                • version — (String)

                  A string that describes the rule version.

              • configuration — (map<String>)

                The action configuration fields for the rule.

              • inputArtifacts — (Array<map>)

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

                • name — required — (String)

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

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

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

              • roleArn — (String)

                The pipeline role ARN associated with the rule.

              • region — (String)

                The Region for the condition associated with the rule.

              • timeoutInMinutes — (Integer)

                The action timeout for the rule.

        • onSuccess — (map)

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

          • conditions — required — (Array<map>)

            The conditions that are success conditions.

            • result — (String)

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

              Possible values include:
              • "ROLLBACK"
              • "FAIL"
            • rules — (Array<map>)

              The rules that make up the condition.

              • name — required — (String)

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

              • ruleTypeId — required — (map)

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

                • category — required — (String)

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

                  Possible values include:
                  • "Rule"
                • owner — (String)

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

                  Possible values include:
                  • "AWS"
                • provider — required — (String)

                  The rule provider, such as the DeploymentWindow rule.

                • version — (String)

                  A string that describes the rule version.

              • configuration — (map<String>)

                The action configuration fields for the rule.

              • inputArtifacts — (Array<map>)

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

                • name — required — (String)

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

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

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

              • roleArn — (String)

                The pipeline role ARN associated with the rule.

              • region — (String)

                The Region for the condition associated with the rule.

              • timeoutInMinutes — (Integer)

                The action timeout for the rule.

        • beforeEntry — (map)

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

          • conditions — required — (Array<map>)

            The conditions that are configured as entry conditions.

            • result — (String)

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

              Possible values include:
              • "ROLLBACK"
              • "FAIL"
            • rules — (Array<map>)

              The rules that make up the condition.

              • name — required — (String)

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

              • ruleTypeId — required — (map)

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

                • category — required — (String)

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

                  Possible values include:
                  • "Rule"
                • owner — (String)

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

                  Possible values include:
                  • "AWS"
                • provider — required — (String)

                  The rule provider, such as the DeploymentWindow rule.

                • version — (String)

                  A string that describes the rule version.

              • configuration — (map<String>)

                The action configuration fields for the rule.

              • inputArtifacts — (Array<map>)

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

                • name — required — (String)

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

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

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

              • roleArn — (String)

                The pipeline role ARN associated with the rule.

              • region — (String)

                The Region for the condition associated with the rule.

              • timeoutInMinutes — (Integer)

                The action timeout for the rule.

      • version — (Integer)

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

      • executionMode — (String)

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

        Possible values include:
        • "QUEUED"
        • "SUPERSEDED"
        • "PARALLEL"
      • pipelineType — (String)

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

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

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

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

        For information about pricing for CodePipeline, see Pricing.

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

        Possible values include:
        • "V1"
        • "V2"
      • variables — (Array<map>)

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

        • name — required — (String)

          The name of a pipeline-level variable.

        • defaultValue — (String)

          The value of a pipeline-level variable.

        • description — (String)

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

      • triggers — (Array<map>)

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

        Note: When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
        • providerType — required — (String)

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

          Possible values include:
          • "CodeStarSourceConnection"
        • gitConfiguration — required — (map)

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

          • sourceActionName — required — (String)

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

            Note: You can only specify one trigger configuration per source action.
          • push — (Array<map>)

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

            • tags — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

            • branches — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

            • filePaths — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

          • pullRequest — (Array<map>)

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

            • events — (Array<String>)

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

            • branches — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

            • filePaths — (map)

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

              • includes — (Array<String>)

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

              • excludes — (Array<String>)

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

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

      • pollingDisabledAt — (Date)

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

Returns:

• (AWS.Request) —

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

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 with the specified pipeline execution.

      • pipelineVersion — (Integer)

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

      • pipelineExecutionId — (String)

        The ID of the pipeline execution.

      • status — (String)

        The status of the pipeline execution.

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

        • InProgress: The pipeline execution is currently running.

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

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

        • Succeeded: The pipeline execution was completed successfully.

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

        • Failed: The pipeline execution was not completed successfully.

        Possible values include:
        • "Cancelled"
        • "InProgress"
        • "Stopped"
        • "Stopping"
        • "Succeeded"
        • "Superseded"
        • "Failed"
      • statusSummary — (String)

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

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

      • variables — (Array<map>)

        A list of pipeline variables used for the pipeline execution.

        • name — (String)

          The name of a pipeline-level variable.

        • resolvedValue — (String)

          The resolved value of a pipeline-level variable.

      • trigger — (map)

        The interaction or event that started a pipeline execution.

        • triggerType — (String)

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

          Possible values include:
          • "CreatePipeline"
          • "StartPipelineExecution"
          • "PollForSourceChanges"
          • "Webhook"
          • "CloudWatchEvent"
          • "PutActionRevision"
          • "WebhookV2"
          • "ManualRollback"
          • "AutomatedRollback"
        • triggerDetail — (String)

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

      • executionMode — (String)

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

        Possible values include:
        • "QUEUED"
        • "SUPERSEDED"
        • "PARALLEL"
      • executionType — (String)

        The type of the pipeline execution.

        Possible values include:
        • "STANDARD"
        • "ROLLBACK"
      • rollbackMetadata — (map)

        The metadata about the execution pertaining to stage rollback.

        • rollbackTargetPipelineExecutionId — (String)

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

Returns:

• (AWS.Request) —

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

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.

      • inboundExecution — (map)

        Represents information about the run of a stage.

        • pipelineExecutionId — required — (String)

          The ID of the pipeline execution associated with the stage.

        • status — required — (String)

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

          Note: A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
          Possible values include:
          • "Cancelled"
          • "InProgress"
          • "Failed"
          • "Stopped"
          • "Stopping"
          • "Succeeded"
        • type — (String)

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

          Possible values include:
          • "STANDARD"
          • "ROLLBACK"
      • inboundExecutions — (Array<map>)

        The inbound executions for a stage.

        • pipelineExecutionId — required — (String)

          The ID of the pipeline execution associated with the stage.

        • status — required — (String)

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

          Note: A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
          Possible values include:
          • "Cancelled"
          • "InProgress"
          • "Failed"
          • "Stopped"
          • "Stopping"
          • "Succeeded"
        • type — (String)

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

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

          • revisionId — required — (String)

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

          • revisionChangeId — required — (String)

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

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

          • actionExecutionId — (String)

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

            Note: For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
          • status — (String)

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

            Possible values include:
            • "InProgress"
            • "Abandoned"
            • "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. It 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 Amazon Web Services that is 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 Amazon Web Services.

            • code — (String)

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

        • pipelineExecutionId — required — (String)

          The ID of the pipeline execution associated with the stage.

        • status — required — (String)

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

          Note: A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
          Possible values include:
          • "Cancelled"
          • "InProgress"
          • "Failed"
          • "Stopped"
          • "Stopping"
          • "Succeeded"
        • type — (String)

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

          Possible values include:
          • "STANDARD"
          • "ROLLBACK"
      • beforeEntryConditionState — (map)

        The state of the entry conditions for a stage.

        • latestExecution — (map)

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

          • status — (String)

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

            Possible values include:
            • "InProgress"
            • "Failed"
            • "Errored"
            • "Succeeded"
            • "Cancelled"
            • "Abandoned"
            • "Overridden"
          • summary — (String)

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

        • conditionStates — (Array<map>)

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

          • latestExecution — (map)

            The state of the latest run of the rule.

            • status — (String)

              The status of the run for a condition.

              Possible values include:
              • "InProgress"
              • "Failed"
              • "Errored"
              • "Succeeded"
              • "Cancelled"
              • "Abandoned"
              • "Overridden"
            • summary — (String)

              The summary of information about a run for a condition.

            • lastStatusChange — (Date)

              The last status change of the condition.

          • ruleStates — (Array<map>)

            The state of the rules for the condition.

            • ruleName — (String)

              The name of the rule.

            • currentRevision — (map)

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

              • revisionId — required — (String)

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

              • revisionChangeId — required — (String)

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

              • created — required — (Date)

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

            • latestExecution — (map)

              Represents information about the latest run of an rule.

              • ruleExecutionId — (String)

                The execution ID for the run of the rule.

              • status — (String)

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

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

                A summary of the run of the rule.

              • lastStatusChange — (Date)

                The last status change of the rule.

              • token — (String)

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

              • lastUpdatedBy — (String)

                The ARN of the user who last changed the rule.

              • externalExecutionId — (String)

                The external ID of the run of the rule.

              • externalExecutionUrl — (String)

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

              • errorDetails — (map)

                Represents information about an error in CodePipeline.

                • code — (String)

                  The system ID or 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 details page.

            • revisionUrl — (String)

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

      • onSuccessConditionState — (map)

        The state of the success conditions for a stage.

        • latestExecution — (map)

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

          • status — (String)

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

            Possible values include:
            • "InProgress"
            • "Failed"
            • "Errored"
            • "Succeeded"
            • "Cancelled"
            • "Abandoned"
            • "Overridden"
          • summary — (String)

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

        • conditionStates — (Array<map>)

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

          • latestExecution — (map)

            The state of the latest run of the rule.

            • status — (String)

              The status of the run for a condition.

              Possible values include:
              • "InProgress"
              • "Failed"
              • "Errored"
              • "Succeeded"
              • "Cancelled"
              • "Abandoned"
              • "Overridden"
            • summary — (String)

              The summary of information about a run for a condition.

            • lastStatusChange — (Date)

              The last status change of the condition.

          • ruleStates — (Array<map>)

            The state of the rules for the condition.

            • ruleName — (String)

              The name of the rule.

            • currentRevision — (map)

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

              • revisionId — required — (String)

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

              • revisionChangeId — required — (String)

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

              • created — required — (Date)

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

            • latestExecution — (map)

              Represents information about the latest run of an rule.

              • ruleExecutionId — (String)

                The execution ID for the run of the rule.

              • status — (String)

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

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

                A summary of the run of the rule.

              • lastStatusChange — (Date)

                The last status change of the rule.

              • token — (String)

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

              • lastUpdatedBy — (String)

                The ARN of the user who last changed the rule.

              • externalExecutionId — (String)

                The external ID of the run of the rule.

              • externalExecutionUrl — (String)

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

              • errorDetails — (map)

                Represents information about an error in CodePipeline.

                • code — (String)

                  The system ID or 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 details page.

            • revisionUrl — (String)

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

      • onFailureConditionState — (map)

        The state of the failure conditions for a stage.

        • latestExecution — (map)

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

          • status — (String)

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

            Possible values include:
            • "InProgress"
            • "Failed"
            • "Errored"
            • "Succeeded"
            • "Cancelled"
            • "Abandoned"
            • "Overridden"
          • summary — (String)

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

        • conditionStates — (Array<map>)

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

          • latestExecution — (map)

            The state of the latest run of the rule.

            • status — (String)

              The status of the run for a condition.

              Possible values include:
              • "InProgress"
              • "Failed"
              • "Errored"
              • "Succeeded"
              • "Cancelled"
              • "Abandoned"
              • "Overridden"
            • summary — (String)

              The summary of information about a run for a condition.

            • lastStatusChange — (Date)

              The last status change of the condition.

          • ruleStates — (Array<map>)

            The state of the rules for the condition.

            • ruleName — (String)

              The name of the rule.

            • currentRevision — (map)

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

              • revisionId — required — (String)

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

              • revisionChangeId — required — (String)

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

              • created — required — (Date)

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

            • latestExecution — (map)

              Represents information about the latest run of an rule.

              • ruleExecutionId — (String)

                The execution ID for the run of the rule.

              • status — (String)

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

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

                A summary of the run of the rule.

              • lastStatusChange — (Date)

                The last status change of the rule.

              • token — (String)

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

              • lastUpdatedBy — (String)

                The ARN of the user who last changed the rule.

              • externalExecutionId — (String)

                The external ID of the run of the rule.

              • externalExecutionUrl — (String)

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

              • errorDetails — (map)

                Represents information about an error in CodePipeline.

                • code — (String)

                  The system ID or 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 details page.

            • revisionUrl — (String)

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

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

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

      • data — (map)

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

        • actionTypeId — (map)

          Represents information about an action type.

          • category — required — (String)

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

            • Source

            • Build

            • Test

            • Deploy

            • Invoke

            • Approval

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

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

            Possible values include:
            • "AWS"
            • "ThirdParty"
            • "Custom"
          • provider — required — (String)

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

          • version — required — (String)

            A string that describes the action version.

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

          Note: Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
          • 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 in the stage of a pipeline.

            • name — (String)

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

            • actionExecutionId — (String)

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

          • pipelineArn — (String)

            The Amazon Resource Name (ARN) of the pipeline.

          • pipelineExecutionId — (String)

            The execution ID of the pipeline.

        • inputArtifacts — (Array<map>)

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

          • 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 S3 bucket that contains the artifact.

              • bucketName — required — (String)

                The name of the S3 bucket.

              • objectKey — required — (String)

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

        • outputArtifacts — (Array<map>)

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

          • 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 S3 bucket that contains the artifact.

              • bucketName — required — (String)

                The name of the S3 bucket.

              • objectKey — required — (String)

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

        • artifactCredentials — (map)

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

          • accessKeyId — required — (String)

            The access key for the session.

          • secretAccessKey — required — (String)

            The secret access key for the session.

          • sessionToken — required — (String)

            The token for the session.

        • continuationToken — (String)

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

          • id — required — (String)

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

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

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

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

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

Returns:

• (AWS.Request) —

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

var params = {
  pipelineName: 'STRING_VALUE', /* required */
  filter: {
    latestInPipelineExecution: {
      pipelineExecutionId: 'STRING_VALUE', /* required */
      startTimeRange: Latest | All /* required */
    },
    pipelineExecutionId: 'STRING_VALUE'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codepipeline.listActionExecutions(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 list action execution history.

  • filter — (map)

    Input information used to filter action execution history.

    • pipelineExecutionId — (String)

      The pipeline execution ID used to filter action execution history.

    • latestInPipelineExecution — (map)

      The latest execution in the pipeline.

      Note: Filtering on the latest execution is available for executions run on or after February 08, 2024.
      • pipelineExecutionId — required — (String)

        The execution ID for the latest execution in the pipeline.

      • startTimeRange — required — (String)

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

        • All

        • Latest

        Possible values include:
        • "Latest"
        • "All"
  • 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. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.

  • nextToken — (String)

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

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:

    • actionExecutionDetails — (Array<map>)

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

      • pipelineExecutionId — (String)

        The pipeline execution ID for the action execution.

      • actionExecutionId — (String)

        The action execution ID.

      • pipelineVersion — (Integer)

        The version of the pipeline where the action was run.

      • stageName — (String)

        The name of the stage that contains the action.

      • actionName — (String)

        The name of the action.

      • startTime — (Date)

        The start time of the action execution.

      • lastUpdateTime — (Date)

        The last update time of the action execution.

      • updatedBy — (String)

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

      • status — (String)

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

        Possible values include:
        • "InProgress"
        • "Abandoned"
        • "Succeeded"
        • "Failed"
      • input — (map)

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

        • actionTypeId — (map)

          Represents information about an action type.

          • category — required — (String)

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

            • Source

            • Build

            • Test

            • Deploy

            • Invoke

            • Approval

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

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

            Possible values include:
            • "AWS"
            • "ThirdParty"
            • "Custom"
          • provider — required — (String)

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

          • version — required — (String)

            A string that describes the action version.

        • configuration — (map<String>)

          Configuration data for an action execution.

        • resolvedConfiguration — (map<String>)

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

        • roleArn — (String)

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

        • region — (String)

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

        • inputArtifacts — (Array<map>)

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

          • name — (String)

            The artifact object name for the action execution.

          • s3location — (map)

            The Amazon S3 artifact location for the action execution.

            • bucket — (String)

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

            • key — (String)

              The artifact name.

        • namespace — (String)

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

      • output — (map)

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

        • outputArtifacts — (Array<map>)

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

          • name — (String)

            The artifact object name for the action execution.

          • s3location — (map)

            The Amazon S3 artifact location for the action execution.

            • bucket — (String)

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

            • key — (String)

              The artifact name.

        • executionResult — (map)

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

          • externalExecutionId — (String)

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

          • externalExecutionSummary — (String)

            The action provider's summary for the action execution.

          • externalExecutionUrl — (String)

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

          • errorDetails — (map)

            Represents information about an error in CodePipeline.

            • code — (String)

              The system ID or number code of the error.

            • message — (String)

              The text of the error message.

        • outputVariables — (map<String>)

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

    • nextToken — (String)

      If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.

Returns:

• (AWS.Request) —

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

var params = {
  actionOwnerFilter: AWS | ThirdParty | Custom,
  nextToken: 'STRING_VALUE',
  regionFilter: '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.

  • regionFilter — (String)

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

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.

      • id — required — (map)

        Represents information about an action type.

        • category — required — (String)

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

          • Source

          • Build

          • Test

          • Deploy

          • Invoke

          • Approval

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

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

          Possible values include:
          • "AWS"
          • "ThirdParty"
          • "Custom"
        • provider — required — (String)

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

        • version — required — (String)

          A string that describes the action version.

      • 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 CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

        • executionUrlTemplate — (String)

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

        • revisionUrlTemplate — (String)

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

      • actionConfigurationProperties — (Array<map>)

        The configuration properties for the action type.

        • name — required — (String)

          The name of the action configuration property.

        • required — required — (Boolean)

          Whether the configuration property is a required value.

        • key — required — (Boolean)

          Whether the configuration property is a key.

        • secret — required — (Boolean)

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

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

        • queryable — (Boolean)

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

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

        • description — (String)

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

        • type — (String)

          The type of the configuration property.

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

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

        • minimumCount — required — (Integer)

          The minimum number of artifacts allowed for the action type.

        • maximumCount — required — (Integer)

          The maximum number of artifacts allowed for the action type.

      • outputArtifactDetails — required — (map)

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

        • minimumCount — required — (Integer)

          The minimum number of artifacts allowed for the action type.

        • maximumCount — required — (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. It 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.

var params = {
  pipelineName: 'STRING_VALUE', /* required */
  filter: {
    succeededInStage: {
      stageName: 'STRING_VALUE'
    }
  },
  maxResults: 'NUMBER_VALUE',
  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. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.

  • filter — (map)

    The pipeline execution to filter on.

    • succeededInStage — (map)

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

      • stageName — (String)

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

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

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

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

        • Succeeded: The pipeline execution was completed successfully.

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

        • Failed: The pipeline execution was not completed successfully.

        Possible values include:
        • "Cancelled"
        • "InProgress"
        • "Stopped"
        • "Stopping"
        • "Succeeded"
        • "Superseded"
        • "Failed"
      • statusSummary — (String)

        Status summary for the pipeline.

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

      • sourceRevisions — (Array<map>)

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

        • actionName — required — (String)

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

        • revisionId — (String)

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

        • revisionSummary — (String)

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

        • revisionUrl — (String)

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

      • trigger — (map)

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

        • triggerType — (String)

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

          Possible values include:
          • "CreatePipeline"
          • "StartPipelineExecution"
          • "PollForSourceChanges"
          • "Webhook"
          • "CloudWatchEvent"
          • "PutActionRevision"
          • "WebhookV2"
          • "ManualRollback"
          • "AutomatedRollback"
        • triggerDetail — (String)

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

      • stopTrigger — (map)

        The interaction that stopped a pipeline execution.

        • reason — (String)

          The user-specified reason the pipeline was stopped.

      • executionMode — (String)

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

        Possible values include:
        • "QUEUED"
        • "SUPERSEDED"
        • "PARALLEL"
      • executionType — (String)

        Type of the pipeline execution.

        Possible values include:
        • "STANDARD"
        • "ROLLBACK"
      • rollbackMetadata — (map)

        The metadata for the stage execution to be rolled back.

        • rollbackTargetPipelineExecutionId — (String)

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

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

var params = {
  maxResults: 'NUMBER_VALUE',
  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. It can be used to return the next set of pipelines in the list.

  • maxResults — (Integer)

    The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.

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.

      • pipelineType — (String)

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

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

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

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

        For information about pricing for CodePipeline, see Pricing.

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

        Possible values include:
        • "V1"
        • "V2"
      • executionMode — (String)

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

        Possible values include:
        • "QUEUED"
        • "SUPERSEDED"
        • "PARALLEL"
      • 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. It 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.

var params = {
  pipelineName: 'STRING_VALUE', /* required */
  filter: {
    latestInPipelineExecution: {
      pipelineExecutionId: 'STRING_VALUE', /* required */
      startTimeRange: Latest | All /* required */
    },
    pipelineExecutionId: 'STRING_VALUE'
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codepipeline.listRuleExecutions(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.

  • filter — (map)

    Input information used to filter rule execution history.

    • pipelineExecutionId — (String)

      The pipeline execution ID used to filter rule execution history.

    • latestInPipelineExecution — (map)

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

      Note: Filtering on the latest execution is available for executions run on or after February 08, 2024.
      • pipelineExecutionId — required — (String)

        The execution ID for the latest execution in the pipeline.

      • startTimeRange — required — (String)

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

        • All

        • Latest

        Possible values include:
        • "Latest"
        • "All"
  • 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. Pipeline 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 ListRuleExecutions call, which can be used to return the next set of rule 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:

    • ruleExecutionDetails — (Array<map>)

      Details about the output for listing rule executions.

      • pipelineExecutionId — (String)

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

      • ruleExecutionId — (String)

        The ID of the run for the rule.

      • pipelineVersion — (Integer)

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

      • stageName — (String)

        The name of the stage where the rule was run.

      • ruleName — (String)

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

      • startTime — (Date)

        The start time of the rule execution.

      • lastUpdateTime — (Date)

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

      • updatedBy — (String)

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

      • status — (String)

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

        Possible values include:
        • "InProgress"
        • "Abandoned"
        • "Succeeded"
        • "Failed"
      • input — (map)

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

        • ruleTypeId — (map)

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

          • category — required — (String)

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

            Possible values include:
            • "Rule"
          • owner — (String)

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

            Possible values include:
            • "AWS"
          • provider — required — (String)

            The rule provider, such as the DeploymentWindow rule.

          • version — (String)

            A string that describes the rule version.

        • configuration — (map<String>)

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

        • resolvedConfiguration — (map<String>)

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

        • roleArn — (String)

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

        • region — (String)

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

        • inputArtifacts — (Array<map>)

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

          • name — (String)

            The artifact object name for the action execution.

          • s3location — (map)

            The Amazon S3 artifact location for the action execution.

            • bucket — (String)

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

            • key — (String)

              The artifact name.

      • output — (map)

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

        • executionResult — (map)

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

          • externalExecutionId — (String)

            The external ID for the rule execution.

          • externalExecutionSummary — (String)

            The external provider summary for the rule execution.

          • externalExecutionUrl — (String)

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

          • errorDetails — (map)

            Represents information about an error in CodePipeline.

            • code — (String)

              The system ID or number code of the error.

            • message — (String)

              The text of the error message.

    • nextToken — (String)

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