Struct aws_sdk_ec2::client::fluent_builders::DescribeHosts

pub struct DescribeHosts<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeHosts.

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.

Implementations

impl<C, M, R> DescribeHosts<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeHostsOutput, SdkError<DescribeHostsError>> where
    R::Policy: SmithyRetryPolicy<DescribeHostsInputOperationOutputAlias, DescribeHostsOutput, DescribeHostsError, DescribeHostsInputOperationRetryAlias>, 

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 filter(self, inp: impl Into<Filter>) -> Self

Appends an item to Filter.

To override the contents of this collection use set_filter.

The filters.

• auto-placement - Whether auto-placement is enabled or disabled (on | off).

• availability-zone - The Availability Zone of the host.

• client-token - The idempotency token that you provided when you allocated the host.

• host-reservation-id - The ID of the reservation assigned to this host.

• instance-type - The instance type size that the Dedicated Host is configured to support.

• state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

The filters.

• auto-placement - Whether auto-placement is enabled or disabled (on | off).

• availability-zone - The Availability Zone of the host.

• client-token - The idempotency token that you provided when you allocated the host.

• host-reservation-id - The ID of the reservation assigned to this host.

• instance-type - The instance type size that the Dedicated Host is configured to support.

• state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

pub fn host_ids(self, inp: impl Into<String>) -> Self

Appends an item to HostIds.

To override the contents of this collection use set_host_ids.

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

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

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

pub fn max_results(self, inp: 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.

You cannot specify this parameter and the host IDs parameter in the same request.

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.

You cannot specify this parameter and the host IDs parameter in the same request.

pub fn next_token(self, inp: 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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeHosts<C, M, R>

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

Formats the value using the given formatter.