You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeLaunchTemplatesRequest

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

Overview

Note:

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

{
  dry_run: false,
  launch_template_ids: ["String"],
  launch_template_names: ["LaunchTemplateName"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


9168
9169
9170
9171
9172
9173
9174
9175
9176
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9168

class DescribeLaunchTemplatesRequest < Struct.new(
  :dry_run,
  :launch_template_ids,
  :launch_template_names,
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

  • create-time - The time the launch template was created.

  • launch-template-name - The name of the launch template.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of the tag's key). If you want to list only resources where Purpose is X, see the tag:key=value filter.

Returns:



9168
9169
9170
9171
9172
9173
9174
9175
9176
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9168

class DescribeLaunchTemplatesRequest < Struct.new(
  :dry_run,
  :launch_template_ids,
  :launch_template_names,
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end

#launch_template_idsArray<String>

One or more launch template IDs.

Returns:

  • (Array<String>)


9168
9169
9170
9171
9172
9173
9174
9175
9176
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9168

class DescribeLaunchTemplatesRequest < Struct.new(
  :dry_run,
  :launch_template_ids,
  :launch_template_names,
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end

#launch_template_namesArray<String>

One or more launch template names.

Returns:

  • (Array<String>)


9168
9169
9170
9171
9172
9173
9174
9175
9176
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9168

class DescribeLaunchTemplatesRequest < Struct.new(
  :dry_run,
  :launch_template_ids,
  :launch_template_names,
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000.

Returns:

  • (Integer)


9168
9169
9170
9171
9172
9173
9174
9175
9176
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9168

class DescribeLaunchTemplatesRequest < Struct.new(
  :dry_run,
  :launch_template_ids,
  :launch_template_names,
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

The token to request the next page of results.

Returns:

  • (String)


9168
9169
9170
9171
9172
9173
9174
9175
9176
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9168

class DescribeLaunchTemplatesRequest < Struct.new(
  :dry_run,
  :launch_template_ids,
  :launch_template_names,
  :filters,
  :next_token,
  :max_results)
  include Aws::Structure
end