Health / Paginator / DescribeEventsForOrganization

DescribeEventsForOrganization#

class Health.Paginator.DescribeEventsForOrganization#

paginator = client.get_paginator('describe_events_for_organization')

paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'eventTypeCodes': [
            'string',
        ],
        'awsAccountIds': [
            'string',
        ],
        'services': [
            'string',
        ],
        'regions': [
            'string',
        ],
        'startTime': {
            'from': datetime(2015, 1, 1),
            'to': datetime(2015, 1, 1)
        },
        'endTime': {
            'from': datetime(2015, 1, 1),
            'to': datetime(2015, 1, 1)
        },
        'lastUpdatedTime': {
            'from': datetime(2015, 1, 1),
            'to': datetime(2015, 1, 1)
        },
        'entityArns': [
            'string',
        ],
        'entityValues': [
            'string',
        ],
        'eventTypeCategories': [
            'issue'|'accountNotification'|'scheduledChange'|'investigation',
        ],
        'eventStatusCodes': [
            'open'|'closed'|'upcoming',
        ]
    },
    locale='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

filter (dict) –
Values to narrow the results returned.
- eventTypeCodes (list) –
  
  A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
  - (string) –
- awsAccountIds (list) –
  
  A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
  - (string) –
- services (list) –
  
  The Amazon Web Services services associated with the event. For example, EC2, RDS.
  - (string) –
- regions (list) –
  
  A list of Amazon Web Services Regions.
  - (string) –
- startTime (dict) –
  
  A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp ( startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.
  - from (datetime) –
    
    The starting date and time of a time range.
  - to (datetime) –
    
    The ending date and time of a time range.
- endTime (dict) –
  
  A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp ( startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.
  - from (datetime) –
    
    The starting date and time of a time range.
  - to (datetime) –
    
    The ending date and time of a time range.
- lastUpdatedTime (dict) –
  
  A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp ( startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.
  - from (datetime) –
    
    The starting date and time of a time range.
  - to (datetime) –
    
    The ending date and time of a time range.
- entityArns (list) –
  
  A list of entity ARNs (unique identifiers).
  - (string) –
- entityValues (list) –
  
  A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
  - (string) –
- eventTypeCategories (list) –
  
  A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn’t supported at this time.
  - (string) –
- eventStatusCodes (list) –
  
  A list of event status codes.
  - (string) –
locale (string) – The locale (language) to return information in. English (en) is the default and the only supported value at this time.
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:

dict

Returns:

Response Syntax

{
    'events': [
        {
            'arn': 'string',
            'service': 'string',
            'eventTypeCode': 'string',
            'eventTypeCategory': 'issue'|'accountNotification'|'scheduledChange'|'investigation',
            'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE',
            'region': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'statusCode': 'open'|'closed'|'upcoming'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- events (list) –
  
  The events that match the specified filter criteria.
  - (dict) –
    
    Summary information about an event, returned by the DescribeEventsForOrganization operation.
    - arn (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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - service (string) –
      
      The Amazon Web Services service that is affected by the event, such as EC2 and RDS.
    - eventTypeCode (string) –
      
      The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
    - eventTypeCategory (string) –
      
      A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn’t supported at this time.
    - eventScopeCode (string) –
      
      This parameter specifies if the Health event is a public Amazon Web Services 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.
    - region (string) –
      
      The Amazon Web Services Region name of the event.
    - startTime (datetime) –
      
      The date and time that the event began.
    - endTime (datetime) –
      
      The date and time that the event ended.
    - lastUpdatedTime (datetime) –
      
      The most recent date and time that the event was updated.
    - statusCode (string) –
      
      The most recent status of the event. Possible values are open, closed, and upcoming.
- NextToken (string) –
  
  A token to resume pagination.