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

Class: Aws::ACMPCA::Waiters::AuditReportCreated

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/waiters.rb

Overview

Wait until a Audit Report is created

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ AuditReportCreated

Returns a new instance of AuditReportCreated

Parameters:

  • options (Hash)

Options Hash (options):

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


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/waiters.rb', line 22

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_certificate_authority_audit_report,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "audit_report_status",
          "expected" => "SUCCESS"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "audit_report_status",
          "expected" => "FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :certificate_authority_arn (required, String)

    The Amazon Resource Name (ARN) of the private CA. This must be of the form:

    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

  • :audit_report_id (required, String)

    The report ID returned by calling the CreateCertificateAuthorityAuditReport action.

Returns:



49
50
51
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/waiters.rb', line 49

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