Skip to content

Describe Capacity Reservation Topology

ec2_describe_capacity_reservation_topology R Documentation

Describes a tree-based hierarchy that represents the physical host placement of your pending or active Capacity Reservations within an Availability Zone or Local Zone

Description

Describes a tree-based hierarchy that represents the physical host placement of your pending or active Capacity Reservations within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your capacity within the Amazon Web Services network before it is launched and use this information to allocate capacity together to support your tightly coupled workloads.

Capacity Reservation topology is supported for specific instance types only. For more information, see Prerequisites for Amazon EC2 instance topology in the Amazon EC2 User Guide.

The Amazon EC2 API follows an eventual consistency model due to the distributed nature of the system supporting it. As a result, when you call the DescribeCapacityReservationTopology API command immediately after launching instances, the response might return a null value for capacityBlockId because the data might not have fully propagated across all subsystems. For more information, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.

For more information, see Amazon EC2 topology in the Amazon EC2 User Guide.

Usage

ec2_describe_capacity_reservation_topology(DryRun, NextToken,
  MaxResults, CapacityReservationIds, Filters)

Arguments

DryRun

Checks whether you have the required permissions for the operation, 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.
NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
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.

You can't specify this parameter and the Capacity Reservation IDs parameter in the same request.

Default: 10
CapacityReservationIds

The Capacity Reservation IDs.

Default: Describes all your Capacity Reservations.

Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.
Filters

The filters.

  • availability-zone - The name of the Availability Zone (for example, ⁠us-west-2a⁠) or Local Zone (for example, ⁠us-west-2-lax-1b⁠) that the Capacity Reservation is in.

  • instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, ⁠p4d*⁠). You can use the * wildcard to match zero or more characters, or the ⁠?⁠ wildcard to match zero or one character.

Value

A list with the following syntax:

list(
  NextToken = "string",
  CapacityReservations = list(
    list(
      CapacityReservationId = "string",
      CapacityBlockId = "string",
      State = "string",
      InstanceType = "string",
      GroupName = "string",
      NetworkNodes = list(
        "string"
      ),
      AvailabilityZoneId = "string",
      AvailabilityZone = "string"
    )
  )
)

Request syntax

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