Struct aws_sdk_ec2::client::fluent_builders::DescribeCapacityReservations

pub struct DescribeCapacityReservations { /* private fields */ }

Fluent builder constructing a request to DescribeCapacityReservations.

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services Region that you're currently using.

Implementations

impl DescribeCapacityReservations

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeCapacityReservations, AwsResponseRetryClassifier>, SdkError<DescribeCapacityReservationsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeCapacityReservationsOutput, SdkError<DescribeCapacityReservationsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeCapacityReservationsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn capacity_reservation_ids(self, input: impl Into<String>) -> Self

Appends an item to CapacityReservationIds.

To override the contents of this collection use set_capacity_reservation_ids.

The ID of the Capacity Reservation.

pub fn set_capacity_reservation_ids(self, input: Option<Vec<String>>) -> Self

The ID of the Capacity Reservation.

pub fn next_token(self, input: impl Into<String>) -> Self

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

pub fn set_next_token(self, input: Option<String>) -> Self

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

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

pub fn filters(self, input: Filter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

One or more filters.

• instance-type - The type of instance for which the Capacity Reservation reserves capacity.

• owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.

• instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

• availability-zone - The Availability Zone of the Capacity Reservation.

• tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.

• state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active- The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

• start-date - The date and time at which the Capacity Reservation was started.

• end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

• end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

• instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

• placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

One or more filters.

• instance-type - The type of instance for which the Capacity Reservation reserves capacity.

• owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.

• instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

• availability-zone - The Availability Zone of the Capacity Reservation.

• tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.

• state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active- The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

• start-date - The date and time at which the Capacity Reservation was started.

• end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

• end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

• instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

• placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.

pub fn dry_run(self, input: bool) -> Self

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.

pub fn set_dry_run(self, input: Option<bool>) -> Self

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.

Trait Implementations

impl Clone for DescribeCapacityReservations

fn clone(&self) -> DescribeCapacityReservations

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeCapacityReservations

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.