Class: Aws::Imagebuilder::Types::ListComponentsRequest

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 ListComponentsRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#by_nameBoolean

Returns the list of component build versions for the specified name.

Returns:

  • (Boolean)


4099
4100
4101
4102
4103
4104
4105
4106
4107
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4099

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

#filtersArray<Types::Filter>

Use the following filters to streamline results:

  • description

  • name

  • platform

  • supportedOsVersion

  • type

  • version

Returns:



4099
4100
4101
4102
4103
4104
4105
4106
4107
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4099

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

#max_resultsInteger

The maximum items to return in a request.

Returns:

  • (Integer)


4099
4100
4101
4102
4103
4104
4105
4106
4107
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4099

class ListComponentsRequest < Struct.new(
  :owner,
  :filters,
  :by_name,
  :max_results,
  :next_token)
  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)


4099
4100
4101
4102
4103
4104
4105
4106
4107
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4099

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

#ownerString

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

Returns:

  • (String)


4099
4100
4101
4102
4103
4104
4105
4106
4107
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 4099

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