Returns a list of accounts in the organization from Organizations that are affected by the provided 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:
-
event_arn
(eventArn)
–
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
-
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[maxResults], default:
None
)
–
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Raises:
Source code in docs_src/capo_health/_services/async_health.py
| async def describe_affected_accounts_for_organization(
self,
event_arn: "capo_health.types.event_arn.eventArn",
*,
config_overrides: Optional[AsyncHealthClientConfig] = None,
next_token: Optional["capo_health.types.next_token.nextToken"] = None,
max_results: Optional["capo_health.types.max_results.maxResults"] = None,
) -> "capo_health.types.describe_affected_accounts_for_organization_response.DescribeAffectedAccountsForOrganizationResponse":
"""<p>Returns a list of accounts in the organization from Organizations that are affected by the provided event. 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:
event_arn: <p>The unique identifier for the event. The event ARN has the <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code> format.</p> <p>For example, an event ARN might look like the following:</p> <p> <code>arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </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 10 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.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_health.types.describe_affected_accounts_for_organization_request.DescribeAffectedAccountsForOrganizationRequest]",
) -> AsyncOperationResponse[
"capo_health.types.describe_affected_accounts_for_organization_response.DescribeAffectedAccountsForOrganizationResponse"
]:
import capo_health._operations.aws_health_20160804.describe_affected_accounts_for_organization
(
output,
http_response,
) = await capo_health._operations.aws_health_20160804.describe_affected_accounts_for_organization.async_describe_affected_accounts_for_organization(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("DescribeAffectedAccountsForOrganization"),
)
input_: capo_health.types.describe_affected_accounts_for_organization_request.DescribeAffectedAccountsForOrganizationRequest = {
"event_arn": event_arn
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|