DescribeAffectedEntities (smaws-clients.Smaws_Client

Module Smaws_Client_Health.DescribeAffectedEntities

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required.

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

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

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `InvalidPaginationToken of Types.invalid_pagination_token
  | `UnsupportedLocale of Types.unsupported_locale ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.describe_affected_entities_request ->
  (Types.describe_affected_entities_response,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InvalidPaginationToken of Types.invalid_pagination_token
    | `UnsupportedLocale of Types.unsupported_locale ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.describe_affected_entities_request ->
  (Types.describe_affected_entities_response Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InvalidPaginationToken of Types.invalid_pagination_token
    | `UnsupportedLocale of Types.unsupported_locale ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result