Skip to content

Describe Capacity Block Offerings

ec2_describe_capacity_block_offerings R Documentation

Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using

Description

Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.

To search for an available Capacity Block offering, you specify a reservation duration and instance count.

Usage

ec2_describe_capacity_block_offerings(DryRun, InstanceType,
  InstanceCount, StartDateRange, EndDateRange, CapacityDurationHours,
  NextToken, MaxResults)

Arguments

DryRun

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.
InstanceType

The type of instance for which the Capacity Block offering reserves capacity.
InstanceCount

The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.
StartDateRange

The earliest start date for the Capacity Block offering.
EndDateRange

The latest end date for the Capacity Block offering.
CapacityDurationHours

[required] The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.
NextToken

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

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.

Value

A list with the following syntax:

list(
  CapacityBlockOfferings = list(
    list(
      CapacityBlockOfferingId = "string",
      InstanceType = "string",
      AvailabilityZone = "string",
      InstanceCount = 123,
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      EndDate = as.POSIXct(
        "2015-01-01"
      ),
      CapacityBlockDurationHours = 123,
      UpfrontFee = "string",
      CurrencyCode = "string",
      Tenancy = "default"|"dedicated",
      CapacityBlockDurationMinutes = 123
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_capacity_block_offerings(
  DryRun = TRUE|FALSE,
  InstanceType = "string",
  InstanceCount = 123,
  StartDateRange = as.POSIXct(
    "2015-01-01"
  ),
  EndDateRange = as.POSIXct(
    "2015-01-01"
  ),
  CapacityDurationHours = 123,
  NextToken = "string",
  MaxResults = 123
)