Returns information about events across your organization in 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:
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 Health events, see Event.
Before you can call this operation, you must first enable Health to work with 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.
Parameters:
-
filter
(Optional[OrganizationEventFilter], default:
None
)
–
Values to narrow the results returned.
-
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.
-
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.
Raises:
Source code in docs_src/capo_health/_services/health.py
| def describe_events_for_organization(
self,
*,
config_overrides: Optional[HealthClientConfig] = None,
filter: Optional[
"capo_health.types.organization_event_filter.OrganizationEventFilter"
] = None,
next_token: Optional["capo_health.types.next_token.nextToken"] = None,
max_results: Optional[
"capo_health.types.max_results_lower_range.maxResultsLowerRange"
] = None,
locale: Optional["capo_health.types.locale.locale"] = None,
) -> "capo_health.types.describe_events_for_organization_response.DescribeEventsForOrganizationResponse":
"""<p>Returns information about events across your organization in Organizations. You can use the<code>filters</code> 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:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html">DescribeAffectedAccountsForOrganization</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a> </p> </li> </ul> <p>If you don't specify a <code>filter</code>, the <code>DescribeEventsForOrganizations</code> returns all events across your organization. Results are sorted by <code>lastModifiedTime</code>, starting with the most recent event. </p> <p>For more information about the different types of Health events, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p> <p>Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's management account.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>
Args:
filter: <p>Values to narrow the results returned.</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>
locale: <p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</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_events_for_organization_request.DescribeEventsForOrganizationRequest]",
) -> OperationResponse[
"capo_health.types.describe_events_for_organization_response.DescribeEventsForOrganizationResponse"
]:
import capo_health._operations.aws_health_20160804.describe_events_for_organization
output, http_response = (
capo_health._operations.aws_health_20160804.describe_events_for_organization.describe_events_for_organization(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeEventsForOrganization")
)
input_: capo_health.types.describe_events_for_organization_request.DescribeEventsForOrganizationRequest = {}
if filter is not None:
input_["filter"] = filter
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if locale is not None:
input_["locale"] = locale
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|