Class: Aws::ECR::Waiters::LifecyclePolicyPreviewComplete

Inherits:

Object

• Object
• Aws::ECR::Waiters::LifecyclePolicyPreviewComplete

Defined in:

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

Overview

Wait until a lifecycle policy preview request is complete and results can be accessed

Instance Method Summary

• #initialize(options) ⇒ LifecyclePolicyPreviewComplete constructor

  A new instance of LifecyclePolicyPreviewComplete.

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

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

Constructor Details

#initialize(options) ⇒ LifecyclePolicyPreviewComplete

Returns a new instance of LifecyclePolicyPreviewComplete.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/waiters.rb', line 131

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

Instance Method Details

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

Returns a response object which responds to the following methods:

• #registry_id => String
• #repository_name => String
• #lifecycle_policy_text => String
• #status => String
• #next_token => String
• #preview_results => Array<Types::LifecyclePolicyPreviewResult>
• #summary => Types::LifecyclePolicyPreviewSummary

Parameters:

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

  a customizable set of options

Options Hash (params):

• :registry_id (String) —

  The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

• :repository_name (required, String) —

  The name of the repository.

• :image_ids (Array<Types::ImageIdentifier>) —

  The list of imageIDs to be included.

• :next_token (String) —

  The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results exceeded the value of that parameter. Pagination continues from the end of the
 previous results that returned the nextToken value. This value is
 null when there are no more results to return. This option cannot be used when you specify images with imageIds.

• :max_results (Integer) —

  The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a single page along with a nextToken
 response element. The remaining results of the initial request can be seen by sending
 another GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. This value can be between 1 and 1000. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken value, if
 applicable. This option cannot be used when you specify images with imageIds.

• :filter (Types::LifecyclePolicyPreviewFilter) —

  An optional parameter that filters results based on image tag status and all tags, if tagged.

Returns:

• (Types::GetLifecyclePolicyPreviewResponse) —

  Returns a response object which responds to the following methods:

  • #registry_id => String
  • #repository_name => String
  • #lifecycle_policy_text => String
  • #status => String
  • #next_token => String
  • #preview_results => Array<Types::LifecyclePolicyPreviewResult>
  • #summary => Types::LifecyclePolicyPreviewSummary

# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/waiters.rb', line 158

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