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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

Note:

When making an API call, you may pass ListImagesRequest data as a hash:

{
  owner: "Self", # accepts Self, Shared, Amazon
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
  by_name: false,
  max_results: 1,
  next_token: "PaginationToken",
  include_deprecated: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#by_nameBoolean

Requests a list of images with a specific recipe name.

Returns:

  • (Boolean)


4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4700

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

#filtersArray<Types::Filter>

Use the following filters to streamline results:

  • name

  • osVersion

  • platform

  • type

  • version

Returns:



4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4700

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

#include_deprecatedBoolean

Includes deprecated images in the response list.

Returns:

  • (Boolean)


4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4700

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

#max_resultsInteger

The maximum items to return in a request.

Returns:

  • (Integer)


4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4700

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

#next_tokenString

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

Returns:

  • (String)


4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4700

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

#ownerString

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)


4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4700

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