| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AWSHealth
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- DescribeAffectedAccountsForOrganization (Paginated)
- DescribeAffectedEntities (Paginated)
- DescribeAffectedEntitiesForOrganization (Paginated)
- DescribeEntityAggregates
- DescribeEventAggregates (Paginated)
- DescribeEventDetails
- DescribeEventDetailsForOrganization
- DescribeEventTypes (Paginated)
- DescribeEvents (Paginated)
- DescribeEventsForOrganization (Paginated)
- DescribeHealthServiceStatusForOrganization
- DisableHealthServiceAccessForOrganization
- EnableHealthServiceAccessForOrganization
- Types
- EntityStatusCode
- EventAggregateField
- EventScopeCode
- EventStatusCode
- EventTypeCategory
- AffectedEntity
- DateTimeRange
- EntityAggregate
- EntityFilter
- Event
- EventAccountFilter
- EventAggregate
- EventDescription
- EventDetails
- EventDetailsErrorItem
- EventFilter
- EventType
- EventTypeFilter
- OrganizationAffectedEntitiesErrorItem
- OrganizationEvent
- OrganizationEventDetails
- OrganizationEventDetailsErrorItem
- OrganizationEventFilter
Description
Derived from API version 2016-08-04 of the AWS service descriptions, licensed under Apache 2.0.
Health
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.
- 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
SubscriptionRequiredExceptionerror. - 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.
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
DescribeEventsForOrganizationoperation to get all events in your organization, you might receive several page results. Specify thenextTokenin the next request to return more results.
Synopsis
- defaultService :: Service
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _InvalidPaginationToken :: AsError a => Fold a ServiceError
- _UnsupportedLocale :: AsError a => Fold a ServiceError
- data DescribeAffectedAccountsForOrganization = DescribeAffectedAccountsForOrganization' (Maybe Natural) (Maybe Text) Text
- newDescribeAffectedAccountsForOrganization :: Text -> DescribeAffectedAccountsForOrganization
- data DescribeAffectedAccountsForOrganizationResponse = DescribeAffectedAccountsForOrganizationResponse' (Maybe [Text]) (Maybe EventScopeCode) (Maybe Text) Int
- newDescribeAffectedAccountsForOrganizationResponse :: Int -> DescribeAffectedAccountsForOrganizationResponse
- data DescribeAffectedEntities = DescribeAffectedEntities' (Maybe Text) (Maybe Natural) (Maybe Text) EntityFilter
- newDescribeAffectedEntities :: EntityFilter -> DescribeAffectedEntities
- data DescribeAffectedEntitiesResponse = DescribeAffectedEntitiesResponse' (Maybe [AffectedEntity]) (Maybe Text) Int
- newDescribeAffectedEntitiesResponse :: Int -> DescribeAffectedEntitiesResponse
- data DescribeAffectedEntitiesForOrganization = DescribeAffectedEntitiesForOrganization' (Maybe Text) (Maybe Natural) (Maybe Text) (NonEmpty EventAccountFilter)
- newDescribeAffectedEntitiesForOrganization :: NonEmpty EventAccountFilter -> DescribeAffectedEntitiesForOrganization
- data DescribeAffectedEntitiesForOrganizationResponse = DescribeAffectedEntitiesForOrganizationResponse' (Maybe [AffectedEntity]) (Maybe [OrganizationAffectedEntitiesErrorItem]) (Maybe Text) Int
- newDescribeAffectedEntitiesForOrganizationResponse :: Int -> DescribeAffectedEntitiesForOrganizationResponse
- data DescribeEntityAggregates = DescribeEntityAggregates' (Maybe (NonEmpty Text))
- newDescribeEntityAggregates :: DescribeEntityAggregates
- data DescribeEntityAggregatesResponse = DescribeEntityAggregatesResponse' (Maybe [EntityAggregate]) Int
- newDescribeEntityAggregatesResponse :: Int -> DescribeEntityAggregatesResponse
- data DescribeEventAggregates = DescribeEventAggregates' (Maybe EventFilter) (Maybe Natural) (Maybe Text) EventAggregateField
- newDescribeEventAggregates :: EventAggregateField -> DescribeEventAggregates
- data DescribeEventAggregatesResponse = DescribeEventAggregatesResponse' (Maybe [EventAggregate]) (Maybe Text) Int
- newDescribeEventAggregatesResponse :: Int -> DescribeEventAggregatesResponse
- data DescribeEventDetails = DescribeEventDetails' (Maybe Text) (NonEmpty Text)
- newDescribeEventDetails :: NonEmpty Text -> DescribeEventDetails
- data DescribeEventDetailsResponse = DescribeEventDetailsResponse' (Maybe [EventDetailsErrorItem]) (Maybe [EventDetails]) Int
- newDescribeEventDetailsResponse :: Int -> DescribeEventDetailsResponse
- data DescribeEventDetailsForOrganization = DescribeEventDetailsForOrganization' (Maybe Text) (NonEmpty EventAccountFilter)
- newDescribeEventDetailsForOrganization :: NonEmpty EventAccountFilter -> DescribeEventDetailsForOrganization
- data DescribeEventDetailsForOrganizationResponse = DescribeEventDetailsForOrganizationResponse' (Maybe [OrganizationEventDetailsErrorItem]) (Maybe [OrganizationEventDetails]) Int
- newDescribeEventDetailsForOrganizationResponse :: Int -> DescribeEventDetailsForOrganizationResponse
- data DescribeEventTypes = DescribeEventTypes' (Maybe EventTypeFilter) (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeEventTypes :: DescribeEventTypes
- data DescribeEventTypesResponse = DescribeEventTypesResponse' (Maybe [EventType]) (Maybe Text) Int
- newDescribeEventTypesResponse :: Int -> DescribeEventTypesResponse
- data DescribeEvents = DescribeEvents' (Maybe EventFilter) (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEventsForOrganization = DescribeEventsForOrganization' (Maybe OrganizationEventFilter) (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeEventsForOrganization :: DescribeEventsForOrganization
- data DescribeEventsForOrganizationResponse = DescribeEventsForOrganizationResponse' (Maybe [OrganizationEvent]) (Maybe Text) Int
- newDescribeEventsForOrganizationResponse :: Int -> DescribeEventsForOrganizationResponse
- data DescribeHealthServiceStatusForOrganization = DescribeHealthServiceStatusForOrganization' {
- newDescribeHealthServiceStatusForOrganization :: DescribeHealthServiceStatusForOrganization
- data DescribeHealthServiceStatusForOrganizationResponse = DescribeHealthServiceStatusForOrganizationResponse' (Maybe Text) Int
- newDescribeHealthServiceStatusForOrganizationResponse :: Int -> DescribeHealthServiceStatusForOrganizationResponse
- data DisableHealthServiceAccessForOrganization = DisableHealthServiceAccessForOrganization' {
- newDisableHealthServiceAccessForOrganization :: DisableHealthServiceAccessForOrganization
- data DisableHealthServiceAccessForOrganizationResponse = DisableHealthServiceAccessForOrganizationResponse' {
- newDisableHealthServiceAccessForOrganizationResponse :: DisableHealthServiceAccessForOrganizationResponse
- data EnableHealthServiceAccessForOrganization = EnableHealthServiceAccessForOrganization' {
- newEnableHealthServiceAccessForOrganization :: EnableHealthServiceAccessForOrganization
- data EnableHealthServiceAccessForOrganizationResponse = EnableHealthServiceAccessForOrganizationResponse' {
- newEnableHealthServiceAccessForOrganizationResponse :: EnableHealthServiceAccessForOrganizationResponse
- newtype EntityStatusCode where
- EntityStatusCode' { }
- pattern EntityStatusCode_IMPAIRED :: EntityStatusCode
- pattern EntityStatusCode_UNIMPAIRED :: EntityStatusCode
- pattern EntityStatusCode_UNKNOWN :: EntityStatusCode
- newtype EventAggregateField where
- newtype EventScopeCode where
- EventScopeCode' { }
- pattern EventScopeCode_ACCOUNT_SPECIFIC :: EventScopeCode
- pattern EventScopeCode_NONE :: EventScopeCode
- pattern EventScopeCode_PUBLIC :: EventScopeCode
- newtype EventStatusCode where
- EventStatusCode' { }
- pattern EventStatusCode_Closed :: EventStatusCode
- pattern EventStatusCode_Open :: EventStatusCode
- pattern EventStatusCode_Upcoming :: EventStatusCode
- newtype EventTypeCategory where
- data AffectedEntity = AffectedEntity' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EntityStatusCode) (Maybe (HashMap Text Text))
- newAffectedEntity :: AffectedEntity
- data DateTimeRange = DateTimeRange' (Maybe POSIX) (Maybe POSIX)
- newDateTimeRange :: DateTimeRange
- data EntityAggregate = EntityAggregate' (Maybe Int) (Maybe Text)
- newEntityAggregate :: EntityAggregate
- data EntityFilter = EntityFilter' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty DateTimeRange)) (Maybe (NonEmpty EntityStatusCode)) (Maybe [HashMap Text Text]) (NonEmpty Text)
- newEntityFilter :: NonEmpty Text -> EntityFilter
- data Event = Event' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EventScopeCode) (Maybe EventTypeCategory) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EventStatusCode)
- newEvent :: Event
- data EventAccountFilter = EventAccountFilter' (Maybe Text) Text
- newEventAccountFilter :: Text -> EventAccountFilter
- data EventAggregate = EventAggregate' (Maybe Text) (Maybe Int)
- newEventAggregate :: EventAggregate
- data EventDescription = EventDescription' (Maybe Text)
- newEventDescription :: EventDescription
- data EventDetails = EventDetails' (Maybe Event) (Maybe EventDescription) (Maybe (HashMap Text Text))
- newEventDetails :: EventDetails
- data EventDetailsErrorItem = EventDetailsErrorItem' (Maybe Text) (Maybe Text) (Maybe Text)
- newEventDetailsErrorItem :: EventDetailsErrorItem
- data EventFilter = EventFilter' (Maybe [Text]) (Maybe (NonEmpty DateTimeRange)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty EventStatusCode)) (Maybe (NonEmpty EventTypeCategory)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty DateTimeRange)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty DateTimeRange)) (Maybe [HashMap Text Text])
- newEventFilter :: EventFilter
- data EventType = EventType' (Maybe EventTypeCategory) (Maybe Text) (Maybe Text)
- newEventType :: EventType
- data EventTypeFilter = EventTypeFilter' (Maybe (NonEmpty EventTypeCategory)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text))
- newEventTypeFilter :: EventTypeFilter
- data OrganizationAffectedEntitiesErrorItem = OrganizationAffectedEntitiesErrorItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newOrganizationAffectedEntitiesErrorItem :: OrganizationAffectedEntitiesErrorItem
- data OrganizationEvent = OrganizationEvent' (Maybe Text) (Maybe POSIX) (Maybe EventScopeCode) (Maybe EventTypeCategory) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EventStatusCode)
- newOrganizationEvent :: OrganizationEvent
- data OrganizationEventDetails = OrganizationEventDetails' (Maybe Text) (Maybe Event) (Maybe EventDescription) (Maybe (HashMap Text Text))
- newOrganizationEventDetails :: OrganizationEventDetails
- data OrganizationEventDetailsErrorItem = OrganizationEventDetailsErrorItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newOrganizationEventDetailsErrorItem :: OrganizationEventDetailsErrorItem
- data OrganizationEventFilter = OrganizationEventFilter' (Maybe (NonEmpty Text)) (Maybe DateTimeRange) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty EventStatusCode)) (Maybe (NonEmpty EventTypeCategory)) (Maybe (NonEmpty Text)) (Maybe DateTimeRange) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe DateTimeRange)
- newOrganizationEventFilter :: OrganizationEventFilter
Service Configuration
defaultService :: Service Source #
API version 2016-08-04 of the Amazon Health APIs and Notifications SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AWSHealth.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
EnableHealthServiceAccessForOrganization is already in progress. Wait for the action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.
InvalidPaginationToken
_InvalidPaginationToken :: AsError a => Fold a ServiceError Source #
The specified pagination token (nextToken) is not valid.
UnsupportedLocale
_UnsupportedLocale :: AsError a => Fold a ServiceError Source #
The specified locale is not supported.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeAffectedAccountsForOrganization (Paginated)
data DescribeAffectedAccountsForOrganization Source #
See: newDescribeAffectedAccountsForOrganization smart constructor.
Instances
newDescribeAffectedAccountsForOrganization Source #
Create a value of DescribeAffectedAccountsForOrganization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:DescribeAffectedAccountsForOrganization', describeAffectedAccountsForOrganization_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
DescribeAffectedAccountsForOrganization, describeAffectedAccountsForOrganization_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.
DescribeAffectedAccountsForOrganization, describeAffectedAccountsForOrganization_eventArn - 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
data DescribeAffectedAccountsForOrganizationResponse Source #
See: newDescribeAffectedAccountsForOrganizationResponse smart constructor.
Constructors
| DescribeAffectedAccountsForOrganizationResponse' (Maybe [Text]) (Maybe EventScopeCode) (Maybe Text) Int |
Instances
newDescribeAffectedAccountsForOrganizationResponse Source #
Arguments
| :: Int |
|
| -> DescribeAffectedAccountsForOrganizationResponse |
Create a value of DescribeAffectedAccountsForOrganizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:affectedAccounts:DescribeAffectedAccountsForOrganizationResponse', describeAffectedAccountsForOrganizationResponse_affectedAccounts - A JSON set of elements of the affected accounts.
DescribeAffectedAccountsForOrganizationResponse, describeAffectedAccountsForOrganizationResponse_eventScopeCode - This parameter specifies if the Health event is a public Amazon Web
Services service event or an account-specific event.
- If the
eventScopeCodevalue isPUBLIC, then theaffectedAccountsvalue is always empty. - If the
eventScopeCodevalue isACCOUNT_SPECIFIC, then theaffectedAccountsvalue 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
eventScopeCodevalue isNONE, then theeventArnthat you specified in the request is invalid or doesn't exist.
DescribeAffectedAccountsForOrganization, describeAffectedAccountsForOrganizationResponse_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.
$sel:httpStatus:DescribeAffectedAccountsForOrganizationResponse', describeAffectedAccountsForOrganizationResponse_httpStatus - The response's http status code.
DescribeAffectedEntities (Paginated)
data DescribeAffectedEntities Source #
See: newDescribeAffectedEntities smart constructor.
Constructors
| DescribeAffectedEntities' (Maybe Text) (Maybe Natural) (Maybe Text) EntityFilter |
Instances
newDescribeAffectedEntities Source #
Create a value of DescribeAffectedEntities with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locale:DescribeAffectedEntities', describeAffectedEntities_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
$sel:maxResults:DescribeAffectedEntities', describeAffectedEntities_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
DescribeAffectedEntities, describeAffectedEntities_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.
$sel:filter':DescribeAffectedEntities', describeAffectedEntities_filter - Values to narrow the results returned. At least one event ARN is
required.
data DescribeAffectedEntitiesResponse Source #
See: newDescribeAffectedEntitiesResponse smart constructor.
Constructors
| DescribeAffectedEntitiesResponse' (Maybe [AffectedEntity]) (Maybe Text) Int |
Instances
newDescribeAffectedEntitiesResponse Source #
Create a value of DescribeAffectedEntitiesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entities:DescribeAffectedEntitiesResponse', describeAffectedEntitiesResponse_entities - The entities that match the filter criteria.
DescribeAffectedEntities, describeAffectedEntitiesResponse_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.
$sel:httpStatus:DescribeAffectedEntitiesResponse', describeAffectedEntitiesResponse_httpStatus - The response's http status code.
DescribeAffectedEntitiesForOrganization (Paginated)
data DescribeAffectedEntitiesForOrganization Source #
See: newDescribeAffectedEntitiesForOrganization smart constructor.
Constructors
| DescribeAffectedEntitiesForOrganization' (Maybe Text) (Maybe Natural) (Maybe Text) (NonEmpty EventAccountFilter) |
Instances
newDescribeAffectedEntitiesForOrganization Source #
Arguments
| :: NonEmpty EventAccountFilter |
|
| -> DescribeAffectedEntitiesForOrganization |
Create a value of DescribeAffectedEntitiesForOrganization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locale:DescribeAffectedEntitiesForOrganization', describeAffectedEntitiesForOrganization_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
$sel:maxResults:DescribeAffectedEntitiesForOrganization', describeAffectedEntitiesForOrganization_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
DescribeAffectedEntitiesForOrganization, describeAffectedEntitiesForOrganization_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.
$sel:organizationEntityFilters:DescribeAffectedEntitiesForOrganization', describeAffectedEntitiesForOrganization_organizationEntityFilters - A JSON set of elements including the awsAccountId and the eventArn.
data DescribeAffectedEntitiesForOrganizationResponse Source #
See: newDescribeAffectedEntitiesForOrganizationResponse smart constructor.
Constructors
| DescribeAffectedEntitiesForOrganizationResponse' (Maybe [AffectedEntity]) (Maybe [OrganizationAffectedEntitiesErrorItem]) (Maybe Text) Int |
Instances
newDescribeAffectedEntitiesForOrganizationResponse Source #
Arguments
| :: Int |
|
| -> DescribeAffectedEntitiesForOrganizationResponse |
Create a value of DescribeAffectedEntitiesForOrganizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entities:DescribeAffectedEntitiesForOrganizationResponse', describeAffectedEntitiesForOrganizationResponse_entities - A JSON set of elements including the awsAccountId and its entityArn,
entityValue and its entityArn, lastUpdatedTime, and statusCode.
$sel:failedSet:DescribeAffectedEntitiesForOrganizationResponse', describeAffectedEntitiesForOrganizationResponse_failedSet - A JSON set of elements of the failed response, including the
awsAccountId, errorMessage, errorName, and eventArn.
DescribeAffectedEntitiesForOrganization, describeAffectedEntitiesForOrganizationResponse_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.
$sel:httpStatus:DescribeAffectedEntitiesForOrganizationResponse', describeAffectedEntitiesForOrganizationResponse_httpStatus - The response's http status code.
DescribeEntityAggregates
data DescribeEntityAggregates Source #
See: newDescribeEntityAggregates smart constructor.
Constructors
| DescribeEntityAggregates' (Maybe (NonEmpty Text)) |
Instances
newDescribeEntityAggregates :: DescribeEntityAggregates Source #
Create a value of DescribeEntityAggregates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeEntityAggregates, describeEntityAggregates_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"
data DescribeEntityAggregatesResponse Source #
See: newDescribeEntityAggregatesResponse smart constructor.
Constructors
| DescribeEntityAggregatesResponse' (Maybe [EntityAggregate]) Int |
Instances
newDescribeEntityAggregatesResponse Source #
Create a value of DescribeEntityAggregatesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityAggregates:DescribeEntityAggregatesResponse', describeEntityAggregatesResponse_entityAggregates - The number of entities that are affected by each of the specified
events.
$sel:httpStatus:DescribeEntityAggregatesResponse', describeEntityAggregatesResponse_httpStatus - The response's http status code.
DescribeEventAggregates (Paginated)
data DescribeEventAggregates Source #
See: newDescribeEventAggregates smart constructor.
Constructors
| DescribeEventAggregates' (Maybe EventFilter) (Maybe Natural) (Maybe Text) EventAggregateField |
Instances
newDescribeEventAggregates Source #
Arguments
| :: EventAggregateField | |
| -> DescribeEventAggregates |
Create a value of DescribeEventAggregates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':DescribeEventAggregates', describeEventAggregates_filter - Values to narrow the results returned.
$sel:maxResults:DescribeEventAggregates', describeEventAggregates_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
DescribeEventAggregates, describeEventAggregates_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.
$sel:aggregateField:DescribeEventAggregates', describeEventAggregates_aggregateField - The only currently supported value is eventTypeCategory.
data DescribeEventAggregatesResponse Source #
See: newDescribeEventAggregatesResponse smart constructor.
Constructors
| DescribeEventAggregatesResponse' (Maybe [EventAggregate]) (Maybe Text) Int |
Instances
newDescribeEventAggregatesResponse Source #
Create a value of DescribeEventAggregatesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventAggregates:DescribeEventAggregatesResponse', describeEventAggregatesResponse_eventAggregates - The number of events in each category that meet the optional filter
criteria.
DescribeEventAggregates, describeEventAggregatesResponse_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.
$sel:httpStatus:DescribeEventAggregatesResponse', describeEventAggregatesResponse_httpStatus - The response's http status code.
DescribeEventDetails
data DescribeEventDetails Source #
See: newDescribeEventDetails smart constructor.
Constructors
| DescribeEventDetails' (Maybe Text) (NonEmpty Text) |
Instances
newDescribeEventDetails Source #
Arguments
| :: NonEmpty Text | |
| -> DescribeEventDetails |
Create a value of DescribeEventDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locale:DescribeEventDetails', describeEventDetails_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
DescribeEventDetails, describeEventDetails_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"
data DescribeEventDetailsResponse Source #
See: newDescribeEventDetailsResponse smart constructor.
Constructors
| DescribeEventDetailsResponse' (Maybe [EventDetailsErrorItem]) (Maybe [EventDetails]) Int |
Instances
newDescribeEventDetailsResponse Source #
Create a value of DescribeEventDetailsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failedSet:DescribeEventDetailsResponse', describeEventDetailsResponse_failedSet - Error messages for any events that could not be retrieved.
$sel:successfulSet:DescribeEventDetailsResponse', describeEventDetailsResponse_successfulSet - Information about the events that could be retrieved.
$sel:httpStatus:DescribeEventDetailsResponse', describeEventDetailsResponse_httpStatus - The response's http status code.
DescribeEventDetailsForOrganization
data DescribeEventDetailsForOrganization Source #
See: newDescribeEventDetailsForOrganization smart constructor.
Constructors
| DescribeEventDetailsForOrganization' (Maybe Text) (NonEmpty EventAccountFilter) |
Instances
newDescribeEventDetailsForOrganization Source #
Arguments
| :: NonEmpty EventAccountFilter |
|
| -> DescribeEventDetailsForOrganization |
Create a value of DescribeEventDetailsForOrganization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locale:DescribeEventDetailsForOrganization', describeEventDetailsForOrganization_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
$sel:organizationEventDetailFilters:DescribeEventDetailsForOrganization', describeEventDetailsForOrganization_organizationEventDetailFilters - A set of JSON elements that includes the awsAccountId and the
eventArn.
data DescribeEventDetailsForOrganizationResponse Source #
See: newDescribeEventDetailsForOrganizationResponse smart constructor.
Constructors
| DescribeEventDetailsForOrganizationResponse' (Maybe [OrganizationEventDetailsErrorItem]) (Maybe [OrganizationEventDetails]) Int |
Instances
newDescribeEventDetailsForOrganizationResponse Source #
Arguments
| :: Int |
|
| -> DescribeEventDetailsForOrganizationResponse |
Create a value of DescribeEventDetailsForOrganizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failedSet:DescribeEventDetailsForOrganizationResponse', describeEventDetailsForOrganizationResponse_failedSet - Error messages for any events that could not be retrieved.
$sel:successfulSet:DescribeEventDetailsForOrganizationResponse', describeEventDetailsForOrganizationResponse_successfulSet - Information about the events that could be retrieved.
$sel:httpStatus:DescribeEventDetailsForOrganizationResponse', describeEventDetailsForOrganizationResponse_httpStatus - The response's http status code.
DescribeEventTypes (Paginated)
data DescribeEventTypes Source #
See: newDescribeEventTypes smart constructor.
Constructors
| DescribeEventTypes' (Maybe EventTypeFilter) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newDescribeEventTypes :: DescribeEventTypes Source #
Create a value of DescribeEventTypes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':DescribeEventTypes', describeEventTypes_filter - Values to narrow the results returned.
$sel:locale:DescribeEventTypes', describeEventTypes_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
$sel:maxResults:DescribeEventTypes', describeEventTypes_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
DescribeEventTypes, describeEventTypes_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.
data DescribeEventTypesResponse Source #
See: newDescribeEventTypesResponse smart constructor.
Instances
newDescribeEventTypesResponse Source #
Create a value of DescribeEventTypesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventTypes:DescribeEventTypesResponse', describeEventTypesResponse_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).
DescribeEventTypes, describeEventTypesResponse_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.
$sel:httpStatus:DescribeEventTypesResponse', describeEventTypesResponse_httpStatus - The response's http status code.
DescribeEvents (Paginated)
data DescribeEvents Source #
See: newDescribeEvents smart constructor.
Constructors
| DescribeEvents' (Maybe EventFilter) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newDescribeEvents :: DescribeEvents Source #
Create a value of DescribeEvents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':DescribeEvents', describeEvents_filter - Values to narrow the results returned.
$sel:locale:DescribeEvents', describeEvents_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
$sel:maxResults:DescribeEvents', describeEvents_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
DescribeEvents, describeEvents_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.
data DescribeEventsResponse Source #
See: newDescribeEventsResponse smart constructor.
Instances
newDescribeEventsResponse Source #
Create a value of DescribeEventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:DescribeEventsResponse', describeEventsResponse_events - The events that match the specified filter criteria.
DescribeEvents, describeEventsResponse_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.
$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.
DescribeEventsForOrganization (Paginated)
data DescribeEventsForOrganization Source #
See: newDescribeEventsForOrganization smart constructor.
Constructors
| DescribeEventsForOrganization' (Maybe OrganizationEventFilter) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newDescribeEventsForOrganization :: DescribeEventsForOrganization Source #
Create a value of DescribeEventsForOrganization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filter':DescribeEventsForOrganization', describeEventsForOrganization_filter - Values to narrow the results returned.
$sel:locale:DescribeEventsForOrganization', describeEventsForOrganization_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
$sel:maxResults:DescribeEventsForOrganization', describeEventsForOrganization_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
DescribeEventsForOrganization, describeEventsForOrganization_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.
data DescribeEventsForOrganizationResponse Source #
See: newDescribeEventsForOrganizationResponse smart constructor.
Constructors
| DescribeEventsForOrganizationResponse' (Maybe [OrganizationEvent]) (Maybe Text) Int |
Instances
newDescribeEventsForOrganizationResponse Source #
Arguments
| :: Int | |
| -> DescribeEventsForOrganizationResponse |
Create a value of DescribeEventsForOrganizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:DescribeEventsForOrganizationResponse', describeEventsForOrganizationResponse_events - The events that match the specified filter criteria.
DescribeEventsForOrganization, describeEventsForOrganizationResponse_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.
$sel:httpStatus:DescribeEventsForOrganizationResponse', describeEventsForOrganizationResponse_httpStatus - The response's http status code.
DescribeHealthServiceStatusForOrganization
data DescribeHealthServiceStatusForOrganization Source #
See: newDescribeHealthServiceStatusForOrganization smart constructor.
Constructors
| DescribeHealthServiceStatusForOrganization' | |
Instances
newDescribeHealthServiceStatusForOrganization :: DescribeHealthServiceStatusForOrganization Source #
Create a value of DescribeHealthServiceStatusForOrganization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeHealthServiceStatusForOrganizationResponse Source #
See: newDescribeHealthServiceStatusForOrganizationResponse smart constructor.
Constructors
| DescribeHealthServiceStatusForOrganizationResponse' (Maybe Text) Int |
Instances
newDescribeHealthServiceStatusForOrganizationResponse Source #
Arguments
| :: Int |
|
| -> DescribeHealthServiceStatusForOrganizationResponse |
Create a value of DescribeHealthServiceStatusForOrganizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:healthServiceAccessStatusForOrganization:DescribeHealthServiceStatusForOrganizationResponse', describeHealthServiceStatusForOrganizationResponse_healthServiceAccessStatusForOrganization - Information about the status of enabling or disabling the Health
organizational view feature in your organization.
Valid values are ENABLED | DISABLED | PENDING.
$sel:httpStatus:DescribeHealthServiceStatusForOrganizationResponse', describeHealthServiceStatusForOrganizationResponse_httpStatus - The response's http status code.
DisableHealthServiceAccessForOrganization
data DisableHealthServiceAccessForOrganization Source #
See: newDisableHealthServiceAccessForOrganization smart constructor.
Constructors
| DisableHealthServiceAccessForOrganization' | |
Instances
newDisableHealthServiceAccessForOrganization :: DisableHealthServiceAccessForOrganization Source #
Create a value of DisableHealthServiceAccessForOrganization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DisableHealthServiceAccessForOrganizationResponse Source #
See: newDisableHealthServiceAccessForOrganizationResponse smart constructor.
Instances
newDisableHealthServiceAccessForOrganizationResponse :: DisableHealthServiceAccessForOrganizationResponse Source #
Create a value of DisableHealthServiceAccessForOrganizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
EnableHealthServiceAccessForOrganization
data EnableHealthServiceAccessForOrganization Source #
See: newEnableHealthServiceAccessForOrganization smart constructor.
Constructors
| EnableHealthServiceAccessForOrganization' | |
Instances
newEnableHealthServiceAccessForOrganization :: EnableHealthServiceAccessForOrganization Source #
Create a value of EnableHealthServiceAccessForOrganization with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data EnableHealthServiceAccessForOrganizationResponse Source #
See: newEnableHealthServiceAccessForOrganizationResponse smart constructor.
Instances
newEnableHealthServiceAccessForOrganizationResponse :: EnableHealthServiceAccessForOrganizationResponse Source #
Create a value of EnableHealthServiceAccessForOrganizationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
EntityStatusCode
newtype EntityStatusCode Source #
Constructors
| EntityStatusCode' | |
Fields | |
Bundled Patterns
| pattern EntityStatusCode_IMPAIRED :: EntityStatusCode | |
| pattern EntityStatusCode_UNIMPAIRED :: EntityStatusCode | |
| pattern EntityStatusCode_UNKNOWN :: EntityStatusCode |
Instances
EventAggregateField
newtype EventAggregateField Source #
Constructors
| EventAggregateField' | |
Fields | |
Bundled Patterns
| pattern EventAggregateField_EventTypeCategory :: EventAggregateField |
Instances
EventScopeCode
newtype EventScopeCode Source #
Constructors
| EventScopeCode' | |
Fields | |
Bundled Patterns
| pattern EventScopeCode_ACCOUNT_SPECIFIC :: EventScopeCode | |
| pattern EventScopeCode_NONE :: EventScopeCode | |
| pattern EventScopeCode_PUBLIC :: EventScopeCode |
Instances
EventStatusCode
newtype EventStatusCode Source #
Constructors
| EventStatusCode' | |
Fields | |
Bundled Patterns
| pattern EventStatusCode_Closed :: EventStatusCode | |
| pattern EventStatusCode_Open :: EventStatusCode | |
| pattern EventStatusCode_Upcoming :: EventStatusCode |
Instances
EventTypeCategory
newtype EventTypeCategory Source #
Constructors
| EventTypeCategory' | |
Fields | |
Bundled Patterns
| pattern EventTypeCategory_AccountNotification :: EventTypeCategory | |
| pattern EventTypeCategory_Investigation :: EventTypeCategory | |
| pattern EventTypeCategory_Issue :: EventTypeCategory | |
| pattern EventTypeCategory_ScheduledChange :: EventTypeCategory |
Instances
AffectedEntity
data AffectedEntity Source #
Information about an entity that is affected by a Health event.
See: newAffectedEntity smart constructor.
Constructors
| AffectedEntity' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EntityStatusCode) (Maybe (HashMap Text Text)) |
Instances
newAffectedEntity :: AffectedEntity Source #
Create a value of AffectedEntity with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsAccountId:AffectedEntity', affectedEntity_awsAccountId - The 12-digit Amazon Web Services account number that contains the
affected entity.
$sel:entityArn:AffectedEntity', affectedEntity_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
$sel:entityUrl:AffectedEntity', affectedEntity_entityUrl - The URL of the affected entity.
$sel:entityValue:AffectedEntity', affectedEntity_entityValue - The ID of the affected entity.
$sel:eventArn:AffectedEntity', affectedEntity_eventArn - 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
$sel:lastUpdatedTime:AffectedEntity', affectedEntity_lastUpdatedTime - The most recent time that the entity was updated.
$sel:statusCode:AffectedEntity', affectedEntity_statusCode - The most recent status of the entity affected by the event. The possible
values are IMPAIRED, UNIMPAIRED, and UNKNOWN.
$sel:tags:AffectedEntity', affectedEntity_tags - A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
DateTimeRange
data DateTimeRange Source #
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.
See: newDateTimeRange smart constructor.
Constructors
| DateTimeRange' (Maybe POSIX) (Maybe POSIX) |
Instances
newDateTimeRange :: DateTimeRange Source #
Create a value of DateTimeRange with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:from:DateTimeRange', dateTimeRange_from - The starting date and time of a time range.
$sel:to:DateTimeRange', dateTimeRange_to - The ending date and time of a time range.
EntityAggregate
data EntityAggregate Source #
The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
See: newEntityAggregate smart constructor.
Constructors
| EntityAggregate' (Maybe Int) (Maybe Text) |
Instances
newEntityAggregate :: EntityAggregate Source #
Create a value of EntityAggregate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:count:EntityAggregate', entityAggregate_count - The number of entities that match the criteria for the specified events.
$sel:eventArn:EntityAggregate', entityAggregate_eventArn - 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
EntityFilter
data EntityFilter Source #
The values to use to filter results from the DescribeAffectedEntities operation.
See: newEntityFilter smart constructor.
Constructors
| EntityFilter' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty DateTimeRange)) (Maybe (NonEmpty EntityStatusCode)) (Maybe [HashMap Text Text]) (NonEmpty Text) |
Instances
Arguments
| :: NonEmpty Text | |
| -> EntityFilter |
Create a value of EntityFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:entityArns:EntityFilter', entityFilter_entityArns - A list of entity ARNs (unique identifiers).
$sel:entityValues:EntityFilter', entityFilter_entityValues - A list of IDs for affected entities.
$sel:lastUpdatedTimes:EntityFilter', entityFilter_lastUpdatedTimes - A list of the most recent dates and times that the entity was updated.
$sel:statusCodes:EntityFilter', entityFilter_statusCodes - A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
$sel:tags:EntityFilter', entityFilter_tags - A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
$sel:eventArns:EntityFilter', entityFilter_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"
Event
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.
See: newEvent smart constructor.
Constructors
| Event' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EventScopeCode) (Maybe EventTypeCategory) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EventStatusCode) |
Instances
Create a value of Event with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Event', event_arn - 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
$sel:availabilityZone:Event', event_availabilityZone - The Amazon Web Services Availability Zone of the event. For example,
us-east-1a.
$sel:endTime:Event', event_endTime - The date and time that the event ended.
$sel:eventScopeCode:Event', event_eventScopeCode - This parameter specifies if the Health event is a public Amazon Web
Services service event or an account-specific event.
- If the
eventScopeCodevalue isPUBLIC, then theaffectedAccountsvalue is always empty. - If the
eventScopeCodevalue isACCOUNT_SPECIFIC, then theaffectedAccountsvalue 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
eventScopeCodevalue isNONE, then theeventArnthat you specified in the request is invalid or doesn't exist.
$sel:eventTypeCategory:Event', event_eventTypeCategory - A list of event type category codes. Possible values are issue,
accountNotification, or scheduledChange. Currently, the
investigation value isn't supported at this time.
$sel:eventTypeCode:Event', event_eventTypeCode - The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION ; for example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
$sel:lastUpdatedTime:Event', event_lastUpdatedTime - The most recent date and time that the event was updated.
$sel:region:Event', event_region - The Amazon Web Services Region name of the event.
$sel:service:Event', event_service - The Amazon Web Services service that is affected by the event. For
example, EC2, RDS.
$sel:startTime:Event', event_startTime - The date and time that the event began.
$sel:statusCode:Event', event_statusCode - The most recent status of the event. Possible values are open,
closed, and upcoming.
EventAccountFilter
data EventAccountFilter Source #
The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
See: newEventAccountFilter smart constructor.
Constructors
| EventAccountFilter' (Maybe Text) Text |
Instances
newEventAccountFilter Source #
Arguments
| :: Text | |
| -> EventAccountFilter |
Create a value of EventAccountFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsAccountId:EventAccountFilter', eventAccountFilter_awsAccountId - The 12-digit Amazon Web Services account numbers that contains the
affected entities.
$sel:eventArn:EventAccountFilter', eventAccountFilter_eventArn - 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
data EventAggregate Source #
The number of events of each issue type. Returned by the DescribeEventAggregates operation.
See: newEventAggregate smart constructor.
Constructors
| EventAggregate' (Maybe Text) (Maybe Int) |
Instances
newEventAggregate :: EventAggregate Source #
Create a value of EventAggregate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aggregateValue:EventAggregate', eventAggregate_aggregateValue - The issue type for the associated count.
$sel:count:EventAggregate', eventAggregate_count - The number of events of the associated issue type.
EventDescription
data EventDescription Source #
The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
See: newEventDescription smart constructor.
Constructors
| EventDescription' (Maybe Text) |
Instances
newEventDescription :: EventDescription Source #
Create a value of EventDescription with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:latestDescription:EventDescription', eventDescription_latestDescription - The most recent description of the event.
EventDetails
data EventDetails Source #
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.
See: newEventDetails smart constructor.
Constructors
| EventDetails' (Maybe Event) (Maybe EventDescription) (Maybe (HashMap Text Text)) |
Instances
newEventDetails :: EventDetails Source #
Create a value of EventDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:event:EventDetails', eventDetails_event - Summary information about the event.
$sel:eventDescription:EventDetails', eventDetails_eventDescription - The most recent description of the event.
$sel:eventMetadata:EventDetails', eventDetails_eventMetadata - Additional metadata about the event.
EventDetailsErrorItem
data EventDetailsErrorItem Source #
Error information returned when a DescribeEventDetails operation can't find a specified event.
See: newEventDetailsErrorItem smart constructor.
Instances
newEventDetailsErrorItem :: EventDetailsErrorItem Source #
Create a value of EventDetailsErrorItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorMessage:EventDetailsErrorItem', eventDetailsErrorItem_errorMessage - A message that describes the error.
$sel:errorName:EventDetailsErrorItem', eventDetailsErrorItem_errorName - The name of the error.
$sel:eventArn:EventDetailsErrorItem', eventDetailsErrorItem_eventArn - 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
data EventFilter Source #
The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.
See: newEventFilter smart constructor.
Constructors
| EventFilter' (Maybe [Text]) (Maybe (NonEmpty DateTimeRange)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty EventStatusCode)) (Maybe (NonEmpty EventTypeCategory)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty DateTimeRange)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty DateTimeRange)) (Maybe [HashMap Text Text]) |
Instances
newEventFilter :: EventFilter Source #
Create a value of EventFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityZones:EventFilter', eventFilter_availabilityZones - A list of Amazon Web Services Availability Zones.
$sel:endTimes:EventFilter', eventFilter_endTimes - A list of dates and times that the event ended.
$sel:entityArns:EventFilter', eventFilter_entityArns - A list of entity ARNs (unique identifiers).
$sel:entityValues:EventFilter', eventFilter_entityValues - A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or
EBS volumes (vol-426ab23e).
$sel:eventArns:EventFilter', eventFilter_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"
$sel:eventStatusCodes:EventFilter', eventFilter_eventStatusCodes - A list of event status codes.
$sel:eventTypeCategories:EventFilter', eventFilter_eventTypeCategories - A list of event type category codes. Possible values are issue,
accountNotification, or scheduledChange. Currently, the
investigation value isn't supported at this time.
$sel:eventTypeCodes:EventFilter', eventFilter_eventTypeCodes - A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
$sel:lastUpdatedTimes:EventFilter', eventFilter_lastUpdatedTimes - A list of dates and times that the event was last updated.
$sel:regions:EventFilter', eventFilter_regions - A list of Amazon Web Services Regions.
$sel:services:EventFilter', eventFilter_services - The Amazon Web Services services associated with the event. For example,
EC2, RDS.
$sel:startTimes:EventFilter', eventFilter_startTimes - A list of dates and times that the event began.
$sel:tags:EventFilter', eventFilter_tags - A map of entity tags attached to the affected entity.
Currently, the tags property isn't supported.
EventType
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.
See: newEventType smart constructor.
Constructors
| EventType' (Maybe EventTypeCategory) (Maybe Text) (Maybe Text) |
Instances
| FromJSON EventType Source # | |
| Generic EventType Source # | |
| Read EventType Source # | |
| Show EventType Source # | |
| NFData EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType | |
| Eq EventType Source # | |
| Hashable EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType | |
| type Rep EventType Source # | |
Defined in Amazonka.AWSHealth.Types.EventType type Rep EventType = D1 ('MetaData "EventType" "Amazonka.AWSHealth.Types.EventType" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "EventType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventTypeCategory)) :*: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newEventType :: EventType Source #
Create a value of EventType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:category:EventType', eventType_category - A list of event type category codes. Possible values are issue,
accountNotification, or scheduledChange. Currently, the
investigation value isn't supported at this time.
$sel:code:EventType', eventType_code - The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION ; for example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
$sel:service:EventType', eventType_service - The Amazon Web Services service that is affected by the event. For
example, EC2, RDS.
EventTypeFilter
data EventTypeFilter Source #
The values to use to filter results from the DescribeEventTypes operation.
See: newEventTypeFilter smart constructor.
Constructors
| EventTypeFilter' (Maybe (NonEmpty EventTypeCategory)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) |
Instances
newEventTypeFilter :: EventTypeFilter Source #
Create a value of EventTypeFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eventTypeCategories:EventTypeFilter', eventTypeFilter_eventTypeCategories - A list of event type category codes. Possible values are issue,
accountNotification, or scheduledChange. Currently, the
investigation value isn't supported at this time.
$sel:eventTypeCodes:EventTypeFilter', eventTypeFilter_eventTypeCodes - A list of event type codes.
$sel:services:EventTypeFilter', eventTypeFilter_services - The Amazon Web Services services associated with the event. For example,
EC2, RDS.
OrganizationAffectedEntitiesErrorItem
data OrganizationAffectedEntitiesErrorItem Source #
Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
See: newOrganizationAffectedEntitiesErrorItem smart constructor.
Constructors
| OrganizationAffectedEntitiesErrorItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newOrganizationAffectedEntitiesErrorItem :: OrganizationAffectedEntitiesErrorItem Source #
Create a value of OrganizationAffectedEntitiesErrorItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsAccountId:OrganizationAffectedEntitiesErrorItem', organizationAffectedEntitiesErrorItem_awsAccountId - The 12-digit Amazon Web Services account numbers that contains the
affected entities.
$sel:errorMessage:OrganizationAffectedEntitiesErrorItem', organizationAffectedEntitiesErrorItem_errorMessage - The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION. For example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
$sel:errorName:OrganizationAffectedEntitiesErrorItem', organizationAffectedEntitiesErrorItem_errorName - The name of the error.
$sel:eventArn:OrganizationAffectedEntitiesErrorItem', organizationAffectedEntitiesErrorItem_eventArn - 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
OrganizationEvent
data OrganizationEvent Source #
Summary information about an event, returned by the DescribeEventsForOrganization operation.
See: newOrganizationEvent smart constructor.
Constructors
| OrganizationEvent' (Maybe Text) (Maybe POSIX) (Maybe EventScopeCode) (Maybe EventTypeCategory) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EventStatusCode) |
Instances
newOrganizationEvent :: OrganizationEvent Source #
Create a value of OrganizationEvent with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:OrganizationEvent', organizationEvent_arn - 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
$sel:endTime:OrganizationEvent', organizationEvent_endTime - The date and time that the event ended.
$sel:eventScopeCode:OrganizationEvent', organizationEvent_eventScopeCode - This parameter specifies if the Health event is a public Amazon Web
Services service event or an account-specific event.
- If the
eventScopeCodevalue isPUBLIC, then theaffectedAccountsvalue is always empty. - If the
eventScopeCodevalue isACCOUNT_SPECIFIC, then theaffectedAccountsvalue 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
eventScopeCodevalue isNONE, then theeventArnthat you specified in the request is invalid or doesn't exist.
$sel:eventTypeCategory:OrganizationEvent', organizationEvent_eventTypeCategory - A list of event type category codes. Possible values are issue,
accountNotification, or scheduledChange. Currently, the
investigation value isn't supported at this time.
$sel:eventTypeCode:OrganizationEvent', organizationEvent_eventTypeCode - The unique identifier for the event type. The format is
AWS_SERVICE_DESCRIPTION. For example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
$sel:lastUpdatedTime:OrganizationEvent', organizationEvent_lastUpdatedTime - The most recent date and time that the event was updated.
$sel:region:OrganizationEvent', organizationEvent_region - The Amazon Web Services Region name of the event.
$sel:service:OrganizationEvent', organizationEvent_service - The Amazon Web Services service that is affected by the event, such as
EC2 and RDS.
$sel:startTime:OrganizationEvent', organizationEvent_startTime - The date and time that the event began.
$sel:statusCode:OrganizationEvent', organizationEvent_statusCode - The most recent status of the event. Possible values are open,
closed, and upcoming.
OrganizationEventDetails
data OrganizationEventDetails Source #
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.
See: newOrganizationEventDetails smart constructor.
Constructors
| OrganizationEventDetails' (Maybe Text) (Maybe Event) (Maybe EventDescription) (Maybe (HashMap Text Text)) |
Instances
newOrganizationEventDetails :: OrganizationEventDetails Source #
Create a value of OrganizationEventDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsAccountId:OrganizationEventDetails', organizationEventDetails_awsAccountId - The 12-digit Amazon Web Services account numbers that contains the
affected entities.
$sel:event:OrganizationEventDetails', organizationEventDetails_event - Undocumented member.
$sel:eventDescription:OrganizationEventDetails', organizationEventDetails_eventDescription - Undocumented member.
$sel:eventMetadata:OrganizationEventDetails', organizationEventDetails_eventMetadata - Additional metadata about the event.
OrganizationEventDetailsErrorItem
data OrganizationEventDetailsErrorItem Source #
Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
See: newOrganizationEventDetailsErrorItem smart constructor.
Instances
newOrganizationEventDetailsErrorItem :: OrganizationEventDetailsErrorItem Source #
Create a value of OrganizationEventDetailsErrorItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsAccountId:OrganizationEventDetailsErrorItem', organizationEventDetailsErrorItem_awsAccountId - Error information returned when a
DescribeEventDetailsForOrganization
operation can't find a specified event.
$sel:errorMessage:OrganizationEventDetailsErrorItem', organizationEventDetailsErrorItem_errorMessage - 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.
$sel:errorName:OrganizationEventDetailsErrorItem', organizationEventDetailsErrorItem_errorName - The name of the error.
$sel:eventArn:OrganizationEventDetailsErrorItem', organizationEventDetailsErrorItem_eventArn - 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
data OrganizationEventFilter Source #
The values to filter results from the DescribeEventsForOrganization operation.
See: newOrganizationEventFilter smart constructor.
Constructors
| OrganizationEventFilter' (Maybe (NonEmpty Text)) (Maybe DateTimeRange) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty EventStatusCode)) (Maybe (NonEmpty EventTypeCategory)) (Maybe (NonEmpty Text)) (Maybe DateTimeRange) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe DateTimeRange) |
Instances
newOrganizationEventFilter :: OrganizationEventFilter Source #
Create a value of OrganizationEventFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsAccountIds:OrganizationEventFilter', organizationEventFilter_awsAccountIds - A list of 12-digit Amazon Web Services account numbers that contains the
affected entities.
$sel:endTime:OrganizationEventFilter', organizationEventFilter_endTime - Undocumented member.
$sel:entityArns:OrganizationEventFilter', organizationEventFilter_entityArns - A list of entity ARNs (unique identifiers).
$sel:entityValues:OrganizationEventFilter', organizationEventFilter_entityValues - A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or
EBS volumes (vol-426ab23e).
$sel:eventStatusCodes:OrganizationEventFilter', organizationEventFilter_eventStatusCodes - A list of event status codes.
$sel:eventTypeCategories:OrganizationEventFilter', organizationEventFilter_eventTypeCategories - A list of event type category codes. Possible values are issue,
accountNotification, or scheduledChange. Currently, the
investigation value isn't supported at this time.
$sel:eventTypeCodes:OrganizationEventFilter', organizationEventFilter_eventTypeCodes - A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
$sel:lastUpdatedTime:OrganizationEventFilter', organizationEventFilter_lastUpdatedTime - Undocumented member.
$sel:regions:OrganizationEventFilter', organizationEventFilter_regions - A list of Amazon Web Services Regions.
$sel:services:OrganizationEventFilter', organizationEventFilter_services - The Amazon Web Services services associated with the event. For example,
EC2, RDS.
$sel:startTime:OrganizationEventFilter', organizationEventFilter_startTime - Undocumented member.