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. This number must be returned in the response.
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 will preserve the prior value of the secret.
Boolean queryable
Indicates that the proprety will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
String description
The description of the action configuration property that will be displayed to users.
String type
The type of the configuration property.
String name
The name of the action within the context of a job.
String name
The action declaration's name.
ActionTypeId actionTypeId
The configuration information for the action type.
Integer runOrder
The order in which actions are run.
Map<K,V> configuration
The action declaration's configuration.
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 will perform the declared action. This is assumed through the roleArn for the pipeline.
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 externalExecutionId
The external ID of the run of the action.
String externalExecutionUrl
The URL of a resource external to AWS that will be 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 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
ActionExecution latestExecution
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
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 values below.
String owner
The creator of the action being called.
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.
String version
A string that identifies the action type.
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 within 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 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 type
The type of artifact in the location.
S3ArtifactLocation s3Location
The Amazon S3 bucket that contains the artifact.
String type
The type of the artifact store, such as S3.
String location
The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
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 source action or a build action.
String provider
The provider of the service used in the custom action, such as AWS CodeDeploy.
String version
The version number of the custom action.
ActionTypeSettings settings
List<E> configurationProperties
The configuration properties for the custom action.
ArtifactDetails inputArtifactDetails
ArtifactDetails outputArtifactDetails
ActionType actionType
PipelineDeclaration pipeline
PipelineDeclaration pipeline
String name
The name of the pipeline to be deleted.
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 will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
String reason
The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
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 will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound).
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 zero to one hundred percent.
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.
PipelineDeclaration pipeline
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.
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
Additional 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. This number must be returned in the response.
String accountId
The ID of the AWS account to use when performing the job.
ActionTypeId actionTypeId
ActionConfiguration actionConfiguration
PipelineContext pipelineContext
List<E> inputArtifacts
The artifact supplied to the job.
List<E> outputArtifacts
The output of the job.
AWSSessionCredentials artifactCredentials
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
EncryptionKey encryptionKey
String nextToken
An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.
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
String name
The name of the action to be performed.
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
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 automatically incremented when a pipeline is updated.
ActionTypeId actionTypeId
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 will be returned.
ActionTypeId actionTypeId
Integer maxBatchSize
The maximum number of jobs to return in a poll for jobs call.
String pipelineName
The name of the pipeline that will start processing the revision to the source.
String stageName
The name of the stage that contains the action that will act upon the revision.
String actionName
The name of the action that will process the revision.
ActionRevision actionRevision
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 upon 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 will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
ExecutionDetails executionDetails
The execution details of the successful job, such as the actions taken by the job worker.
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
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
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 will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied.
ExecutionDetails executionDetails
String name
The name of the stage.
String stageName
The name of the stage.
TransitionState inboundTransitionState
The state of the inbound transition, which is either enabled or disabled.
List<E> actionStates
The state of the stage.
String name
The name of the pipeline to start.
String pipelineExecutionId
The unique system-generated ID of the pipeline that was started.
ActionTypeId actionTypeId
ActionConfiguration actionConfiguration
PipelineContext pipelineContext
List<E> inputArtifacts
The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
List<E> outputArtifacts
The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
AWSSessionCredentials artifactCredentials
String continuationToken
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order 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. This number must be returned in the response.
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.
Copyright © 2017. All rights reserved.