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

The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.

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

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

The response's http status code.

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

The details about the failure of a job.

The name of the pipeline that contains the action.

The name of the stage that contains the action.

The name of the action for which approval is requested.

Represents information about the result of the approval request.

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

The timestamp showing when the approval or rejection was submitted.

The response's http status code.

The unique system-generated ID of the job.

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.

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.

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

The response's http status code.

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

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.

Represents information about failure details.

The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.

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

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

If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent API call to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.

The tags for the resource.

The response's http status code.

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

The response's http status code.

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

Represents information about an action type.

Information about the jobs to take action on.

The response's http status code.

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

A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.

Represents information about an action type.

Information about the jobs to take action on.

The response's http status code.

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

The name of the pipeline to start.

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

The response's http status code.

The name of the pipeline to be updated.

The structure of the updated pipeline.

The response's http status code.

The name of the pipeline to be deleted.

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

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

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

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

The version number of the pipeline.

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

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

The response's http status code.

The unique system-generated ID for the job.

The details of the job.

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

The response's http status code.

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.

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.

The list of pipelines.

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.

The response's http status code.

The name of the pipeline that contains the failed stage.

The name of the failed stage to be retried.

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

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

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

The response's http status code.

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

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

Represents information about the execution of a pipeline.

The response's http status code.

Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.

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

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

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

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

The name of the webhook you want to deregister.

The response's http status code.

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

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

The version of the custom action to delete.

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

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

The name of the action that processes the revision.

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

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

The ID of the current workflow state of the pipeline.

The response's http status code.

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

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

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

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.

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

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

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

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.

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.

The response's http status code.

Provides details of the action types.

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

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.

Whether the job worker has received the specified job.

The response's http status code.

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

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

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

The name of the webhook you want to delete.

The response's http status code.

The tags for the webhook.

The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

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

The response's http status code.

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

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

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

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

The response's http status code.

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.

Input information used to filter action execution history.

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.

Detailed execution history is available for executions run on or after February 21, 2019.

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

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

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.

The response's http status code.

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

• Source

• Build

• Test

• Deploy

• Approval

• Invoke

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

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

A string that describes the action type version.

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

The response's http status code.

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

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

The name of the pipeline to stop.

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

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

The response's http status code.

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

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

The response's http status code.

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

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

The response's http status code.

The tags for the pipeline.

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

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

Specifies the tags applied to the pipeline.

The response's http status code.

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

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.

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

The response's http status code.

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

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

Represents information about a current revision.

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

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.

URLs that provide users information about this custom action.

The configuration properties for the custom action.

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

The tags for the custom action.

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

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

The version identifier of the custom action.

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

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

Specifies the tags applied to the custom action.

The response's http status code.

Returns information about the details of an action type.

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.

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.

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

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.

A list of executions in the history of a pipeline.

The response's http status code.

The access key for the session.

The secret access key for the session.

The token for the session.

The configuration data for the action.

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.

The type of the configuration property.

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

The name of the action configuration property.

Whether the configuration property is a required value.

Whether the configuration property is a key.

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.

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

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

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

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

The order in which actions are run.

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

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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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 },

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

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

The action declaration's name.

Specifies the action type and the provider of the action.

The ARN of the user who last changed the pipeline.

A summary of the run of the action.

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

The last status change of the action.

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.

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

The external ID of the run of the action.

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

A percentage of completeness of the action as it runs.

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

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

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

The start time of the action execution.

The version of the pipeline where the action was run.

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

The name of the action.

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

The pipeline execution ID for the action execution.

The name of the stage that contains the action.

The last update time of the action execution.

The action execution ID.

The pipeline execution ID used to filter action execution history.

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

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

The AWS Region for the action, such as us-east-1.

Configuration data for an action execution.

Undocumented member.

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

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

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

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

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

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

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

The action provider's summary for the action execution.

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

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

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

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

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

The name of the action.

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

Represents information about the run of an action.

The settings for the action type.

The configuration properties for the action type.

Represents information about an action type.

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

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

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.

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.

The links associated with the action type to be updated.

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

The description for the action type to be updated.

The properties of the action type to be updated.

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

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

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.

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.

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.

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

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

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

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

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

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

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.

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

A string that describes the action version.

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

• Source

• Build

• Test

• Deploy

• Approval

• Invoke

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

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

A string that describes the action type version.

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

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.

The description of the property that is displayed to users.

The property name that is displayed to users.

Whether the configuration property is an optional value.

Whether the configuration property is a key.

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.

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.

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

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

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

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.

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.

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.

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

The summary of the current status of the approval request.

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

The location of an artifact.

The artifact's name.

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

The artifact object name for the action execution.

The Amazon S3 artifact location for the action execution.

The minimum number of artifacts allowed for the action type.

The maximum number of artifacts allowed for the action type.

The S3 bucket that contains the artifact.

The type of artifact in the location.

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

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

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

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

The revision ID of the artifact.

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

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

The type of the artifact store, such as S3.

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 AWS Region as the pipeline to store your pipeline artifacts.

Reserved for future use.

Reserved for future use.

The summary of the most recent revision of the artifact.

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

The revision ID of the current version of an artifact.

The change identifier for the current revision.

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

Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

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

The system ID or number code of the error.

The text of the error message.

The summary of the current status of the actions.

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

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

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

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.

Details about the Lambda executor of the action type.

Details about the JobWorker executor of the action type.

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

The type of the failure.

The message about the failure.

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

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

Other data about a job.

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

The unique system-generated ID of the job.

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

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

The output of the job.

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

Represents information about a pipeline to a job worker.

Includes pipelineArn and pipelineExecutionId for custom jobs.

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

Represents information about an action type.

The artifact supplied to the job.

Represents information about an action configuration.

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

The AWS account ID associated with the job.

The unique system-generated ID of the job.

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

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

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

The Amazon Resource Name (ARN) of the webhook.

The number code of the error.

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

The text of the error message about the webhook.

Specifies the tags applied to the webhook.

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

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

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.

The stage of the pipeline.

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.

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

The Amazon Resource Name (ARN) of the pipeline.

The execution ID of the pipeline.

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

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

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

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

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.

The name of the pipeline.

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

The stage in which to perform the action.

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.

The name of the pipeline with the specified pipeline execution.

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

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

The ID of the pipeline execution.

A list of ArtifactRevision objects included in a pipeline execution.

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.

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

The interaction that stopped a pipeline execution.

The ID of the pipeline execution.

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

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

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

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

The Amazon Resource Name (ARN) of the pipeline.

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

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

The name of the pipeline.

The version number of the pipeline.

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

The name of the S3 bucket.

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

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

The artifact name.

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

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

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

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

The name of the stage.

Reserved for future use.

The name of the stage.

The actions included in a stage.

The ID of the pipeline execution associated with the stage.

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

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

Undocumented member.

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

The state of the stage.

The name of the stage.

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

The user-specified reason the pipeline was stopped.

The tag's key.

The tag's value.

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.

The identifier used to identify the job in AWS CodePipeline.

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

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.

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

Represents information about a pipeline to a job worker.

Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

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

Represents information about an action type.

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.

Represents information about an action configuration.

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

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

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

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

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

The timestamp when the transition state was last changed.

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

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

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

The name of the webhook.

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

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

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

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

• For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
• IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
• UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

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

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

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