AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeCapacityReservationTopology operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.DescribeCapacityReservationTopologyRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C# 
public class DescribeCapacityReservationTopologyRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeCapacityReservationTopologyRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeCapacityReservationTopologyRequest()

Properties

NameTypeDescription
Public Property CapacityReservationIds System.Collections.Generic.List<System.String>

Gets and sets the property CapacityReservationIds.

The Capacity Reservation IDs.

Default: Describes all your Capacity Reservations.

Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.

Public Property Filters System.Collections.Generic.List<Amazon.EC2.Model.Filter>

Gets and sets the property 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.

Public Property MaxResults System.Int32

Gets and sets the property 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
Public Property NextToken System.String

Gets and sets the property NextToken.

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5