Health ¶

Table of Contents

Health
- Client
- Paginators

Client ¶

class Health.Client¶

A low-level client representing AWS Health APIs and Notifications

The Health API provides programmatic access to the Health information that appears in the Personal Health Dashboard . You can use the API operations to get information about events that might affect your Amazon Web Services services and resources.

Note

You must have a Business or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call the Health API from an Amazon Web Services account that doesn't have a Business or Enterprise Support plan, you receive a SubscriptionRequiredException error.
You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the Health API operations. Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which Amazon Web Services Region is active, so that you can get the latest information from the API. For more information, see Accessing the Health API in the Health User Guide .

For authentication of requests, Health uses the Signature Version 4 Signing Process .

If your Amazon Web Services account is part of Organizations, you can use the Health organizational view feature. This feature provides a centralized view of Health events across all accounts in your organization. You can aggregate Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating Health events in the Health User Guide .

Note

When you use the Health API operations to return Health events, see the following recommendations:

Use the eventScopeCode parameter to specify whether to return Health events that are public or account-specific.
Use pagination to view all events from the response. For example, if you call the DescribeEventsForOrganization operation to get all events in your organization, you might receive several page results. Specify the nextToken in the next request to return more results.

import boto3

client = boto3.client('health')

These are the available methods:

can_paginate()
describe_affected_accounts_for_organization()
describe_affected_entities()
describe_affected_entities_for_organization()
describe_entity_aggregates()
describe_event_aggregates()
describe_event_details()
describe_event_details_for_organization()
describe_event_types()
describe_events()
describe_events_for_organization()
describe_health_service_status_for_organization()
disable_health_service_access_for_organization()
enable_health_service_access_for_organization()
get_paginator()
get_waiter()

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

describe_affected_accounts_for_organization(**kwargs)¶

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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.describe_affected_accounts_for_organization(
    eventArn='string',
    nextToken='string',
    maxResults=123
)

Parameters

eventArn (string) --
[REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'affectedAccounts': [
        'string',
    ],
    '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 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.
- 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.

Exceptions

Health.Client.exceptions.InvalidPaginationToken

describe_affected_entities(**kwargs)¶

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required.

Note

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_affected_entities(
    filter={
        'eventArns': [
            'string',
        ],
        'entityArns': [
            'string',
        ],
        'entityValues': [
            'string',
        ],
        'lastUpdatedTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'tags': [
            {
                'string': 'string'
            },
        ],
        'statusCodes': [
            'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN',
        ]
    },
    locale='string',
    nextToken='string',
    maxResults=123
)

Parameters

filter (dict) --
[REQUIRED]

Values to narrow the results returned. At least one event ARN is required.
- eventArns (list) -- [REQUIRED]
  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - (string) --
- entityArns (list) --
  A list of entity ARNs (unique identifiers).
  - (string) --
- entityValues (list) --
  A list of IDs for affected entities.
  - (string) --
- lastUpdatedTimes (list) --
  A list of the most recent dates and times that the entity was updated.
  - (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.
- tags (list) --
  A map of entity tags attached to the affected entity.
  
  Note
  
  Currently, the tags property isn't supported.
  - (dict) --
    - (string) --
      - (string) --
- statusCodes (list) --
  A list of entity status codes (IMPAIRED , UNIMPAIRED , or UNKNOWN ).
  - (string) --
locale (string) -- The locale (language) to return information in. English (en) is the default and the only supported value at this time.
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.

Return type

dict

Returns

Response Syntax

{
    'entities': [
        {
            'entityArn': 'string',
            'eventArn': 'string',
            'entityValue': 'string',
            'entityUrl': 'string',
            'awsAccountId': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'statusCode': 'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- entities (list) --
  
  The entities that match the filter criteria.
  - (dict) --
    
    Information about an entity that is affected by a Health event.
    - entityArn (string) --
      
      The unique identifier for the entity. Format: arn:aws:health:*entity-region* :*aws-account* :entity/*entity-id* `` . Example: ``arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - entityValue (string) --
      
      The ID of the affected entity.
    - entityUrl (string) --
      
      The URL of the affected entity.
    - awsAccountId (string) --
      
      The 12-digit Amazon Web Services account number that contains the affected entity.
    - lastUpdatedTime (datetime) --
      
      The most recent time that the entity was updated.
    - statusCode (string) --
      
      The most recent status of the entity affected by the event. The possible values are IMPAIRED , UNIMPAIRED , and UNKNOWN .
    - tags (dict) --
      
      A map of entity tags attached to the affected entity.
      
      Note
      
      Currently, the tags property isn't supported.
      - (string) --
        
        (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.

Exceptions

Health.Client.exceptions.InvalidPaginationToken
Health.Client.exceptions.UnsupportedLocale

describe_affected_entities_for_organization(**kwargs)¶

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service.

At least one event Amazon Resource Name (ARN) and account ID are required.

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.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_affected_entities_for_organization(
    organizationEntityFilters=[
        {
            'eventArn': 'string',
            'awsAccountId': 'string'
        },
    ],
    locale='string',
    nextToken='string',
    maxResults=123
)

Parameters

organizationEntityFilters (list) --
[REQUIRED]

A JSON set of elements including the awsAccountId and the eventArn .
- (dict) --
  The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
  - eventArn (string) -- [REQUIRED]
    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
  - awsAccountId (string) --
    The 12-digit Amazon Web Services account numbers that contains the affected entities.
locale (string) -- The locale (language) to return information in. English (en) is the default and the only supported value at this time.
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.

Return type

dict

Returns

Response Syntax

{
    'entities': [
        {
            'entityArn': 'string',
            'eventArn': 'string',
            'entityValue': 'string',
            'entityUrl': 'string',
            'awsAccountId': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'statusCode': 'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'failedSet': [
        {
            'awsAccountId': 'string',
            'eventArn': 'string',
            'errorName': 'string',
            'errorMessage': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- entities (list) --
  
  A JSON set of elements including the awsAccountId and its entityArn , entityValue and its entityArn , lastUpdatedTime , and statusCode .
  - (dict) --
    
    Information about an entity that is affected by a Health event.
    - entityArn (string) --
      
      The unique identifier for the entity. Format: arn:aws:health:*entity-region* :*aws-account* :entity/*entity-id* `` . Example: ``arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - entityValue (string) --
      
      The ID of the affected entity.
    - entityUrl (string) --
      
      The URL of the affected entity.
    - awsAccountId (string) --
      
      The 12-digit Amazon Web Services account number that contains the affected entity.
    - lastUpdatedTime (datetime) --
      
      The most recent time that the entity was updated.
    - statusCode (string) --
      
      The most recent status of the entity affected by the event. The possible values are IMPAIRED , UNIMPAIRED , and UNKNOWN .
    - tags (dict) --
      
      A map of entity tags attached to the affected entity.
      
      Note
      
      Currently, the tags property isn't supported.
      - (string) --
        
        (string) --
- failedSet (list) --
  
  A JSON set of elements of the failed response, including the awsAccountId , errorMessage , errorName , and eventArn .
  - (dict) --
    
    Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
    - awsAccountId (string) --
      
      The 12-digit Amazon Web Services account numbers that contains the affected entities.
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - errorName (string) --
      
      The name of the error.
    - errorMessage (string) --
      
      The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION . For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT .
- 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.

Exceptions

Health.Client.exceptions.InvalidPaginationToken
Health.Client.exceptions.UnsupportedLocale

describe_entity_aggregates(**kwargs)¶

Returns the number of entities that are affected by each of the specified events.

See also: AWS API Documentation

Request Syntax

response = client.describe_entity_aggregates(
    eventArns=[
        'string',
    ]
)

Parameters

eventArns (list) --

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

(string) --

Return type

dict

Returns

Response Syntax

{
    'entityAggregates': [
        {
            'eventArn': 'string',
            'count': 123
        },
    ]
}

Response Structure

(dict) --
- entityAggregates (list) --
  The number of entities that are affected by each of the specified events.
  - (dict) --
    The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - count (integer) --
      The number of entities that match the criteria for the specified events.

describe_event_aggregates(**kwargs)¶

Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.describe_event_aggregates(
    filter={
        'eventArns': [
            'string',
        ],
        'eventTypeCodes': [
            'string',
        ],
        'services': [
            'string',
        ],
        'regions': [
            'string',
        ],
        'availabilityZones': [
            'string',
        ],
        'startTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'endTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'lastUpdatedTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'entityArns': [
            'string',
        ],
        'entityValues': [
            'string',
        ],
        'eventTypeCategories': [
            'issue'|'accountNotification'|'scheduledChange'|'investigation',
        ],
        'tags': [
            {
                'string': 'string'
            },
        ],
        'eventStatusCodes': [
            'open'|'closed'|'upcoming',
        ]
    },
    aggregateField='eventTypeCategory',
    maxResults=123,
    nextToken='string'
)

Parameters

filter (dict) --
Values to narrow the results returned.
- eventArns (list) --
  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - (string) --
- eventTypeCodes (list) --
  A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
  - (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) --
- availabilityZones (list) --
  A list of Amazon Web Services Availability Zones.
  - (string) --
- startTimes (list) --
  A list of dates and times that the event began.
  - (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.
- endTimes (list) --
  A list of dates and times that the event ended.
  - (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.
- lastUpdatedTimes (list) --
  A list of dates and times that the event was last updated.
  - (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) --
- tags (list) --
  A map of entity tags attached to the affected entity.
  
  Note
  
  Currently, the tags property isn't supported.
  - (dict) --
    - (string) --
      - (string) --
- eventStatusCodes (list) --
  A list of event status codes.
  - (string) --
aggregateField (string) --
[REQUIRED]

The only currently supported value is eventTypeCategory .
maxResults (integer) -- The maximum number of items to return in one batch, between 10 and 100, inclusive.
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.

Return type

dict

Returns

Response Syntax

{
    'eventAggregates': [
        {
            'aggregateValue': 'string',
            'count': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- eventAggregates (list) --
  
  The number of events in each category that meet the optional filter criteria.
  - (dict) --
    
    The number of events of each issue type. Returned by the DescribeEventAggregates operation.
    - aggregateValue (string) --
      
      The issue type for the associated count.
    - count (integer) --
      
      The number of events of the associated issue type.
- 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.

Exceptions

Health.Client.exceptions.InvalidPaginationToken

describe_event_details(**kwargs)¶

Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents ), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.

If a specified event can't be retrieved, an error message is returned for that event.

Note

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_event_details(
    eventArns=[
        'string',
    ],
    locale='string'
)

Parameters

eventArns (list) --
[REQUIRED]

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
- (string) --
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

{
    'successfulSet': [
        {
            'event': {
                'arn': 'string',
                'service': 'string',
                'eventTypeCode': 'string',
                'eventTypeCategory': 'issue'|'accountNotification'|'scheduledChange'|'investigation',
                'region': 'string',
                'availabilityZone': 'string',
                'startTime': datetime(2015, 1, 1),
                'endTime': datetime(2015, 1, 1),
                'lastUpdatedTime': datetime(2015, 1, 1),
                'statusCode': 'open'|'closed'|'upcoming',
                'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE'
            },
            'eventDescription': {
                'latestDescription': 'string'
            },
            'eventMetadata': {
                'string': 'string'
            }
        },
    ],
    'failedSet': [
        {
            'eventArn': 'string',
            'errorName': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- successfulSet (list) --
  
  Information about the events that could be retrieved.
  - (dict) --
    
    Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.
    - event (dict) --
      
      Summary information about the event.
      - 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. For example, EC2 , 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.
      - region (string) --
        
        The Amazon Web Services Region name of the event.
      - availabilityZone (string) --
        
        The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
      - 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 .
      - 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.
    - eventDescription (dict) --
      
      The most recent description of the event.
      - latestDescription (string) --
        
        The most recent description of the event.
    - eventMetadata (dict) --
      
      Additional metadata about the event.
      - (string) --
        
        (string) --
- failedSet (list) --
  
  Error messages for any events that could not be retrieved.
  - (dict) --
    
    Error information returned when a DescribeEventDetails operation can't find a specified event.
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - errorName (string) --
      
      The name of the error.
    - errorMessage (string) --
      
      A message that describes the error.

Exceptions

Health.Client.exceptions.UnsupportedLocale

describe_event_details_for_organization(**kwargs)¶

Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization. This information includes standard event data (such as the Amazon Web Services Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

Note

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.

When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the Health event type, note the following differences:

To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, Health returns an error message because public events aren't specific to an account.
To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, Health returns an error message because the event is specific to an account in your organization.

For more information, see Event .

Note

This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_event_details_for_organization(
    organizationEventDetailFilters=[
        {
            'eventArn': 'string',
            'awsAccountId': 'string'
        },
    ],
    locale='string'
)

Parameters

organizationEventDetailFilters (list) --
[REQUIRED]

A set of JSON elements that includes the awsAccountId and the eventArn .
- (dict) --
  The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
  - eventArn (string) -- [REQUIRED]
    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
  - awsAccountId (string) --
    The 12-digit Amazon Web Services account numbers that contains the affected entities.
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

{
    'successfulSet': [
        {
            'awsAccountId': 'string',
            'event': {
                'arn': 'string',
                'service': 'string',
                'eventTypeCode': 'string',
                'eventTypeCategory': 'issue'|'accountNotification'|'scheduledChange'|'investigation',
                'region': 'string',
                'availabilityZone': 'string',
                'startTime': datetime(2015, 1, 1),
                'endTime': datetime(2015, 1, 1),
                'lastUpdatedTime': datetime(2015, 1, 1),
                'statusCode': 'open'|'closed'|'upcoming',
                'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE'
            },
            'eventDescription': {
                'latestDescription': 'string'
            },
            'eventMetadata': {
                'string': 'string'
            }
        },
    ],
    'failedSet': [
        {
            'awsAccountId': 'string',
            'eventArn': 'string',
            'errorName': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- successfulSet (list) --
  
  Information about the events that could be retrieved.
  - (dict) --
    
    Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetailsForOrganization operation.
    - awsAccountId (string) --
      
      The 12-digit Amazon Web Services account numbers that contains the affected entities.
    - event (dict) --
      
      Summary information about an Health event.
      
      Health events can be public or account-specific:
      - Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.
      - Account-specific events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.
      You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode .
      - 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. For example, EC2 , 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.
      - region (string) --
        
        The Amazon Web Services Region name of the event.
      - availabilityZone (string) --
        
        The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
      - 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 .
      - 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.
    - eventDescription (dict) --
      
      The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
      - latestDescription (string) --
        
        The most recent description of the event.
    - eventMetadata (dict) --
      
      Additional metadata about the event.
      - (string) --
        
        (string) --
- failedSet (list) --
  
  Error messages for any events that could not be retrieved.
  - (dict) --
    
    Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
    - awsAccountId (string) --
      
      Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - errorName (string) --
      
      The name of the error.
    - errorMessage (string) --
      
      A message that describes the error.
      
      If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:
      - We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.
      - We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.
      - Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business or Enterprise Support plan.

Exceptions

Health.Client.exceptions.UnsupportedLocale

describe_event_types(**kwargs)¶

Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Services service, and event code. The metadata for each event appears in the EventType object.

If you don't specify a filter criteria, the API operation returns all event types, in no particular order.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.describe_event_types(
    filter={
        'eventTypeCodes': [
            'string',
        ],
        'services': [
            'string',
        ],
        'eventTypeCategories': [
            'issue'|'accountNotification'|'scheduledChange'|'investigation',
        ]
    },
    locale='string',
    nextToken='string',
    maxResults=123
)

Parameters

filter (dict) --
Values to narrow the results returned.
- eventTypeCodes (list) --
  A list of event type codes.
  - (string) --
- services (list) --
  The Amazon Web Services services associated with the event. For example, EC2 , RDS .
  - (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) --
locale (string) -- The locale (language) to return information in. English (en) is the default and the only supported value at this time.
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.

Return type

dict

Returns

Response Syntax

{
    'eventTypes': [
        {
            'service': 'string',
            'code': 'string',
            'category': 'issue'|'accountNotification'|'scheduledChange'|'investigation'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- eventTypes (list) --
  
  A list of event types that match the filter criteria. Event types have a category (issue , accountNotification , or scheduledChange ), a service (for example, EC2 , RDS , DATAPIPELINE , BILLING ), and a code (in the format AWS_*SERVICE* _*DESCRIPTION* `` ; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT ).
  - (dict) --
    
    Contains the metadata about a type of event that is reported by Health. The EventType shows the category, service, and the event type code of the event. For example, an issue might be the category, EC2 the service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.
    
    You can use the DescribeEventTypes API operation to return this information about an event.
    
    You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see Monitor for Health events with Amazon CloudWatch Events in the Health User Guide .
    - service (string) --
      
      The Amazon Web Services service that is affected by the event. For example, EC2 , RDS .
    - code (string) --
      
      The unique identifier for the event type. The format is AWS_*SERVICE* _*DESCRIPTION* `` ; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT .
    - category (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.
- 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.

Exceptions

Health.Client.exceptions.InvalidPaginationToken
Health.Client.exceptions.UnsupportedLocale

describe_events(**kwargs)¶

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime , starting with the most recent event.

Note

When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event .
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

See also: AWS API Documentation

Request Syntax

response = client.describe_events(
    filter={
        'eventArns': [
            'string',
        ],
        'eventTypeCodes': [
            'string',
        ],
        'services': [
            'string',
        ],
        'regions': [
            'string',
        ],
        'availabilityZones': [
            'string',
        ],
        'startTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'endTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'lastUpdatedTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'entityArns': [
            'string',
        ],
        'entityValues': [
            'string',
        ],
        'eventTypeCategories': [
            'issue'|'accountNotification'|'scheduledChange'|'investigation',
        ],
        'tags': [
            {
                'string': 'string'
            },
        ],
        'eventStatusCodes': [
            'open'|'closed'|'upcoming',
        ]
    },
    nextToken='string',
    maxResults=123,
    locale='string'
)

Parameters

filter (dict) --
Values to narrow the results returned.
- eventArns (list) --
  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - (string) --
- eventTypeCodes (list) --
  A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
  - (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) --
- availabilityZones (list) --
  A list of Amazon Web Services Availability Zones.
  - (string) --
- startTimes (list) --
  A list of dates and times that the event began.
  - (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.
- endTimes (list) --
  A list of dates and times that the event ended.
  - (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.
- lastUpdatedTimes (list) --
  A list of dates and times that the event was last updated.
  - (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) --
- tags (list) --
  A map of entity tags attached to the affected entity.
  
  Note
  
  Currently, the tags property isn't supported.
  - (dict) --
    - (string) --
      - (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',
            'region': 'string',
            'availabilityZone': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'statusCode': 'open'|'closed'|'upcoming',
            'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- events (list) --
  
  The events that match the specified filter criteria.
  - (dict) --
    
    Summary information about an Health event.
    
    Health events can be public or account-specific:
    - Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.
    - Account-specific events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.
    You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode .
    - 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. For example, EC2 , 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.
    - region (string) --
      
      The Amazon Web Services Region name of the event.
    - availabilityZone (string) --
      
      The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
    - 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 .
    - 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.
- 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.

Exceptions

Health.Client.exceptions.InvalidPaginationToken
Health.Client.exceptions.UnsupportedLocale

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.

See also: AWS API Documentation

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

Exceptions

Health.Client.exceptions.InvalidPaginationToken
Health.Client.exceptions.UnsupportedLocale

describe_health_service_status_for_organization()¶

This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account.

See also: AWS API Documentation

Request Syntax

response = client.describe_health_service_status_for_organization()

Return type

dict

Returns

Response Syntax

{
    'healthServiceAccessStatusForOrganization': 'string'
}

Response Structure

(dict) --
- healthServiceAccessStatusForOrganization (string) --
  Information about the status of enabling or disabling the Health organizational view feature in your organization.
  
  Valid values are ENABLED | DISABLED | PENDING .

disable_health_service_access_for_organization()¶

Disables Health from working with Organizations. To call this operation, you must sign in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account. For more information, see Aggregating Health events in the Health User Guide .

This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide .

Note

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, Health stops aggregating events for all other Amazon Web Services accounts in your organization. If you call the Health API operations for organizational view, Health returns an error. Health continues to aggregate health events for your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.disable_health_service_access_for_organization()

Returns: None

Exceptions

Health.Client.exceptions.ConcurrentModificationException

enable_health_service_access_for_organization()¶

Enables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.

This operation also creates a service-linked role for the management account in the organization.

Note

To call this operation, you must meet the following requirements:

You must have a Business or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call the Health API from an Amazon Web Services account that doesn't have a Business or Enterprise Support plan, you receive a SubscriptionRequiredException error.
You must have permission to call this operation from the organization's management account. For example IAM policies, see Health identity-based policy examples .

If you don't have the required support plan, you can instead use the Health console to enable the organizational view feature. For more information, see Aggregating Health events in the Health User Guide .

See also: AWS API Documentation

Request Syntax

response = client.enable_health_service_access_for_organization()

Returns: None

Exceptions

Health.Client.exceptions.ConcurrentModificationException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

Paginators ¶

The available paginators are:

Health.Paginator.DescribeAffectedAccountsForOrganization
Health.Paginator.DescribeAffectedEntities
Health.Paginator.DescribeAffectedEntitiesForOrganization
Health.Paginator.DescribeEventAggregates
Health.Paginator.DescribeEventTypes
Health.Paginator.DescribeEvents
Health.Paginator.DescribeEventsForOrganization

class Health.Paginator.DescribeAffectedAccountsForOrganization¶

paginator = client.get_paginator('describe_affected_accounts_for_organization')

paginate(**kwargs)¶

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(
    eventArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

eventArn (string) --
[REQUIRED]

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
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

{
    'affectedAccounts': [
        'string',
    ],
    '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 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.
- NextToken (string) --
  
  A token to resume pagination.

class Health.Paginator.DescribeAffectedEntities¶

paginator = client.get_paginator('describe_affected_entities')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'eventArns': [
            'string',
        ],
        'entityArns': [
            'string',
        ],
        'entityValues': [
            'string',
        ],
        'lastUpdatedTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'tags': [
            {
                'string': 'string'
            },
        ],
        'statusCodes': [
            'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN',
        ]
    },
    locale='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

filter (dict) --
[REQUIRED]

Values to narrow the results returned. At least one event ARN is required.
- eventArns (list) -- [REQUIRED]
  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - (string) --
- entityArns (list) --
  A list of entity ARNs (unique identifiers).
  - (string) --
- entityValues (list) --
  A list of IDs for affected entities.
  - (string) --
- lastUpdatedTimes (list) --
  A list of the most recent dates and times that the entity was updated.
  - (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.
- tags (list) --
  A map of entity tags attached to the affected entity.
  
  Note
  
  Currently, the tags property isn't supported.
  - (dict) --
    - (string) --
      - (string) --
- statusCodes (list) --
  A list of entity status codes (IMPAIRED , UNIMPAIRED , or UNKNOWN ).
  - (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

{
    'entities': [
        {
            'entityArn': 'string',
            'eventArn': 'string',
            'entityValue': 'string',
            'entityUrl': 'string',
            'awsAccountId': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'statusCode': 'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- entities (list) --
  
  The entities that match the filter criteria.
  - (dict) --
    
    Information about an entity that is affected by a Health event.
    - entityArn (string) --
      
      The unique identifier for the entity. Format: arn:aws:health:*entity-region* :*aws-account* :entity/*entity-id* `` . Example: ``arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - entityValue (string) --
      
      The ID of the affected entity.
    - entityUrl (string) --
      
      The URL of the affected entity.
    - awsAccountId (string) --
      
      The 12-digit Amazon Web Services account number that contains the affected entity.
    - lastUpdatedTime (datetime) --
      
      The most recent time that the entity was updated.
    - statusCode (string) --
      
      The most recent status of the entity affected by the event. The possible values are IMPAIRED , UNIMPAIRED , and UNKNOWN .
    - tags (dict) --
      
      A map of entity tags attached to the affected entity.
      
      Note
      
      Currently, the tags property isn't supported.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  A token to resume pagination.

class Health.Paginator.DescribeAffectedEntitiesForOrganization¶

paginator = client.get_paginator('describe_affected_entities_for_organization')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    organizationEntityFilters=[
        {
            'eventArn': 'string',
            'awsAccountId': 'string'
        },
    ],
    locale='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

organizationEntityFilters (list) --
[REQUIRED]

A JSON set of elements including the awsAccountId and the eventArn .
- (dict) --
  The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
  - eventArn (string) -- [REQUIRED]
    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
  - awsAccountId (string) --
    The 12-digit Amazon Web Services account numbers that contains the affected entities.
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

{
    'entities': [
        {
            'entityArn': 'string',
            'eventArn': 'string',
            'entityValue': 'string',
            'entityUrl': 'string',
            'awsAccountId': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'statusCode': 'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'failedSet': [
        {
            'awsAccountId': 'string',
            'eventArn': 'string',
            'errorName': 'string',
            'errorMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- entities (list) --
  
  A JSON set of elements including the awsAccountId and its entityArn , entityValue and its entityArn , lastUpdatedTime , and statusCode .
  - (dict) --
    
    Information about an entity that is affected by a Health event.
    - entityArn (string) --
      
      The unique identifier for the entity. Format: arn:aws:health:*entity-region* :*aws-account* :entity/*entity-id* `` . Example: ``arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - entityValue (string) --
      
      The ID of the affected entity.
    - entityUrl (string) --
      
      The URL of the affected entity.
    - awsAccountId (string) --
      
      The 12-digit Amazon Web Services account number that contains the affected entity.
    - lastUpdatedTime (datetime) --
      
      The most recent time that the entity was updated.
    - statusCode (string) --
      
      The most recent status of the entity affected by the event. The possible values are IMPAIRED , UNIMPAIRED , and UNKNOWN .
    - tags (dict) --
      
      A map of entity tags attached to the affected entity.
      
      Note
      
      Currently, the tags property isn't supported.
      - (string) --
        
        (string) --
- failedSet (list) --
  
  A JSON set of elements of the failed response, including the awsAccountId , errorMessage , errorName , and eventArn .
  - (dict) --
    
    Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
    - awsAccountId (string) --
      
      The 12-digit Amazon Web Services account numbers that contains the affected entities.
    - 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:
      
      arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
    - errorName (string) --
      
      The name of the error.
    - errorMessage (string) --
      
      The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION . For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT .
- NextToken (string) --
  
  A token to resume pagination.

class Health.Paginator.DescribeEventAggregates¶

paginator = client.get_paginator('describe_event_aggregates')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'eventArns': [
            'string',
        ],
        'eventTypeCodes': [
            'string',
        ],
        'services': [
            'string',
        ],
        'regions': [
            'string',
        ],
        'availabilityZones': [
            'string',
        ],
        'startTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'endTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'lastUpdatedTimes': [
            {
                'from': datetime(2015, 1, 1),
                'to': datetime(2015, 1, 1)
            },
        ],
        'entityArns': [
            'string',
        ],
        'entityValues': [
            'string',
        ],
        'eventTypeCategories': [
            'issue'|'accountNotification'|'scheduledChange'|'investigation',
        ],
        'tags': [
            {
                'string': 'string'
            },
        ],
        'eventStatusCodes': [
            'open'|'closed'|'upcoming',
        ]
    },
    aggregateField='eventTypeCategory',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

filter (dict) --
Values to narrow the results returned.
- eventArns (list) --
  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - (string) --
- eventTypeCodes (list) --
  A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
  - (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) --
- availabilityZones (list) --
  A list of Amazon Web Services Availability Zones.
  - (string) --
- startTimes (list) --
  A list of dates and times that the event began.
  - (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.
- endTimes (list) --
  A list of dates and times that the event ended.
  - (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.
- lastUpdatedTimes (list) --
  A list of dates and times that the event was last updated.
  - (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) --
- tags (list) --
  A map of entity tags attached to the affected entity.
  
  Note
  
  Currently, the tags property isn't supported.
  - (dict) --
    - (string) --
      - (string) --
- eventStatusCodes (list) --
  A list of event status codes.
  - (string) --
aggregateField (string) --
[REQUIRED]

The only currently supported value is eventTypeCategory .
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

{
    'eventAggregates': [
        {
            'aggregateValue': 'string',
            'count': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- eventAggregates (list) --
  
  The number of events in each category that meet the optional filter criteria.
  - (dict) --
    
    The number of events of each issue type. Returned by the DescribeEventAggregates operation.
    - aggregateValue (string) --
      
      The issue type for the associated count.
    - count (integer) --
      
      The number of events of the associated issue type.
- NextToken (string) --
  
  A token to resume pagination.

class Health.Paginator.DescribeEventTypes¶

paginator = client.get_paginator('describe_event_types')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filter={
        'eventTypeCodes': [
            'string',
        ],
        'services': [
            'string',
        ],
        'eventTypeCategories': [
            'issue'|'accountNotification'|'scheduledChange'|'investigation',
        ]
    },
    locale='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

filter (dict) --
Values to narrow the results returned.
- eventTypeCodes (list) --
  A list of event type codes.
  - (string) --
- services (list) --
  The Amazon Web Services services associated with the event. For example, EC2 , RDS .
  - (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) --
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

{
    'eventTypes': [
        {
            'service': 'string',
            'code': 'string',
            'category': 'issue'|'accountNotification'|'scheduledChange'|'investigation'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- eventTypes (list) --
  
  A list of event types that match the filter criteria. Event types have a category (issue , accountNotification , or scheduledChange ), a service (for example, EC2 , RDS , DATAPIPELINE , BILLING ), and a code (in the format AWS_*SERVICE* _*DESCRIPTION* `` ; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT ).
  - (dict) --
    
    Contains the metadata about a type of event that is reported by Health. The EventType shows the category, service, and the event type code of the event. For example, an issue might be the category, EC2 the service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.
    
    You can use the DescribeEventTypes API operation to return this information about an event.
    
    You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see Monitor for Health events with Amazon CloudWatch Events in the Health User Guide .
    - service (string) --
      
      The Amazon Web Services service that is affected by the event. For example, EC2 , RDS .
    - code (string) --
      
      The unique identifier for the event type. The format is AWS_*SERVICE* _*DESCRIPTION* `` ; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT .
    - category (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.
- NextToken (string) --
  
  A token to resume pagination.

class Health.Paginator.DescribeEvents¶

paginator = client.get_paginator('describe_events')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

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

Parameters

filter (dict) --
Values to narrow the results returned.
- eventArns (list) --
  A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
  - (string) --
- eventTypeCodes (list) --
  A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
  - (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) --
- availabilityZones (list) --
  A list of Amazon Web Services Availability Zones.
  - (string) --
- startTimes (list) --
  A list of dates and times that the event began.
  - (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.
- endTimes (list) --
  A list of dates and times that the event ended.
  - (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.
- lastUpdatedTimes (list) --
  A list of dates and times that the event was last updated.
  - (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) --
- tags (list) --
  A map of entity tags attached to the affected entity.
  
  Note
  
  Currently, the tags property isn't supported.
  - (dict) --
    - (string) --
      - (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',
            'region': 'string',
            'availabilityZone': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'statusCode': 'open'|'closed'|'upcoming',
            'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- events (list) --
  
  The events that match the specified filter criteria.
  - (dict) --
    
    Summary information about an Health event.
    
    Health events can be public or account-specific:
    - Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don't use services or resources in that Region.
    - Account-specific events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.
    You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode .
    - 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. For example, EC2 , 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.
    - region (string) --
      
      The Amazon Web Services Region name of the event.
    - availabilityZone (string) --
      
      The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
    - 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 .
    - 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.
- NextToken (string) --
  
  A token to resume pagination.

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.

Navigation

Table Of Contents

Health¶

Client¶

Paginators¶

Navigation

Health ¶

Client ¶

Paginators ¶