Struct aws_sdk_health::client::fluent_builders::DescribeAffectedEntitiesForOrganization

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

Fluent builder constructing a request to DescribeAffectedEntitiesForOrganization.

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.

At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

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.

• This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.

Implementations

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

pub async fn send(
    self
) -> Result<DescribeAffectedEntitiesForOrganizationOutput, SdkError<DescribeAffectedEntitiesForOrganizationError>> where
    R::Policy: SmithyRetryPolicy<DescribeAffectedEntitiesForOrganizationInputOperationOutputAlias, DescribeAffectedEntitiesForOrganizationOutput, DescribeAffectedEntitiesForOrganizationError, DescribeAffectedEntitiesForOrganizationInputOperationRetryAlias>, 

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

Appends an item to organizationEntityFilters.

To override the contents of this collection use set_organization_entity_filters.

A JSON set of elements including the awsAccountId and the eventArn.

pub fn set_organization_entity_filters(
    self,
    input: Option<Vec<EventAccountFilter>>
) -> Self

A JSON set of elements including the awsAccountId and the eventArn.

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.

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.

Trait Implementations

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

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

Formats the value using the given formatter.