Skip to content

DescribeAffectedEntitiesRequest

Source code in docs_src/capo_health/types/describe_affected_entities_request.py 
16
17
18
19
20
21
22
23
24
25
26
class DescribeAffectedEntitiesRequest(TypedDict, closed=True):
    filter: "capo_health.types.entity_filter.EntityFilter"
    """<p>Values to narrow the results returned. At least one event ARN is required.</p>"""
    locale: NotRequired["capo_health.types.locale.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: NotRequired["capo_health.types.next_token.nextToken"]
    """<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: NotRequired[
        "capo_health.types.max_results_lower_range.maxResultsLowerRange"
    ]
    """<p>The maximum number of items to return in one batch, between 1 and 100, inclusive.</p>"""

filter instance-attribute 

filter: EntityFilter

Values to narrow the results returned. At least one event ARN is required.

locale instance-attribute 

locale: NotRequired[locale]

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

max_results instance-attribute 

max_results: NotRequired[maxResultsLowerRange]

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

next_token instance-attribute 

next_token: NotRequired[nextToken]

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.