You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodePipeline::Types::PutJobSuccessResultInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb

Overview

Note:

When making an API call, you may pass PutJobSuccessResultInput data as a hash:

{
  job_id: "JobId", # required
  current_revision: {
    revision: "Revision", # required
    change_identifier: "RevisionChangeIdentifier", # required
    created: Time.now,
    revision_summary: "RevisionSummary",
  },
  continuation_token: "ContinuationToken",
  execution_details: {
    summary: "ExecutionSummary",
    external_execution_id: "ExecutionId",
    percent_complete: 1,
  },
}

Represents the input of a PutJobSuccessResult action.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#continuation_token ⇒ String

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

Returns:

  • (String) 


2798
2799
2800
2801
2802
2803
2804
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2798

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details)
  include Aws::Structure
end

#current_revision ⇒ Types::CurrentRevision

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

Returns:



2798
2799
2800
2801
2802
2803
2804
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2798

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details)
  include Aws::Structure
end

#execution_details ⇒ Types::ExecutionDetails

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

Returns:



2798
2799
2800
2801
2802
2803
2804
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2798

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details)
  include Aws::Structure
end

#job_id ⇒ String

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

Returns:

  • (String) 


2798
2799
2800
2801
2802
2803
2804
 
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2798

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details)
  include Aws::Structure
end