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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-imagebuilder/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #by_name ⇒ Boolean

  Specifies whether to return one entry per image name, with all versions of each image aggregated.

• #filters ⇒ Array<Types::Filter>

  Use the following filters to streamline results:.

• #include_deprecated ⇒ Boolean

  Specifies whether to include deprecated Amazon-managed images in the results.

• #max_results ⇒ Integer

  The maximum number of items to return in a single request.

• #next_token ⇒ String

  A token to specify where to start paginating.

• #owner ⇒ String

  Filters the list to images owned by you, by Amazon, or shared with you by other accounts.

Instance Attribute Details

#by_name ⇒ Boolean

Specifies whether to return one entry per image name, with all versions of each image aggregated. Defaults to false, which returns one entry per image version. You can't combine this option with the version filter.

Returns:

• (Boolean)

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

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 'lib/aws-sdk-imagebuilder/types.rb', line 7467

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

#include_deprecated ⇒ Boolean

Specifies whether to include deprecated Amazon-managed images in the results. Deprecated images that you own are always returned. Defaults to false.

Returns:

• (Boolean)

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

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

#max_results ⇒ Integer

The maximum number of items to return in a single request.

Returns:

• (Integer)

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

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. Use the nextToken value from a previously truncated response.

Returns:

• (String)

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

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

#owner ⇒ String

Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.

Returns:

• (String)

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

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