Describes details about Capacity Blocks in the Amazon Web Services Region that you're currently using¶

Description¶

Describes details about Capacity Blocks in the Amazon Web Services Region that you're currently using.

Usage¶

ec2_describe_capacity_blocks(CapacityBlockIds, NextToken, MaxResults,
  Filters, DryRun)

Arguments¶

• CapacityBlockIds

  The IDs of the Capacity Blocks.

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

• Filters

  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.

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

Value¶

A list with the following syntax:

list(
  CapacityBlocks = list(
    list(
      CapacityBlockId = "string",
      UltraserverType = "string",
      AvailabilityZone = "string",
      AvailabilityZoneId = "string",
      CapacityReservationIds = list(
        "string"
      ),
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      EndDate = as.POSIXct(
        "2015-01-01"
      ),
      CreateDate = as.POSIXct(
        "2015-01-01"
      ),
      State = "active"|"expired"|"unavailable"|"cancelled"|"failed"|"scheduled"|"payment-pending"|"payment-failed",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_capacity_blocks(
  CapacityBlockIds = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE
)