Skip to content

Describe Capacity Block Status

ec2_describe_capacity_block_status R Documentation

Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks

Description

Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.

Usage

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

Arguments

CapacityBlockIds

The ID of the Capacity Block.

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.

  • interconnect-status - The status of the interconnect for the Capacity Block (ok | impaired | insufficient-data).

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(
  CapacityBlockStatuses = list(
    list(
      CapacityBlockId = "string",
      InterconnectStatus = "ok"|"impaired"|"insufficient-data",
      TotalCapacity = 123,
      TotalAvailableCapacity = 123,
      TotalUnavailableCapacity = 123,
      CapacityReservationStatuses = list(
        list(
          CapacityReservationId = "string",
          TotalCapacity = 123,
          TotalAvailableCapacity = 123,
          TotalUnavailableCapacity = 123
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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