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

Inherits:

Struct

• Object
• Struct
• Aws::CodePipeline::Types::PutJobSuccessResultInput

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,
  },
  output_variables: {
    "OutputVariablesKey" => "OutputVariablesValue",
  },
}

Represents the input of a PutJobSuccessResult action.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #current_revision ⇒ Types::CurrentRevision

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

• #execution_details ⇒ Types::ExecutionDetails

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

• #job_id ⇒ String

  The unique system-generated ID of the job that succeeded.

• #output_variables ⇒ Hash<String,String>

  Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration.

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

Returns:

• (String)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3974

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details,
  :output_variables)
  SENSITIVE = []
  include Aws::Structure
end

#current_revision ⇒ Types::CurrentRevision

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

Returns:

• (Types::CurrentRevision)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3974

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details,
  :output_variables)
  SENSITIVE = []
  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:

• (Types::ExecutionDetails)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3974

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details,
  :output_variables)
  SENSITIVE = []
  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)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3974

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details,
  :output_variables)
  SENSITIVE = []
  include Aws::Structure
end

#output_variables ⇒ Hash<String,String>

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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3974

class PutJobSuccessResultInput < Struct.new(
  :job_id,
  :current_revision,
  :continuation_token,
  :execution_details,
  :output_variables)
  SENSITIVE = []
  include Aws::Structure
end