String jobId
The unique system-generated ID of the job for which you want to confirm receipt.
String nonce
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.
String status
Whether the job worker has received the specified job.
String jobId
The unique system-generated ID of the job.
String nonce
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.
String clientToken
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.
String status
The status information for the third party job, if any.
String name
The name of the action configuration property.
Boolean required
Whether the configuration property is a required value.
Boolean key
Whether the configuration property is a key.
Boolean secret
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.
Boolean queryable
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.
String description
The description of the action configuration property that is displayed to users.
String type
The type of the configuration property.
String name
The action declaration's name.
ActionTypeId actionTypeId
Specifies the action type and the provider of the action.
Integer runOrder
The order in which actions are run.
Map<K,V> configuration
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 },
List<E> outputArtifacts
The name or ID of the result of the action declaration, such as a test or build artifact.
List<E> inputArtifacts
The name or ID of the artifact consumed by the action, such as a test or build artifact.
String roleArn
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
String region
The action declaration's AWS Region, such as us-east-1.
String namespace
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
String actionExecutionId
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.
String status
The status of the action, or for a completed action, the last status of the action.
String summary
A summary of the run of the action.
Date lastStatusChange
The last status change of the action.
String token
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.
String lastUpdatedBy
The ARN of the user who last changed the pipeline.
String externalExecutionId
The external ID of the run of the action.
String externalExecutionUrl
The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).
Integer percentComplete
A percentage of completeness of the action as it runs.
ErrorDetails errorDetails
The details of an error returned by a URL external to AWS.
String pipelineExecutionId
The pipeline execution ID for the action execution.
String actionExecutionId
The action execution ID.
Integer pipelineVersion
The version of the pipeline where the action was run.
String stageName
The name of the stage that contains the action.
String actionName
The name of the action.
Date startTime
The start time of the action execution.
Date lastUpdateTime
The last update time of the action execution.
String status
The status of the action execution. Status categories are InProgress
, Succeeded
, and
Failed
.
ActionExecutionInput input
Input details for the action execution, such as role ARN, Region, and input artifacts.
ActionExecutionOutput output
Output details for the action execution, such as the action execution result.
String pipelineExecutionId
The pipeline execution ID used to filter action execution history.
ActionTypeId actionTypeId
Map<K,V> configuration
Configuration data for an action execution.
Map<K,V> resolvedConfiguration
Configuration data for an action execution with all variable references replaced with their real values for the execution.
String roleArn
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
String region
The AWS Region for the action, such as us-east-1.
List<E> inputArtifacts
Details of input artifacts of the action that correspond to the action execution.
String namespace
The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
List<E> outputArtifacts
Details of output artifacts of the action that correspond to the action execution.
ActionExecutionResult executionResult
Execution result information listed in the output details for an action execution.
Map<K,V> outputVariables
The outputVariables field shows the key-value pairs that were output as part of that execution.
String externalExecutionId
The action provider's external ID for the action execution.
String externalExecutionSummary
The action provider's summary for the action execution.
String externalExecutionUrl
The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
String revisionId
The system-generated unique ID that identifies the revision number of the action.
String revisionChangeId
The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
Date created
The date and time when the most recent version of the action was created, in timestamp format.
String actionName
The name of the action.
ActionRevision currentRevision
Represents information about the version (or revision) of an action.
ActionExecution latestExecution
Represents information about the run of an action.
String entityUrl
A URL link for more information about the state of the action, such as a deployment group details page.
String revisionUrl
A URL link for more information about the revision, such as a commit details page.
ActionTypeId id
Represents information about an action type.
ActionTypeSettings settings
The settings for the action type.
List<E> actionConfigurationProperties
The configuration properties for the action type.
ArtifactDetails inputArtifactDetails
The details of the input artifact for the action, such as its commit ID.
ArtifactDetails outputArtifactDetails
The details of the output artifact of the action, such as its commit ID.
String category
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
String owner
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.
String provider
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.
String version
A string that describes the action version.
String thirdPartyConfigurationUrl
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.
String entityUrlTemplate
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.
String executionUrlTemplate
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.
String revisionUrlTemplate
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.
String name
The artifact's name.
String revision
The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
ArtifactLocation location
The location of an artifact.
String name
The artifact object name for the action execution.
S3Location s3location
The Amazon S3 artifact location for the action execution.
String type
The type of artifact in the location.
S3ArtifactLocation s3Location
The S3 bucket that contains the artifact.
String name
The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
String revisionId
The revision ID of the artifact.
String revisionChangeIdentifier
An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
String revisionSummary
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.
Date created
The date and time when the most recent revision of the artifact was created, in timestamp format.
String revisionUrl
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.
String type
The type of the artifact store, such as S3.
String location
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.
EncryptionKey encryptionKey
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.
String category
The category of the custom action, such as a build action or a test action.
String provider
The provider of the service used in the custom action, such as AWS CodeDeploy.
String version
The version identifier of the custom action.
ActionTypeSettings settings
URLs that provide users information about this custom action.
List<E> configurationProperties
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.
ArtifactDetails inputArtifactDetails
The details of the input artifact for the action, such as its commit ID.
ArtifactDetails outputArtifactDetails
The details of the output artifact of the action, such as its commit ID.
List<E> tags
The tags for the custom action.
ActionType actionType
Returns information about the details of an action type.
List<E> tags
Specifies the tags applied to the custom action.
PipelineDeclaration pipeline
Represents the structure of actions and stages to be performed in the pipeline.
List<E> tags
The tags for the pipeline.
PipelineDeclaration pipeline
Represents the structure of actions and stages to be performed in the pipeline.
List<E> tags
Specifies the tags applied to the pipeline.
String revision
The revision ID of the current version of an artifact.
String changeIdentifier
The change identifier for the current revision.
Date created
The date and time when the most recent revision of the artifact was created, in timestamp format.
String revisionSummary
The summary of the most recent revision of the artifact.
String name
The name of the pipeline to be deleted.
String name
The name of the webhook you want to delete.
String webhookName
The name of the webhook you want to deregister.
String pipelineName
The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
String stageName
The name of the stage where you want to disable the inbound or outbound transition of artifacts.
String transitionType
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).
String reason
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.
String pipelineName
The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
String stageName
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).
String transitionType
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).
String id
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.
String type
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'.
String summary
The summary of the current status of the actions.
String externalExecutionId
The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
Integer percentComplete
The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
String triggerType
The type of change-detection method, command, or user interaction that started a pipeline execution.
String triggerDetail
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.
String jobId
The unique system-generated ID for the job.
JobDetails jobDetails
The details of the job.
If AWSSessionCredentials is used, a long-running job can call GetJobDetails
again to obtain new
credentials.
PipelineExecution pipelineExecution
Represents information about the execution of a pipeline.
PipelineDeclaration pipeline
Represents the structure of actions and stages to be performed in the pipeline.
PipelineMetadata metadata
Represents the pipeline metadata information returned as part of the output of a GetPipeline
action.
String name
The name of the pipeline about which you want to get information.
String pipelineName
The name of the pipeline for which you want to get the state.
Integer pipelineVersion
The version number of the pipeline.
A newly created pipeline is always assigned a version number of 1
.
List<E> stageStates
A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
Date created
The date and time the pipeline was created, in timestamp format.
Date updated
The date and time the pipeline was last updated, in timestamp format.
ThirdPartyJobDetails jobDetails
The details of the job, including any protected values defined for the job.
String name
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.
String id
The unique system-generated ID of the job.
JobData data
Other data about a job.
String nonce
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.
String accountId
The ID of the AWS account to use when performing the job.
ActionTypeId actionTypeId
Represents information about an action type.
ActionConfiguration actionConfiguration
Represents information about an action configuration.
PipelineContext pipelineContext
Represents information about a pipeline to a job worker.
Includes pipelineArn
and pipelineExecutionId
for custom jobs.
List<E> inputArtifacts
The artifact supplied to the job.
List<E> outputArtifacts
The output of the job.
AWSSessionCredentials artifactCredentials
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.
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
EncryptionKey encryptionKey
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
String pipelineName
The name of the pipeline for which you want to list action execution history.
ActionExecutionFilter filter
Input information used to filter action execution history.
Integer maxResults
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.
String nextToken
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.
List<E> actionExecutionDetails
The details for a list of recent executions, such as action execution ID.
String nextToken
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.
String pipelineName
The name of the pipeline for which you want to get execution summary information.
Integer maxResults
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.
String nextToken
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.
List<E> pipelineExecutionSummaries
A list of executions in the history of a pipeline.
String nextToken
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.
String nextToken
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.
String resourceArn
The Amazon Resource Name (ARN) of the resource to get tags for.
String nextToken
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.
Integer maxResults
The maximum number of results to return in a single call.
List<E> tags
The tags for the resource.
String nextToken
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.
WebhookDefinition definition
The detail returned for each webhook, such as the webhook authentication type and filter rules.
String url
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.
String errorMessage
The text of the error message about the webhook.
String errorCode
The number code of the error.
Date lastTriggered
The date and time a webhook was last successfully triggered, in timestamp format.
String arn
The Amazon Resource Name (ARN) of the webhook.
List<E> tags
Specifies the tags applied to the webhook.
String nextToken
The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
Integer maxResults
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
List<E> webhooks
The JSON detail returned for each webhook in the list output for the ListWebhooks call.
String nextToken
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.
String name
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.
String pipelineName
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.
StageContext stage
The stage of the pipeline.
ActionContext action
The context of an action to a job worker in the stage of a pipeline.
String pipelineArn
The Amazon Resource Name (ARN) of the pipeline.
String pipelineExecutionId
The execution ID of the pipeline.
String name
The name of the pipeline.
String roleArn
The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no
actionRoleArn
, or to use to assume roles for actions with an actionRoleArn
.
ArtifactStore artifactStore
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
.
Map<K,V> artifactStores
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
.
List<E> stages
The stage in which to perform the action.
Integer version
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.
String pipelineName
The name of the pipeline with the specified pipeline execution.
Integer pipelineVersion
The version number of the pipeline with the specified pipeline execution.
String pipelineExecutionId
The ID of the pipeline execution.
String status
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.
String statusSummary
A summary that contains a description of the pipeline execution status.
List<E> artifactRevisions
A list of ArtifactRevision
objects included in a pipeline execution.
String pipelineExecutionId
The ID of the pipeline execution.
String status
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.
Date startTime
The date and time when the pipeline execution began, in timestamp format.
Date lastUpdateTime
The date and time of the last change to the pipeline execution, in timestamp format.
List<E> sourceRevisions
A list of the source artifact revisions that initiated a pipeline execution.
ExecutionTrigger trigger
The interaction or event that started a pipeline execution, such as automated change detection or a
StartPipelineExecution
API call.
StopExecutionTrigger stopTrigger
The interaction that stopped a pipeline execution.
ActionTypeId actionTypeId
Represents information about an action type.
Integer maxBatchSize
The maximum number of jobs to return in a poll for jobs call.
Map<K,V> queryParam
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.
ActionTypeId actionTypeId
Represents information about an action type.
Integer maxBatchSize
The maximum number of jobs to return in a poll for jobs call.
String pipelineName
The name of the pipeline that starts processing the revision to the source.
String stageName
The name of the stage that contains the action that acts on the revision.
String actionName
The name of the action that processes the revision.
ActionRevision actionRevision
Represents information about the version (or revision) of an action.
String pipelineName
The name of the pipeline that contains the action.
String stageName
The name of the stage that contains the action.
String actionName
The name of the action for which approval is requested.
ApprovalResult result
Represents information about the result of the approval request.
String token
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.
Date approvedAt
The timestamp showing when the approval or rejection was submitted.
String jobId
The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs
.
FailureDetails failureDetails
The details about the failure of a job.
String jobId
The unique system-generated ID of the job that succeeded. This is the same ID returned from
PollForJobs
.
CurrentRevision currentRevision
The ID of the current revision of the artifact successfully worked on by the job.
String continuationToken
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.
ExecutionDetails executionDetails
The execution details of the successful job, such as the actions taken by the job worker.
Map<K,V> outputVariables
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.
String jobId
The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs
.
String clientToken
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
FailureDetails failureDetails
Represents information about failure details.
String jobId
The ID of the job that successfully completed. This is the same ID returned from
PollForThirdPartyJobs
.
String clientToken
The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
CurrentRevision currentRevision
Represents information about a current revision.
String continuationToken
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.
ExecutionDetails executionDetails
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
WebhookDefinition 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.
List<E> tags
The tags for the webhook.
ListWebhookItem webhook
The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
String webhookName
The name of an existing webhook created with PutWebhook to register with a supported third party.
String pipelineName
The name of the pipeline that contains the failed stage.
String stageName
The name of the failed stage to be retried.
String pipelineExecutionId
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
String retryMode
The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
String pipelineExecutionId
The ID of the current workflow execution in the failed stage.
String actionName
The name of the action that processed the revision to the source artifact.
String revisionId
The system-generated unique ID that identifies the revision number of the artifact.
String revisionSummary
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.
String revisionUrl
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.
String name
The name of the stage.
String pipelineExecutionId
The ID of the pipeline execution associated with the stage.
String status
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.
String stageName
The name of the stage.
StageExecution inboundExecution
TransitionState inboundTransitionState
The state of the inbound transition, which is either enabled or disabled.
List<E> actionStates
The state of the stage.
StageExecution latestExecution
Information about the latest execution in the stage, including its ID and status.
String pipelineExecutionId
The unique system-generated ID of the pipeline execution that was started.
String reason
The user-specified reason the pipeline was stopped.
String pipelineName
The name of the pipeline to stop.
String pipelineExecutionId
The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState
action
to retrieve the current pipelineExecutionId.
Boolean abandon
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.
String reason
Use this option to enter comments, such as the reason the pipeline was stopped.
String pipelineExecutionId
The unique system-generated ID of the pipeline execution that was stopped.
ActionTypeId actionTypeId
Represents information about an action type.
ActionConfiguration actionConfiguration
Represents information about an action configuration.
PipelineContext pipelineContext
Represents information about a pipeline to a job worker.
Does not include pipelineArn
and pipelineExecutionId
for ThirdParty jobs.
List<E> inputArtifacts
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.
List<E> outputArtifacts
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.
AWSSessionCredentials artifactCredentials
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.
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
EncryptionKey encryptionKey
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.
String id
The identifier used to identify the job details in AWS CodePipeline.
ThirdPartyJobData data
The data to be returned by the third party job worker.
String nonce
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.
Boolean enabled
Whether the transition between stages is enabled (true) or disabled (false).
String lastChangedBy
The ID of the user who last changed the transition state.
Date lastChangedAt
The timestamp when the transition state was last changed.
String disabledReason
The user-specified reason why the transition between two stages of a pipeline was disabled.
PipelineDeclaration pipeline
The name of the pipeline to be updated.
PipelineDeclaration pipeline
The structure of the updated pipeline.
String allowedIPRange
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.
String secretToken
The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken
property
must be set.
String name
The name of the webhook.
String targetPipeline
The name of the pipeline you want to connect to the webhook.
String targetAction
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.
List<E> filters
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.
String authentication
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.
WebhookAuthConfiguration authenticationConfiguration
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.
String jsonPath
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.
String matchEquals
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.
Copyright © 2021. All rights reserved.