Class: Aws::EC2::Types::DescribeCapacityBlocksRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeCapacityBlocksRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capacity_block_ids ⇒ Array<String>

  The IDs of the Capacity Blocks.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  One or more filters.

• #max_results ⇒ Integer

  The maximum number of items to return for this request.

• #next_token ⇒ String

  The token to use to retrieve the next page of results.

Instance Attribute Details

#capacity_block_ids ⇒ Array<String>

The IDs of the Capacity Blocks.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 22036

class DescribeCapacityBlocksRequest < Struct.new(
  :capacity_block_ids,
  :next_token,
  :max_results,
  :filters,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

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)

# File 'lib/aws-sdk-ec2/types.rb', line 22036

class DescribeCapacityBlocksRequest < Struct.new(
  :capacity_block_ids,
  :next_token,
  :max_results,
  :filters,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

One or more filters.

• ‘capacity-block-id` - The ID of the Capacity Block.

• ‘ultraserver-type` - The Capacity Block type. The type can be `instances` or `ultraservers`.

• ‘availability-zone` - The Availability Zone of the Capacity Block.

• ‘start-date` - The date and time at which the Capacity Block was started.

• ‘end-date` - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

• ‘create-date` - The date and time at which the Capacity Block was created.

• ‘state` - The state of the Capacity Block (`active` | `expired` | `unavailable` | `cancelled` | `failed` | `scheduled` | `payment-pending` | `payment-failed`).

• ‘tags` - The tags assigned to the Capacity Block.

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 22036

class DescribeCapacityBlocksRequest < Struct.new(
  :capacity_block_ids,
  :next_token,
  :max_results,
  :filters,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 22036

class DescribeCapacityBlocksRequest < Struct.new(
  :capacity_block_ids,
  :next_token,
  :max_results,
  :filters,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token to use to retrieve the next page of results.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 22036

class DescribeCapacityBlocksRequest < Struct.new(
  :capacity_block_ids,
  :next_token,
  :max_results,
  :filters,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end