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

Class: Aws::EC2::Types::DescribeClassicLinkInstancesRequest

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

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

Contains the parameters for DescribeClassicLinkInstances.

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)


5731
5732
5733
5734
5735
5736
5737
5738
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5731

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • 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 what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

Returns:



5731
5732
5733
5734
5735
5736
5737
5738
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5731

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#instance_idsArray<String>

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

Returns:

  • (Array<String>)


5731
5732
5733
5734
5735
5736
5737
5738
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5731

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

Returns:

  • (Integer)


5731
5732
5733
5734
5735
5736
5737
5738
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5731

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


5731
5732
5733
5734
5735
5736
5737
5738
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5731

class DescribeClassicLinkInstancesRequest < Struct.new(
  :filters,
  :dry_run,
  :instance_ids,
  :max_results,
  :next_token)
  include Aws::Structure
end