Class: Aws::Imagebuilder::Types::ListImagesRequest

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::ListImagesRequest

Defined in:

gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #by_name ⇒ Boolean

  Requests a list of images with a specific recipe name.

• #filters ⇒ Array<Types::Filter>

  Use the following filters to streamline results:.

• #include_deprecated ⇒ Boolean

  Includes deprecated images in the response list.

• #max_results ⇒ Integer

  Specify the maximum number of items to return in a request.

• #next_token ⇒ String

  A token to specify where to start paginating.

• #owner ⇒ String

  The owner defines which images you want to list.

Instance Attribute Details

#by_name ⇒ Boolean

Requests a list of images with a specific recipe name.

Returns:

• (Boolean)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 6763

class ListImagesRequest < Struct.new(
  :owner,
  :filters,
  :by_name,
  :max_results,
  :next_token,
  :include_deprecated)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

Use the following filters to streamline results:

• name

• osVersion

• platform

• type

• version

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 6763

class ListImagesRequest < Struct.new(
  :owner,
  :filters,
  :by_name,
  :max_results,
  :next_token,
  :include_deprecated)
  SENSITIVE = []
  include Aws::Structure
end

#include_deprecated ⇒ Boolean

Includes deprecated images in the response list.

Returns:

• (Boolean)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 6763

class ListImagesRequest < Struct.new(
  :owner,
  :filters,
  :by_name,
  :max_results,
  :next_token,
  :include_deprecated)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Specify the maximum number of items to return in a request.

Returns:

• (Integer)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 6763

class ListImagesRequest < Struct.new(
  :owner,
  :filters,
  :by_name,
  :max_results,
  :next_token,
  :include_deprecated)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 6763

class ListImagesRequest < Struct.new(
  :owner,
  :filters,
  :by_name,
  :max_results,
  :next_token,
  :include_deprecated)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 6763

class ListImagesRequest < Struct.new(
  :owner,
  :filters,
  :by_name,
  :max_results,
  :next_token,
  :include_deprecated)
  SENSITIVE = []
  include Aws::Structure
end