String entityArn
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
String eventArn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
String entityValue
The ID of the affected entity.
String entityUrl
The URL of the affected entity.
String awsAccountId
The 12-digit AWS account number that contains the affected entity.
Date lastUpdatedTime
The most recent time that the entity was updated.
String statusCode
The most recent status of the entity affected by the event. The possible values are IMPAIRED,
UNIMPAIRED, and UNKNOWN.
Map<K,V> tags
A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
String eventArn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
String nextToken
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.
Integer maxResults
The maximum number of items to return in one batch, between 10 and 100, inclusive.
List<E> affectedAccounts
A JSON set of elements of the affected accounts.
String eventScopeCode
This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as
Amazon Elastic Compute Cloud and you have AWS 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.
String nextToken
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.
List<E> organizationEntityFilters
A JSON set of elements including the awsAccountId and the eventArn.
String locale
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
String nextToken
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.
Integer maxResults
The maximum number of items to return in one batch, between 10 and 100, inclusive.
List<E> entities
A JSON set of elements including the awsAccountId and its entityArn,
entityValue and its entityArn, lastUpdatedTime, and
statusCode.
List<E> failedSet
A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.
String nextToken
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.
EntityFilter filter
Values to narrow the results returned. At least one event ARN is required.
String locale
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
String nextToken
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.
Integer maxResults
The maximum number of items to return in one batch, between 10 and 100, inclusive.
List<E> entities
The entities that match the filter criteria.
String nextToken
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.
EventFilter filter
Values to narrow the results returned.
String aggregateField
The only currently supported value is eventTypeCategory.
Integer maxResults
The maximum number of items to return in one batch, between 10 and 100, inclusive.
String nextToken
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.
List<E> eventAggregates
The number of events in each category that meet the optional filter criteria.
String nextToken
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.
List<E> eventArns
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
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
OrganizationEventFilter filter
Values to narrow the results returned.
String nextToken
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.
Integer maxResults
The maximum number of items to return in one batch, between 10 and 100, inclusive.
String locale
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
List<E> events
The events that match the specified filter criteria.
String nextToken
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.
EventFilter filter
Values to narrow the results returned.
String nextToken
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.
Integer maxResults
The maximum number of items to return in one batch, between 10 and 100, inclusive.
String locale
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
List<E> events
The events that match the specified filter criteria.
String nextToken
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.
EventTypeFilter filter
Values to narrow the results returned.
String locale
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
String nextToken
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.
Integer maxResults
The maximum number of items to return in one batch, between 10 and 100, inclusive.
List<E> eventTypes
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).
String nextToken
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.
String healthServiceAccessStatusForOrganization
Information about the status of enabling or disabling AWS Health Organizational View in your organization.
Valid values are ENABLED | DISABLED | PENDING.
String eventArn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
Integer count
The number of entities that match the criteria for the specified events.
List<E> eventArns
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"
List<E> entityArns
A list of entity ARNs (unique identifiers).
List<E> entityValues
A list of IDs for affected entities.
List<E> lastUpdatedTimes
A list of the most recent dates and times that the entity was updated.
List<E> tags
A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
List<E> statusCodes
A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
String arn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
String service
The AWS service that is affected by the event. For example, EC2, RDS.
String eventTypeCode
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for
example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
String eventTypeCategory
The category of the event. Possible values are issue, scheduledChange, and
accountNotification.
String region
The AWS region name of the event.
String availabilityZone
The AWS Availability Zone of the event. For example, us-east-1a.
Date startTime
The date and time that the event began.
Date endTime
The date and time that the event ended.
Date lastUpdatedTime
The most recent date and time that the event was updated.
String statusCode
The most recent status of the event. Possible values are open, closed, and
upcoming.
String eventScopeCode
This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as
Amazon Elastic Compute Cloud and you have AWS 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.
String eventArn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
String awsAccountId
The 12-digit AWS account numbers that contains the affected entities.
String latestDescription
The most recent description of the event.
Event event
Summary information about the event.
EventDescription eventDescription
The most recent description of the event.
Map<K,V> eventMetadata
Additional metadata about the event.
String eventArn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
String errorName
The name of the error.
String errorMessage
A message that describes the error.
List<E> eventArns
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"
List<E> eventTypeCodes
A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
List<E> services
The AWS services associated with the event. For example, EC2, RDS.
List<E> regions
A list of AWS regions.
List<E> availabilityZones
A list of AWS availability zones.
List<E> startTimes
A list of dates and times that the event began.
List<E> endTimes
A list of dates and times that the event ended.
List<E> lastUpdatedTimes
A list of dates and times that the event was last updated.
List<E> entityArns
A list of entity ARNs (unique identifiers).
List<E> entityValues
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (
vol-426ab23e).
List<E> eventTypeCategories
A list of event type category codes (issue, scheduledChange, or
accountNotification).
List<E> tags
A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
List<E> eventStatusCodes
A list of event status codes.
String service
The AWS service that is affected by the event. For example, EC2, RDS.
String code
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for
example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
String category
A list of event type category codes (issue, scheduledChange, or
accountNotification).
String awsAccountId
The 12-digit AWS account numbers that contains the affected entities.
String eventArn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
String errorName
The name of the error.
String errorMessage
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
String arn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
String service
The AWS service that is affected by the event. For example, EC2, RDS.
String eventTypeCode
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
String eventTypeCategory
The category of the event type.
String eventScopeCode
This parameter specifies if the AWS Health event is a public AWS 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 AWS accounts in your organization. For example, if an event affects a service such as
Amazon Elastic Compute Cloud and you have AWS 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.
String region
The AWS Region name of the event.
Date startTime
The date and time that the event began.
Date endTime
The date and time that the event ended.
Date lastUpdatedTime
The most recent date and time that the event was updated.
String statusCode
The most recent status of the event. Possible values are open, closed, and
upcoming.
String awsAccountId
Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
String eventArn
The unique identifier for the event. Format:
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
. Example:
Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
String errorName
The name of the error.
String errorMessage
A message that describes the error.
List<E> eventTypeCodes
A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
List<E> awsAccountIds
A list of 12-digit AWS account numbers that contains the affected entities.
List<E> services
The AWS services associated with the event. For example, EC2, RDS.
List<E> regions
A list of AWS Regions.
DateTimeRange startTime
DateTimeRange endTime
DateTimeRange lastUpdatedTime
List<E> entityArns
A list of entity ARNs (unique identifiers).
List<E> entityValues
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
List<E> eventTypeCategories
A list of event type category codes (issue, scheduledChange, or accountNotification).
List<E> eventStatusCodes
A list of event status codes.
Copyright © 2021. All rights reserved.