Health / Paginator / DescribeAffectedAccountsForOrganization


class Health.Paginator.DescribeAffectedAccountsForOrganization#
paginator = client.get_paginator('describe_affected_accounts_for_organization')

Creates an iterator that will paginate through responses from Health.Client.describe_affected_accounts_for_organization().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • eventArn (string) –


    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:


  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'affectedAccounts': [
    'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE',
    'NextToken': 'string'

Response Structure

  • (dict) –

    • affectedAccounts (list) –

      A JSON set of elements of the affected accounts.

      • (string) –

    • eventScopeCode (string) –

      This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.

      • If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.

      • If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.

      • If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn’t exist.

    • NextToken (string) –

      A token to resume pagination.