Health / Client / describe_events_for_organization

describe_events_for_organization#

Health.Client.describe_events_for_organization(**kwargs)#

Returns information about events across your organization in Organizations. You can use the filters 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.

Note

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Request Syntax

response = client.describe_events_for_organization(
    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',
        ]
    },
    nextToken='string',
    maxResults=123,
    locale='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 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) –
nextToken (string) – 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.
maxResults (integer) – The maximum number of items to return in one batch, between 10 and 100, inclusive.
locale (string) – The locale (language) to return information in. English (en) is the default and the only supported value at this time.

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 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 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) –
  
  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.

describe_events_for_organization#

Note

Request Syntax

Response Syntax

Response Structure

Exceptions