| 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.DescribeEventsForOrganization
Description
Returns information about events across your organization in
Organizations. You can use thefilters parameter to specify the events
that you want to return. Events are returned in a summary form and
don't include the affected accounts, detailed description, any
additional metadata that depends on the event type, or any affected
resources. To retrieve that information, use the following operations:
- DescribeAffectedAccountsForOrganization
- DescribeEventDetailsForOrganization
- DescribeAffectedEntitiesForOrganization
If you don't specify a filter, the DescribeEventsForOrganizations
returns all events across your organization. Results are sorted by
lastModifiedTime, starting with the most recent event.
For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in
the next request to return more results.
This operation returns paginated results.
Synopsis
- data DescribeEventsForOrganization = DescribeEventsForOrganization' {}
- newDescribeEventsForOrganization :: DescribeEventsForOrganization
- describeEventsForOrganization_filter :: Lens' DescribeEventsForOrganization (Maybe OrganizationEventFilter)
- describeEventsForOrganization_locale :: Lens' DescribeEventsForOrganization (Maybe Text)
- describeEventsForOrganization_maxResults :: Lens' DescribeEventsForOrganization (Maybe Natural)
- describeEventsForOrganization_nextToken :: Lens' DescribeEventsForOrganization (Maybe Text)
- data DescribeEventsForOrganizationResponse = DescribeEventsForOrganizationResponse' {
- events :: Maybe [OrganizationEvent]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeEventsForOrganizationResponse :: Int -> DescribeEventsForOrganizationResponse
- describeEventsForOrganizationResponse_events :: Lens' DescribeEventsForOrganizationResponse (Maybe [OrganizationEvent])
- describeEventsForOrganizationResponse_nextToken :: Lens' DescribeEventsForOrganizationResponse (Maybe Text)
- describeEventsForOrganizationResponse_httpStatus :: Lens' DescribeEventsForOrganizationResponse Int
Creating a Request
data DescribeEventsForOrganization Source #
See: newDescribeEventsForOrganization smart constructor.
Constructors
| DescribeEventsForOrganization' | |
Fields
| |
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.
Request Lenses
describeEventsForOrganization_filter :: Lens' DescribeEventsForOrganization (Maybe OrganizationEventFilter) Source #
Values to narrow the results returned.
describeEventsForOrganization_locale :: Lens' DescribeEventsForOrganization (Maybe Text) Source #
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
describeEventsForOrganization_maxResults :: Lens' DescribeEventsForOrganization (Maybe Natural) Source #
The maximum number of items to return in one batch, between 10 and 100, inclusive.
describeEventsForOrganization_nextToken :: Lens' DescribeEventsForOrganization (Maybe Text) Source #
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.
Destructuring the Response
data DescribeEventsForOrganizationResponse Source #
See: newDescribeEventsForOrganizationResponse smart constructor.
Constructors
| DescribeEventsForOrganizationResponse' | |
Fields
| |
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.
Response Lenses
describeEventsForOrganizationResponse_events :: Lens' DescribeEventsForOrganizationResponse (Maybe [OrganizationEvent]) Source #
The events that match the specified filter criteria.
describeEventsForOrganizationResponse_nextToken :: Lens' DescribeEventsForOrganizationResponse (Maybe Text) Source #
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.
describeEventsForOrganizationResponse_httpStatus :: Lens' DescribeEventsForOrganizationResponse Int Source #
The response's http status code.