Struct aws_sdk_health::client::fluent_builders::DescribeEventsForOrganization

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

Fluent builder constructing a request to DescribeEventsForOrganization.

Returns information about events across your organization in AWS Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:

• DescribeAffectedAccountsForOrganization

• DescribeEventDetailsForOrganization

• DescribeAffectedEntitiesForOrganization

If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event.

For more information about the different types of AWS Health events, see Event.

Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.

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

Implementations

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

pub async fn send(
    self
) -> Result<DescribeEventsForOrganizationOutput, SdkError<DescribeEventsForOrganizationError>> where
    R::Policy: SmithyRetryPolicy<DescribeEventsForOrganizationInputOperationOutputAlias, DescribeEventsForOrganizationOutput, DescribeEventsForOrganizationError, DescribeEventsForOrganizationInputOperationRetryAlias>, 

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

Values to narrow the results returned.

pub fn set_filter(self, input: Option<OrganizationEventFilter>) -> 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 DescribeEventsForOrganization<C, M, R>

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

Formats the value using the given formatter.