Struct aws_sdk_health::client::fluent_builders::DescribeEvents

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

Fluent builder constructing a request to DescribeEvents.

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event.

• When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.

• This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Implementations

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

pub async fn send(
    self
) -> Result<DescribeEventsOutput, SdkError<DescribeEventsError>> where
    R::Policy: SmithyRetryPolicy<DescribeEventsInputOperationOutputAlias, DescribeEventsOutput, DescribeEventsError, DescribeEventsInputOperationRetryAlias>, 

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: EventFilter) -> Self

Values to narrow the results returned.

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

Values to narrow the results returned.

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

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

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

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

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

The maximum number of items to return in one batch, between 10 and 100, inclusive.

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

The maximum number of items to return in one batch, between 10 and 100, inclusive.

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

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

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

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Trait Implementations

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

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

Formats the value using the given formatter.