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

Class: Aws::EC2::Types::DescribeCapacityReservationsRequest

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_reservation_idsArray<String>

The ID of the Capacity Reservation.

Returns:

  • (Array<String>)


9582
9583
9584
9585
9586
9587
9588
9589
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9582

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

#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)


9582
9583
9584
9585
9586
9587
9588
9589
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9582

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

#filtersArray<Types::Filter>

One or more filters.

Returns:



9582
9583
9584
9585
9586
9587
9588
9589
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9582

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

#max_resultsInteger

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

Returns:

  • (Integer)


9582
9583
9584
9585
9586
9587
9588
9589
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9582

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

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


9582
9583
9584
9585
9586
9587
9588
9589
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 9582

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