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

Class: Aws::CodePipeline::Types::PutThirdPartyJobSuccessResultInput

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 PutThirdPartyJobSuccessResultInput data as a hash:

{
  job_id: "ThirdPartyJobId", # required
  client_token: "ClientToken", # 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 PutThirdPartyJobSuccessResult action.

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

Returns:

  • (String)


2899
2900
2901
2902
2903
2904
2905
2906
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2899

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

#continuation_tokenString

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.

Returns:

  • (String)


2899
2900
2901
2902
2903
2904
2905
2906
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2899

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

#current_revisionTypes::CurrentRevision

Represents information about a current revision.



2899
2900
2901
2902
2903
2904
2905
2906
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2899

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

#execution_detailsTypes::ExecutionDetails

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



2899
2900
2901
2902
2903
2904
2905
2906
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2899

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

#job_idString

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

Returns:

  • (String)


2899
2900
2901
2902
2903
2904
2905
2906
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 2899

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