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.
Parameters:
-
filter
(EntityFilter)
–
Values to narrow the results returned. At least one event ARN is required.
-
locale
(Optional[locale], default:
None
)
–
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
-
next_token
(Optional[nextToken], default:
None
)
–
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.
-
max_results
(Optional[maxResultsLowerRange], default:
None
)
–
The maximum number of items to return in one batch, between 1 and 100, inclusive.
Raises:
Source code in docs_src/capo_health/_services/health.py
| def describe_affected_entities(
self,
filter: "capo_health.types.entity_filter.EntityFilter",
*,
config_overrides: Optional[HealthClientConfig] = None,
locale: Optional["capo_health.types.locale.locale"] = None,
next_token: Optional["capo_health.types.next_token.nextToken"] = None,
max_results: Optional[
"capo_health.types.max_results_lower_range.maxResultsLowerRange"
] = None,
) -> "capo_health.types.describe_affected_entities_response.DescribeAffectedEntitiesResponse":
"""<p>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.</p> <p>At least one event ARN is required.</p> <note> <ul> <li> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </li> <li> <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p> </li> </ul> </note>
Args:
filter: <p>Values to narrow the results returned. At least one event ARN is required.</p>
locale: <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>
next_token: <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> 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.</p>
max_results: <p>The maximum number of items to return in one batch, between 1 and 100, inclusive.</p>
Raises:
capo_health.errors.invalid_pagination_token.InvalidPaginationToken: <p>The specified pagination token (<code>nextToken</code>) is not valid.</p>
capo_health.errors.unsupported_locale.UnsupportedLocale: <p>The specified locale is not supported.</p>
capo_health.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_health.types.describe_affected_entities_request.DescribeAffectedEntitiesRequest]",
) -> OperationResponse[
"capo_health.types.describe_affected_entities_response.DescribeAffectedEntitiesResponse"
]:
import capo_health._operations.aws_health_20160804.describe_affected_entities
output, http_response = (
capo_health._operations.aws_health_20160804.describe_affected_entities.describe_affected_entities(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeAffectedEntities")
)
input_: capo_health.types.describe_affected_entities_request.DescribeAffectedEntitiesRequest = {
"filter": filter
}
if locale is not None:
input_["locale"] = locale
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|