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

Class: Aws::EC2::Types::DescribeElasticGpusRequest

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

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

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)


11141
11142
11143
11144
11145
11146
11147
11148
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11141

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

#elastic_gpu_idsArray<String>

The Elastic Graphics accelerator IDs.

Returns:

  • (Array<String>)


11141
11142
11143
11144
11145
11146
11147
11148
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11141

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

#filtersArray<Types::Filter>

The filters.

  • availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.

  • elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).

  • elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).

  • elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.

  • instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.

Returns:



11141
11142
11143
11144
11145
11146
11147
11148
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11141

class DescribeElasticGpusRequest < Struct.new(
  :elastic_gpu_ids,
  :dry_run,
  :filters,
  :max_results,
  :next_token)
  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)


11141
11142
11143
11144
11145
11146
11147
11148
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11141

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

#next_tokenString

The token to request the next page of results.

Returns:

  • (String)


11141
11142
11143
11144
11145
11146
11147
11148
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11141

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