Class: Aws::Signer::Waiters::SuccessfulSigningJob

Inherits:

Object

• Object
• Aws::Signer::Waiters::SuccessfulSigningJob

Defined in:

gems/aws-sdk-signer/lib/aws-sdk-signer/waiters.rb

Instance Method Summary

• #initialize(options) ⇒ SuccessfulSigningJob constructor

  A new instance of SuccessfulSigningJob.

• #wait(params = {}) ⇒ Types::DescribeSigningJobResponse

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ SuccessfulSigningJob

Returns a new instance of SuccessfulSigningJob.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 25
• :delay (Integer) — default: 20
• :before_attempt (Proc)
• :before_wait (Proc)

# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/waiters.rb', line 84

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 25,
    delay: 20,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_signing_job,
      acceptors: [
        {
          "expected" => "Succeeded",
          "matcher" => "path",
          "state" => "success",
          "argument" => "status"
        },
        {
          "expected" => "Failed",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "status"
        },
        {
          "expected" => "ResourceNotFoundException",
          "matcher" => "error",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeSigningJobResponse

Returns a response object which responds to the following methods:

• #job_id => String
• #source => Types::Source
• #signing_material => Types::SigningMaterial
• #platform_id => String
• #platform_display_name => String
• #profile_name => String
• #profile_version => String
• #overrides => Types::SigningPlatformOverrides
• #signing_parameters => Hash<String,String>
• #created_at => Time
• #completed_at => Time
• #signature_expires_at => Time
• #requested_by => String
• #status => String
• #status_reason => String
• #revocation_record => Types::SigningJobRevocationRecord
• #signed_object => Types::SignedObject
• #job_owner => String
• #job_invoker => String

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :job_id (required, String) —

  The ID of the signing job on input.

Returns:

• (Types::DescribeSigningJobResponse) —

  Returns a response object which responds to the following methods:

  • #job_id => String
  • #source => Types::Source
  • #signing_material => Types::SigningMaterial
  • #platform_id => String
  • #platform_display_name => String
  • #profile_name => String
  • #profile_version => String
  • #overrides => Types::SigningPlatformOverrides
  • #signing_parameters => Hash<String,String>
  • #created_at => Time
  • #completed_at => Time
  • #signature_expires_at => Time
  • #requested_by => String
  • #status => String
  • #status_reason => String
  • #revocation_record => Types::SigningJobRevocationRecord
  • #signed_object => Types::SignedObject
  • #job_owner => String
  • #job_invoker => String

# File 'gems/aws-sdk-signer/lib/aws-sdk-signer/waiters.rb', line 116

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end