| 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.DescribeAffectedEntitiesForOrganization
Description
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service.
At least one event Amazon Resource Name (ARN) and account ID are required.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
- This API operation uses pagination. Specify the
nextTokenparameter in the next request to return more results. - This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
This operation returns paginated results.
Synopsis
- data DescribeAffectedEntitiesForOrganization = DescribeAffectedEntitiesForOrganization' {}
- newDescribeAffectedEntitiesForOrganization :: NonEmpty EventAccountFilter -> DescribeAffectedEntitiesForOrganization
- describeAffectedEntitiesForOrganization_locale :: Lens' DescribeAffectedEntitiesForOrganization (Maybe Text)
- describeAffectedEntitiesForOrganization_maxResults :: Lens' DescribeAffectedEntitiesForOrganization (Maybe Natural)
- describeAffectedEntitiesForOrganization_nextToken :: Lens' DescribeAffectedEntitiesForOrganization (Maybe Text)
- describeAffectedEntitiesForOrganization_organizationEntityFilters :: Lens' DescribeAffectedEntitiesForOrganization (NonEmpty EventAccountFilter)
- data DescribeAffectedEntitiesForOrganizationResponse = DescribeAffectedEntitiesForOrganizationResponse' {}
- newDescribeAffectedEntitiesForOrganizationResponse :: Int -> DescribeAffectedEntitiesForOrganizationResponse
- describeAffectedEntitiesForOrganizationResponse_entities :: Lens' DescribeAffectedEntitiesForOrganizationResponse (Maybe [AffectedEntity])
- describeAffectedEntitiesForOrganizationResponse_failedSet :: Lens' DescribeAffectedEntitiesForOrganizationResponse (Maybe [OrganizationAffectedEntitiesErrorItem])
- describeAffectedEntitiesForOrganizationResponse_nextToken :: Lens' DescribeAffectedEntitiesForOrganizationResponse (Maybe Text)
- describeAffectedEntitiesForOrganizationResponse_httpStatus :: Lens' DescribeAffectedEntitiesForOrganizationResponse Int
Creating a Request
data DescribeAffectedEntitiesForOrganization Source #
See: newDescribeAffectedEntitiesForOrganization smart constructor.
Constructors
| DescribeAffectedEntitiesForOrganization' | |
Fields
| |
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.
Request Lenses
describeAffectedEntitiesForOrganization_locale :: Lens' DescribeAffectedEntitiesForOrganization (Maybe Text) Source #
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
describeAffectedEntitiesForOrganization_maxResults :: Lens' DescribeAffectedEntitiesForOrganization (Maybe Natural) Source #
The maximum number of items to return in one batch, between 10 and 100, inclusive.
describeAffectedEntitiesForOrganization_nextToken :: Lens' DescribeAffectedEntitiesForOrganization (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.
describeAffectedEntitiesForOrganization_organizationEntityFilters :: Lens' DescribeAffectedEntitiesForOrganization (NonEmpty EventAccountFilter) Source #
A JSON set of elements including the awsAccountId and the eventArn.
Destructuring the Response
data DescribeAffectedEntitiesForOrganizationResponse Source #
See: newDescribeAffectedEntitiesForOrganizationResponse smart constructor.
Constructors
| DescribeAffectedEntitiesForOrganizationResponse' | |
Fields
| |
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.
Response Lenses
describeAffectedEntitiesForOrganizationResponse_entities :: Lens' DescribeAffectedEntitiesForOrganizationResponse (Maybe [AffectedEntity]) Source #
A JSON set of elements including the awsAccountId and its entityArn,
entityValue and its entityArn, lastUpdatedTime, and statusCode.
describeAffectedEntitiesForOrganizationResponse_failedSet :: Lens' DescribeAffectedEntitiesForOrganizationResponse (Maybe [OrganizationAffectedEntitiesErrorItem]) Source #
A JSON set of elements of the failed response, including the
awsAccountId, errorMessage, errorName, and eventArn.
describeAffectedEntitiesForOrganizationResponse_nextToken :: Lens' DescribeAffectedEntitiesForOrganizationResponse (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.
describeAffectedEntitiesForOrganizationResponse_httpStatus :: Lens' DescribeAffectedEntitiesForOrganizationResponse Int Source #
The response's http status code.