AWS Health APIs and Notifications 2016-08-04
- Client: Aws\Health\HealthClient
- Service ID: health
- Version: 2016-08-04
This page describes the parameters and results for the operations of the AWS Health APIs and Notifications (2016-08-04), and shows how to use the Aws\Health\HealthClient object to call the described operations. This documentation is specific to the 2016-08-04 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- DescribeAffectedAccountsForOrganization ( array $params = [] )
- Returns a list of accounts in the organization from Organizations that are affected by the provided event.
- DescribeAffectedEntities ( array $params = [] )
- Returns a list of entities that have been affected by the specified events, based on the specified filter criteria.
- DescribeAffectedEntitiesForOrganization ( array $params = [] )
- 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.
- DescribeEntityAggregates ( array $params = [] )
- Returns the number of entities that are affected by each of the specified events.
- DescribeEntityAggregatesForOrganization ( array $params = [] )
- Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
- DescribeEventAggregates ( array $params = [] )
- Returns the number of events of each event type (issue, scheduled change, and account notification).
- DescribeEventDetails ( array $params = [] )
- Returns detailed information about one or more specified events.
- DescribeEventDetailsForOrganization ( array $params = [] )
- Returns detailed information about one or more specified events for one or more Amazon Web Services accounts in your organization.
- DescribeEventTypes ( array $params = [] )
- Returns the event types that meet the specified filter criteria.
- DescribeEvents ( array $params = [] )
- Returns information about events that meet the specified filter criteria.
- DescribeEventsForOrganization ( array $params = [] )
- Returns information about events across your organization in Organizations.
- DescribeHealthServiceStatusForOrganization ( array $params = [] )
- This operation provides status information on enabling or disabling Health to work with your organization.
- DisableHealthServiceAccessForOrganization ( array $params = [] )
- Disables Health from working with Organizations.
- EnableHealthServiceAccessForOrganization ( array $params = [] )
- Enables Health to work with Organizations.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- DescribeAffectedAccountsForOrganization
- DescribeAffectedEntities
- DescribeAffectedEntitiesForOrganization
- DescribeEntityAggregates
- DescribeEventAggregates
- DescribeEventTypes
- DescribeEvents
- DescribeEventsForOrganization
Operations
DescribeAffectedAccountsForOrganization
$result = $client->describeAffectedAccountsForOrganization
([/* ... */]); $promise = $client->describeAffectedAccountsForOrganizationAsync
([/* ... */]);
Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken
parameter in the next request to return more results.
Parameter Syntax
$result = $client->describeAffectedAccountsForOrganization([ 'eventArn' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- eventArn
-
- Required: Yes
- Type: 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
- maxResults
-
- Type: int
The maximum number of items to return in one batch, between 10 and 100, inclusive.
- nextToken
-
- Type: 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.
Result Syntax
[ 'affectedAccounts' => ['<string>', ...], 'eventScopeCode' => 'PUBLIC|ACCOUNT_SPECIFIC|NONE', 'nextToken' => '<string>', ]
Result Details
Members
- affectedAccounts
-
- Type: Array of strings
A JSON set of elements of the affected accounts.
- eventScopeCode
-
- Type: string
This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.
-
If the
eventScopeCode
value isPUBLIC
, then theaffectedAccounts
value is always empty. -
If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
- nextToken
-
- Type: 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.
Errors
- InvalidPaginationToken:
The specified pagination token (
nextToken
) is not valid.
DescribeAffectedEntities
$result = $client->describeAffectedEntities
([/* ... */]); $promise = $client->describeAffectedEntitiesAsync
([/* ... */]);
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 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.
-
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.
Parameter Syntax
$result = $client->describeAffectedEntities([ 'filter' => [ // REQUIRED 'entityArns' => ['<string>', ...], 'entityValues' => ['<string>', ...], 'eventArns' => ['<string>', ...], // REQUIRED 'lastUpdatedTimes' => [ [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], // ... ], 'statusCodes' => ['<string>', ...], 'tags' => [ ['<string>', ...], // ... ], ], 'locale' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- filter
-
- Required: Yes
- Type: EntityFilter structure
Values to narrow the results returned. At least one event ARN is required.
- locale
-
- Type: string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
- maxResults
-
- Type: int
The maximum number of items to return in one batch, between 10 and 100, inclusive.
- nextToken
-
- Type: 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.
Result Syntax
[ 'entities' => [ [ 'awsAccountId' => '<string>', 'entityArn' => '<string>', 'entityUrl' => '<string>', 'entityValue' => '<string>', 'eventArn' => '<string>', 'lastUpdatedTime' => <DateTime>, 'statusCode' => 'IMPAIRED|UNIMPAIRED|UNKNOWN|PENDING|RESOLVED', 'tags' => ['<string>', ...], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- entities
-
- Type: Array of AffectedEntity structures
The entities that match the filter criteria.
- nextToken
-
- Type: 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.
Errors
- InvalidPaginationToken:
The specified pagination token (
nextToken
) is not valid.- UnsupportedLocale:
The specified locale is not supported.
DescribeAffectedEntitiesForOrganization
$result = $client->describeAffectedEntitiesForOrganization
([/* ... */]); $promise = $client->describeAffectedEntitiesForOrganizationAsync
([/* ... */]);
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 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.
-
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.
Parameter Syntax
$result = $client->describeAffectedEntitiesForOrganization([ 'locale' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'organizationEntityAccountFilters' => [ [ 'awsAccountId' => '<string>', 'eventArn' => '<string>', // REQUIRED 'statusCodes' => ['<string>', ...], ], // ... ], 'organizationEntityFilters' => [ [ 'awsAccountId' => '<string>', 'eventArn' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- locale
-
- Type: string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
- maxResults
-
- Type: int
The maximum number of items to return in one batch, between 10 and 100, inclusive.
- nextToken
-
- Type: 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. - organizationEntityAccountFilters
-
- Type: Array of EntityAccountFilter structures
A JSON set of elements including the
awsAccountId
,eventArn
and a set ofstatusCodes
. - organizationEntityFilters
-
- Type: Array of EventAccountFilter structures
A JSON set of elements including the
awsAccountId
and theeventArn
.
Result Syntax
[ 'entities' => [ [ 'awsAccountId' => '<string>', 'entityArn' => '<string>', 'entityUrl' => '<string>', 'entityValue' => '<string>', 'eventArn' => '<string>', 'lastUpdatedTime' => <DateTime>, 'statusCode' => 'IMPAIRED|UNIMPAIRED|UNKNOWN|PENDING|RESOLVED', 'tags' => ['<string>', ...], ], // ... ], 'failedSet' => [ [ 'awsAccountId' => '<string>', 'errorMessage' => '<string>', 'errorName' => '<string>', 'eventArn' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- entities
-
- Type: Array of AffectedEntity structures
A JSON set of elements including the
awsAccountId
and itsentityArn
,entityValue
and itsentityArn
,lastUpdatedTime
, andstatusCode
. - failedSet
-
- Type: Array of OrganizationAffectedEntitiesErrorItem structures
A JSON set of elements of the failed response, including the
awsAccountId
,errorMessage
,errorName
, andeventArn
. - nextToken
-
- Type: 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.
Errors
- InvalidPaginationToken:
The specified pagination token (
nextToken
) is not valid.- UnsupportedLocale:
The specified locale is not supported.
DescribeEntityAggregates
$result = $client->describeEntityAggregates
([/* ... */]); $promise = $client->describeEntityAggregatesAsync
([/* ... */]);
Returns the number of entities that are affected by each of the specified events.
Parameter Syntax
$result = $client->describeEntityAggregates([ 'eventArns' => ['<string>', ...], ]);
Parameter Details
Members
- eventArns
-
- Type: Array of strings
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"
Result Syntax
[ 'entityAggregates' => [ [ 'count' => <integer>, 'eventArn' => '<string>', 'statuses' => [<integer>, ...], ], // ... ], ]
Result Details
Members
- entityAggregates
-
- Type: Array of EntityAggregate structures
The number of entities that are affected by each of the specified events.
Errors
There are no errors described for this operation.
DescribeEntityAggregatesForOrganization
$result = $client->describeEntityAggregatesForOrganization
([/* ... */]); $promise = $client->describeEntityAggregatesForOrganizationAsync
([/* ... */]);
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
Parameter Syntax
$result = $client->describeEntityAggregatesForOrganization([ 'awsAccountIds' => ['<string>', ...], 'eventArns' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- awsAccountIds
-
- Type: Array of strings
A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
- eventArns
-
- Required: Yes
- Type: Array of strings
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"
Result Syntax
[ 'organizationEntityAggregates' => [ [ 'accounts' => [ [ 'accountId' => '<string>', 'count' => <integer>, 'statuses' => [<integer>, ...], ], // ... ], 'count' => <integer>, 'eventArn' => '<string>', 'statuses' => [<integer>, ...], ], // ... ], ]
Result Details
Members
- organizationEntityAggregates
-
- Type: Array of OrganizationEntityAggregate structures
The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.
Errors
There are no errors described for this operation.
DescribeEventAggregates
$result = $client->describeEventAggregates
([/* ... */]); $promise = $client->describeEventAggregatesAsync
([/* ... */]);
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.
This API operation uses pagination. Specify the nextToken
parameter in the next request to return more results.
Parameter Syntax
$result = $client->describeEventAggregates([ 'aggregateField' => 'eventTypeCategory', // REQUIRED 'filter' => [ 'availabilityZones' => ['<string>', ...], 'endTimes' => [ [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], // ... ], 'entityArns' => ['<string>', ...], 'entityValues' => ['<string>', ...], 'eventArns' => ['<string>', ...], 'eventStatusCodes' => ['<string>', ...], 'eventTypeCategories' => ['<string>', ...], 'eventTypeCodes' => ['<string>', ...], 'lastUpdatedTimes' => [ [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], // ... ], 'regions' => ['<string>', ...], 'services' => ['<string>', ...], 'startTimes' => [ [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], // ... ], 'tags' => [ ['<string>', ...], // ... ], ], 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- aggregateField
-
- Required: Yes
- Type: string
The only currently supported value is
eventTypeCategory
. - filter
-
- Type: EventFilter structure
Values to narrow the results returned.
- maxResults
-
- Type: int
The maximum number of items to return in one batch, between 10 and 100, inclusive.
- nextToken
-
- Type: 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.
Result Syntax
[ 'eventAggregates' => [ [ 'aggregateValue' => '<string>', 'count' => <integer>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- eventAggregates
-
- Type: Array of EventAggregate structures
The number of events in each category that meet the optional filter criteria.
- nextToken
-
- Type: 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.
Errors
- InvalidPaginationToken:
The specified pagination token (
nextToken
) is not valid.
DescribeEventDetails
$result = $client->describeEventDetails
([/* ... */]); $promise = $client->describeEventDetailsAsync
([/* ... */]);
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.
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.
Parameter Syntax
$result = $client->describeEventDetails([ 'eventArns' => ['<string>', ...], // REQUIRED 'locale' => '<string>', ]);
Parameter Details
Members
- eventArns
-
- Required: Yes
- Type: Array of strings
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"
- locale
-
- Type: string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
Result Syntax
[ 'failedSet' => [ [ 'errorMessage' => '<string>', 'errorName' => '<string>', 'eventArn' => '<string>', ], // ... ], 'successfulSet' => [ [ 'event' => [ 'arn' => '<string>', 'availabilityZone' => '<string>', 'endTime' => <DateTime>, 'eventScopeCode' => 'PUBLIC|ACCOUNT_SPECIFIC|NONE', 'eventTypeCategory' => 'issue|accountNotification|scheduledChange|investigation', 'eventTypeCode' => '<string>', 'lastUpdatedTime' => <DateTime>, 'region' => '<string>', 'service' => '<string>', 'startTime' => <DateTime>, 'statusCode' => 'open|closed|upcoming', ], 'eventDescription' => [ 'latestDescription' => '<string>', ], 'eventMetadata' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- failedSet
-
- Type: Array of EventDetailsErrorItem structures
Error messages for any events that could not be retrieved.
- successfulSet
-
- Type: Array of EventDetails structures
Information about the events that could be retrieved.
Errors
- UnsupportedLocale:
The specified locale is not supported.
DescribeEventDetailsForOrganization
$result = $client->describeEventDetailsForOrganization
([/* ... */]); $promise = $client->describeEventDetailsForOrganizationAsync
([/* ... */]);
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.
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.
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.
Parameter Syntax
$result = $client->describeEventDetailsForOrganization([ 'locale' => '<string>', 'organizationEventDetailFilters' => [ // REQUIRED [ 'awsAccountId' => '<string>', 'eventArn' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- locale
-
- Type: string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
- organizationEventDetailFilters
-
- Required: Yes
- Type: Array of EventAccountFilter structures
A set of JSON elements that includes the
awsAccountId
and theeventArn
.
Result Syntax
[ 'failedSet' => [ [ 'awsAccountId' => '<string>', 'errorMessage' => '<string>', 'errorName' => '<string>', 'eventArn' => '<string>', ], // ... ], 'successfulSet' => [ [ 'awsAccountId' => '<string>', 'event' => [ 'arn' => '<string>', 'availabilityZone' => '<string>', 'endTime' => <DateTime>, 'eventScopeCode' => 'PUBLIC|ACCOUNT_SPECIFIC|NONE', 'eventTypeCategory' => 'issue|accountNotification|scheduledChange|investigation', 'eventTypeCode' => '<string>', 'lastUpdatedTime' => <DateTime>, 'region' => '<string>', 'service' => '<string>', 'startTime' => <DateTime>, 'statusCode' => 'open|closed|upcoming', ], 'eventDescription' => [ 'latestDescription' => '<string>', ], 'eventMetadata' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- failedSet
-
- Type: Array of OrganizationEventDetailsErrorItem structures
Error messages for any events that could not be retrieved.
- successfulSet
-
- Type: Array of OrganizationEventDetails structures
Information about the events that could be retrieved.
Errors
- UnsupportedLocale:
The specified locale is not supported.
DescribeEventTypes
$result = $client->describeEventTypes
([/* ... */]); $promise = $client->describeEventTypesAsync
([/* ... */]);
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 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.
This API operation uses pagination. Specify the nextToken
parameter in the next request to return more results.
Parameter Syntax
$result = $client->describeEventTypes([ 'filter' => [ 'eventTypeCategories' => ['<string>', ...], 'eventTypeCodes' => ['<string>', ...], 'services' => ['<string>', ...], ], 'locale' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- filter
-
- Type: EventTypeFilter structure
Values to narrow the results returned.
- locale
-
- Type: string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
- maxResults
-
- Type: int
The maximum number of items to return in one batch, between 10 and 100, inclusive.
If you don't specify the
maxResults
parameter, this operation returns a maximum of 30 items by default. - nextToken
-
- Type: 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.
Result Syntax
[ 'eventTypes' => [ [ 'category' => 'issue|accountNotification|scheduledChange|investigation', 'code' => '<string>', 'service' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- eventTypes
-
- Type: Array of EventType structures
A list of event types that match the filter criteria. Event types have a category (
issue
,accountNotification
, orscheduledChange
), a service (for example,EC2
,RDS
,DATAPIPELINE
,BILLING
), and a code (in the formatAWS_SERVICE_DESCRIPTION
; for example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT
). - nextToken
-
- Type: 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.
Errors
- InvalidPaginationToken:
The specified pagination token (
nextToken
) is not valid.- UnsupportedLocale:
The specified locale is not supported.
DescribeEvents
$result = $client->describeEvents
([/* ... */]); $promise = $client->describeEventsAsync
([/* ... */]);
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.
-
When you call the
DescribeEvents
operation and specify an entity for theentityValues
parameter, Health might return public events that aren't specific to that resource. For example, if you callDescribeEvents
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 theservices
parameter in thefilter
object. For more information, see Event. -
This API operation uses pagination. Specify the
nextToken
parameter in the next request to return more results.
Parameter Syntax
$result = $client->describeEvents([ 'filter' => [ 'availabilityZones' => ['<string>', ...], 'endTimes' => [ [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], // ... ], 'entityArns' => ['<string>', ...], 'entityValues' => ['<string>', ...], 'eventArns' => ['<string>', ...], 'eventStatusCodes' => ['<string>', ...], 'eventTypeCategories' => ['<string>', ...], 'eventTypeCodes' => ['<string>', ...], 'lastUpdatedTimes' => [ [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], // ... ], 'regions' => ['<string>', ...], 'services' => ['<string>', ...], 'startTimes' => [ [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], // ... ], 'tags' => [ ['<string>', ...], // ... ], ], 'locale' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- filter
-
- Type: EventFilter structure
Values to narrow the results returned.
- locale
-
- Type: string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
- maxResults
-
- Type: int
The maximum number of items to return in one batch, between 10 and 100, inclusive.
- nextToken
-
- Type: 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.
Result Syntax
[ 'events' => [ [ 'arn' => '<string>', 'availabilityZone' => '<string>', 'endTime' => <DateTime>, 'eventScopeCode' => 'PUBLIC|ACCOUNT_SPECIFIC|NONE', 'eventTypeCategory' => 'issue|accountNotification|scheduledChange|investigation', 'eventTypeCode' => '<string>', 'lastUpdatedTime' => <DateTime>, 'region' => '<string>', 'service' => '<string>', 'startTime' => <DateTime>, 'statusCode' => 'open|closed|upcoming', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- events
-
- Type: Array of Event structures
The events that match the specified filter criteria.
- nextToken
-
- Type: 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.
Errors
- InvalidPaginationToken:
The specified pagination token (
nextToken
) is not valid.- UnsupportedLocale:
The specified locale is not supported.
DescribeEventsForOrganization
$result = $client->describeEventsForOrganization
([/* ... */]); $promise = $client->describeEventsForOrganizationAsync
([/* ... */]);
Returns information about events across your organization in Organizations. You can use thefilters
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.
This API operation uses pagination. Specify the nextToken
parameter in the next request to return more results.
Parameter Syntax
$result = $client->describeEventsForOrganization([ 'filter' => [ 'awsAccountIds' => ['<string>', ...], 'endTime' => [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], 'entityArns' => ['<string>', ...], 'entityValues' => ['<string>', ...], 'eventStatusCodes' => ['<string>', ...], 'eventTypeCategories' => ['<string>', ...], 'eventTypeCodes' => ['<string>', ...], 'lastUpdatedTime' => [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], 'regions' => ['<string>', ...], 'services' => ['<string>', ...], 'startTime' => [ 'from' => <integer || string || DateTime>, 'to' => <integer || string || DateTime>, ], ], 'locale' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- filter
-
- Type: OrganizationEventFilter structure
Values to narrow the results returned.
- locale
-
- Type: string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
- maxResults
-
- Type: int
The maximum number of items to return in one batch, between 10 and 100, inclusive.
- nextToken
-
- Type: 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.
Result Syntax
[ 'events' => [ [ 'arn' => '<string>', 'endTime' => <DateTime>, 'eventScopeCode' => 'PUBLIC|ACCOUNT_SPECIFIC|NONE', 'eventTypeCategory' => 'issue|accountNotification|scheduledChange|investigation', 'eventTypeCode' => '<string>', 'lastUpdatedTime' => <DateTime>, 'region' => '<string>', 'service' => '<string>', 'startTime' => <DateTime>, 'statusCode' => 'open|closed|upcoming', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- events
-
- Type: Array of OrganizationEvent structures
The events that match the specified filter criteria.
- nextToken
-
- Type: 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.
Errors
- InvalidPaginationToken:
The specified pagination token (
nextToken
) is not valid.- UnsupportedLocale:
The specified locale is not supported.
DescribeHealthServiceStatusForOrganization
$result = $client->describeHealthServiceStatusForOrganization
([/* ... */]); $promise = $client->describeHealthServiceStatusForOrganizationAsync
([/* ... */]);
This operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.
Parameter Syntax
$result = $client->describeHealthServiceStatusForOrganization([ ]);
Parameter Details
Members
Result Syntax
[ 'healthServiceAccessStatusForOrganization' => '<string>', ]
Result Details
Members
- healthServiceAccessStatusForOrganization
-
- Type: string
Information about the status of enabling or disabling the Health organizational view feature in your organization.
Valid values are
ENABLED | DISABLED | PENDING
.
Errors
There are no errors described for this operation.
DisableHealthServiceAccessForOrganization
$result = $client->disableHealthServiceAccessForOrganization
([/* ... */]); $promise = $client->disableHealthServiceAccessForOrganizationAsync
([/* ... */]);
Disables Health from working with Organizations. To call this operation, you must sign in to 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.
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.
Parameter Syntax
$result = $client->disableHealthServiceAccessForOrganization([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
- ConcurrentModificationException:
EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.
EnableHealthServiceAccessForOrganization
$result = $client->enableHealthServiceAccessForOrganization
([/* ... */]); $promise = $client->enableHealthServiceAccessForOrganizationAsync
([/* ... */]);
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.
To call this operation, you must meet the following requirements:
-
You must have a Business, Enterprise On-Ramp, 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, Enterprise On-Ramp, 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.
Parameter Syntax
$result = $client->enableHealthServiceAccessForOrganization([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
- ConcurrentModificationException:
EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.
Shapes
AccountEntityAggregate
Description
The number of entities in an account that are impacted by a specific event aggregated by the entity status codes.
Members
- accountId
-
- Type: string
The 12-digit Amazon Web Services account numbers that contains the affected entities.
- count
-
- Type: int
The number of entities that match the filter criteria for the specified events.
- statuses
-
- Type: Associative array of custom strings keys (entityStatusCode) to ints
The number of affected entities aggregated by the entity status codes.
AffectedEntity
Description
Information about an entity that is affected by a Health event.
Members
- awsAccountId
-
- Type: string
The 12-digit Amazon Web Services account number that contains the affected entity.
- entityArn
-
- Type: 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
- entityUrl
-
- Type: string
The URL of the affected entity.
- entityValue
-
- Type: string
The ID of the affected entity.
- eventArn
-
- Type: 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
- lastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent time that the entity was updated.
- statusCode
-
- Type: string
The most recent status of the entity affected by the event. The possible values are
IMPAIRED
,UNIMPAIRED
, andUNKNOWN
. - tags
-
- Type: Associative array of custom strings keys (tagKey) to strings
A map of entity tags attached to the affected entity.
Currently, the
tags
property isn't supported.
ConcurrentModificationException
Description
EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.
Members
- message
-
- Type: string
DateTimeRange
Description
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
.
Members
- from
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The starting date and time of a time range.
- to
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ending date and time of a time range.
EntityAccountFilter
Description
A JSON set of elements including the awsAccountId
, eventArn
and a set of statusCodes
.
Members
- awsAccountId
-
- Type: string
The 12-digit Amazon Web Services account numbers that contains the affected entities.
- eventArn
-
- Required: Yes
- Type: 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
- statusCodes
-
- Type: Array of strings
A list of entity status codes.
EntityAggregate
Description
The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
Members
- count
-
- Type: int
The number of entities that match the criteria for the specified events.
- eventArn
-
- Type: 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
- statuses
-
- Type: Associative array of custom strings keys (entityStatusCode) to ints
The number of affected entities aggregated by the entity status codes.
EntityFilter
Description
The values to use to filter results from the DescribeAffectedEntities operation.
Members
- entityArns
-
- Type: Array of strings
A list of entity ARNs (unique identifiers).
- entityValues
-
- Type: Array of strings
A list of IDs for affected entities.
- eventArns
-
- Required: Yes
- Type: Array of strings
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"
- lastUpdatedTimes
-
- Type: Array of DateTimeRange structures
A list of the most recent dates and times that the entity was updated.
- statusCodes
-
- Type: Array of strings
A list of entity status codes (
IMPAIRED
,UNIMPAIRED
, orUNKNOWN
). - tags
-
- Type: Array of stringss
A map of entity tags attached to the affected entity.
Currently, the
tags
property isn't supported.
Event
Description
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.
Members
- arn
-
- Type: 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
- availabilityZone
-
- Type: string
The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event ended.
- eventScopeCode
-
- Type: string
This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.
-
If the
eventScopeCode
value isPUBLIC
, then theaffectedAccounts
value is always empty. -
If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
- eventTypeCategory
-
- Type: string
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time. - eventTypeCode
-
- Type: string
The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION
; for example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT
. - lastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent date and time that the event was updated.
- region
-
- Type: string
The Amazon Web Services Region name of the event.
- service
-
- Type: string
The Amazon Web Service that is affected by the event. For example,
EC2
,RDS
. - startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event began.
- statusCode
-
- Type: string
The most recent status of the event. Possible values are
open
,closed
, andupcoming
.
EventAccountFilter
Description
The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
Members
- awsAccountId
-
- Type: string
The 12-digit Amazon Web Services account numbers that contains the affected entities.
- eventArn
-
- Required: Yes
- Type: 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
EventAggregate
Description
The number of events of each issue type. Returned by the DescribeEventAggregates operation.
Members
- aggregateValue
-
- Type: string
The issue type for the associated count.
- count
-
- Type: int
The number of events of the associated issue type.
EventDescription
Description
The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
Members
- latestDescription
-
- Type: string
The most recent description of the event.
EventDetails
Description
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.
Members
- event
-
- Type: Event structure
Summary information about the event.
- eventDescription
-
- Type: EventDescription structure
The most recent description of the event.
- eventMetadata
-
- Type: Associative array of custom strings keys (metadataKey) to strings
Additional metadata about the event.
EventDetailsErrorItem
Description
Error information returned when a DescribeEventDetails operation can't find a specified event.
Members
- errorMessage
-
- Type: string
A message that describes the error.
- errorName
-
- Type: string
The name of the error.
- eventArn
-
- Type: 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
EventFilter
Description
The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.
Members
- availabilityZones
-
- Type: Array of strings
A list of Amazon Web Services Availability Zones.
- endTimes
-
- Type: Array of DateTimeRange structures
A list of dates and times that the event ended.
- entityArns
-
- Type: Array of strings
A list of entity ARNs (unique identifiers).
- entityValues
-
- Type: Array of strings
A list of entity identifiers, such as EC2 instance IDs (
i-34ab692e
) or EBS volumes (vol-426ab23e
). - eventArns
-
- Type: Array of strings
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"
- eventStatusCodes
-
- Type: Array of strings
A list of event status codes.
- eventTypeCategories
-
- Type: Array of strings
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time. - eventTypeCodes
-
- Type: Array of strings
A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
- lastUpdatedTimes
-
- Type: Array of DateTimeRange structures
A list of dates and times that the event was last updated.
- regions
-
- Type: Array of strings
A list of Amazon Web Services Regions.
- services
-
- Type: Array of strings
The Amazon Web Services associated with the event. For example,
EC2
,RDS
. - startTimes
-
- Type: Array of DateTimeRange structures
A list of dates and times that the event began.
- tags
-
- Type: Array of stringss
A map of entity tags attached to the affected entity.
Currently, the
tags
property isn't supported.
EventType
Description
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.
Members
- category
-
- Type: string
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time. - code
-
- Type: string
The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION
; for example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT
. - service
-
- Type: string
The Amazon Web Service that is affected by the event. For example,
EC2
,RDS
.
EventTypeFilter
Description
The values to use to filter results from the DescribeEventTypes operation.
Members
- eventTypeCategories
-
- Type: Array of strings
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time. - eventTypeCodes
-
- Type: Array of strings
A list of event type codes.
- services
-
- Type: Array of strings
The Amazon Web Services associated with the event. For example,
EC2
,RDS
.
InvalidPaginationToken
Description
The specified pagination token (nextToken
) is not valid.
Members
- message
-
- Type: string
OrganizationAffectedEntitiesErrorItem
Description
Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
Members
- awsAccountId
-
- Type: string
The 12-digit Amazon Web Services account numbers that contains the affected entities.
- errorMessage
-
- Type: string
A message that describes the error. Follow the error message and retry your request.
For example, the
InvalidAccountInputError
error message appears if you call theDescribeAffectedEntitiesForOrganization
operation and specify theAccountSpecific
value for theEventScopeCode
parameter, but don't specify an Amazon Web Services account. - errorName
-
- Type: string
The name of the error.
- eventArn
-
- Type: 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
OrganizationEntityAggregate
Description
The aggregate results of entities affected by the specified event in your organization. The results are aggregated by the entity status codes for the specified set of accountsIDs.
Members
- accounts
-
- Type: Array of AccountEntityAggregate structures
A list of entity aggregates for each of the specified accounts in your organization that are affected by a specific event. If there are no
awsAccountIds
provided in the request, this field will be empty in the response. - count
-
- Type: int
The number of entities for the organization that match the filter criteria for the specified events.
- eventArn
-
- Type: string
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"
- statuses
-
- Type: Associative array of custom strings keys (entityStatusCode) to ints
The number of affected entities aggregated by the entitiy status codes.
OrganizationEvent
Description
Summary information about an event, returned by the DescribeEventsForOrganization operation.
Members
- arn
-
- Type: 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
- endTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event ended.
- eventScopeCode
-
- Type: string
This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.
-
If the
eventScopeCode
value isPUBLIC
, then theaffectedAccounts
value is always empty. -
If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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 isNONE
, then theeventArn
that you specified in the request is invalid or doesn't exist.
- eventTypeCategory
-
- Type: string
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time. - eventTypeCode
-
- Type: string
The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION
. For example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT
. - lastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The most recent date and time that the event was updated.
- region
-
- Type: string
The Amazon Web Services Region name of the event.
- service
-
- Type: string
The Amazon Web Service that is affected by the event, such as EC2 and RDS.
- startTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event began.
- statusCode
-
- Type: string
The most recent status of the event. Possible values are
open
,closed
, andupcoming
.
OrganizationEventDetails
Description
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.
Members
- awsAccountId
-
- Type: string
The 12-digit Amazon Web Services account numbers that contains the affected entities.
- event
-
- Type: Event structure
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. - eventDescription
-
- Type: EventDescription structure
The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
- eventMetadata
-
- Type: Associative array of custom strings keys (metadataKey) to strings
Additional metadata about the event.
OrganizationEventDetailsErrorItem
Description
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
Members
- awsAccountId
-
- Type: string
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
- errorMessage
-
- Type: 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, Enterprise On-Ramp, or Enterprise Support plan.
- errorName
-
- Type: string
The name of the error.
- eventArn
-
- Type: 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
OrganizationEventFilter
Description
The values to filter results from the DescribeEventsForOrganization operation.
Members
- awsAccountIds
-
- Type: Array of strings
A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
- endTime
-
- Type: DateTimeRange structure
A range of dates and times that is used by the EventFilter and EntityFilter objects. If
from
is set andto
is set: match items where the timestamp (startTime
,endTime
, orlastUpdatedTime
) is betweenfrom
andto
inclusive. Iffrom
is set andto
is not set: match items where the timestamp value is equal to or afterfrom
. Iffrom
is not set andto
is set: match items where the timestamp value is equal to or beforeto
. - entityArns
-
- Type: Array of strings
A list of entity ARNs (unique identifiers).
- entityValues
-
- Type: Array of strings
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
- eventStatusCodes
-
- Type: Array of strings
A list of event status codes.
- eventTypeCategories
-
- Type: Array of strings
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn't supported at this time. - eventTypeCodes
-
- Type: Array of strings
A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
- lastUpdatedTime
-
- Type: DateTimeRange structure
A range of dates and times that is used by the EventFilter and EntityFilter objects. If
from
is set andto
is set: match items where the timestamp (startTime
,endTime
, orlastUpdatedTime
) is betweenfrom
andto
inclusive. Iffrom
is set andto
is not set: match items where the timestamp value is equal to or afterfrom
. Iffrom
is not set andto
is set: match items where the timestamp value is equal to or beforeto
. - regions
-
- Type: Array of strings
A list of Amazon Web Services Regions.
- services
-
- Type: Array of strings
The Amazon Web Services associated with the event. For example,
EC2
,RDS
. - startTime
-
- Type: DateTimeRange structure
A range of dates and times that is used by the EventFilter and EntityFilter objects. If
from
is set andto
is set: match items where the timestamp (startTime
,endTime
, orlastUpdatedTime
) is betweenfrom
andto
inclusive. Iffrom
is set andto
is not set: match items where the timestamp value is equal to or afterfrom
. Iffrom
is not set andto
is set: match items where the timestamp value is equal to or beforeto
.
UnsupportedLocale
Description
The specified locale is not supported.
Members
- message
-
- Type: string